From d16baf4b0ad956645d67342ba794c2ae329cc5e7 Mon Sep 17 00:00:00 2001 From: Denys Fedoryshchenko Date: Thu, 16 Jul 2026 20:11:36 +0300 Subject: [PATCH] github: update API tokens issue template for Maestro API The template still described the retired kernelci-backend and its admin-issued permission-scoped tokens. Update it for the Maestro API (kernelci-api): access is based on user accounts with an invite flow, reads are public and need no token, and accounts are only needed to send data. Split lab owner guidance by lab type: pull labs need an API account to poll for jobs and push results, while LAVA labs use a callback token set up in the lab itself. Also fix the stale staging URL. Signed-off-by: Denys Fedoryshchenko --- .github/ISSUE_TEMPLATE/kernelci-api-tokens.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/kernelci-api-tokens.md b/.github/ISSUE_TEMPLATE/kernelci-api-tokens.md index 28f4237217..b10b455d8a 100644 --- a/.github/ISSUE_TEMPLATE/kernelci-api-tokens.md +++ b/.github/ISSUE_TEMPLATE/kernelci-api-tokens.md @@ -1,15 +1,17 @@ --- -name: KernelCI API tokens -about: Request to get some KernelCI API tokens -title: Request API tokens for USER +name: KernelCI API accounts +about: Request a KernelCI (Maestro) API account +title: Request API account for USER labels: '' assignees: '' --- -KernelCI uses kernelci-backend to manage its database which contains all the data about builds and tests. There are 2 main instances, a production one for kernelci.org and a test one for staging.kernelci.org. Separate tokens can be provided for either or both, with several permissions to choose from. KernelCI labs will also typically need a token to be able to push their test results. +KernelCI uses the [Maestro API](https://github.com/kernelci/kernelci-api) to manage its database which contains all the data about builds and tests. There are 2 main instances, a production one for kernelci.org and a staging one for testing changes. Access is based on user accounts: an admin sends you an invitation link, you set a password and then obtain API tokens by logging in. Reading data doesn't require any account or token, so this is only needed to send data to the API. -Please answer the questions below to request some API tokens: +Lab owners connecting their lab to KernelCI typically need an account for [pull labs](https://docs.kernelci.org/components/maestro/pipeline/connecting-pull-lab/), which poll the API for jobs and push their test results. [LAVA labs](https://docs.kernelci.org/components/maestro/pipeline/connecting-lab/) don't need an API account: they use a callback token generated in the lab itself and added to the pipeline configuration. + +Please answer the questions below to request an account: **Contact details** @@ -17,28 +19,26 @@ Please answer the questions below to request some API tokens: ⇨ Email address: -If this is for a lab token: +If this is for a lab: ⇨ Lab owner first and last names: ⇨ Lab name: +⇨ Lab type (pull lab or LAVA): + **Production** -The production instance is the one behind `https://kernelci.org`. Production tokens are only provided for labs that are able to send useful data, or with read-only permissions to create dashboards or consume the results data in any way (stats, reports...). Uses of the kernelci.org production data should ideally be made public. +The production instance is the one behind `https://kernelci.org`. Production accounts are only provided for labs and services that are able to send useful data. Reading the production data doesn't require an account. The URL of the production API server is `https://api.kernelci.org`. -Do you need a token to access the production API? If so, is this to be able to read the data or also send some test results from a lab? - -⇨ Read-only or also to to push results: +⇨ Do you need an account on the production API? **Staging** -The URL of the staging API server is `https://staging-api.kernelci.org`. - -The staging instance is used for experimental features without impacting the production instance. This is useful for anything new that needs to be tested in a full KernelCI environment with results publicly available on `https://staging.kernelci.org` but not sent to regular mailing lists. +The URL of the staging API server is `https://staging.kernelci.org:9000`. -Do you need a token to access the staging API? If so, is this to be able to read the data or send some test results from a lab? +The staging instance is used for experimental features without impacting the production instance. This is useful for anything new that needs to be tested in a full KernelCI environment before moving to production. -⇨ Read-only or also to push results: +⇨ Do you need an account on the staging API?