Skip to content

fix(srv): update Jobs x Secrets doc wording #3937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2024
Merged

fix(srv): update Jobs x Secrets doc wording #3937

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions serverless/jobs/how-to/reference-secret-in-job.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ A [job run](/serverless/jobs/concepts/#job-run) accesses each secret at startup,

5. Select the desired reference method:

- **File**: copies the encrypted value of your secret to a file stored at the indicated location within your container. This method is recommended for large or complex data. For example, if your secret is a certificate, you can store it as a file in the `/my-certificates` folder in your container.
- **File**: copies the encrypted value of your secret to a file stored at the indicated location within your job. This method is recommended for large or complex data. For example, if your secret is a certificate, you can store it as a file in the `/my-certificates` folder in your job.

- **Environment variable**: passes the encrypted value of your secret to your job as a variable. This method is recommended for small pieces of information, such as passwords, or API secret keys. For example, if you name this variable `MY_SECRET`, calling `$MY_SECRET` in your container will return the value of the selected secret in a secure way.
- **Environment variable**: passes the encrypted value of your secret to your job as a variable. This method is recommended for small pieces of information, such as passwords, or API secret keys. For example, if you name this variable `MY_SECRET`, calling `$MY_SECRET` in your job will return the value of the selected secret in a secure way.

6. Click **Add reference** to add the secret to your Serverless Job. Optionally, tick the **Add another reference** to add a new secret right away, then repeat steps 4 to 6.

The secret is now referenced in your Serverless Job, and can be used within the container.
The secret is now referenced in your Serverless Job, and can be used within the job.

## Update a secret reference from a job

Expand All @@ -60,7 +60,7 @@ The secret is now referenced in your Serverless Job, and can be used within the
5. Either update the location of the file, or the name of the environment variable, then click **Update reference** to confirm your changes.

<Message type="note">
You cannot change the reference method of an existing secret. You have to delete the secret reference within the job first, then create it again with the desired reference method.
You cannot change the reference method of an existing secret. To modify it, first delete the secret reference within the job, then create a new one with the desired reference method.
</Message>

## Delete a secret reference from a job
Expand Down