Commit ee73f5f7 authored by Marcia Ramos's avatar Marcia Ramos

Merge branch '26777-add-documentation' into 'master'

Documentation for Typed AWS Environment Variables

See merge request gitlab-org/gitlab!29325
parents 78af9da0 eea71bc4
...@@ -81,6 +81,8 @@ echo "$KUBE_CA_PEM" > "$(pwd)/kube.ca.pem" ...@@ -81,6 +81,8 @@ echo "$KUBE_CA_PEM" > "$(pwd)/kube.ca.pem"
kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$(pwd)/kube.ca.pem" kubectl config set-cluster e2e --server="$KUBE_URL" --certificate-authority="$(pwd)/kube.ca.pem"
``` ```
There are [some predefined variables](#custom-variables-validated-by-gitlab) of this type, which may be further validated. They will appear when you add or update a variable.
##### File type ##### File type
The example above can now be simplified by creating a "File" type variable, and using The example above can now be simplified by creating a "File" type variable, and using
...@@ -116,6 +118,21 @@ If the value does not meet the requirements above, then the CI variable will fai ...@@ -116,6 +118,21 @@ If the value does not meet the requirements above, then the CI variable will fai
In order to save, either alter the value to meet the masking requirements In order to save, either alter the value to meet the masking requirements
or disable **Masked** for the variable. or disable **Masked** for the variable.
#### Custom variables validated by GitLab
Some variables are listed in the UI so you can choose them more quickly.
GitLab validates the values of these variables to ensure they are in the correct format.
| Variable | Allowed Values | Introduced in |
|-------------------------|----------------------------------------------------|---------------|
| `AWS_ACCESS_KEY_ID` | 20 characters: letters, digits | 12.10 |
| `AWS_DEFAULT_REGION` | Any | 12.10 |
| `AWS_SECRET_ACCESS_KEY` | 40 characters: letters, digits, special characters | 12.10 |
NOTE: **Note:**
When you store credentials, there are security implications. If you are using AWS keys,
for example, follow their [best practices](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html).
## Getting started ## Getting started
To get started with environment variables in the scope of GitLab To get started with environment variables in the scope of GitLab
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment