From ce543e910cd183efc7ff98a3cb5c34984aee50c1 Mon Sep 17 00:00:00 2001 From: Angira Kekteeva Date: Fri, 12 Aug 2022 03:13:02 +0400 Subject: [PATCH] [#634] Update docs Signed-off-by: Angira Kekteeva --- CHANGELOG.md | 1 + config/config.env | 4 ++++ config/config.yaml | 6 ++++++ docs/configuration.md | 40 +++++++++++++++++++++++++++------------- 4 files changed, 38 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cc0d2228..e047a23f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ This document outlines major changes between releases. ### Added - Exposure of pool metrics (#615) +- Configuration of `set_copies_number` (#634) ### Changed - Improved wallet configuration via `.yaml` config and environment variables (#607) ### Removed diff --git a/config/config.env b/config/config.env index 60bfd3e0..b90ac0a3 100644 --- a/config/config.env +++ b/config/config.env @@ -99,3 +99,7 @@ S3_GW_DEFAULT_POLICY="REP 3" # value of Access-Control-Max-Age header if this value is not set in a rule. Has an int type. S3_GW_CORS_DEFAULT_MAX_AGE=600 +# Parameters of requests to NeoFS +# Number of the object copies to consider PUT to NeoFS successful. +# If not set, default value 0 will be used -- it means that object will be processed according to the container's placement policy +S3_GW_NEOFS_SET_COPIES_NUMBER=0 diff --git a/config/config.yaml b/config/config.yaml index d421b23b..95fda40e 100644 --- a/config/config.yaml +++ b/config/config.yaml @@ -111,3 +111,9 @@ default_policy: REP 3 # value of Access-Control-Max-Age header if this value is not set in a rule. Has an int type. cors: default_max_age: 600 + +# Parameters of requests to NeoFS +neofs: +# Number of the object copies to consider PUT to NeoFS successful. +# `0` means that object will be processed according to the container's placement policy + set_copies_number: 0 diff --git a/docs/configuration.md b/docs/configuration.md index 0de45e1a..3b568e37 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -120,19 +120,20 @@ There are some custom types used for brevity: ### Structure -| Section | Description | -|--------------|-------------------------------------------------| -| no section | [General parameters](#general-section) | -| `wallet` | [Wallet configuration](#wallet-section) | -| `peers` | [Nodes configuration](#peers-section) | -| `tls` | [TLS configuration](#tls-section) | -| `logger` | [Logger configuration](#logger-section) | -| `tree` | [Tree configuration](#tree-section) | -| `cache` | [Cache configuration](#cache-section) | -| `nats` | [NATS configuration](#nats-section) | -| `cors` | [CORS configuration](#cors-section) | -| `pprof` | [Pprof configuration](#pprof-section) | -| `prometheus` | [Prometheus configuration](#prometheus-section) | +| Section | Description | +|--------------|---------------------------------------------------| +| no section | [General parameters](#general-section) | +| `wallet` | [Wallet configuration](#wallet-section) | +| `peers` | [Nodes configuration](#peers-section) | +| `tls` | [TLS configuration](#tls-section) | +| `logger` | [Logger configuration](#logger-section) | +| `tree` | [Tree configuration](#tree-section) | +| `cache` | [Cache configuration](#cache-section) | +| `nats` | [NATS configuration](#nats-section) | +| `cors` | [CORS configuration](#cors-section) | +| `pprof` | [Pprof configuration](#pprof-section) | +| `prometheus` | [Prometheus configuration](#prometheus-section) | +| `neofs` | [Parameters of requests to NeoFS](#neofs-section) | ### General section @@ -364,3 +365,16 @@ prometheus: |-----------|----------|------------------|-----------------------------------------| | `enabled` | `bool` | `false` | Flag to enable the service. | | `address` | `string` | `localhost:8086` | Address that service listener binds to. | + +# `neofs` section + +Contains parameters of requests to NeoFS. + +```yaml +neofs: + set_copies_number: 0 +``` + +| Parameter | Type | Default value | Description | +|---------------------|----------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `set_copies_number` | `uint32` | `0` | Number of the object copies to consider PUT to NeoFS successful.
Default value `0` means that object will be processed according to the container's placement policy |