From 2b709e79e7ea5ca8fa5b5a5127b535ae708318c0 Mon Sep 17 00:00:00 2001 From: Marko Date: Wed, 12 Feb 2020 12:45:24 +0100 Subject: [PATCH] make: remove sentry setup cmds (#4383) * make: remove sentry setup cmds removal of make comands for sentry setup. it was unclear if they were being maintained and there has not been a mention of people using them - closes #4379 Signed-off-by: Marko Baricevic * remove depreacted readme * add not being maintained section to docs --- Makefile | 25 +------- docs/networks/terraform-and-ansible.md | 2 + networks/local/README.md | 82 +------------------------- 3 files changed, 5 insertions(+), 104 deletions(-) diff --git a/Makefile b/Makefile index 540d157b8..610a0c6b5 100644 --- a/Makefile +++ b/Makefile @@ -180,27 +180,6 @@ localnet-start: localnet-stop build-docker-localnode localnet-stop: docker-compose down -############################################################################### -### Remote full-nodes (sentry) using terraform and ansible ### -############################################################################### - -# Server management -sentry-start: - @if [ -z "$(DO_API_TOKEN)" ]; then echo "DO_API_TOKEN environment variable not set." ; false ; fi - @if ! [ -f $(HOME)/.ssh/id_rsa.pub ]; then ssh-keygen ; fi - cd networks/remote/terraform && terraform init && terraform apply -var DO_API_TOKEN="$(DO_API_TOKEN)" -var SSH_KEY_FILE="$(HOME)/.ssh/id_rsa.pub" - @if ! [ -f $(CURDIR)/build/node0/config/genesis.json ]; then docker run --rm -v $(CURDIR)/build:/tendermint:Z tendermint/localnode testnet --v 0 --n 4 --o . ; fi - cd networks/remote/ansible && ANSIBLE_HOST_KEY_CHECKING=False ansible-playbook -i inventory/digital_ocean.py -l sentrynet install.yml - @echo "Next step: Add your validator setup in the genesis.json and config.tml files and run \"make sentry-config\". (Public key of validator, chain ID, peer IP and node ID.)" - -# Configuration management -sentry-config: - cd networks/remote/ansible && ansible-playbook -i inventory/digital_ocean.py -l sentrynet config.yml -e BINARY=$(CURDIR)/build/tendermint -e CONFIGDIR=$(CURDIR)/build - -sentry-stop: - @if [ -z "$(DO_API_TOKEN)" ]; then echo "DO_API_TOKEN environment variable not set." ; false ; fi - cd networks/remote/terraform && terraform destroy -var DO_API_TOKEN="$(DO_API_TOKEN)" -var SSH_KEY_FILE="$(HOME)/.ssh/id_rsa.pub" - # Build hooks for dredd, to skip or add information on some steps build-contract-tests-hooks: ifeq ($(OS),Windows_NT) @@ -221,7 +200,7 @@ contract-tests: # unless there is a reason not to. # https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html .PHONY: check build build_race build_abci dist install install_abci check_tools tools update_tools draw_deps \ - gen_certs clean_certs grpc_dbserver fmt build-linux localnet-start \ - localnet-stop build-docker build-docker-localnode sentry-start sentry-config sentry-stop \ + protoc_abci protoc_libs gen_certs clean_certs grpc_dbserver fmt build-linux localnet-start \ + localnet-stop build-docker build-docker-localnode protoc_grpc protoc_all \ build_c install_c test_with_deadlock cleanup_after_test_with_deadlock lint build-contract-tests-hooks contract-tests \ build_c-amazonlinux diff --git a/docs/networks/terraform-and-ansible.md b/docs/networks/terraform-and-ansible.md index b55563ea9..ec6cee1ba 100644 --- a/docs/networks/terraform-and-ansible.md +++ b/docs/networks/terraform-and-ansible.md @@ -4,6 +4,8 @@ order: 3 # Terraform & Ansible +> Note: These commands/files are not being maintained by the tendermint team currently. Please use them carefully. + Automated deployments are done using [Terraform](https://www.terraform.io/) to create servers on Digital Ocean then [Ansible](http://www.ansible.com/) to create and manage diff --git a/networks/local/README.md b/networks/local/README.md index 8d4299693..dcb31ae71 100644 --- a/networks/local/README.md +++ b/networks/local/README.md @@ -1,83 +1,3 @@ # Local Cluster with Docker Compose -DEPRECATED! - -See the [docs](https://tendermint.com/docs/networks/docker-compose.html). - -## Requirements - -- [Install tendermint](/docs/install.md) -- [Install docker](https://docs.docker.com/engine/installation/) -- [Install docker-compose](https://docs.docker.com/compose/install/) - -## Build - -Build the `tendermint` binary and the `tendermint/localnode` docker image. - -Note the binary will be mounted into the container so it can be updated without -rebuilding the image. - -``` -cd $GOPATH/src/github.com/tendermint/tendermint - -# Build the linux binary in ./build -make build-linux - -# Build tendermint/localnode image -make build-docker-localnode -``` - - -## Run a testnet - -To start a 4 node testnet run: - -``` -make localnet-start -``` - -The nodes bind their RPC servers to ports 26657, 26660, 26662, and 26664 on the host. -This file creates a 4-node network using the localnode image. -The nodes of the network expose their P2P and RPC endpoints to the host machine on ports 26656-26657, 26659-26660, 26661-26662, and 26663-26664 respectively. - -To update the binary, just rebuild it and restart the nodes: - -``` -make build-linux -make localnet-stop -make localnet-start -``` - -## Configuration - -The `make localnet-start` creates files for a 4-node testnet in `./build` by calling the `tendermint testnet` command. - -The `./build` directory is mounted to the `/tendermint` mount point to attach the binary and config files to the container. - -For instance, to create a single node testnet: - -``` -cd $GOPATH/src/github.com/tendermint/tendermint - -# Clear the build folder -rm -rf ./build - -# Build binary -make build-linux - -# Create configuration -docker run -e LOG="stdout" -v `pwd`/build:/tendermint tendermint/localnode testnet --o . --v 1 - -#Run the node -docker run -v `pwd`/build:/tendermint tendermint/localnode - -``` - -## Logging - -Log is saved under the attached volume, in the `tendermint.log` file. If the `LOG` environment variable is set to `stdout` at start, the log is not saved, but printed on the screen. - -## Special binaries - -If you have multiple binaries with different names, you can specify which one to run with the BINARY environment variable. The path of the binary is relative to the attached volume. - +See the [docs](https://docs.tendermint.com/master/networks/docker-compose.html).