From ffe5012ab6e82553973a9f6322d4f86cded292dc Mon Sep 17 00:00:00 2001 From: Denis Kirillov Date: Wed, 21 Dec 2022 14:59:19 +0300 Subject: [PATCH] [TrueCloudLab#1] Update docs Signed-off-by: Denis Kirillov --- .github/logo.svg | 129 ---------------------------------------------- CONTRIBUTING.md | 18 +++---- README.md | 33 ++++++------ docs/basenet.md | 4 +- docs/chain.md | 38 +++++++------- docs/faq.md | 14 ++--- docs/http_gate.md | 16 +++--- docs/ir.md | 6 +-- docs/morph.md | 34 ++++++------ docs/notary.md | 2 +- docs/rest_gate.md | 12 ++--- docs/s3_gate.md | 8 +-- docs/storage.md | 4 +- 13 files changed, 93 insertions(+), 225 deletions(-) delete mode 100644 .github/logo.svg diff --git a/.github/logo.svg b/.github/logo.svg deleted file mode 100644 index b4da076..0000000 --- a/.github/logo.svg +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f6b65f..f3ae1f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,8 @@ First, thank you for contributing! We love and encourage pull requests from everyone. Please follow the guidelines: -- Check the open [issues](https://github.com/nspcc-dev/neofs-dev-env/issues) and - [pull requests](https://github.com/nspcc-dev/neofs-dev-env/pulls) for existing +- Check the open [issues](https://github.com/TrueCloudLab/frostfs-dev-env/issues) and + [pull requests](https://github.com/TrueCloudLab/frostfs-dev-env/pulls) for existing discussions. - Open an issue first, to discuss a new feature or enhancement. @@ -21,23 +21,23 @@ everyone. Please follow the guidelines: ## Development Workflow -Start by forking the `neofs-dev-env` repository, make changes in a branch and then +Start by forking the `frostfs-dev-env` repository, make changes in a branch and then send a pull request. We encourage pull requests to discuss code changes. Here are the steps in details: -### Setup your GitHub Repository -Fork [NeoFS node upstream](https://github.com/nspcc-dev/neofs-dev-env/fork) source +### Set up your GitHub Repository +Fork [FrostFS node upstream](https://github.com/TrueCloudLab/frostfs-dev-env/fork) source repository to your own personal repository. Copy the URL of your fork (you will need it for the `git clone` command below). ```sh -$ git clone https://github.com/nspcc-dev/neofs-dev-env +$ git clone https://github.com/TrueCloudLab/frostfs-dev-env ``` ### Set up git remote as ``upstream`` ```sh -$ cd neofs-dev-env -$ git remote add upstream https://github.com/nspcc-dev/neofs-dev-env +$ cd frostfs-dev-env +$ git remote add upstream https://github.com/TrueCloudLab/frostfs-dev-env $ git fetch upstream $ git merge upstream/master ... @@ -103,7 +103,7 @@ contributors". To sign your work, just add a line like this at the end of your commit message: ``` -Signed-off-by: Samii Sakisaka +Signed-off-by: Samii Sakisaka ``` This can easily be done with the `--signoff` option to `git commit`. diff --git a/README.md b/README.md index b620273..42cb644 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,11 @@

-NeoFS -

-

- NeoFS local Development and Testing environment + FrostFS local Development and Testing environment

--- ## Overview -Tools to set up local NeoFS network and N3 privnets. Devenv, for short. +Tools to set up local FrostFS network and N3 privnets. Devenv, for short. ## Prerequisites @@ -27,7 +24,7 @@ Make sure you have installed all of the following prerequisites on your machine: Clone repo: ``` -$ git clone https://github.com/nspcc-dev/neofs-dev-env.git +$ git clone https://github.com/TrueCloudLab/frostfs-dev-env.git ``` Run next commands from project's root: @@ -42,11 +39,11 @@ been added already, there is no need to run it separately. ``` $ make hosts -192.168.130.10 bastion.neofs.devenv -192.168.130.50 main-chain.neofs.devenv -192.168.130.61 ir01.neofs.devenv +192.168.130.10 bastion.frostfs.devenv +192.168.130.50 main-chain.frostfs.devenv +192.168.130.61 ir01.frostfs.devenv ... -192.168.130.74 s04.neofs.devenv +192.168.130.74 s04.frostfs.devenv ``` This command shows addresses and hostnames of components. Add `make hosts` @@ -58,7 +55,7 @@ $ make up ``` When all services are up, you need to make GAS deposit for test wallet to be -able to pay for NeoFS operations. Test wallet is located in +able to pay for FrostFS operations. Test wallet is located in `wallets/wallet.json` with the corresponding key in `wallets/wallet.key`. The password is empty. @@ -68,16 +65,16 @@ password > fa6ba62bffb04030d303dcc95bda7413e03aa3c7e6ca9c2f999d65db9ec9b82c ``` -Also you should add self-signed node (`s04.neofs.devenv`) certificate to trusted +Also, you should add self-signed node (`s04.frostfs.devenv`) certificate to trusted store (default location might be changed using `CA_CERTS_TRUSTED_STORE` -variable). This step is required for client services (neofs-http-gw, -neofs-s3-gw) to interact with the node: +variable). This step is required for client services (frostfs-http-gw, +frostfs-s3-gw) to interact with the node: ``` $ sudo make prepare.storage ``` -Change NeoFS global configuration values with `make update.*` commands. The +Change FrostFS global configuration values with `make update.*` commands. The password of inner ring wallet is `one`. See examples in `make help`. ``` @@ -85,7 +82,7 @@ $ make update.epoch_duration val=30 Changing EpochDuration configration value to 30 Enter account NNudMSGzEoktFzdYGYoNb3bzHzbmM1genF password > Sent invocation transaction dbb8c1145b6d10f150135630e13bb0dc282023163f5956c6945a60db0cb45cb0 -Updating NeoFS epoch to 2 +Updating FrostFS epoch to 2 Enter account NNudMSGzEoktFzdYGYoNb3bzHzbmM1genF password > Sent invocation transaction 0e6eb5e190f36332e5e5f4e866c7e100826e285fd949e11c085e15224f343ba6 ``` @@ -121,9 +118,9 @@ You can find more information on each service in `docs` directory. Maybe you will find the answer for your question in [F.A.Q.](docs/faq.md) -## Using NeoFS Admin Tool in `dev-env` +## Using FrostFS Admin Tool in `dev-env` -Devenv supports NeoFS network management via [neofs-adm](https://github.com/nspcc-dev/neofs-node/tree/master/cmd/neofs-adm). +Devenv supports FrostFS network management via [frostfs-adm](https://github.com/TrueCloudLab/frostfs-node/tree/master/cmd/frostfs-adm). `services/ir` contains the Alphabet wallet in a proper format, specify it with `--alphabet-wallets` flag. diff --git a/docs/basenet.md b/docs/basenet.md index 7883889..0ce1f5e 100644 --- a/docs/basenet.md +++ b/docs/basenet.md @@ -7,7 +7,7 @@ host machine, so all programs running on host can connect to services exposed to ## .env settings -### LOCAL_DOMAIN=neofs.devenv +### LOCAL_DOMAIN=frostfs.devenv Domain to use for all containers exposed to `basenet_internet`. @@ -28,7 +28,7 @@ devenv services. Run shell in bastion: ``` -neofs-dev-env$ docker exec -ti bastion /bin/bash +frostfs-dev-env$ docker exec -ti bastion /bin/bash root@bastion:/# ip a sh 1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 diff --git a/docs/chain.md b/docs/chain.md index 0ed13ce..a1cb608 100644 --- a/docs/chain.md +++ b/docs/chain.md @@ -4,10 +4,10 @@ A single-node N3 privnet deployment, running on [neo-go](https://github.com/nspcc-dev/neo-go). Represents N3 MainNet. Contracts deployed: -- NeoFS [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/neofs) -- Processing [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/processing) +- FrostFS [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/neofs) +- Processing [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/processing) -RPC available at `http://main-chain.neofs.devenv:30333`. +RPC available at `http://main-chain.frostfs.devenv:30333`. ## .env settings @@ -31,7 +31,7 @@ There is a wallet with GAS that used for contract deployment: ``` $ neo-go wallet nep17 balance \ -w wallets/wallet.json \ - -r http://main-chain.neofs.devenv:30333 + -r http://main-chain.frostfs.devenv:30333 Account NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf) @@ -40,14 +40,14 @@ GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf) ``` If you want to operate in main chain with your personal wallet (e.g. to make -a deposit in NeoFS contract), you can transfer GAS from there. +a deposit in FrostFS contract), you can transfer GAS from there. 1. Create new wallet. ``` -$ neo-go wallet init -a -w wallets/neofs1.json +$ neo-go wallet init -a -w wallets/frostfs1.json -Enter the name of the account > neofs1 +Enter the name of the account > frostfs1 Enter passphrase > Confirm passphrase > @@ -57,7 +57,7 @@ Confirm passphrase > { "address": "NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6", ... -wallet successfully created, file location is wallets/neofs1.json +wallet successfully created, file location is wallets/frostfs1.json ``` 2. Transfer GAS from `wallets/wallet.json`. The password is empty. @@ -65,7 +65,7 @@ wallet successfully created, file location is wallets/neofs1.json ``` $ neo-go wallet nep17 transfer \ -w wallets/wallet.json \ - -r http://main-chain.neofs.devenv:30333 \ + -r http://main-chain.frostfs.devenv:30333 \ --from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \ --to NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 \ --amount 50 \ @@ -76,8 +76,8 @@ $ neo-go wallet nep17 transfer \ ``` $ neo-go wallet nep17 balance \ - -w wallets/neofs1.json \ - -r http://main-chain.neofs.devenv:30333 + -w wallets/frostfs1.json \ + -r http://main-chain.frostfs.devenv:30333 Account NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf) @@ -98,7 +98,7 @@ Claim GAS to consensus node's wallet. Use account that contains NEO tokens. ``` $ neo-go wallet claim \ -w services/chain/node-wallet.json \ - -r http://main-chain.neofs.devenv:30333 \ + -r http://main-chain.frostfs.devenv:30333 \ -a NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP \ Password > 70e09bbd55846dcc7cee23905b737c63e5a80d32e387bce108bc6db8e641fb90 @@ -109,17 +109,17 @@ Then you can transfer GAS the same way as it was done in previous section. ``` $ neo-go wallet nep17 transfer \ -w services/chain/node-wallet.json \ - -r http://main-chain.neofs.devenv:30333 \ + -r http://main-chain.frostfs.devenv:30333 \ --from NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP \ --to NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 \ --amount 50 \ --token GAS ``` -## NeoFS GAS deposit +## FrostFS GAS deposit -NeoFS identifies users by their Neo wallet key pair. To start using NeoFS in -devenv you need to transfer some GAS to NeoFS contract in main chain. +FrostFS identifies users by their Neo wallet key pair. To start using FrostFS in +devenv you need to transfer some GAS to FrostFS contract in main chain. Invoke `bin/deposit.sh` script by running `make prepare.ir` command to transfer 50 GAS from account in `wallets/wallet.json` file. Script enters passwords @@ -136,7 +136,7 @@ Script converts addresses and executes this command: ``` $ neo-go wallet nep17 transfer \ -w wallets/wallet.json \ - -r http://main-chain.neofs.devenv:30333 \ + -r http://main-chain.frostfs.devenv:30333 \ --from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \ --to NerhjaqJsJt4LxMqUbkkVMpsF2d9TtcpFv \ --token GAS \ @@ -144,12 +144,12 @@ $ neo-go wallet nep17 transfer \ ``` You can specify any wallet address scripthash in the transfer's data argument, -and NeoFS deposit will be transferred to that address. +and FrostFS deposit will be transferred to that address. ``` $ neo-go wallet nep17 transfer \ -w wallets/wallet.json \ - -r http://main-chain.neofs.devenv:30333 \ + -r http://main-chain.frostfs.devenv:30333 \ --from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \ --to NerhjaqJsJt4LxMqUbkkVMpsF2d9TtcpFv \ --token GAS \ diff --git a/docs/faq.md b/docs/faq.md index 14f0c4f..12e5df7 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,9 +1,9 @@ # F.A.Q, tips and tricks -### How to export private key from Neo wallet for NeoFS use? +### How to export private key from Neo wallet for FrostFS use? -Private key for usage with NeoFS tools can be extracted from Neo wallet in three +Private key for usage with FrostFS tools can be extracted from Neo wallet in three simple steps. 1. Get the key in WIF format @@ -17,7 +17,7 @@ KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr 2. Convert form WIF to HEX ``` -$ neofs-cli util keyer KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr +$ frostfs-cli util keyer KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr PrivateKey 1dd37fba80fec4e6a6f13fd708d8dcb3b29def768017052f6c930fa1c5d90bbb PublicKey 031a6c6fbbdf02ca351745fa86b9ba5a9452d785ac4f7fc2b7548ca2a46c4fcf4a WIF KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr @@ -35,16 +35,16 @@ $ xxd wallets/wallet.key 00000010: b29d ef76 8017 052f 6c93 0fa1 c5d9 0bbb ...v.../l....... ``` -Later you will be able to provide wallet file in neofs-node config. +Later you will be able to provide wallet file in frostfs-node config. -### How to create Neo wallet JSON file using a NeoFS key file? +### How to create Neo wallet JSON file using a FrostFS key file? -You will need `neo-go` and `neofs-cli`. +You will need `neo-go` and `frostfs-cli`. 1. Get the WIF format of the private key ``` -$ neofs-cli util keyer -key ./services/ir/01.key | grep WIF | awk '{print $NF}' > temp_WIF +$ frostfs-cli util keyer -key ./services/ir/01.key | grep WIF | awk '{print $NF}' > temp_WIF ``` 2. Init a new empty Neo wallet diff --git a/docs/http_gate.md b/docs/http_gate.md index 9141929..1aadd27 100644 --- a/docs/http_gate.md +++ b/docs/http_gate.md @@ -1,8 +1,8 @@ # HTTP Protocol gateway -Protocol Gateway to access data in NeoFS using HTTP protocol. +Protocol Gateway to access data in FrostFS using HTTP protocol. -Source code and more information can be found in [project's GitHub repository](https://github.com/nspcc-dev/neofs-http-gate) +Source code and more information can be found in [project's GitHub repository](https://github.com/TrueCloudLab/frostfs-http-gate) ## .env settings @@ -10,10 +10,10 @@ Source code and more information can be found in [project's GitHub repository](h Image version label to use for containers. -If you want to use locally built image, just set it's label here. Instead of +If you want to use locally built image, just set its label here. Instead of pulling from DockerHub, the local image will be used. -### HTTP_GW_IMAGE=nspccdev/neofs-http-gw +### HTTP_GW_IMAGE=truecloudlab/frostfs-http-gw Image label prefix to use for containers. @@ -21,7 +21,7 @@ Image label prefix to use for containers. - Create a new container ``` -$ neofs-cli --rpc-endpoint s01.neofs.devenv:8080 \ +$ frostfs-cli --rpc-endpoint s01.frostfs.devenv:8080 \ --key wallets/wallet.key \ container create --basic-acl readonly --await \ --policy "REP 1 SELECT 1 FROM *" @@ -32,7 +32,7 @@ container has been persisted on sidechain ``` - Put an object into the newly created container ``` -$ neofs-cli --rpc-endpoint s01.neofs.devenv:8080 \ +$ frostfs-cli --rpc-endpoint s01.frostfs.devenv:8080 \ --key wallets/wallet.key \ object put --file /tmp/backup.jpeg \ --cid 4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP @@ -40,9 +40,9 @@ $ neofs-cli --rpc-endpoint s01.neofs.devenv:8080 \ ID: 6EPpYqSFMGWrNLvYE9mNnut1CPKuPBKyi1ixHakzqsSB CID: 4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP ``` -- Call `curl -sSI -XGET http://http.neofs.devenv/get//` +- Call `curl -sSI -XGET http://http.frostfs.devenv/get//` ``` -$ curl -sSI -XGET http://http.neofs.devenv/get/4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP/6EPpYqSFMGWrNLvYE9mNnut1CPKuPBKyi1ixHakzqsSB +$ curl -sSI -XGET http://http.frostfs.devenv/get/4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP/6EPpYqSFMGWrNLvYE9mNnut1CPKuPBKyi1ixHakzqsSB HTTP/1.1 200 OK Date: Thu, 03 Dec 2020 10:34:26 GMT Content-Type: image/jpeg diff --git a/docs/ir.md b/docs/ir.md index 28313f0..a870063 100644 --- a/docs/ir.md +++ b/docs/ir.md @@ -1,6 +1,6 @@ -# NeoFS Inner Ring +# FrostFS Inner Ring -NeoFS Inner Ring (Alphabet) node. According to governance scheme, Inner Ring +FrostFS Inner Ring (Alphabet) node. According to governance scheme, Inner Ring should contain Alphabet nodes that share key with one of side chain consensus nodes. In basic setup there is a single consensus node and single Inner Ring (Alphabet) node. @@ -14,6 +14,6 @@ Image version label to use for Inner Ring docker containers. If you want to use locally built image, just set it's label here. Instead of pulling from DockerHub, the local image will be used. -### IR_IMAGE=nspccdev/neofs-ir +### IR_IMAGE=truecloudlab/frostfs-ir Image label prefix to use for Inner Ring docker containers. diff --git a/docs/morph.md b/docs/morph.md index a30bfb5..4429298 100644 --- a/docs/morph.md +++ b/docs/morph.md @@ -1,18 +1,18 @@ -# N3 NeoFS side chain privnet service +# N3 FrostFS side chain privnet service A single-node N3 privnet deployment, running on -[neo-go](https://github.com/nspcc-dev/neo-go). Represents N3 NeoFS SideChain. +[neo-go](https://github.com/nspcc-dev/neo-go). Represents N3 FrostFS SideChain. Contracts deployed: -- Alphabet (AZ) [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/alphabet) -- Audit [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/audit) -- Balance [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/balance) -- Container [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/container) -- Netmap [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/netmap) -- NeoFSID [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/neofsid) -- Proxy [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/proxy) -- Reputation [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/reputation) +- Alphabet (AZ) [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/alphabet) +- Audit [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/audit) +- Balance [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/balance) +- Container [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/container) +- Netmap [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/netmap) +- NeoFSID [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/neofsid) +- Proxy [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/proxy) +- Reputation [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/reputation) -RPC available at `http://morph-chain.neofs.devenv:30333`. +RPC available at `http://morph-chain.frostfs.devenv:30333`. ## .env settings @@ -36,22 +36,22 @@ There is a wallet with GAS that used for contract deployment: ``` $ neo-go wallet nep17 balance \ -w wallets/wallet.json \ - -r http://morph-chain.neofs.devenv:30333 + -r http://morph-chain.frostfs.devenv:30333 Account NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf) Amount : 189826.0515316 Updated: 3909 -NEOFS: NeoFS Balance (69550190e740b93f92dbd5dea52246f550391057) +FROSTFS: FrostFS Balance (69550190e740b93f92dbd5dea52246f550391057) Amount : 50 Updated: 3909 ``` -This way you can also monitor NeoFS internal balance of your account. +This way you can also monitor FrostFS internal balance of your account. -## NeoFS global config +## FrostFS global config -NeoFS uses global configuration to store epoch duration, maximum object size, +FrostFS uses global configuration to store epoch duration, maximum object size, container fee and other network parameters. Global configuration is stored in netmap contract and managed by Inner Ring (Alphabet) nodes. @@ -64,7 +64,7 @@ $ make update.epoch_duration val=30 Changing EpochDuration configration value to 30 Enter account NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP password > Sent invocation transaction bdc0fa88cd6719ef6df2b9c82de423ddec6141ca24255c2d0072688083b1de9d -Updating NeoFS epoch to 20 +Updating FrostFS epoch to 20 Enter account NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP password > Sent invocation transaction 12296e1ce24dd6c04edb9c56d0a1d0e26d3226adefb0333c74a28788f44a8d0f ``` diff --git a/docs/notary.md b/docs/notary.md index b973ead..eab01f7 100644 --- a/docs/notary.md +++ b/docs/notary.md @@ -78,4 +78,4 @@ ApplicationConfiguration: Main chain generates a block once per 15 seconds, so Inner Ring takes about 15-30 seconds to make a notary deposit in main chain after startup. Then -neofs-dev-env is ready to work. +frostfs-dev-env is ready to work. diff --git a/docs/rest_gate.md b/docs/rest_gate.md index 2597a2c..e511280 100644 --- a/docs/rest_gate.md +++ b/docs/rest_gate.md @@ -1,8 +1,8 @@ # REST Gateway -REST Gateway to access data in NeoFS using REST. +REST Gateway to access data in FrostFS using REST. -Source code and more information can be found in [project's GitHub repository](https://github.com/nspcc-dev/neofs-rest-gw) +Source code and more information can be found in [project's GitHub repository](https://github.com/TrueCloudLab/frostfs-rest-gw) ## .env settings @@ -13,7 +13,7 @@ Image version label to use for containers. If you want to use locally built image, just set its label here. Instead of pulling from DockerHub, the local image will be used. -### REST_GW_IMAGE=nspccdev/neofs-rest-gw +### REST_GW_IMAGE=truecloudlab/frostfs-rest-gw Image label prefix to use for containers. @@ -22,7 +22,7 @@ Image label prefix to use for containers. - List container for specific owner: ```shell -$ curl http://rest.neofs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq +$ curl http://rest.frostfs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq { "containers": [ { @@ -49,7 +49,7 @@ $ curl http://rest.neofs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuG - Get container info: ```shell -$ curl http://rest.neofs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq +$ curl http://rest.frostfs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq { "attributes": [ { @@ -67,4 +67,4 @@ $ curl http://rest.neofs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjT } ``` -See all available routes http://rest.neofs.devenv:8090/v1/docs +See all available routes http://rest.frostfs.devenv:8090/v1/docs diff --git a/docs/s3_gate.md b/docs/s3_gate.md index 9c00573..0a110d6 100644 --- a/docs/s3_gate.md +++ b/docs/s3_gate.md @@ -1,8 +1,8 @@ # S3 Protocol gateway -Protocol Gateway to access data in NeoFS using AWS S3 protocol +Protocol Gateway to access data in FrostFS using AWS S3 protocol -Source code and more information can be found in [project's GitHub repository](https://github.com/nspcc-dev/neofs-s3-gw) +Source code and more information can be found in [project's GitHub repository](https://github.com/TrueCloudLab/frostfs-s3-gw) ## .env settings @@ -10,9 +10,9 @@ Source code and more information can be found in [project's GitHub repository](h Image version label to use for containers. -If you want to use locally built image, just set it's label here. Instead of +If you want to use locally built image, just set its label here. Instead of pulling from DockerHub, the local image will be used. -### S3_GW_IMAGE=nspccdev/neofs-s3-gw +### S3_GW_IMAGE=truecloudlab/frostfs-s3-gw Image label prefix to use for containers. diff --git a/docs/storage.md b/docs/storage.md index d46db7e..64ba5fe 100644 --- a/docs/storage.md +++ b/docs/storage.md @@ -6,9 +6,9 @@ Image version label to use for Storage docker containers. -If you want to use locally built image, just set it's label here. Instead of +If you want to use locally built image, just set its label here. Instead of pulling from DockerHub, the local image will be used. -### NODE_IMAGE=nspccdev/neofs-ir +### NODE_IMAGE=truecloudlab/frostfs-ir Image label prefix to use for Storage docker containers.