kci-dev

Tool for interact programmatically with KernelCI instances.

kci-dev is a cmdline tool for interact with a enabled KernelCI server.
Purpose of this tool to provide a easy way to use features of KernelCI Pipeline instance.

Installation

Using PyPI and virtualenv

virtualenv .venv
source .venv/bin/activate
pip install kci-dev

Using poetry and virtualenv

virtualenv .venv
source .venv/bin/activate
pip install poetry
poetry install
poetry run kci-dev

Configuration

kci-dev searches for and loads a configuration file in the following order of priority:

The global configuration file located at /etc/kci-dev.toml.
The user-specific configuration file at ~/.config/kci-dev/kci-dev.toml
A site-specific configuration file, which is .kci-dev.toml by default, but can be overridden with the –settings option.

Priority: The configuration files are loaded in the order listed above, with each subsequent file overriding the settings from the previous one.
If a user-specific file is present, it will override the global configuration.
The site-specific file, whether default or specified by –settings, takes precedence over both the global and user-specific configuration files.

default_instance="local"

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

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

[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 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 script.

Options

instance

You can provide the instance name to use for the command.

Example:

kci-dev --instance staging

settings

You can provide the configuration file path to use for the command.