Secrets in Jobs¶
Sometimes you want to use sensitive information within your code. Examples are: passwords, OAuth tokens, or ssh keys. The best practice for saving such information in Kubernetes is via Kubernetes Secrets. Kubernetes Secrets let you store and manage sensitive information. Access to secrets is limited via configuration.
A Kubernetes secret may hold multiple key - value pairs.
Using Secrets in Run:AI Jobs¶
Our goal is to provide Run:AI Jobs with secrets as input in a secure way. Using the Run:AI command-line, you will be able to pass a reference to a secret that already exists in Kubernetes.
Creating a secret¶
For details on how to create a Kubernetes secret see: https://kubernetes.io/docs/concepts/configuration/secret/. Here is an example:
apiVersion: v1 kind: Secret metadata: name: my-secret namespace: runai-<project-name> data: username: am9obgo= password: bXktcGFzc3dvcmQK
kubectl apply -f <file-name>
- Secrets are base64 encoded
- Secrets are stored in the scope of a namespace and will not be accessible from other namespaces. Hence the reference to the Run:AI Project name above. Run:AI provides the ability to propagate secrets throughout all Run:AI Projects. See below.
Attaching a secret to a Job on Submit¶
When you submit a new Job, you will want to connect the secret to the new Job. To do that, run:
runai submit -e <ENV-VARIABLE>=SECRET:<secret-name>,<secret-key> ....
runai submit -i ubuntu -e MYUSERNAME=SECRET:my-secret,username
Secrets and Projects¶
The feature described below is not enabled by default in Run:AI cluster installations
As per the note above, secrets are namespace-specific. If your secret relates to all Run:AI Projects, do the following to propagate the secret to all Projects:
- Create a secret within the
- Run the following once to allow Run:AI to propagate the secret to all Run:AI Projects:
runai-adm set secret <secret name> --cluster-wide
The Run:AI Administrator CLI can be obtained here.
To delete a secret from all Run:AI Projects, run:
runai-adm remove secret <secret name> --cluster-wide
Secrets and Templates¶
A Secret can be set at the template level. For additional information see template configuration