Verified Commit 381a5b48 authored by Tomasz Maczukin's avatar Tomasz Maczukin
Browse files

Add cache config deprecations table to docs

parent 50866cc9
Pipeline #29905010 passed with stages
in 28 minutes and 29 seconds
......@@ -513,6 +513,25 @@ With GitLab Runner 11.3.0, the configuration parameters related to S3 were moved
The old format of the configuration with S3 configured directly in `[runners.cache]` section is still supported,
but is deprecated with GitLab Runner 11.3.0. **This support will be removed in GitLab Runner 12.0.0**.
Bellow is a table containing a summary of `config.toml`, cli options and ENV variables deprecations:
| Setting | TOML field | CLI option for `register` | ENV for `register` | deprecated TOML field | deprecated CLI option | deprecated ENV |
|---------------------|------------------------------------------|--------------------------------|-----------------------------------|-------------------------------------|-------------------------|-----------------------|
| Type | `[runners.cache] -> Type` | `--cache-type` | `$CACHE_TYPE` | | | |
| Path | `[runners.cache] -> Path` | `--cache-path` | `$CACHE_PATH` | | `--cache-s3-cache-path` | `$S3_CACHE_PATH` |
| Shared | `[runners.cache] -> Shared` | `--cache-shared` | `$CACHE_SHARED` | | `--cache-cache-shared` | |
| S3.ServerAddress | `[runners.cache.s3] -> ServerAddress` | `--cache-s3-server-address` | `$CACHE_S3_SERVER_ADDRESS` | `[runners.cache] -> ServerAddress` | | `$S3_SERVER_ADDRESS` |
| S3.AccessKey | `[runners.cache.s3] -> AccessKey` | `--cache-s3-access-key` | `$CACHE_S3_ACCESS_KEY` | `[runners.cache] -> AccessKey` | | `$S3_ACCESS_KEY` |
| S3.SecretKey | `[runners.cache.s3] -> SecretKey` | `--cache-s3-secret-key` | `$CACHE_S3_SECRET_KEY` | `[runners.cache] -> SecretKey` | | `$S3_SECRET_KEY` |
| S3.BucketName | `[runners.cache.s3] -> BucketName` | `--cache-s3-bucket-name` | `$CACHE_S3_BUCKET_NAME` | `[runners.cache] -> BucketName` | | `$S3_BUCKET_NAME` |
| S3.BucketLocation | `[runners.cache.s3] -> BucketLocation` | `--cache-s3-bucket-location` | `$CACHE_S3_BUCKET_LOCATION` | `[runners.cache] -> BucketLocation` | | `$S3_BUCKET_LOCATION` |
| S3.Insecure | `[runners.cache.s3] -> Insecure` | `--cache-s3-insecure` | `$CACHE_S3_INSECURE` | `[runners.cache] -> Insecure` | | `$S3_INSECURE` |
| GCS.AccessID | `[runners.cache.gcs] -> AccessID` | `--cache-gcs-access-id` | `$CACHE_GCS_ACCESS_ID` | | | |
| GCS.PrivateKey | `[runners.cache.gcs] -> PrivateKey` | `--cache-gcs-private-key` | `$CACHE_GCS_PRIVATE_KEY` | | | |
| GCS.CredentialsFile | `[runners.cache.gcs] -> CredentialsFile` | `--cache-gcs-credentials-file` | `$GOOGLE_APPLICATION_CREDENTIALS` | | | |
| GCS.BucketName | `[runners.cache.gcs] -> BucketName` | `--cache-gcs-bucket-name` | `$CACHE_GCS_BUCKET_NAME` | | | |
### The `[runners.cache.s3]` section
NOTE: **Note:**
......
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