-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into fix-writecache
- Loading branch information
Showing
24 changed files
with
571 additions
and
116 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # NeoFS subnetwork creation | ||
|
|
||
| This is a short guide on how to create NeoFS subnetworks. This guide | ||
| considers that side chain and inner ring (alphabet nodes) have already | ||
| been deployed and side chain contains deployed `subnet` contract. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To follow this guide you need: | ||
| - neo-go side chain RPC endpoint; | ||
| - latest released version of [neofs-adm](https://github.com/nspcc-dev/neofs-node/releases); | ||
| - wallet with NeoFS account. | ||
|
|
||
| ## Creation | ||
|
|
||
| ```shell | ||
| $ neofs-adm morph subnet create \ | ||
| -r <side_chain_RPC_endpoint> \ | ||
| -w </path/to/owner/wallet> \ | ||
| --notary | ||
| Create subnet request sent successfully. ID: 4223489767. | ||
| ``` | ||
|
|
||
| **NOTE:** use `--notary` only in notary-enabled environmental. You need to | ||
| have sufficient notary deposit (not expired with enough GAS balance). This | ||
| is the only one command that requires alphabet signature and, therefore, | ||
| the only one command that needs `--notary` flag. Your subnet ID will differ | ||
| from the example. | ||
|
|
||
| Default account in the wallet that was passed with `-w` flag is the owner | ||
| of the just created subnetwork. | ||
|
|
||
| You can check if your subnetwork was created successfully: | ||
|
|
||
| ```shell | ||
| $ neofs-adm morph subnet get \ | ||
| -r <side_chain_RPC_endpoint> \ | ||
| --subnet <subnet_ID> | ||
| Owner: NUc734PMJXiqa2J9jRtvskU3kCdyyuSN8Q | ||
| ``` | ||
| Your owner will differ from the example. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| # Managing Subnetworks | ||
|
|
||
| This is a short guide on how to manage NeoFS subnetworks. This guide | ||
| considers that side chain and inner ring (alphabet nodes) have already | ||
| been deployed and side chain contains deployed `subnet` contract. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - neo-go side chain RPC endpoint; | ||
| - latest released version of [neofs-adm](https://github.com/nspcc-dev/neofs-node/releases); | ||
| - [created](subnetwork-creation.md) subnetwork; | ||
| - wallet with account that owns the subnetwork; | ||
| - public key of the Storage Node; | ||
| - public keys of the node and client administrators; | ||
| - owner IDs of the NeoFS users. | ||
|
|
||
| ## Add node administrator | ||
|
|
||
| Node administrators are the accounts that can manage (add and delete nodes) | ||
| whitelist of the nodes that could be included to the subnetwork. Only subnet | ||
| owner is allowed to add and remove node administrators from subnetwork. | ||
|
|
||
| ```shell | ||
| $ neofs-adm morph subnet admin add \ | ||
| -r <side_chain_RPC_endpoint> \ | ||
| -w </path/to/owner/wallet> \ | ||
| --admin <HEX_admin_public_key> \ | ||
| --subnet <subnet_ID> | ||
| Add admin request sent successfully. | ||
| ``` | ||
|
|
||
| ## Add node | ||
|
|
||
| Adding a node to a subnetwork means that the node becomes able to service | ||
| containers that have been created in that subnetwork. Addition only changes | ||
| list of the allowed nodes. Node is not required to be bootstrapped at the | ||
| moment of its inclusion. | ||
|
|
||
| ```shell | ||
| $ neofs-adm morph subnet node add \ | ||
| -r <side_chain_RPC_endpoint> \ | ||
| -w </path/to/node_admin/wallet> \ | ||
| --node <HEX_node_public_key> \ | ||
| --subnet <subnet_ID> | ||
| Add node request sent successfully. | ||
| ``` | ||
|
|
||
| **NOTE:** owner of the subnetwork is also allowed to add nodes. | ||
|
|
||
| ## Add client administrator | ||
|
|
||
| Client administrators are the accounts that can manage (add and delete | ||
| nodes) whitelist of the clients that can creates containers in the | ||
| subnetwork. Only subnet owner is allowed to add and remove client | ||
| administrators from subnetwork. | ||
|
|
||
| ```shell | ||
| $ neofs-adm morph subnet admin add \ | ||
| -r <side_chain_RPC_endpoint> \ | ||
| -w </path/to/owner/wallet> \ | ||
| --admin <HEX_admin_public_key> \ | ||
| --subnet <subnet_ID> \ | ||
| --client \ | ||
| --group <group_ID> | ||
| Add admin request sent successfully. | ||
| ``` | ||
|
|
||
| **NOTE:** you do not need to create group explicitly, it would be created | ||
| right after the first client admin has been added. Group ID is 4-byte | ||
| positive integer number. | ||
|
|
||
| ## Add client | ||
|
|
||
| ```shell | ||
| $ neofs-adm morph subnet client add \ | ||
| -r <side_chain_RPC_endpoint> \ | ||
| -w </path/to/client_admin/wallet> \ | ||
| --client <client_ownerID> \ | ||
| --subnet <subnet_ID> \ | ||
| --group <group_ID> | ||
| Add client request sent successfully. | ||
| ``` | ||
|
|
||
| **NOTE:** owner of the subnetwork is also allowed to add clients. This is | ||
| the only one command that accepts `ownerID`, not the public key. | ||
| Administrator can manage only his group (a group where that administrator | ||
| has been added by subnet owner). | ||
|
|
||
| # Bootstrapping Storage Node | ||
|
|
||
| After subnetwork [creation](subnetwork-creation.md) and inclusion node to it, the | ||
| node could be bootstrapped and service subnetwork containers. | ||
|
|
||
| For bootstrapping you need to specify ID of the subnetwork in the node's | ||
| configuration: | ||
|
|
||
| ```yaml | ||
| ... | ||
| node: | ||
| ... | ||
| subnet: | ||
| entries: # list of IDs of subnets to enter in a text format of NeoFS API protocol (overrides corresponding attributes) | ||
| - <subnetwork_ID> | ||
| ... | ||
| ... | ||
| ``` | ||
|
|
||
| **NOTE:** specifying subnetwork that is denied for the node is not an error: | ||
| that configuration value would be ignored. You do not need to specify zero | ||
| (with 0 ID) subnetwork: its inclusion is implicit. On the contrary, to exclude | ||
| node from the default zero subnetwork you need to specify it explicitly: | ||
|
|
||
| ```yaml | ||
| ... | ||
| node: | ||
| ... | ||
| subnet: | ||
| exit_zero: true # toggle entrance to zero subnet (overrides corresponding attribute and occurrence in `entries`) | ||
| ... | ||
| ... | ||
| ``` | ||
|
|
||
| # Creating container in non-zero subnetwork | ||
|
|
||
| Creating containers without using `--subnet` flag is equivalent to the | ||
| creating container in the zero subnetwork. | ||
|
|
||
| To create container in a private network your wallet must have been added to | ||
| the client whitelist by client admins or subnet owners: | ||
|
|
||
| ```shell | ||
| $ neofs-cli container create \ | ||
| --policy 'REP 1' \ | ||
| -w </path/to/wallet> \ | ||
| -r s01.neofs.devenv:8080 \ | ||
| --subnet <subnet_ID> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| package modules | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| var completionCmd = &cobra.Command{ | ||
| Use: "completion [bash|zsh|fish|powershell]", | ||
| Short: "Generate completion script", | ||
| Long: `To load completions: | ||
| Bash: | ||
| $ source <(neofs-adm completion bash) | ||
| # To load completions for each session, execute once: | ||
| Linux: | ||
| $ neofs-adm completion bash > /etc/bash_completion.d/neofs-adm | ||
| MacOS: | ||
| $ neofs-adm completion bash > /usr/local/etc/bash_completion.d/neofs-adm | ||
| Zsh: | ||
| # If shell completion is not already enabled in your environment you will need | ||
| # to enable it. You can execute the following once: | ||
| $ echo "autoload -U compinit; compinit" >> ~/.zshrc | ||
| # To load completions for each session, execute once: | ||
| $ neofs-adm completion zsh > "${fpath[1]}/_neofs-adm" | ||
| # You will need to start a new shell for this setup to take effect. | ||
| Fish: | ||
| $ neofs-adm completion fish | source | ||
| # To load completions for each session, execute once: | ||
| $ neofs-adm completion fish > ~/.config/fish/completions/neofs-adm.fish | ||
| `, | ||
| DisableFlagsInUseLine: true, | ||
| ValidArgs: []string{"bash", "zsh", "fish", "powershell"}, | ||
| Args: cobra.ExactValidArgs(1), | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| switch args[0] { | ||
| case "bash": | ||
| _ = cmd.Root().GenBashCompletion(os.Stdout) | ||
| case "zsh": | ||
| _ = cmd.Root().GenZshCompletion(os.Stdout) | ||
| case "fish": | ||
| _ = cmd.Root().GenFishCompletion(os.Stdout, true) | ||
| case "powershell": | ||
| _ = cmd.Root().GenPowerShellCompletion(os.Stdout) | ||
| } | ||
| }, | ||
| } |
Oops, something went wrong.