Skip to content

Commit ef4d8dc

Browse files
committed
Add UniverseDomain configuration for GCS cache
Document the UniverseDomain parameter added in https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/6338 for Google Cloud Storage cache configuration. This parameter enables support for Google Cloud Dedicated and other custom universe domains. Relates to https://gitlab.com/gitlab-org/gitlab/-/work_items/581881
1 parent 2252fc2 commit ef4d8dc

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

docs/configuration/advanced-configuration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1690,6 +1690,7 @@ about these values, see the
16901690
| `AccessID` | string | ID of GCP Service Account used to access the storage. |
16911691
| `PrivateKey` | string | Private key used to sign GCS requests. |
16921692
| `BucketName` | string | Name of the storage bucket where cache is stored. |
1693+
| `UniverseDomain` | string | Universe domain for GCS requests (optional). For public Google Cloud, use `googleapis.com`. For Google Cloud Dedicated or other custom universe domains, specify the appropriate domain (for example, `custom.universe.com`). If you don't specify a domain, the default is `googleapis.com`. |
16931694

16941695
Examples:
16951696

@@ -1704,6 +1705,7 @@ Examples:
17041705
AccessID = "cache-access-account@test-project-123456.iam.gserviceaccount.com"
17051706
PrivateKey = "-----BEGIN PRIVATE KEY-----\nXXXXXX\n-----END PRIVATE KEY-----\n"
17061707
BucketName = "runners-cache"
1708+
UniverseDomain = "googleapis.com" # Optional
17071709
```
17081710

17091711
**Credentials in JSON file downloaded from GCP**:
@@ -1716,6 +1718,7 @@ Examples:
17161718
[runners.cache.gcs]
17171719
CredentialsFile = "/etc/gitlab-runner/service-account.json"
17181720
BucketName = "runners-cache"
1721+
UniverseDomain = "googleapis.com" # Optional
17191722
```
17201723

17211724
**Application Default Credentials (ADC) from the metadata server in GCP**:
@@ -1729,6 +1732,7 @@ When you use GitLab Runner with Google Cloud ADC, you typically use the default
17291732
Shared = false
17301733
[runners.cache.gcs]
17311734
BucketName = "runners-cache"
1735+
UniverseDomain = "googleapis.com" # Optional
17321736
```
17331737

17341738
If you use ADC, be sure that the service account that you use has the `iam.serviceAccounts.signBlob` permission. Typically this is done by granting the [Service Account Token Creator role](https://docs.cloud.google.com/iam/docs/service-account-permissions#token-creator-role) to the service account.

0 commit comments

Comments
 (0)