Skip to content

Commit ad5f244

Browse files
committed
(docs) Update staging documentation
Explain a bit better way how staging instance works, also remove encouragement to obtain Staging credentials, because it is needed only in very specific cases. Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
1 parent 2d9d037 commit ad5f244

1 file changed

Lines changed: 27 additions & 13 deletions

File tree

doc/staging.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,36 @@ description: "Staging API"
55
weight: 5
66
---
77

8-
Maestro has a staging instance running for development purposes.
9-
It allows users to request an account on the new KernelCI API to give it a try. You can also enable your
10-
trees, builds, and tests on it. Here is the
11-
[developer documentation](https://docs.kernelci.org/maestro/pipeline/developer-documentation/) for the same.
12-
13-
[Staging
14-
deployment](https://github.com/kernelci/kernelci-api/tree/main/kube/aks)
15-
can already run a pipeline with KUnit, kselftest, kernel builds
16-
and boot tests. So please give it a go and create issues on
17-
GitHub and ask questions on the [mailing
18-
list](mailto:kernelci@lists.linux.dev), IRC `#kernelci` on libera.chat
19-
or [Slack](https://kernelci.slack.com) with whatever you may find.
8+
Maestro maintains a staging instance for development purposes.
9+
10+
This environment allows you to test the latest changes and features before they are
11+
merged into the production KernelCI API.
12+
If you contribute to the kernelci-core, kernelci-pipeline, or kernelci-api repositories and
13+
open a pull request, staging will automatically incorporate your changes (provided you're on the [contributor list](https://github.com/kernelci/kernelci-deploy/blob/main/data/staging.ini))
14+
and deploy them to the staging instance. This enables you to test your changes
15+
and receive feedback from other contributors before merging into the production API.
16+
The staging instance updates every 8 hours or can be manually triggered by
17+
the sysadmin team. You can also exclude a pull request from deployment by adding the `staging-skip` label.
18+
It is highly recommended to set such label if your pull request is not ready for
19+
deployment and might break the staging instance.
20+
21+
The staging deployment runs only
22+
kernelci-stable, kernelci-mainline, and kernelci-next branches by default, which are mirrors of
23+
Linux kernel trees. If you need to test changes with a different tree or are adding a new
24+
tree, you can use the [kci-dev](https://github.com/kernelci/kci-dev) tool to trigger jobs on the staging instance.
25+
The staging instance is not intended for production use and stability is not
26+
guaranteed. Occasional crashes are expected.
27+
28+
Please try it out and report any issues on
29+
GitHub or ask questions through the [available contacts](https://kernelci.org/community-contact/).
30+
31+
[Developer documentation](https://docs.kernelci.org/maestro/pipeline/developer-documentation/)
2032

2133
## Requesting a user account
2234

23-
Anyone interested is very much encouraged to request an account.
35+
If your workflow requires authenticated access to the API (you need to submit your own nodes),
36+
you need to request a user account. This is done via the KernelCI GitHub
37+
repository. The user account will be created for you by the sysadmin team.
2438

2539
It can be done in two simple steps:
2640

0 commit comments

Comments
 (0)