mirrors/distribution
0
0 Fork 0
mirror of https://github.com/distribution/distribution.git synced 2026-10-28 10:15:27 +08:00
Code Activity

docs(storage-drivers/gcs): document credentials, maxconcurrency and useragent

Browse Source 
The GCS driver reads three parameters that the parameters table in
docs/content/storage-drivers/gcs.md does not list:

- `credentials`: an inline service account key, used when `keyfile` is
  not set. It already appears in the configuration.md example, but not
  in the driver page.
- `maxconcurrency`: the limit passed to base.NewRegulator. It defaults
  to 50 (defaultMaxConcurrency) and is raised to 25 (minConcurrency)
  when set lower.
- `useragent`: passed to the storage client with option.WithUserAgent.

Add a row for each.

Signed-off-by: ump45nose <52391318+ump45nose@users.noreply.github.com>
This commit is contained in:
ump45nose committed 2026-10-17 07:35:22 +08:00
1 parent 7ffd469066
commit 41688c0f58
1 file changed
+3
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/storage-drivers/gcs.md
+3
View File
@@ -12,8 +12,11 @@ An implementation of the `storagedriver.StorageDriver` interface which uses Goog
|:--------------|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `bucket` | yes | The name of your Google Cloud Storage bucket where you wish to store objects (needs to already be created prior to driver initialization). |
| `keyfile` | no | A private service account key file in JSON format used for [Service Account Authentication](https://cloud.google.com/storage/docs/authentication#service_accounts). |
| `credentials` | no | A service account key given inline as a map, with the same fields as the JSON key file (`type`, `project_id`, `private_key_id`, `private_key`, `client_email`, and so on). Ignored when `keyfile` is set. |
| `rootdirectory` | no | The root directory tree in which all registry files are stored. Defaults to the empty string (bucket root). If a prefix is used, the path `bucketname/<prefix>` has to be pre-created before starting the registry. The prefix is applied to all Google Cloud Storage keys to allow you to segment data in your bucket if necessary.|
| `chunksize` | no (default 16777216) | This is the chunk size used for uploading large blobs, must be a multiple of 256*1024. |
| `maxconcurrency` | no (default 50) | The maximum number of concurrent Google Cloud Storage operations the driver runs. Values below 25 are raised to 25. |
| `useragent` | no | The `User-Agent` header value sent by the Google Cloud Storage client. |
{{< hint type=note >}}
Instead of a key file you can use [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials).