kernelci / kernelci/kernelci-pipeline
Add template parameter for Kubernetes secret holding API token
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 11
- Forks
- 40
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 14
Description
At the moment, the Kubernetes secret containing the API key is hard-coded in the job template:
env:
- name: API_TOKEN
valueFrom:
secretKeyRef:
name: {{ "kci-api-jwt-staging" }}
key: token
This probably should become a parameter in the API configuration in YAML, or rely on a convention based on the API configuration name. The current standard API configurations are:
api_configs:
docker-host:
url: http://172.17.0.1:8001
staging.kernelci.org:
url: https://staging.kernelci.org:9000
So we could have something like kci-api-jtw-{{ config }} e.g. kci-api-jwt-staging.kernelci.org. Maybe this could be a first step, and if we're hitting limitations such as a requirement to have multiple secret token names then this could be changed to a YAML configuration parameter instead.
Note: A similar but not identical issue needs to be resolved for the storage credentials, so maybe a common way of handling "secrets" would be good to make it easier for users to configure a whole system.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the job template containing the hard-coded kci-api-jwt-staging secret and review how API configurations are loaded from YAML. Compare the proposed convention with the storage-credential concern and existing configuration names. Done means API token secrets can be selected through supported configuration rather than remaining hard-coded, with the documented limitation addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- devops, infrastructure
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100