From ce9294685c46eb8ae7ea2ebedc93a6fc1c21c9c1 Mon Sep 17 00:00:00 2001 From: Denis Kirillov Date: Wed, 24 May 2023 09:40:45 +0300 Subject: [PATCH] [#101] Update docs for frostfs.set_copies_number Signed-off-by: Denis Kirillov --- config/config.env | 5 +++-- config/config.yaml | 6 +++--- docs/configuration.md | 11 ++++++----- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/config/config.env b/config/config.env index 0a2282c9..5ae99158 100644 --- a/config/config.env +++ b/config/config.env @@ -124,8 +124,9 @@ S3_GW_PLACEMENT_POLICY_COPIES_NUMBERS_1_VECTOR=2 3 4 S3_GW_CORS_DEFAULT_MAX_AGE=600 # Parameters of requests to FrostFS -# Number of the object copies to consider PUT to FrostFS successful. -# If not set, default value 0 will be used -- it means that object will be processed according to the container's placement policy +# Numbers of the object copies (for each replica, syntax the same as for `S3_GW_PLACEMENT_POLICY_COPIES_NUMBERS_0_VECTOR` above) +# 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 # List of allowed AccessKeyID prefixes diff --git a/config/config.yaml b/config/config.yaml index e5f72d66..1b757ddf 100644 --- a/config/config.yaml +++ b/config/config.yaml @@ -148,9 +148,9 @@ cors: # Parameters of requests to FrostFS frostfs: - # Number of the object copies to consider PUT to FrostFS successful. - # `0` means that object will be processed according to the container's placement policy - set_copies_number: 0 + # Numbers of the object copies (for each replica) to consider PUT to FrostFS successful. + # `[0]` or empty list means that object will be processed according to the container's placement policy + set_copies_number: [0] # List of allowed AccessKeyID prefixes # If the parameter is omitted, S3 GW will accept all AccessKeyIDs diff --git a/docs/configuration.md b/docs/configuration.md index 454dd36a..36724ee9 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -502,16 +502,17 @@ prometheus: # `frostfs` section 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 frostfs: - set_copies_number: 0 + set_copies_number: [0] ``` -| Parameter | Type | Default value | Description | -|---------------------|----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `set_copies_number` | `uint32` | `0` | Number of the object copies to consider PUT to FrostFS successful.
Default value `0` means that object will be processed according to the container's placement policy | +| Parameter | Type | Default value | Description | +|---------------------|------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `set_copies_number` | `[]uint32` | `[0]` | Numbers of the object copies (for each replica) to consider PUT to FrostFS successful.
Default value `[0]` or empty list means that object will be processed according to the container's placement policy | # `resolve_bucket` section