Skip to content

Commit

Permalink
docs/index.md: Update .kci-dev.toml informations with pipeline and api
Browse files Browse the repository at this point in the history
Signed-off-by: Arisu Tachibana <arisu.tachibana@miraclelinux.com>
  • Loading branch information
aliceinwire committed Nov 6, 2024
1 parent e6a78fb commit 1dc963c
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,29 +28,24 @@ kci-dev uses a configuration file .kci-dev.toml in the program directory.
default_instance="local"

[local]
host="https://127.0.0.1"
pipeline="https://127.0.0.1"
api="https://127.0.0.1:8001/"
token="example"

[staging_pipeline]
host="https://staging.kernelci.org:9100/"
[staging]
pipeline="https://staging.kernelci.org:9100/"
api="https://staging.kernelci.org:9000/"
token="example"

[staging_api]
host="https://staging.kernelci.org:9000/"
token="example"

[production_pipeline]
host="https://kernelci-pipeline.westus3.cloudapp.azure.com/"
token="example"

[production_api]
host="https://kernelci-api.westus3.cloudapp.azure.com/"
[production]
pipeline="https://kernelci-pipeline.westus3.cloudapp.azure.com/"
api="https://kernelci-api.westus3.cloudapp.azure.com/"
token="example"
```

Where `default_instance` is the default instance to use, if not provided in the command line.
In section `local`, `staging`, `production` you can provide the host and token for the available instances.
host is the URL of the KernelCI Pipeline API endpoint, and token is the API token to use for authentication.
In section `local`, `staging`, `production` you can provide the host for the pipeline, api and also a token for the available instances.
pipeline is the URL of the KernelCI Pipeline API endpoint, api is the URL of the new KernelCI API endpoint, and token is the API token to use for authentication.
If you are using KernelCI Pipeline instance, you can get the token from the project maintainers.
If it is a local instance, you can generate your token using [kernelci-pipeline/tools/jwt_generator.py](https://github.com/kernelci/kernelci-pipeline/blob/main/tools/jwt_generator.py) script.

Expand All @@ -61,7 +56,7 @@ You can provide the instance name to use for the command.

Example:
```sh
kci-dev --instance staging_api
kci-dev --instance staging
```

### settings
Expand Down

0 comments on commit 1dc963c

Please sign in to comment.