Skip to content

Commit

Permalink
Merge pull request #1266 from run-ai/Credentials_fix
Browse files Browse the repository at this point in the history
Update credentials.md
  • Loading branch information
camielRunai authored Dec 2, 2024
2 parents 033eff5 + a702149 commit db262d4
Showing 1 changed file with 15 additions and 16 deletions.
31 changes: 15 additions & 16 deletions docs/platform-admin/workloads/assets/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,38 +184,37 @@ Add secrets in advance to be used when creating credentials via the Run:ai UI.
Follow the steps below for each required scope:

=== "Cluster scope"

1. Create the secret in the Run:ai namespace (runai)
2. To authorize Run:ai to use the secret, label it: `run.ai/cluster-wide: "true"`
3. Label the secret with the correct credential type:
1. Docker registry - `run.ai/cluster-wide: "docker-registry"`
2. Access key - `run.ai/cluster-wide: "access-key"`
3. Username and password - `run.ai/cluster-wide: "password"`
4. Generic secret - `run.ai/cluster-wide: "generic"` ֿ

1. Docker registry - `run.ai/resource: "docker-registry"`
2. Access key - `run.ai/resource: "access-key"`
3. Username and password - `run.ai/resource: "password"`
4. Generic secret - `run.ai/resource: "generic"` ֿ

=== "Department scope"

1. Create the secret in the Run:ai namespace (runai)
2. To authorize Run:ai to use the secret, label it: `run.ai/department: "<name of department>"`
2. To authorize Run:ai to use the secret, label it: `run.ai/department: "<department id>"`
3. Label the secret with the correct credential type:
1. Docker registry - `run.ai/cluster-wide: "docker-registry"`
2. Access key - `run.ai/cluster-wide: "access-key"`
3. Username and password - `run.ai/cluster-wide: "password"`
4. Generic secret - `run.ai/cluster-wide: "generic"`

1. Docker registry - `run.ai/resource: "docker-registry"`
2. Access key - `run.ai/resource: "access-key"`
3. Username and password - `run.ai/resource: "password"`
4. Generic secret - `run.ai/resource: "generic"`

=== "Project scope"

1. Create the secret in the project’s namespace
2. Label the secret with the correct credential type:
1. Docker registry - `run.ai/cluster-wide: "docker-registry"`
2. Access key - `run.ai/cluster-wide: "access-key"`
3. Username and password - `run.ai/cluster-wide: "password"`
4. Generic secret - `run.ai/cluster-wide: "generic"`
1. Docker registry - `run.ai/resource: "docker-registry"`
2. Access key - `run.ai/resource: "access-key"`
3. Username and password - `run.ai/resource: "password"`
4. Generic secret - `run.ai/resource: "generic"`

The secret is now displayed for that scope in the list of existing secrets.


## Using API

To view the available actions, go to the [Credentials](https://app.run.ai/api/docs#tag/Credentials) API reference
To view the available actions, go to the [Credentials](https://app.run.ai/api/docs#tag/Credentials) API reference

0 comments on commit db262d4

Please sign in to comment.