From c6645ef77599fff6c63f86b116b268a14b3d3d47 Mon Sep 17 00:00:00 2001 From: Stanislav Bogatyrev Date: Fri, 3 Feb 2023 19:28:51 +0300 Subject: [PATCH] [#1] Documentation rebranding Signed-off-by: Stanislav Bogatyrev --- CONTRIBUTING.md | 2 +- cmd/frostfs-cli/docs/sessions.md | 6 ++--- cmd/frostfs-cli/docs/storage-node-xheaders.md | 26 +++++++++---------- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed01174c..ce617f7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ $ git clone https://github.com/TrueCloudLab/frostfs-node ### Set up git remote as ``upstream`` ```sh -$ cd neofs-node +$ cd frostfs-node $ git remote add upstream https://github.com/TrueCloudLab/frostfs-node $ git fetch upstream $ git merge upstream/master diff --git a/cmd/frostfs-cli/docs/sessions.md b/cmd/frostfs-cli/docs/sessions.md index 638e2153..04563b7a 100644 --- a/cmd/frostfs-cli/docs/sessions.md +++ b/cmd/frostfs-cli/docs/sessions.md @@ -1,8 +1,8 @@ -# How NeoFS CLI uses session mechanism of the NeoFS +# How FrostFS CLI uses session mechanism of the FrostFS ## Overview -NeoFS sessions implement a mechanism for issuing a power of attorney by one +FrostFS sessions implement a mechanism for issuing a power of attorney by one party to another. A trusted party can provide a so-called session token as proof of the right to act on behalf of another member of the network. The client of operations carried out with such a token will be the user who opened @@ -15,7 +15,7 @@ attached session token is treated as performed by the original client. ## Types -NeoFS CLI supports two ways to execute operation within a session depending on +FrostFS CLI supports two ways to execute operation within a session depending on whether the user of the command application is an original user (1) or a trusted one (2). diff --git a/cmd/frostfs-cli/docs/storage-node-xheaders.md b/cmd/frostfs-cli/docs/storage-node-xheaders.md index f332b22a..db759dcf 100644 --- a/cmd/frostfs-cli/docs/storage-node-xheaders.md +++ b/cmd/frostfs-cli/docs/storage-node-xheaders.md @@ -2,26 +2,26 @@ ## Overview -Extended headers are used for request/response. They may contain any user-defined headers -to be interpreted on application level. -Key name must be a unique valid UTF-8 string. Value can't be empty. Requests or -Responses with duplicated header names or headers with empty values are -considered invalid. +Extended headers are used for request/response. They may contain any +user-defined headers to be interpreted on application level. Key name must be a +unique valid UTF-8 string. Value can't be empty. Requests or Responses with +duplicated header names or headers with empty values are considered invalid. ## Existing headers -There are some "well-known" headers starting with `__NEOFS__` prefix that -affect system behaviour: +There are some "well-known" headers starting with `__FROSTFS__` prefix that +affect system behaviour. For backward compatibility, the same set of +"well-known" headers may also use `__NEOFS__` prefix: -* `__NEOFS__NETMAP_EPOCH` - netmap epoch to use for object placement calculation. The `value` is string +* `__FROSTFS__NETMAP_EPOCH` - netmap epoch to use for object placement calculation. The `value` is string encoded `uint64` in decimal presentation. If set to '0' or omitted, the current epoch only will be used. -* `__NEOFS__NETMAP_LOOKUP_DEPTH` - if object can't be found using current epoch's netmap, this header limits -how many past epochs the node can look up through. Depth is applied to a current epoch or the value -of `__NEOFS__NETMAP_EPOCH` attribute. The `value` is string encoded `uint64` in decimal presentation. +* `__FROSTFS__NETMAP_LOOKUP_DEPTH` - if object can't be found using current epoch's netmap, this header limits +how many past epochs the node can look up through. Depth is applied to a current epoch or the value +of `__FROSTFS__NETMAP_EPOCH` attribute. The `value` is string encoded `uint64` in decimal presentation. If set to '0' or not set, only the current epoch is used. -## `neofs-cli` commands with `--xhdr` +## `frostfs-cli` commands with `--xhdr` List of commands with support of extended headers: * `container list-objects` @@ -30,5 +30,5 @@ List of commands with support of extended headers: Example: ```shell -$ neofs-cli object put -r s01.neofs.devenv:8080 -w wallet.json --cid CID --file FILE --xhdr "__NEOFS__NETMAP_EPOCH=777" +$ frostfs-cli object put -r s01.frostfs.devenv:8080 -w wallet.json --cid CID --file FILE --xhdr "__FROSTFS__NETMAP_EPOCH=777" ```