[#101] Update docs for frostfs.set_copies_number #119

Merged
dkirillov merged 1 commit from dkirillov/frostfs-s3-gw:update_docs into master 2023-05-25 09:11:10 +00:00
3 changed files with 12 additions and 10 deletions

View file

@ -124,8 +124,9 @@ S3_GW_PLACEMENT_POLICY_COPIES_NUMBERS_1_VECTOR=2 3 4
S3_GW_CORS_DEFAULT_MAX_AGE=600 S3_GW_CORS_DEFAULT_MAX_AGE=600
# Parameters of requests to FrostFS # Parameters of requests to FrostFS
# Number of the object copies to consider PUT to FrostFS successful. # Numbers of the object copies (for each replica, syntax the same as for `S3_GW_PLACEMENT_POLICY_COPIES_NUMBERS_0_VECTOR` above)
# If not set, default value 0 will be used -- it means that object will be processed according to the container's placement policy # to consider PUT to FrostFS successful.
# `0` or empty list means that object will be processed according to the container's placement policy
S3_GW_FROSTFS_SET_COPIES_NUMBER=0 S3_GW_FROSTFS_SET_COPIES_NUMBER=0
# List of allowed AccessKeyID prefixes # List of allowed AccessKeyID prefixes

View file

@ -148,9 +148,9 @@ cors:
# Parameters of requests to FrostFS # Parameters of requests to FrostFS
frostfs: frostfs:
# Number of the object copies to consider PUT to FrostFS successful. # Numbers of the object copies (for each replica) to consider PUT to FrostFS successful.
# `0` means that object will be processed according to the container's placement policy # `[0]` or empty list means that object will be processed according to the container's placement policy
set_copies_number: 0 set_copies_number: [0]
# List of allowed AccessKeyID prefixes # List of allowed AccessKeyID prefixes
# If the parameter is omitted, S3 GW will accept all AccessKeyIDs # If the parameter is omitted, S3 GW will accept all AccessKeyIDs

View file

@ -502,16 +502,17 @@ prometheus:
# `frostfs` section # `frostfs` section
Contains parameters of requests to FrostFS. Contains parameters of requests to FrostFS.
This value can be overridden with `X-Amz-Meta-Frostfs-Copies-Number` header for `PutObject`, `CopyObject`, `CreateMultipartUpload`. This value can be overridden with `X-Amz-Meta-Frostfs-Copies-Number` (value is comma separated numbers: `1,2,3`)
header for `PutObject`, `CopyObject`, `CreateMultipartUpload`.
```yaml ```yaml
frostfs: frostfs:
set_copies_number: 0 set_copies_number: [0]
``` ```
| Parameter | Type | Default value | Description | | Parameter | Type | Default value | Description |
|---------------------|----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `set_copies_number` | `uint32` | `0` | Number of the object copies to consider PUT to FrostFS successful. <br/>Default value `0` means that object will be processed according to the container's placement policy | | `set_copies_number` | `[]uint32` | `[0]` | Numbers of the object copies (for each replica) to consider PUT to FrostFS successful. <br/>Default value `[0]` or empty list means that object will be processed according to the container's placement policy |
# `resolve_bucket` section # `resolve_bucket` section