EliChin/frostfs-dev-env
1
0
Fork 0
forked from TrueCloudLab/frostfs-dev-env
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update documentation

Browse source 
Brief descriptions of newly added services and minor README updates.

Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-12-01 18:03:59 +03:00 committed by Stanislav Bogatyrev
parent 369b237095
commit 178ddfa8d3
5 changed files with 41 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -15,6 +15,14 @@ Tools to set up local NeoFS network and Neo 3 privnet. Devenv, for short.
``` ```
$ make up $ 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 `wallet/wallet.json`.
```
$ make prepare.ir
Enter account NTrezR3C4X8aMLVg7vozt5wguyNfFhwuFx password >
Sent invocation transaction fa6ba62bffb04030d303dcc95bda7413e03aa3c7e6ca9c2f999d65db9ec9b82c
```
You can see the addresses and hostnames of components with `make hosts` command. You can see the addresses and hostnames of components with `make hosts` command.
@ -29,6 +37,7 @@ $ make hosts
It's recommended to add `make hosts` output to your local `/etc/hosts` file. It's recommended to add `make hosts` output to your local `/etc/hosts` file.
## How it's organized ## How it's organized
``` ```
@ -55,6 +64,34 @@ can comment out services you don't want to start or add your own new services.
You can find more information on each service in `docs` directory. 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)
## Notable make targets
`make help` will print the brief description of available targets. Here we
describe some of them in a more detailed way.
### up
Start all Devenv services.
This target call `pull` to get container images, `get` to download required
artifacts, `vendor/hosts` to generate hosts file and then starts all services in
the order defined in `.services` file.
### down
Shutdowns all services. This will destroy all containers and networks. All
changes made inside containers will be lost.
### hosts
Display addresses and host names for each running service, if available.
### clean
Clean up `vendor` directory.
## Contributing ## Contributing
Feel free to contribute to this project after reading the [contributing Feel free to contribute to this project after reading the [contributing

2
help.mk
View file

@ -8,4 +8,4 @@ help:
@echo '' @echo ''
@echo ' Targets:' @echo ' Targets:'
@echo '' @echo ''
@awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9_-]+ ?:/{ print " ", $$1, comment }' $(MAKEFILE_LIST) | column -t -s ':' | grep -v 'IGNORE' | sort | uniq @awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9._-]+ ?:/{ print " ", $$1, comment }' $(MAKEFILE_LIST) | column -t -s ':' | grep -v 'IGNORE' | sort -u

1
services/chain/artifacts.mk
View file

@ -1,3 +1,4 @@
# Download privnet chain dump with pre-deployed NeoFS contracts
get.chain: CHAIN_DUMP_NAME=devenv.dump. get.chain: CHAIN_DUMP_NAME=devenv.dump.
get.chain: CHAIN_PATH?= get.chain: CHAIN_PATH?=
get.chain: get.chain:

2
services/ir/prepare.mk
View file

@ -1,3 +1,3 @@
# Deposit GAS from defualt wallet to NeoFS mainnet contract # Deposit GAS from default wallet to NeoFS privnet contract
prepare.ir: prepare.ir:
@./bin/deposit.sh @./bin/deposit.sh

1
services/morph_chain/artifacts.mk
View file

@ -1,3 +1,4 @@
# Download NeoFS sidechain dump with pre-deployed NeoFS contracts
get.morph_chain: MORPH_CHAIN_DUMP_NAME=neo.morph.dump. get.morph_chain: MORPH_CHAIN_DUMP_NAME=neo.morph.dump.
get.morph_chain: MORPH_CHAIN_PATH?= get.morph_chain: MORPH_CHAIN_PATH?=
get.morph_chain: get.morph_chain: