From fb457c2c9c4ff968e57a307347ea1eaea5dc60a7 Mon Sep 17 00:00:00 2001 From: Gary Tomato Date: Tue, 30 May 2017 17:39:50 -0400 Subject: [PATCH 1/7] DigitalOcean example and genesis file creation added --- .gitignore | 6 +- ansible-tendermint/README.md | 151 ---- ansible-tendermint/collect_public_keys.yml | 11 - ansible-tendermint/defaults/main.yml | 64 -- ansible-tendermint/handlers/main.yml | 9 - ansible-tendermint/templates/config.toml.j2 | 38 - ansible-tendermint/templates/genesis.json.j2 | 6 - ansible-tendermint/test.yml | 13 - ansible-tendermint/vars/Debian.yml | 3 - ansible-tendermint/vars/RedHat.yml | 3 - {ansible-tendermint => ansible}/.gitignore | 0 {ansible-tendermint => ansible}/LICENSE | 0 ansible/README.md | 84 +++ {ansible-tendermint => ansible}/Vagrantfile | 2 +- ansible/ansible.cfg | 4 + .../img/a_plus_t.png | Bin ansible/install.yml | 9 + ansible/inventory/COPYING | 675 ++++++++++++++++++ ansible/inventory/digital_ocean.ini | 34 + ansible/inventory/digital_ocean.py | 471 ++++++++++++ .../roles/basecoin}/ansible.cfg | 0 ansible/roles/basecoin/defaults/main.yml | 23 + ansible/roles/basecoin/handlers/main.yml | 6 + ansible/roles/basecoin/tasks/install.yml | 109 +++ .../roles/basecoin}/tasks/main.yml | 2 +- .../roles/basecoin}/tasks/start.yml | 0 .../roles/basecoin/templates/basecoin.conf.j2 | 15 + .../basecoin/templates/basecoin.systemd.j2 | 17 + ansible/roles/basecoin/vars/Debian.yml | 2 + ansible/roles/basecoin/vars/RedHat.yml | 2 + ansible/roles/tendermint/defaults/main.yml | 23 + ansible/roles/tendermint/handlers/main.yml | 6 + ansible/roles/tendermint/tasks/genesis.yml | 19 + .../roles/tendermint}/tasks/install.yml | 38 +- ansible/roles/tendermint/tasks/main.yml | 9 + ansible/roles/tendermint/tasks/start.yml | 26 + .../tendermint/templates/genesis.json.j2 | 16 + .../tendermint}/templates/tendermint.conf.j2 | 3 +- .../templates/tendermint.systemd.j2 | 0 ansible/roles/tendermint/vars/Debian.yml | 2 + ansible/roles/tendermint/vars/RedHat.yml | 2 + create-digitalocean-testnet.sh | 28 + terraforce/README.md | 155 +--- terraforce/cluster/main.tf | 72 +- terraforce/cluster/outputs.tf | 19 + terraforce/cluster/variables.tf | 30 + terraforce/examples/dummy/bins | 2 - terraforce/examples/dummy/run.sh | 8 - terraforce/examples/in-proc-linux/bins | 1 - terraforce/examples/in-proc-linux/run.sh | 7 - terraforce/examples/in-proc/bins | 1 - terraforce/examples/in-proc/run.sh | 7 - terraforce/main.tf | 41 +- terraforce/test.sh | 30 - 54 files changed, 1718 insertions(+), 586 deletions(-) delete mode 100644 ansible-tendermint/README.md delete mode 100644 ansible-tendermint/collect_public_keys.yml delete mode 100644 ansible-tendermint/defaults/main.yml delete mode 100644 ansible-tendermint/handlers/main.yml delete mode 100644 ansible-tendermint/templates/config.toml.j2 delete mode 100644 ansible-tendermint/templates/genesis.json.j2 delete mode 100644 ansible-tendermint/test.yml delete mode 100644 ansible-tendermint/vars/Debian.yml delete mode 100644 ansible-tendermint/vars/RedHat.yml rename {ansible-tendermint => ansible}/.gitignore (100%) rename {ansible-tendermint => ansible}/LICENSE (100%) create mode 100644 ansible/README.md rename {ansible-tendermint => ansible}/Vagrantfile (94%) create mode 100644 ansible/ansible.cfg rename {ansible-tendermint => ansible}/img/a_plus_t.png (100%) create mode 100644 ansible/install.yml create mode 100644 ansible/inventory/COPYING create mode 100644 ansible/inventory/digital_ocean.ini create mode 100755 ansible/inventory/digital_ocean.py rename {ansible-tendermint => ansible/roles/basecoin}/ansible.cfg (100%) create mode 100644 ansible/roles/basecoin/defaults/main.yml create mode 100644 ansible/roles/basecoin/handlers/main.yml create mode 100644 ansible/roles/basecoin/tasks/install.yml rename {ansible-tendermint => ansible/roles/basecoin}/tasks/main.yml (91%) rename {ansible-tendermint => ansible/roles/basecoin}/tasks/start.yml (100%) create mode 100644 ansible/roles/basecoin/templates/basecoin.conf.j2 create mode 100644 ansible/roles/basecoin/templates/basecoin.systemd.j2 create mode 100644 ansible/roles/basecoin/vars/Debian.yml create mode 100644 ansible/roles/basecoin/vars/RedHat.yml create mode 100644 ansible/roles/tendermint/defaults/main.yml create mode 100644 ansible/roles/tendermint/handlers/main.yml create mode 100644 ansible/roles/tendermint/tasks/genesis.yml rename {ansible-tendermint => ansible/roles/tendermint}/tasks/install.yml (74%) create mode 100644 ansible/roles/tendermint/tasks/main.yml create mode 100644 ansible/roles/tendermint/tasks/start.yml create mode 100644 ansible/roles/tendermint/templates/genesis.json.j2 rename {ansible-tendermint => ansible/roles/tendermint}/templates/tendermint.conf.j2 (75%) rename {ansible-tendermint => ansible/roles/tendermint}/templates/tendermint.systemd.j2 (100%) create mode 100644 ansible/roles/tendermint/vars/Debian.yml create mode 100644 ansible/roles/tendermint/vars/RedHat.yml create mode 100755 create-digitalocean-testnet.sh create mode 100644 terraforce/cluster/outputs.tf create mode 100644 terraforce/cluster/variables.tf delete mode 100644 terraforce/examples/dummy/bins delete mode 100644 terraforce/examples/dummy/run.sh delete mode 100644 terraforce/examples/in-proc-linux/bins delete mode 100644 terraforce/examples/in-proc-linux/run.sh delete mode 100644 terraforce/examples/in-proc/bins delete mode 100644 terraforce/examples/in-proc/run.sh delete mode 100644 terraforce/test.sh diff --git a/.gitignore b/.gitignore index 07fc221d..d378669d 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,5 @@ -*/vendor +.terraform +terraform.tfstate +terraform.tfstate.backup +terraform.tfstate.d + diff --git a/ansible-tendermint/README.md b/ansible-tendermint/README.md deleted file mode 100644 index 56983498..00000000 --- a/ansible-tendermint/README.md +++ /dev/null @@ -1,151 +0,0 @@ -# Ansible role for Tendermint - -![Ansible plus Tendermint](img/a_plus_t.png) - -* [Requirements](#requirements) -* [Variables](#variables) -* [Handlers](#handlers) -* [Example playbook that configures a Tendermint on Ubuntu](#example-playbook-that-configures-a-tendermint-on-ubuntu) - -`ansible-tendermint` is an [ansible](http://www.ansible.com/) role which: - -* installs tendermint -* configures tendermint -* configures tendermint service - -## Requirements - -This role requires Ansible 2.0 or higher. - -## Variables - -Here is a list of all the default variables for this role, which are also -available in `defaults/main.yml`. - -``` -tendermint_version: 0.9.0 -tendermint_archive: "tendermint_{{tendermint_version}}_linux_amd64.zip" -tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/{{tendermint_version}}/{{tendermint_archive}}" -tendermint_download_folder: /tmp - -tendermint_user: tendermint -tendermint_group: tendermint - -# Upstart start/stop conditions can vary by distribution and environment -tendermint_upstart_start_on: start on runlevel [345] -tendermint_upstart_stop_on: stop on runlevel [!345] -tendermint_manage_service: true -tendermint_use_upstart: true -tendermint_use_systemd: false -tendermint_upstart_template: "tendermint.conf.j2" -tendermint_systemd_template: "tendermint.systemd.j2" - -tendermint_home: /opt/tendermint -tendermint_node_port: 46656 -tendermint_rpc_port: 46657 -tendermint_proxy_app: "tcp://127.0.0.1:46658" -tendermint_node_laddr: "tcp://0.0.0.0:{{tendermint_node_port}}" -tendermint_rpc_laddr: "tcp://0.0.0.0:{{tendermint_rpc_port}}" -tendermint_seeds: "" -tendermint_fast_sync: true -tendermint_db_backend: leveldb -tendermint_log_level: notice -tendermint_genesis_file: "{{tendermint_home}}/genesis.json" -tendermint_abci: socket -tendermint_skip_upnp: false -tendermint_addrbook_file: "{{tendermint_home}}/addrbook.json" -tendermint_addrbook_strict: true -tendermint_pex_reactor: false -tendermint_priv_validator_file: "{{tendermint_home}}/priv_validator.json" -tendermint_db_dir: "{{tendermint_home}}/data" -tendermint_grpc_laddr: "" -tendermint_prof_laddr: "" -tendermint_cs_wal_file: "{{tendermint_db_dir}}/cs.wal/wal" -tendermint_cs_wal_light: false -tendermint_filter_peers: false -tendermint_block_size: 10000 -tendermint_block_part_size: 65536 -tendermint_disable_data_hash: false -# all timeouts are in milliseconds -tendermint_timeout_propose: 3000 -tendermint_timeout_propose_delta: 500 -tendermint_timeout_prevote: 1000 -tendermint_timeout_prevote_delta: 500 -tendermint_timeout_precommit: 1000 -tendermint_timeout_precommit_delta: 500 -tendermint_timeout_commit: 1000 -tendermint_skip_timeout_commit: false -tendermint_mempool_recheck: true -tendermint_mempool_recheck_empty: true -tendermint_mempool_broadcast: true -tendermint_mempool_wal_dir: "{{tendermint_db_dir}}/mempool.wal" - -tendermint_log_file: /var/log/tendermint.log - -tendermint_chain_id: mychain -tendermint_genesis_time: "{{ansible_date_time.iso8601_micro}}" -tendermint_validators: [] -``` - -## Handlers - -These are the handlers that are defined in `handlers/main.yml`. - -* `restart tendermint` -* `reload systemd` - -## Example playbook that configures a Tendermint on Ubuntu 14.04 - -``` ---- - -- hosts: all - vars: - tendermint_chain_id: MyAwesomeChain - tendermint_seeds: "172.13.0.1:46656,172.13.0.2:46656,172.13.0.3:46656" - roles: - - ansible-tendermint -``` - -This playbook will install Tendermint and will create all the -required directories. But **it won't start the Tendermint if no -validators were given**. - -You will need to collect validators public keys manually or using -`collect_public_keys.yml` given you have SSH access to all the nodes and set `tendermint_validators` variable: - -``` ---- - -- hosts: all - vars: - tendermint_chain_id: MyAwesomeChain - tendermint_seeds: "172.13.0.1:46656,172.13.0.2:46656,172.13.0.3:46656" - tendermint_validators: - - pub_key: - - 1 - - 1F017E488A6327FAFBBE092193B427912E117733DE6AF72150BF09AA58411E7F - amount: 10 - name: paris - roles: - - ansible-tendermint -``` - -### Example playbook that configures a Tendermint with in-proc dummy app - -``` ---- - -- hosts: all - vars: - tendermint_chain_id: MyAwesomeChain - tendermint_proxy_app: dummy - roles: - - ansible-tendermint -``` - -## Testing - -``` -vagrant up -``` diff --git a/ansible-tendermint/collect_public_keys.yml b/ansible-tendermint/collect_public_keys.yml deleted file mode 100644 index c60fbc0c..00000000 --- a/ansible-tendermint/collect_public_keys.yml +++ /dev/null @@ -1,11 +0,0 @@ ---- -# Outputs validator public keys from all the nodes to help you form genesis file - -- hosts: all - vars: - tendermint_home: /opt/tendermint - tasks: - - shell: cat "{{tendermint_home}}/priv_validator.json" | jq ".pub_key[1]" - register: pk - - - debug: var=pk.stdout_lines diff --git a/ansible-tendermint/defaults/main.yml b/ansible-tendermint/defaults/main.yml deleted file mode 100644 index 7dd7e281..00000000 --- a/ansible-tendermint/defaults/main.yml +++ /dev/null @@ -1,64 +0,0 @@ ---- -tendermint_version: 0.9.0 -tendermint_archive: "tendermint_{{tendermint_version}}_linux_amd64.zip" -tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/{{tendermint_version}}/{{tendermint_archive}}" -tendermint_download_folder: /tmp - -tendermint_user: tendermint -tendermint_group: tendermint - -# Upstart start/stop conditions can vary by distribution and environment -tendermint_upstart_start_on: start on runlevel [345] -tendermint_upstart_stop_on: stop on runlevel [!345] -tendermint_manage_service: true -tendermint_use_upstart: true -tendermint_use_systemd: false -tendermint_upstart_template: "tendermint.conf.j2" -tendermint_systemd_template: "tendermint.systemd.j2" - -tendermint_home: /opt/tendermint -tendermint_node_port: 46656 -tendermint_rpc_port: 46657 -tendermint_proxy_app: "tcp://127.0.0.1:46658" -tendermint_node_laddr: "tcp://0.0.0.0:{{tendermint_node_port}}" -tendermint_rpc_laddr: "tcp://0.0.0.0:{{tendermint_rpc_port}}" -tendermint_seeds: "" -tendermint_fast_sync: true -tendermint_db_backend: leveldb -tendermint_log_level: notice -tendermint_genesis_file: "{{tendermint_home}}/genesis.json" -tendermint_abci: socket -tendermint_skip_upnp: false -tendermint_addrbook_file: "{{tendermint_home}}/addrbook.json" -tendermint_addrbook_strict: true -tendermint_pex_reactor: false -tendermint_priv_validator_file: "{{tendermint_home}}/priv_validator.json" -tendermint_db_dir: "{{tendermint_home}}/data" -tendermint_grpc_laddr: "" -tendermint_prof_laddr: "" -tendermint_cs_wal_file: "{{tendermint_db_dir}}/cs.wal/wal" -tendermint_cs_wal_light: false -tendermint_filter_peers: false -tendermint_block_size: 10000 -tendermint_block_part_size: 65536 -tendermint_disable_data_hash: false -# all timeouts are in milliseconds -tendermint_timeout_propose: 3000 -tendermint_timeout_propose_delta: 500 -tendermint_timeout_prevote: 1000 -tendermint_timeout_prevote_delta: 500 -tendermint_timeout_precommit: 1000 -tendermint_timeout_precommit_delta: 500 -tendermint_timeout_commit: 1000 -tendermint_skip_timeout_commit: false -tendermint_mempool_recheck: true -tendermint_mempool_recheck_empty: true -tendermint_mempool_broadcast: true -tendermint_mempool_wal_dir: "{{tendermint_db_dir}}/mempool.wal" - -tendermint_log_file: /var/log/tendermint.log - -tendermint_chain_id: mychain -# FIXME https://github.com/tendermint/tools/issues/22 -tendermint_genesis_time: "0001-01-01T00:00:00.000Z" -tendermint_validators: [] diff --git a/ansible-tendermint/handlers/main.yml b/ansible-tendermint/handlers/main.yml deleted file mode 100644 index dab7e901..00000000 --- a/ansible-tendermint/handlers/main.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- - -- name: reload systemd - become: true - command: systemctl daemon-reload - -- name: restart tendermint - action: service name=tendermint state=restarted enabled=yes - when: tendermint_manage_service diff --git a/ansible-tendermint/templates/config.toml.j2 b/ansible-tendermint/templates/config.toml.j2 deleted file mode 100644 index 3743a195..00000000 --- a/ansible-tendermint/templates/config.toml.j2 +++ /dev/null @@ -1,38 +0,0 @@ -proxy_app = "{{tendermint_proxy_app}}" -node_laddr = "{{tendermint_node_laddr}}" -seeds = "{{tendermint_seeds}}" -fast_sync = {{tendermint_fast_sync | bool | lower}} -db_backend = "{{tendermint_db_backend}}" -log_level = "{{tendermint_log_level}}" -rpc_laddr = "{{tendermint_rpc_laddr}}" - -genesis_file = "{{tendermint_genesis_file}}" -abci = "{{tendermint_abci}}" -skip_upnp = {{tendermint_skip_upnp | bool | lower}} -addrbook_file = "{{tendermint_addrbook_file}}" -addrbook_strict = {{tendermint_addrbook_strict | bool | lower}} -pex_reactor = {{tendermint_pex_reactor | bool | lower}} -priv_validator_file = "{{tendermint_priv_validator_file}}" - -db_dir = "{{tendermint_db_dir}}" -grpc_laddr = "{{tendermint_grpc_laddr}}" -prof_laddr = "{{tendermint_prof_laddr}}" -cs_wal_file = "{{tendermint_cs_wal_file}}" -cs_wal_light = {{tendermint_cs_wal_light | bool | lower}} -filter_peers = {{tendermint_filter_peers | bool | lower}} - -block_size = {{tendermint_block_size}} -block_part_size = {{tendermint_block_part_size}} -disable_data_hash = {{tendermint_disable_data_hash | bool | lower}} -timeout_propose = {{tendermint_timeout_propose}} -timeout_propose_delta = {{tendermint_timeout_propose_delta}} -timeout_prevote = {{tendermint_timeout_prevote}} -timeout_prevote_delta = {{tendermint_timeout_prevote_delta}} -timeout_precommit = {{tendermint_timeout_precommit}} -timeout_precommit_delta = {{tendermint_timeout_precommit_delta}} -timeout_commit = {{tendermint_timeout_commit}} -skip_timeout_commit = {{tendermint_skip_timeout_commit | bool | lower}} -mempool_recheck = {{tendermint_mempool_recheck | bool | lower}} -mempool_recheck_empty = {{tendermint_mempool_recheck_empty | bool | lower}} -mempool_broadcast = {{tendermint_mempool_broadcast | bool | lower}} -mempool_wal_dir = "{{tendermint_mempool_wal_dir}}" diff --git a/ansible-tendermint/templates/genesis.json.j2 b/ansible-tendermint/templates/genesis.json.j2 deleted file mode 100644 index ea438833..00000000 --- a/ansible-tendermint/templates/genesis.json.j2 +++ /dev/null @@ -1,6 +0,0 @@ -{ - "app_hash": "", - "chain_id": "{{tendermint_chain_id}}", - "genesis_time": "{{tendermint_genesis_time}}", - "validators": {{tendermint_validators | to_nice_json}} -} diff --git a/ansible-tendermint/test.yml b/ansible-tendermint/test.yml deleted file mode 100644 index 4b11dd24..00000000 --- a/ansible-tendermint/test.yml +++ /dev/null @@ -1,13 +0,0 @@ ---- - -- hosts: all - roles: - - ansible-tendermint - vars: - tendermint_proxy_app: dummy - # tendermint_validators: - # - pub_key: - # - 1 - # - 1F017E488A6327FAFBBE092193B427912E117733DE6AF72150BF09AA58411E7F - # amount: 10 - # name: paris diff --git a/ansible-tendermint/vars/Debian.yml b/ansible-tendermint/vars/Debian.yml deleted file mode 100644 index 642304b9..00000000 --- a/ansible-tendermint/vars/Debian.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -consul_upstart_start_on: (local-filesystems and net-device-up IFACE!=lo) -consul_upstart_stop_on: runlevel [016] diff --git a/ansible-tendermint/vars/RedHat.yml b/ansible-tendermint/vars/RedHat.yml deleted file mode 100644 index 4c2bb72b..00000000 --- a/ansible-tendermint/vars/RedHat.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -consul_upstart_start_on: (runlevel [345] and started network) -consul_upstart_stop_on: (runlevel [!345] or stopping network) diff --git a/ansible-tendermint/.gitignore b/ansible/.gitignore similarity index 100% rename from ansible-tendermint/.gitignore rename to ansible/.gitignore diff --git a/ansible-tendermint/LICENSE b/ansible/LICENSE similarity index 100% rename from ansible-tendermint/LICENSE rename to ansible/LICENSE diff --git a/ansible/README.md b/ansible/README.md new file mode 100644 index 00000000..2ef5a7a9 --- /dev/null +++ b/ansible/README.md @@ -0,0 +1,84 @@ +# Ansible playbook for Tendermint on DigitalOcean + +![Ansible plus Tendermint](img/a_plus_t.png) + +* [Prerequisites](#Prerequisites) +* [Ansible setup](#Ansible setup) +* [Running the playbook](#Running the playbook) +* [Example playbook that configures a Tendermint on Ubuntu](#example-playbook-that-configures-a-tendermint-on-ubuntu) + +The playbook in this folder contains [ansible](http://www.ansible.com/) roles which: + +* installs tendermint +* configures tendermint +* configures tendermint service +* installs basecoin +* configures basecoin + +## Prerequisites + +* Ansible 2.0 or higher +* DigitalOcean API Token +* SSH key to the servers +* python dopy package + +Head over to the [Terraform folder](https://github.com/tendermint/tools) for a description on how to get a DigitalOcean API Token. + +The DigitalOcean inventory script comes from the ansible team at https://github.com/ansible/ansible. You can get the latest version from the contrib/inventory folder. + +## Ansible setup + +Ansible requires a "command machine" or "local machine" or "orchestrator machine" to run on. This can be your laptop or any machine that runs linux. (It does not have to be part of the DigitalOcean network.) + +Example on RedHat/CentOS: +``` +sudo yum install ansible python-pip +sudo pip install dopy +``` + +Example on Ubuntu/Debian: +``` +sudo apt-get install ansible python-pip +sudo pip install dopy +``` + +To make life easier, you can start an SSH Agent and load your SSH key(s) into it. This way ansible will have an uninterrupted way of connecting to the droplets. + +``` +ssh-agent > ~/.ssh/ssh.env +source ~/.ssh/ssh.env + +ssh-add private.key +``` + +Subsequently, as long as the agent is running, you can use `source ~/.ssh/ssh.env` to load the keys to the current session. + +## Refreshing the DigitalOcean inventory + +If you just finished creating droplets, the local DigitalOcean inventory cache is not up-to-date. To refresh it, run: + +``` +DO_API_TOKEN="" +python -u inventory/digital_ocean.py --refresh-cache 1> /dev/null +``` + +## Running the playbook + +The playbook is locked down to only run if the environment variable `TF_VAR_TESTNET_NAME` is populated. This is a precaution so you don't accidentally run the playbook on all your DigitalOcean droplets. + +The variable `TF_VAR_TESTNET_NAME` contains the testnet name defined when the droplets were created using Terraform. + +``` +TF_VAR_TESTNET_NAME="testnet-servers" +ansible-playbook -i inventory/digital_ocean.py install.yml +``` + +If the playbook cannot connect to the servers because of public key denial, your SSH Agent is not set up properly. Alternatively you can add the SSH key to ansible using the `--private-key` option. + +## Starting the cluster + +To be continued... + +## Role details + +To be continued... diff --git a/ansible-tendermint/Vagrantfile b/ansible/Vagrantfile similarity index 94% rename from ansible-tendermint/Vagrantfile rename to ansible/Vagrantfile index bc6f9fde..83ad0159 100644 --- a/ansible-tendermint/Vagrantfile +++ b/ansible/Vagrantfile @@ -13,7 +13,7 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| config.vm.box = "ubuntu/trusty64" config.vm.provision :ansible do |ansible| - ansible.playbook = "test.yml" + ansible.playbook = "install.yml" ansible.verbose = 'vv' ansible.sudo = true end diff --git a/ansible/ansible.cfg b/ansible/ansible.cfg new file mode 100644 index 00000000..045c1ea6 --- /dev/null +++ b/ansible/ansible.cfg @@ -0,0 +1,4 @@ +[defaults] +retry_files_enabled = False +host_key_checking = False + diff --git a/ansible-tendermint/img/a_plus_t.png b/ansible/img/a_plus_t.png similarity index 100% rename from ansible-tendermint/img/a_plus_t.png rename to ansible/img/a_plus_t.png diff --git a/ansible/install.yml b/ansible/install.yml new file mode 100644 index 00000000..ccd82330 --- /dev/null +++ b/ansible/install.yml @@ -0,0 +1,9 @@ +--- + +- hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" + vars: + testnet_name: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" + user: root + roles: + - tendermint + - basecoin diff --git a/ansible/inventory/COPYING b/ansible/inventory/COPYING new file mode 100644 index 00000000..10926e87 --- /dev/null +++ b/ansible/inventory/COPYING @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/ansible/inventory/digital_ocean.ini b/ansible/inventory/digital_ocean.ini new file mode 100644 index 00000000..b809554b --- /dev/null +++ b/ansible/inventory/digital_ocean.ini @@ -0,0 +1,34 @@ +# Ansible DigitalOcean external inventory script settings +# + +[digital_ocean] + +# The module needs your DigitalOcean API Token. +# It may also be specified on the command line via --api-token +# or via the environment variables DO_API_TOKEN or DO_API_KEY +# +#api_token = 123456abcdefg + + +# API calls to DigitalOcean may be slow. For this reason, we cache the results +# of an API call. Set this to the path you want cache files to be written to. +# One file will be written to this directory: +# - ansible-digital_ocean.cache +# +cache_path = /tmp + + +# The number of seconds a cache file is considered valid. After this many +# seconds, a new API call will be made, and the cache file will be updated. +# +cache_max_age = 300 + +# Use the private network IP address instead of the public when available. +# +use_private_network = False + +# Pass variables to every group, e.g.: +# +# group_variables = { 'ansible_user': 'root' } +# +group_variables = {} diff --git a/ansible/inventory/digital_ocean.py b/ansible/inventory/digital_ocean.py new file mode 100755 index 00000000..24ba6437 --- /dev/null +++ b/ansible/inventory/digital_ocean.py @@ -0,0 +1,471 @@ +#!/usr/bin/env python + +''' +DigitalOcean external inventory script +====================================== + +Generates Ansible inventory of DigitalOcean Droplets. + +In addition to the --list and --host options used by Ansible, there are options +for generating JSON of other DigitalOcean data. This is useful when creating +droplets. For example, --regions will return all the DigitalOcean Regions. +This information can also be easily found in the cache file, whose default +location is /tmp/ansible-digital_ocean.cache). + +The --pretty (-p) option pretty-prints the output for better human readability. + +---- +Although the cache stores all the information received from DigitalOcean, +the cache is not used for current droplet information (in --list, --host, +--all, and --droplets). This is so that accurate droplet information is always +found. You can force this script to use the cache with --force-cache. + +---- +Configuration is read from `digital_ocean.ini`, then from environment variables, +then and command-line arguments. + +Most notably, the DigitalOcean API Token must be specified. It can be specified +in the INI file or with the following environment variables: + export DO_API_TOKEN='abc123' or + export DO_API_KEY='abc123' + +Alternatively, it can be passed on the command-line with --api-token. + +If you specify DigitalOcean credentials in the INI file, a handy way to +get them into your environment (e.g., to use the digital_ocean module) +is to use the output of the --env option with export: + export $(digital_ocean.py --env) + +---- +The following groups are generated from --list: + - ID (droplet ID) + - NAME (droplet NAME) + - image_ID + - image_NAME + - distro_NAME (distribution NAME from image) + - region_NAME + - size_NAME + - status_STATUS + +For each host, the following variables are registered: + - do_backup_ids + - do_created_at + - do_disk + - do_features - list + - do_id + - do_image - object + - do_ip_address + - do_private_ip_address + - do_kernel - object + - do_locked + - do_memory + - do_name + - do_networks - object + - do_next_backup_window + - do_region - object + - do_size - object + - do_size_slug + - do_snapshot_ids - list + - do_status + - do_tags + - do_vcpus + - do_volume_ids + +----- +``` +usage: digital_ocean.py [-h] [--list] [--host HOST] [--all] + [--droplets] [--regions] [--images] [--sizes] + [--ssh-keys] [--domains] [--pretty] + [--cache-path CACHE_PATH] + [--cache-max_age CACHE_MAX_AGE] + [--force-cache] + [--refresh-cache] + [--api-token API_TOKEN] + +Produce an Ansible Inventory file based on DigitalOcean credentials + +optional arguments: + -h, --help show this help message and exit + --list List all active Droplets as Ansible inventory + (default: True) + --host HOST Get all Ansible inventory variables about a specific + Droplet + --all List all DigitalOcean information as JSON + --droplets List Droplets as JSON + --regions List Regions as JSON + --images List Images as JSON + --sizes List Sizes as JSON + --ssh-keys List SSH keys as JSON + --domains List Domains as JSON + --pretty, -p Pretty-print results + --cache-path CACHE_PATH + Path to the cache files (default: .) + --cache-max_age CACHE_MAX_AGE + Maximum age of the cached items (default: 0) + --force-cache Only use data from the cache + --refresh-cache Force refresh of cache by making API requests to + DigitalOcean (default: False - use cache files) + --api-token API_TOKEN, -a API_TOKEN + DigitalOcean API Token +``` + +''' + +# (c) 2013, Evan Wies +# +# Inspired by the EC2 inventory plugin: +# https://github.com/ansible/ansible/blob/devel/contrib/inventory/ec2.py +# +# This file is part of Ansible, +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + +###################################################################### + +import os +import sys +import re +import argparse +from time import time +import ConfigParser +import ast + +try: + import json +except ImportError: + import simplejson as json + +try: + from dopy.manager import DoManager +except ImportError as e: + sys.exit("failed=True msg='`dopy` library required for this script'") + + +class DigitalOceanInventory(object): + + ########################################################################### + # Main execution path + ########################################################################### + + def __init__(self): + ''' Main execution path ''' + + # DigitalOceanInventory data + self.data = {} # All DigitalOcean data + self.inventory = {} # Ansible Inventory + + # Define defaults + self.cache_path = '.' + self.cache_max_age = 0 + self.use_private_network = False + self.group_variables = {} + + # Read settings, environment variables, and CLI arguments + self.read_settings() + self.read_environment() + self.read_cli_args() + + # Verify credentials were set + if not hasattr(self, 'api_token'): + sys.stderr.write('''Could not find values for DigitalOcean api_token. +They must be specified via either ini file, command line argument (--api-token), +or environment variables (DO_API_TOKEN)\n''') + sys.exit(-1) + + # env command, show DigitalOcean credentials + if self.args.env: + print("DO_API_TOKEN=%s" % self.api_token) + sys.exit(0) + + # Manage cache + self.cache_filename = self.cache_path + "/ansible-digital_ocean.cache" + self.cache_refreshed = False + + if self.is_cache_valid(): + self.load_from_cache() + if len(self.data) == 0: + if self.args.force_cache: + sys.stderr.write('''Cache is empty and --force-cache was specified\n''') + sys.exit(-1) + + self.manager = DoManager(None, self.api_token, api_version=2) + + # Pick the json_data to print based on the CLI command + if self.args.droplets: + self.load_from_digital_ocean('droplets') + json_data = {'droplets': self.data['droplets']} + elif self.args.regions: + self.load_from_digital_ocean('regions') + json_data = {'regions': self.data['regions']} + elif self.args.images: + self.load_from_digital_ocean('images') + json_data = {'images': self.data['images']} + elif self.args.sizes: + self.load_from_digital_ocean('sizes') + json_data = {'sizes': self.data['sizes']} + elif self.args.ssh_keys: + self.load_from_digital_ocean('ssh_keys') + json_data = {'ssh_keys': self.data['ssh_keys']} + elif self.args.domains: + self.load_from_digital_ocean('domains') + json_data = {'domains': self.data['domains']} + elif self.args.all: + self.load_from_digital_ocean() + json_data = self.data + elif self.args.host: + json_data = self.load_droplet_variables_for_host() + else: # '--list' this is last to make it default + self.load_from_digital_ocean('droplets') + self.build_inventory() + json_data = self.inventory + + if self.cache_refreshed: + self.write_to_cache() + + if self.args.pretty: + print(json.dumps(json_data, sort_keys=True, indent=2)) + else: + print(json.dumps(json_data)) + # That's all she wrote... + + ########################################################################### + # Script configuration + ########################################################################### + + def read_settings(self): + ''' Reads the settings from the digital_ocean.ini file ''' + config = ConfigParser.SafeConfigParser() + config.read(os.path.dirname(os.path.realpath(__file__)) + '/digital_ocean.ini') + + # Credentials + if config.has_option('digital_ocean', 'api_token'): + self.api_token = config.get('digital_ocean', 'api_token') + + # Cache related + if config.has_option('digital_ocean', 'cache_path'): + self.cache_path = config.get('digital_ocean', 'cache_path') + if config.has_option('digital_ocean', 'cache_max_age'): + self.cache_max_age = config.getint('digital_ocean', 'cache_max_age') + + # Private IP Address + if config.has_option('digital_ocean', 'use_private_network'): + self.use_private_network = config.getboolean('digital_ocean', 'use_private_network') + + # Group variables + if config.has_option('digital_ocean', 'group_variables'): + self.group_variables = ast.literal_eval(config.get('digital_ocean', 'group_variables')) + + def read_environment(self): + ''' Reads the settings from environment variables ''' + # Setup credentials + if os.getenv("DO_API_TOKEN"): + self.api_token = os.getenv("DO_API_TOKEN") + if os.getenv("DO_API_KEY"): + self.api_token = os.getenv("DO_API_KEY") + + def read_cli_args(self): + ''' Command line argument processing ''' + parser = argparse.ArgumentParser(description='Produce an Ansible Inventory file based on DigitalOcean credentials') + + parser.add_argument('--list', action='store_true', help='List all active Droplets as Ansible inventory (default: True)') + parser.add_argument('--host', action='store', help='Get all Ansible inventory variables about a specific Droplet') + + parser.add_argument('--all', action='store_true', help='List all DigitalOcean information as JSON') + parser.add_argument('--droplets', '-d', action='store_true', help='List Droplets as JSON') + parser.add_argument('--regions', action='store_true', help='List Regions as JSON') + parser.add_argument('--images', action='store_true', help='List Images as JSON') + parser.add_argument('--sizes', action='store_true', help='List Sizes as JSON') + parser.add_argument('--ssh-keys', action='store_true', help='List SSH keys as JSON') + parser.add_argument('--domains', action='store_true', help='List Domains as JSON') + + parser.add_argument('--pretty', '-p', action='store_true', help='Pretty-print results') + + parser.add_argument('--cache-path', action='store', help='Path to the cache files (default: .)') + parser.add_argument('--cache-max_age', action='store', help='Maximum age of the cached items (default: 0)') + parser.add_argument('--force-cache', action='store_true', default=False, help='Only use data from the cache') + parser.add_argument('--refresh-cache', '-r', action='store_true', default=False, + help='Force refresh of cache by making API requests to DigitalOcean (default: False - use cache files)') + + parser.add_argument('--env', '-e', action='store_true', help='Display DO_API_TOKEN') + parser.add_argument('--api-token', '-a', action='store', help='DigitalOcean API Token') + + self.args = parser.parse_args() + + if self.args.api_token: + self.api_token = self.args.api_token + + # Make --list default if none of the other commands are specified + if (not self.args.droplets and not self.args.regions and + not self.args.images and not self.args.sizes and + not self.args.ssh_keys and not self.args.domains and + not self.args.all and not self.args.host): + self.args.list = True + + ########################################################################### + # Data Management + ########################################################################### + + def load_from_digital_ocean(self, resource=None): + '''Get JSON from DigitalOcean API''' + if self.args.force_cache and os.path.isfile(self.cache_filename): + return + # We always get fresh droplets + if self.is_cache_valid() and not (resource == 'droplets' or resource is None): + return + if self.args.refresh_cache: + resource = None + + if resource == 'droplets' or resource is None: + self.data['droplets'] = self.manager.all_active_droplets() + self.cache_refreshed = True + if resource == 'regions' or resource is None: + self.data['regions'] = self.manager.all_regions() + self.cache_refreshed = True + if resource == 'images' or resource is None: + self.data['images'] = self.manager.all_images(filter=None) + self.cache_refreshed = True + if resource == 'sizes' or resource is None: + self.data['sizes'] = self.manager.sizes() + self.cache_refreshed = True + if resource == 'ssh_keys' or resource is None: + self.data['ssh_keys'] = self.manager.all_ssh_keys() + self.cache_refreshed = True + if resource == 'domains' or resource is None: + self.data['domains'] = self.manager.all_domains() + self.cache_refreshed = True + + def build_inventory(self): + '''Build Ansible inventory of droplets''' + self.inventory = { + 'all': { + 'hosts': [], + 'vars': self.group_variables + }, + '_meta': {'hostvars': {}} + } + + # add all droplets by id and name + for droplet in self.data['droplets']: + # when using private_networking, the API reports the private one in "ip_address". + if 'private_networking' in droplet['features'] and not self.use_private_network: + for net in droplet['networks']['v4']: + if net['type'] == 'public': + dest = net['ip_address'] + else: + continue + else: + dest = droplet['ip_address'] + + self.inventory['all']['hosts'].append(dest) + + self.inventory[droplet['id']] = [dest] + self.inventory[droplet['name']] = [dest] + + # groups that are always present + for group in ('region_' + droplet['region']['slug'], + 'image_' + str(droplet['image']['id']), + 'size_' + droplet['size']['slug'], + 'distro_' + self.to_safe(droplet['image']['distribution']), + 'status_' + droplet['status']): + if group not in self.inventory: + self.inventory[group] = {'hosts': [], 'vars': {}} + self.inventory[group]['hosts'].append(dest) + + # groups that are not always present + for group in (droplet['image']['slug'], + droplet['image']['name']): + if group: + image = 'image_' + self.to_safe(group) + if image not in self.inventory: + self.inventory[image] = {'hosts': [], 'vars': {}} + self.inventory[image]['hosts'].append(dest) + + if droplet['tags']: + for tag in droplet['tags']: + if tag not in self.inventory: + self.inventory[tag] = {'hosts': [], 'vars': {}} + self.inventory[tag]['hosts'].append(dest) + + # hostvars + info = self.do_namespace(droplet) + self.inventory['_meta']['hostvars'][dest] = info + + def load_droplet_variables_for_host(self): + '''Generate a JSON response to a --host call''' + host = int(self.args.host) + droplet = self.manager.show_droplet(host) + info = self.do_namespace(droplet) + return {'droplet': info} + + ########################################################################### + # Cache Management + ########################################################################### + + def is_cache_valid(self): + ''' Determines if the cache files have expired, or if it is still valid ''' + if os.path.isfile(self.cache_filename): + mod_time = os.path.getmtime(self.cache_filename) + current_time = time() + if (mod_time + self.cache_max_age) > current_time: + return True + return False + + def load_from_cache(self): + ''' Reads the data from the cache file and assigns it to member variables as Python Objects''' + try: + cache = open(self.cache_filename, 'r') + json_data = cache.read() + cache.close() + data = json.loads(json_data) + except IOError: + data = {'data': {}, 'inventory': {}} + + self.data = data['data'] + self.inventory = data['inventory'] + + def write_to_cache(self): + ''' Writes data in JSON format to a file ''' + data = {'data': self.data, 'inventory': self.inventory} + json_data = json.dumps(data, sort_keys=True, indent=2) + + cache = open(self.cache_filename, 'w') + cache.write(json_data) + cache.close() + + ########################################################################### + # Utilities + ########################################################################### + + def push(self, my_dict, key, element): + ''' Pushed an element onto an array that may not have been defined in the dict ''' + if key in my_dict: + my_dict[key].append(element) + else: + my_dict[key] = [element] + + def to_safe(self, word): + ''' Converts 'bad' characters in a string to underscores so they can be used as Ansible groups ''' + return re.sub("[^A-Za-z0-9\-\.]", "_", word) + + def do_namespace(self, data): + ''' Returns a copy of the dictionary with all the keys put in a 'do_' namespace ''' + info = {} + for k, v in data.items(): + info['do_' + k] = v + return info + + +########################################################################### +# Run the script +DigitalOceanInventory() diff --git a/ansible-tendermint/ansible.cfg b/ansible/roles/basecoin/ansible.cfg similarity index 100% rename from ansible-tendermint/ansible.cfg rename to ansible/roles/basecoin/ansible.cfg diff --git a/ansible/roles/basecoin/defaults/main.yml b/ansible/roles/basecoin/defaults/main.yml new file mode 100644 index 00000000..0be7753e --- /dev/null +++ b/ansible/roles/basecoin/defaults/main.yml @@ -0,0 +1,23 @@ +--- +basecoin_release_install: false +basecoin_version: 0.4.0 +basecoin_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/basecoin/v{{basecoin_version}}/basecoin_{{basecoin_version}}_linux_amd64.zip" + +#If basecoin_release_install == false, copy the binary from here +basecoin_binary: "{{ lookup('env','GOPATH') | default('') }}/bin/basecoin" + +basecoin_user: basecoin +basecoin_group: basecoin + +# Upstart start/stop conditions can vary by distribution and environment +basecoin_upstart_start_on: start on runlevel [345] +basecoin_upstart_stop_on: stop on runlevel [!345] +basecoin_manage_service: true +basecoin_use_upstart: true +basecoin_use_systemd: false +basecoin_upstart_template: "basecoin.conf.j2" +basecoin_systemd_template: "basecoin.systemd.j2" + +basecoin_home: /var/lib/basecoin +basecoin_log_file: /var/log/basecoin.log + diff --git a/ansible/roles/basecoin/handlers/main.yml b/ansible/roles/basecoin/handlers/main.yml new file mode 100644 index 00000000..d00a2b8a --- /dev/null +++ b/ansible/roles/basecoin/handlers/main.yml @@ -0,0 +1,6 @@ +--- + +- name: reload systemd + become: true + command: systemctl daemon-reload + diff --git a/ansible/roles/basecoin/tasks/install.yml b/ansible/roles/basecoin/tasks/install.yml new file mode 100644 index 00000000..92ea01f5 --- /dev/null +++ b/ansible/roles/basecoin/tasks/install.yml @@ -0,0 +1,109 @@ +--- +- name: update apt + apt: > + update_cache=yes + cache_valid_time=3600 + when: ansible_os_family == "Debian" + +- name: install deps (Ubuntu) + apt: > + pkg={{item}} + state=installed + with_items: + - unzip + - jq + when: ansible_os_family == "Debian" + +- name: install deps (RHEL) + yum: > + pkg={{item}} + state=installed + with_items: + - unzip + - jq + when: ansible_os_family == "RedHat" + +- name: create group + group: > + name={{basecoin_group}} + state=present + system=yes + register: basecoin_group_created + +- name: create user + user: > + home={{basecoin_home}} + name={{basecoin_user}} + group={{basecoin_group}} + system=yes + when: basecoin_group_created|changed + +- name: create directory + file: > + path={{basecoin_home}} + state=directory + owner={{basecoin_user}} + group={{basecoin_group}} + mode=0755 + +# Check before creating log dir to prevent aggressively overwriting permissions +- name: check for log directory + stat: > + path={{ basecoin_log_file|dirname }} + register: logdir + +- name: create log directory if it does not exist + file: > + state=directory + path={{ basecoin_log_file|dirname }} + owner={{ basecoin_user }} + group={{ basecoin_group }} + when: not logdir.stat.exists + +- name: touch the log file + file: > + state=touch + path={{ basecoin_log_file }} + owner={{ basecoin_user }} + group={{ basecoin_group }} + changed_when: false + +- name: copy and unpack release binary + when: basecoin_release_install + unarchive: > + src={{basecoin_download}} + dest=/usr/local/bin + remote_src=true + mode=0755 + +- name: copy compiled binary + when: not basecoin_release_install + copy: > + src={{basecoin_binary}} + dest=/usr/local/bin + mode=0755 + +- name: initialize basecoin + command: "basecoin init" + become: yes + become_user: "{{basecoin_user}}" + +- name: copy upstart script + template: > + src={{basecoin_upstart_template}} + dest=/etc/init/basecoin.conf + owner=root + group=root + mode=0644 + when: basecoin_use_upstart + +- name: copy systemd script + template: > + src={{basecoin_systemd_template}} + dest=/etc/systemd/system/basecoin.service + owner=root + group=root + mode=0644 + when: basecoin_use_systemd + notify: + - reload systemd diff --git a/ansible-tendermint/tasks/main.yml b/ansible/roles/basecoin/tasks/main.yml similarity index 91% rename from ansible-tendermint/tasks/main.yml rename to ansible/roles/basecoin/tasks/main.yml index cabf64bd..73bc8379 100644 --- a/ansible-tendermint/tasks/main.yml +++ b/ansible/roles/basecoin/tasks/main.yml @@ -5,4 +5,4 @@ - "{{ ansible_os_family }}-{{ ansible_distribution_major_version}}.yml" - "{{ ansible_os_family }}.yml" - include: install.yml -- include: start.yml +#- include: start.yml diff --git a/ansible-tendermint/tasks/start.yml b/ansible/roles/basecoin/tasks/start.yml similarity index 100% rename from ansible-tendermint/tasks/start.yml rename to ansible/roles/basecoin/tasks/start.yml diff --git a/ansible/roles/basecoin/templates/basecoin.conf.j2 b/ansible/roles/basecoin/templates/basecoin.conf.j2 new file mode 100644 index 00000000..bb9c822b --- /dev/null +++ b/ansible/roles/basecoin/templates/basecoin.conf.j2 @@ -0,0 +1,15 @@ +# Basecoin (Upstart unit) +description "Basecoin" + +start on {{ basecoin_upstart_start_on }} +stop on {{ basecoin_upstart_stop_on }} + +script + # Use su to become tendermint user non-interactively on old Upstart versions (see http://superuser.com/a/234541/76168) + exec su -s /bin/sh -c 'TMROOT={{basecoin_home}} exec "$0" "$@" >> {{ basecoin_log_file }} 2>&1' {{basecoin_user}} -- /usr/local/bin/basecoin start --without-tendermint +end script + +respawn +respawn limit 10 10 + +kill timeout 10 diff --git a/ansible/roles/basecoin/templates/basecoin.systemd.j2 b/ansible/roles/basecoin/templates/basecoin.systemd.j2 new file mode 100644 index 00000000..d6925f8d --- /dev/null +++ b/ansible/roles/basecoin/templates/basecoin.systemd.j2 @@ -0,0 +1,17 @@ +[Unit] +Description=Basecoin +Requires=network-online.target +After=network-online.target + +[Service] +Environment="TMROOT={{tendermint_home}}" +Restart=on-failure +User={{ tendermint_user }} +Group={{ tendermint_group }} +PermissionsStartOnly=true +ExecStart=/usr/local/bin/basecoin start --without-tendermint +ExecReload=/bin/kill -HUP $MAINPID +KillSignal=SIGINT + +[Install] +WantedBy=multi-user.target diff --git a/ansible/roles/basecoin/vars/Debian.yml b/ansible/roles/basecoin/vars/Debian.yml new file mode 100644 index 00000000..a87f2b25 --- /dev/null +++ b/ansible/roles/basecoin/vars/Debian.yml @@ -0,0 +1,2 @@ +--- +#Placeholder diff --git a/ansible/roles/basecoin/vars/RedHat.yml b/ansible/roles/basecoin/vars/RedHat.yml new file mode 100644 index 00000000..a87f2b25 --- /dev/null +++ b/ansible/roles/basecoin/vars/RedHat.yml @@ -0,0 +1,2 @@ +--- +#Placeholder diff --git a/ansible/roles/tendermint/defaults/main.yml b/ansible/roles/tendermint/defaults/main.yml new file mode 100644 index 00000000..d8f72eec --- /dev/null +++ b/ansible/roles/tendermint/defaults/main.yml @@ -0,0 +1,23 @@ +--- +tendermint_release_install: false +tendermint_version: 0.10.0-rc1 +tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/tendermint/v{{tendermint_version}}/tendermint_{{tendermint_version}}_linux_amd64.zip" + +#If tendermint_release_install == false, copy the binary from here +tendermint_binary: "{{ lookup('env','GOPATH') | default('') }}/bin/tendermint" + +tendermint_user: tendermint +tendermint_group: tendermint + +# Upstart start/stop conditions can vary by distribution and environment +tendermint_upstart_start_on: start on runlevel [345] +tendermint_upstart_stop_on: stop on runlevel [!345] +tendermint_manage_service: true +tendermint_use_upstart: true +tendermint_use_systemd: false +tendermint_upstart_template: "tendermint.conf.j2" +tendermint_systemd_template: "tendermint.systemd.j2" + +tendermint_home: /var/lib/tendermint +tendermint_log_file: /var/log/tendermint.log + diff --git a/ansible/roles/tendermint/handlers/main.yml b/ansible/roles/tendermint/handlers/main.yml new file mode 100644 index 00000000..d00a2b8a --- /dev/null +++ b/ansible/roles/tendermint/handlers/main.yml @@ -0,0 +1,6 @@ +--- + +- name: reload systemd + become: true + command: systemctl daemon-reload + diff --git a/ansible/roles/tendermint/tasks/genesis.yml b/ansible/roles/tendermint/tasks/genesis.yml new file mode 100644 index 00000000..f00c160d --- /dev/null +++ b/ansible/roles/tendermint/tasks/genesis.yml @@ -0,0 +1,19 @@ +--- +- name: gather tendermint public keys + command: "jq '.pub_key | .data' {{tendermint_home}}/.tendermint/priv_validator.json" + become: yes + become_user: "{{tendermint_user}}" + register: tendermintpubkeys + +- name: register public keys as host facts + set_fact: "pubkey={{tendermintpubkeys.stdout_lines[0]}}" + connection: local + +- name: copy genesis.json + template: + src: genesis.json.j2 + dest: "{{tendermint_home}}/.tendermint/genesis.json" + become: yes + become_user: "{{tendermint_user}}" + + diff --git a/ansible-tendermint/tasks/install.yml b/ansible/roles/tendermint/tasks/install.yml similarity index 74% rename from ansible-tendermint/tasks/install.yml rename to ansible/roles/tendermint/tasks/install.yml index 49fe6d0d..80647c2f 100644 --- a/ansible-tendermint/tasks/install.yml +++ b/ansible/roles/tendermint/tasks/install.yml @@ -68,38 +68,25 @@ group={{ tendermint_group }} changed_when: false -- name: copy and unpack binary +- name: copy and unpack release binary + when: tendermint_release_install unarchive: > src={{tendermint_download}} dest=/usr/local/bin remote_src=true mode=0755 - creates=/usr/local/bin/tendermint -- name: generate private validator - shell: tendermint gen_validator >> priv_validator.json - args: - chdir: "{{tendermint_home}}" - creates: priv_validator.json +- name: copy compiled binary + when: not tendermint_release_install + copy: > + src={{tendermint_binary}} + dest=/usr/local/bin + mode=0755 -- name: copy config - template: > - src=config.toml.j2 - dest={{tendermint_home}}/config.toml - owner={{tendermint_user}} - group={{tendermint_group}} - mode=0644 - register: config_was_copied - # notify: restart tendermint - -- name: set ownership - file: > - state=directory - path={{tendermint_home}} - owner={{tendermint_user}} - group={{tendermint_group}} - recurse=yes - when: config_was_copied|changed +- name: initialize tendermint + command: "tendermint init" + become: yes + become_user: "{{tendermint_user}}" - name: copy upstart script template: > @@ -109,7 +96,6 @@ group=root mode=0644 when: tendermint_use_upstart - # notify: restart tendermint - name: copy systemd script template: > diff --git a/ansible/roles/tendermint/tasks/main.yml b/ansible/roles/tendermint/tasks/main.yml new file mode 100644 index 00000000..8a7450b6 --- /dev/null +++ b/ansible/roles/tendermint/tasks/main.yml @@ -0,0 +1,9 @@ +--- +- name: gather OS specific variables + include_vars: "{{ item }}" + with_first_found: + - "{{ ansible_os_family }}-{{ ansible_distribution_major_version}}.yml" + - "{{ ansible_os_family }}.yml" +- include: install.yml +- include: genesis.yml +#- include: start.yml diff --git a/ansible/roles/tendermint/tasks/start.yml b/ansible/roles/tendermint/tasks/start.yml new file mode 100644 index 00000000..5bbbc04a --- /dev/null +++ b/ansible/roles/tendermint/tasks/start.yml @@ -0,0 +1,26 @@ +--- + +- name: copy genesis file + template: > + src=genesis.json.j2 + dest={{tendermint_home}}/genesis.json + owner={{tendermint_user}} + group={{tendermint_group}} + mode=0644 + register: genesis_file_copied + +- name: get validators number from genesis file + shell: cat {{tendermint_home}}/genesis.json | jq ".validators | length" + register: num_validators + when: genesis_file_copied|changed + +- name: restart tendermint if number of validators greater than 0 + shell: echo "restarting ..." + when: genesis_file_copied|changed and num_validators.stdout|int > 0 + notify: restart tendermint + +- service: > + name=tendermint + state=started + enabled=yes + when: tendermint_manage_service diff --git a/ansible/roles/tendermint/templates/genesis.json.j2 b/ansible/roles/tendermint/templates/genesis.json.j2 new file mode 100644 index 00000000..a1655fc8 --- /dev/null +++ b/ansible/roles/tendermint/templates/genesis.json.j2 @@ -0,0 +1,16 @@ +{ + "genesis_time":"{{ansible_date_time.iso8601}}", + "chain_id":"{{testnet_name}}", + "validators": + [ +{% for host in groups[testnet_name] %} + { + "pub_key":{"type":"ed25519","data":{{hostvars[host]["pubkey"]}}}, + "amount":10, + "name":"{{hostvars[host]["ansible_hostname"]}}" + } +{% endfor %} + ], + "app_hash":"" +} + diff --git a/ansible-tendermint/templates/tendermint.conf.j2 b/ansible/roles/tendermint/templates/tendermint.conf.j2 similarity index 75% rename from ansible-tendermint/templates/tendermint.conf.j2 rename to ansible/roles/tendermint/templates/tendermint.conf.j2 index 673f0246..d65cebb7 100644 --- a/ansible-tendermint/templates/tendermint.conf.j2 +++ b/ansible/roles/tendermint/templates/tendermint.conf.j2 @@ -6,8 +6,7 @@ stop on {{ tendermint_upstart_stop_on }} script # Use su to become tendermint user non-interactively on old Upstart versions (see http://superuser.com/a/234541/76168) - exec su -s /bin/sh -c 'TMROOT={{tendermint_home}} exec "$0" "$@" >> {{ tendermint_log_file }} 2>&1' tendermint -- /usr/local/bin/tendermint node \ - --moniker={{inventory_hostname}} + exec su -s /bin/sh -c 'TMROOT={{tendermint_home}} exec "$0" "$@" >> {{ tendermint_log_file }} 2>&1' {{ tendermint_user }} -- /usr/local/bin/tendermint node --moniker={{inventory_hostname}} end script respawn diff --git a/ansible-tendermint/templates/tendermint.systemd.j2 b/ansible/roles/tendermint/templates/tendermint.systemd.j2 similarity index 100% rename from ansible-tendermint/templates/tendermint.systemd.j2 rename to ansible/roles/tendermint/templates/tendermint.systemd.j2 diff --git a/ansible/roles/tendermint/vars/Debian.yml b/ansible/roles/tendermint/vars/Debian.yml new file mode 100644 index 00000000..a87f2b25 --- /dev/null +++ b/ansible/roles/tendermint/vars/Debian.yml @@ -0,0 +1,2 @@ +--- +#Placeholder diff --git a/ansible/roles/tendermint/vars/RedHat.yml b/ansible/roles/tendermint/vars/RedHat.yml new file mode 100644 index 00000000..a87f2b25 --- /dev/null +++ b/ansible/roles/tendermint/vars/RedHat.yml @@ -0,0 +1,2 @@ +--- +#Placeholder diff --git a/create-digitalocean-testnet.sh b/create-digitalocean-testnet.sh new file mode 100755 index 00000000..93047031 --- /dev/null +++ b/create-digitalocean-testnet.sh @@ -0,0 +1,28 @@ +#!/bin/bash +# This is an example set of commands that uses Terraform and Ansible to create a testnet on Digital Ocean. + +# Prerequisites: terraform, ansible, DigitalOcean API token, ssh-agent running with the same SSH keys added that are set up during terraform + +#export DO_API_TOKEN="" + +TF_VAR_TESTNET_NAME="$1" + +if [ -z "$TF_VAR_TESTNET_NAME" ]; then + echo "Usage: $0 " + echo "or" + echo "export TF_VAR_TESTNET_NAME= ; $0" + exit +fi + +cd terraforce +terraform init +terraform env new "$TF_VAR_TESTNET_NAME" +terraform apply -var servers=4 -var DO_API_TOKEN="$DO_API_TOKEN" +cd .. + +#Note that SSH Agent needs to be running with SSH keys added or ansible-playbook requires the --private-key option. +cd ansible +python -u inventory/digital_ocean.py --refresh-cache 1> /dev/null +ansible-playbook -i inventory/digital_ocean.py install.yml +cd .. + diff --git a/terraforce/README.md b/terraforce/README.md index a91e21aa..298b0c66 100644 --- a/terraforce/README.md +++ b/terraforce/README.md @@ -1,149 +1,50 @@ -# Stack +# Terraform for Digital Ocean -This is a stripped down version of https://github.com/segmentio/stack -plus some shell scripts. +This is a generic [Terraform](https://www.terraform.io/) configuration that sets up DigitalOcean droplets. -It is responsible for the following: +# Prerequisites - - spin up a cluster of nodes - - copy config files for a tendermint testnet to each node - - copy linux binaries for tendermint and the app to each node - - start tendermint on every node - -# How it Works - -To use, a user must only provide a directory containing two files: `bins` and `run.sh`. - -The `bins` file is a list of binaries, for instance: +* Install [HashiCorp Terraform](https://www.terraform.io) on a linux machine. +* Create a [DigitalOcean API token](https://cloud.digitalocean.com/settings/api/tokens) with read and write capability. +* Set an SSH key at the [DigitalOcean security page](https://cloud.digitalocean.com/settings/security). +* Find out your SSH key ID at DigitalOcean by querying the below command on your linux box: ``` -$GOPATH/bin/tendermint -$GOPATH/bin/dummy +DO_API_TOKEN="" +curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $DO_API_TOKEN" "https://api.digitalocean.com/v2/account/keys" ``` -and the `run.sh` specifies how those binaries ought to be started: +# How to run +## Initialization +If this is your first time using terraform, you have to initialize it by running the below command. (Note: initialization can be run multiple times) ``` -#! /bin/bash - -if [[ "$SEEDS" != "" ]]; then - SEEDS_FLAG="--seeds=$SEEDS" -fi - -./dummy --persist .tendermint/data/dummy_data >> app.log 2>&1 & -./tendermint node --log_level=info $SEEDS_FLAG >> tendermint.log 2>&1 & +terraform init ``` -This let's you specify exactly which versions of Tendermint and the application are to be used, -and how they ought to be started. - -Note that these binaries *MUST* be compiled for Linux. -If you are not on Linux, you can compile binaries for linux using `go build` with the `GOOS` variable: +After initialization it's good measure to create a new Terraform environment for the droplets so they are always managed together. ``` -GOOS=linux go build -o $GOPATH/bin/tendermint-linux $GOPATH/src/github.com/tendermint/tendermint/cmd/tendermint +TESTNET_NAME="testnet-servers" +terraform env new "$TESTNET_NAME" + +## Execution + +The below command will create 4 nodes in DigitalOcean. They will be named `testnet-servers-node0` to `testnet-servers-node3` and they will be tagged as `testnet-servers`. +``` +DO_API_TOKEN="" +terraform apply -var TESTNET_NAME="testnet-servers" -var servers=4 -var DO_API_TOKEN="$DO_API_TOKEN" ``` -This cross-compilation must be done for each binary you want to copy over. - -If you want to use an application that requires more than just a few binaries, you may need to do more manual work, -for instance using `terraforce` to set up the development environment on every machine. - -# Dependencies - -We use `terraform` for spinning up the machines, -and a custom rolled tool, `terraforce`, -for running commands on many machines in parallel. -You can download terraform here: https://www.terraform.io/downloads.html -To download terraforce, run `go get github.com/ebuchman/terraforce` - -We use `tendermint` itself to generate files for a testnet. -You can install `tendermint` with +Alternatively you can use the default settings. The number of default servers is 7 and the testnet name is `tf-testnet1`. Variables can also be defined as environment variables instead of the command-line. Environment variables that start with `TF_VAR_` will be translated into the Terraform configuration. For example the number of servers can be overriden by setting the `TF_VAR_servers` variable. ``` -cd $GOPATH/src/github.com/tendermint/tendermint -glide install -go install ./cmd/tendermint +TF_VAR_DO_API_TOKEN="" +terraform-apply ``` -You also need to set the `DIGITALOCEAN_TOKEN` environment variables so that terraform can -spin up nodes on digital ocean. +# What's next -This stack is currently some terraform and a bunch of shell scripts, -so its helpful to work out of a directory containing everything. -Either change directory to `$GOPATH/src/github.com/tendermint/tendermint/test/net` -or make a copy of that directory and change to it. All commands are expected to be executed from there. +After setting up the nodes, head over to the [ansible folder](https://github.com/tendermint/tools) to set up tendermint and basecoin. -For terraform to work, you must first run `terraform get` -# Create - -To create a cluster with 4 nodes, run - -``` -terraform apply -``` - -To use a different number of nodes, change the `desired_capacity` parameter in the `main.tf`. - -Note that terraform keeps track of the current state of your infrastructure, -so if you change the `desired_capacity` and run `terraform apply` again, it will add or remove nodes as necessary. - -If you think that's amazing, so do we. - -To get some info about the cluster, run `terraform output`. - -See the [terraform docs](https://www.terraform.io/docs/index.html) for more details. - -To tear down the cluster, run `terraform destroy`. - -# Initialize - -Now that we have a cluster up and running, let's generate the necessary files for a Tendermint node and copy them over. -A Tendermint node needs, at the least, a `priv_validator.json` and a `genesis.json`. -To generate files for the nodes, run - -``` -tendermint testnet 4 mytestnet -``` - -This will create the directory `mytestnet`, containing one directory for each of the 4 nodes. -Each node directory contains a unique `priv_validator.json` and a `genesis.json`, -where the `genesis.json` contains the public keys of all `priv_validator.json` files. - -If you want to add more files to each node for your particular app, you'll have to add them to each of the node directories. - -Now we can copy everything over to the cluster. -If you are on Linux, run - -``` -bash scripts/init.sh 4 mytestnet examples/in-proc -``` - -Otherwise (if you are not on Linux), make sure you ran - -``` -GOOS=linux go build -o $GOPATH/bin/tendermint-linux $GOPATH/src/github.com/tendermint/tendermint/cmd/tendermint -``` - -and now run - -``` -bash scripts/init.sh 4 mytestnet examples/in-proc-linux -``` - -# Start - -Finally, to start Tendermint on all the nodes, run - -``` -bash scripts/start.sh 4 -``` - -# Check - -Query the status of all your nodes: - -``` -bash scripts/query.sh 4 status -``` diff --git a/terraforce/cluster/main.tf b/terraforce/cluster/main.tf index 99435a03..43166e7d 100644 --- a/terraforce/cluster/main.tf +++ b/terraforce/cluster/main.tf @@ -1,77 +1,25 @@ -/** - * Cluster on DO - * - */ - -variable "name" { - description = "The cluster name, e.g cdn" +resource "digitalocean_tag" "cluster" { + name = "${var.name}" } -variable "environment" { - description = "Environment tag, e.g prod" -} - -variable "image_id" { - description = "Image ID" -} - -variable "regions" { - description = "Regions to launch in" - type = "list" -} - -variable "key_ids" { - description = "SSH keys to use" - type = "list" -} - -variable "instance_size" { - description = "The instance size to use, e.g 2gb" -} - -variable "desired_capacity" { - description = "Desired instance count" - default = 3 -} - -#----------------------- -# Instances - resource "digitalocean_droplet" "cluster" { # set the image and instance type - name = "${var.name}${count.index}" + name = "${var.name}-node${count.index}" image = "${var.image_id}" size = "${var.instance_size}" - # the `element` function handles modulo region = "${element(var.regions, count.index)}" - ssh_keys = "${var.key_ids}" + count = "${var.servers}" + tags = ["${digitalocean_tag.cluster.id}"] - count = "${var.desired_capacity}" lifecycle = { prevent_destroy = false } + + connection { + timeout = "30s" + } + } -#----------------------- - -// The cluster name, e.g cdn -output "name" { - value = "${var.name}" -} - -// The list of cluster instance ids -output "instances" { - value = ["${digitalocean_droplet.cluster.*.id}"] -} - -// The list of cluster instance ips -output "private_ips" { - value = ["${digitalocean_droplet.cluster.*.ipv4_address_private}"] -} - -// The list of cluster instance ips -output "public_ips" { - value = ["${digitalocean_droplet.cluster.*.ipv4_address}"] -} diff --git a/terraforce/cluster/outputs.tf b/terraforce/cluster/outputs.tf new file mode 100644 index 00000000..59ecb9fb --- /dev/null +++ b/terraforce/cluster/outputs.tf @@ -0,0 +1,19 @@ +// The cluster name, e.g cdn +output "name" { + value = "${var.name}" +} + +// The list of cluster instance ids +output "instances" { + value = ["${digitalocean_droplet.cluster.*.id}"] +} + +// The list of cluster instance ips +output "private_ips" { + value = ["${digitalocean_droplet.cluster.*.ipv4_address_private}"] +} + +// The list of cluster instance ips +output "public_ips" { + value = ["${digitalocean_droplet.cluster.*.ipv4_address}"] +} diff --git a/terraforce/cluster/variables.tf b/terraforce/cluster/variables.tf new file mode 100644 index 00000000..fd76fd36 --- /dev/null +++ b/terraforce/cluster/variables.tf @@ -0,0 +1,30 @@ +variable "name" { + description = "The cluster name, e.g cdn" +} + +variable "image_id" { + description = "Image ID" + default = "ubuntu-14-04-x64" +} + +variable "regions" { + description = "Regions to launch in" + type = "list" + default = ["AMS2", "FRA1", "LON1", "NYC2", "SFO2", "SGP1", "TOR1"] +} + +variable "key_ids" { + description = "SSH keys to use on the nodes" + type = "list" +} + +variable "instance_size" { + description = "The instance size to use" + default = "2gb" +} + +variable "servers" { + description = "Desired instance count" + default = 4 +} + diff --git a/terraforce/examples/dummy/bins b/terraforce/examples/dummy/bins deleted file mode 100644 index 0890780d..00000000 --- a/terraforce/examples/dummy/bins +++ /dev/null @@ -1,2 +0,0 @@ -$GOPATH/bin/tendermint -$GOPATH/bin/dummy diff --git a/terraforce/examples/dummy/run.sh b/terraforce/examples/dummy/run.sh deleted file mode 100644 index 469b260c..00000000 --- a/terraforce/examples/dummy/run.sh +++ /dev/null @@ -1,8 +0,0 @@ -#! /bin/bash - -if [[ "$SEEDS" != "" ]]; then - SEEDS_FLAG="--seeds=$SEEDS" -fi - -./dummy --persist .tendermint/data/dummy_data >> app.log 2>&1 & -./tendermint node --log_level=info $SEEDS_FLAG >> tendermint.log 2>&1 & diff --git a/terraforce/examples/in-proc-linux/bins b/terraforce/examples/in-proc-linux/bins deleted file mode 100644 index fa0c1052..00000000 --- a/terraforce/examples/in-proc-linux/bins +++ /dev/null @@ -1 +0,0 @@ -$GOPATH/bin/tendermint-linux diff --git a/terraforce/examples/in-proc-linux/run.sh b/terraforce/examples/in-proc-linux/run.sh deleted file mode 100644 index ff233950..00000000 --- a/terraforce/examples/in-proc-linux/run.sh +++ /dev/null @@ -1,7 +0,0 @@ -#! /bin/bash - -if [[ "$SEEDS" != "" ]]; then - SEEDS_FLAG="--seeds=$SEEDS" -fi - -./tendermint-linux node --proxy_app=dummy --log_level=note $SEEDS_FLAG >> tendermint.log 2>&1 & diff --git a/terraforce/examples/in-proc/bins b/terraforce/examples/in-proc/bins deleted file mode 100644 index f48f5e35..00000000 --- a/terraforce/examples/in-proc/bins +++ /dev/null @@ -1 +0,0 @@ -$GOPATH/bin/tendermint diff --git a/terraforce/examples/in-proc/run.sh b/terraforce/examples/in-proc/run.sh deleted file mode 100644 index 0627439b..00000000 --- a/terraforce/examples/in-proc/run.sh +++ /dev/null @@ -1,7 +0,0 @@ -#! /bin/bash - -if [[ "$SEEDS" != "" ]]; then - SEEDS_FLAG="--seeds=$SEEDS" -fi - -./tendermint node --proxy_app=dummy --log_level=note $SEEDS_FLAG >> tendermint.log 2>&1 & diff --git a/terraforce/main.tf b/terraforce/main.tf index f03a0be5..d83d10e6 100644 --- a/terraforce/main.tf +++ b/terraforce/main.tf @@ -1,22 +1,38 @@ -module "cluster" { - source = "./cluster" - environment = "test" - name = "tendermint-testnet" +#DigitalOcean Terraform Configuration - # curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" "https://api.digitalocean.com/v2/account/keys" - key_ids = [8163311] - - image_id = "ubuntu-14-04-x64" - desired_capacity = 4 - instance_size = "2gb" - - regions = ["AMS2", "FRA1", "LON1", "NYC2", "SFO2", "SGP1", "TOR1"] +variable "DO_API_TOKEN" { + description = "DigitalOcean Access Token" } +variable "TESTNET_NAME" { + description = "Name of the cluster/testnet" + default = "tf-testnet1" +} + +variable "ssh_keys" { + description = "SSH keys provided in DigitalOcean to be used on the nodes" + # curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" "https://api.digitalocean.com/v2/account/keys" + default = ["9495227"] +} + +variable "servers" { + description = "Number of nodes in cluster" + default = "4" +} provider "digitalocean" { + token = "${var.DO_API_TOKEN}" } + +module "cluster" { + source = "./cluster" + name = "${var.TESTNET_NAME}" + key_ids = "${var.ssh_keys}" + servers = "${var.servers}" +} + + output "public_ips" { value = "${module.cluster.public_ips}" } @@ -32,3 +48,4 @@ output "seeds" { output "rpcs" { value = "${join(":46657,",module.cluster.public_ips)}:46657" } + diff --git a/terraforce/test.sh b/terraforce/test.sh deleted file mode 100644 index d69dc918..00000000 --- a/terraforce/test.sh +++ /dev/null @@ -1,30 +0,0 @@ -#! /bin/bash - -cd $GOPATH/src/github.com/tendermint/tendermint - -TEST_PATH=./test/net/new - -N=4 -TESTNET_DIR=mytestnet - -# install deps -# TODO: we should build a Docker image and -# really do everything that follows in the container -# bash setup.sh - - -# launch infra -terraform get -terraform apply - -# create testnet files -tendermint testnet -n $N -dir $TESTNET_DIR - -# expects a linux tendermint binary to be built already -bash scripts/init.sh $N $TESTNET_DIR test/net/examples/in-proc - -# testnet should now be running :) -bash scripts/start.sh 4 - - - From 4e16ee6d78ba4a2d456a2d5bf48365a808b1acf2 Mon Sep 17 00:00:00 2001 From: Greg Szabo Date: Wed, 31 May 2017 19:58:55 -0400 Subject: [PATCH 2/7] Refactored Ansible, added tendermint and basecoin configuration and multiple playbooks --- ansible/README.md | 104 +- ansible/config.yml | 7 + ansible/group_vars/all | 45 + ansible/install.yml | 10 +- ansible/inventory/ec2.ini | 209 +++ ansible/inventory/ec2.py | 1595 +++++++++++++++++ ansible/reinit.yml | 8 + ansible/reset.yml | 9 + ansible/restart.yml | 7 + ansible/roles/basecoin/tasks/start.yml | 26 - ansible/roles/cleanupconfig/defaults/main.yml | 6 + .../roles/cleanupconfig/tasks/basecoin.yml | 5 + ansible/roles/cleanupconfig/tasks/main.yml | 9 + .../roles/cleanupconfig/tasks/tendermint.yml | 5 + ansible/roles/config/defaults/main.yml | 12 + ansible/roles/config/tasks/basecoin.yml | 43 + ansible/roles/config/tasks/main.yml | 9 + ansible/roles/config/tasks/tendermint.yml | 38 + ansible/roles/config/templates/config.toml.j2 | 16 + .../config/templates/genesis-basecoin.json.j2 | 32 + .../templates/genesis-tendermint.json.j2 | 32 + .../ansible.cfg | 0 .../defaults/main.yml | 9 +- ansible/roles/install-basecoin/files/key.json | 11 + .../roles/install-basecoin/files/key2.json | 11 + .../handlers/main.yml | 0 .../tasks/install.yml | 27 +- .../tasks/main.yml | 2 +- .../templates/basecoin.conf.j2 | 2 +- .../templates/basecoin.systemd.j2 | 8 +- .../vars/Debian.yml | 0 .../vars/RedHat.yml | 0 .../defaults/main.yml | 7 +- .../handlers/main.yml | 0 .../tasks/install.yml | 17 +- .../tasks/main.yml | 3 +- .../templates/tendermint.conf.j2 | 2 +- .../templates/tendermint.systemd.j2 | 4 +- .../vars/Debian.yml | 0 .../vars/RedHat.yml | 0 ansible/roles/start/defaults/main.yml | 3 + ansible/roles/start/tasks/main.yml | 9 + ansible/roles/stop/defaults/main.yml | 3 + ansible/roles/stop/tasks/main.yml | 9 + ansible/roles/tendermint/tasks/genesis.yml | 19 - ansible/roles/tendermint/tasks/start.yml | 26 - .../tendermint/templates/genesis.json.j2 | 16 - ansible/start.yml | 7 + ansible/stop.yml | 7 + create-digitalocean-testnet.sh | 39 +- terraforce/scripts/copy_run.sh | 10 - terraforce/scripts/init.sh | 43 - terraforce/scripts/query.sh | 11 - terraforce/scripts/reset.sh | 10 - terraforce/scripts/restart.sh | 9 - terraforce/scripts/start.sh | 10 - terraforce/scripts/stop.sh | 9 - terraform-aws/README.md | 4 + .../README.md | 0 .../cluster/main.tf | 0 .../cluster/outputs.tf | 0 .../cluster/variables.tf | 0 .../main.tf | 2 +- {terraforce/transact => transact}/transact.go | 0 64 files changed, 2305 insertions(+), 271 deletions(-) create mode 100644 ansible/config.yml create mode 100644 ansible/group_vars/all create mode 100644 ansible/inventory/ec2.ini create mode 100644 ansible/inventory/ec2.py create mode 100644 ansible/reinit.yml create mode 100644 ansible/reset.yml create mode 100644 ansible/restart.yml delete mode 100644 ansible/roles/basecoin/tasks/start.yml create mode 100644 ansible/roles/cleanupconfig/defaults/main.yml create mode 100644 ansible/roles/cleanupconfig/tasks/basecoin.yml create mode 100644 ansible/roles/cleanupconfig/tasks/main.yml create mode 100644 ansible/roles/cleanupconfig/tasks/tendermint.yml create mode 100644 ansible/roles/config/defaults/main.yml create mode 100644 ansible/roles/config/tasks/basecoin.yml create mode 100644 ansible/roles/config/tasks/main.yml create mode 100644 ansible/roles/config/tasks/tendermint.yml create mode 100644 ansible/roles/config/templates/config.toml.j2 create mode 100644 ansible/roles/config/templates/genesis-basecoin.json.j2 create mode 100644 ansible/roles/config/templates/genesis-tendermint.json.j2 rename ansible/roles/{basecoin => install-basecoin}/ansible.cfg (100%) rename ansible/roles/{basecoin => install-basecoin}/defaults/main.yml (74%) create mode 100644 ansible/roles/install-basecoin/files/key.json create mode 100644 ansible/roles/install-basecoin/files/key2.json rename ansible/roles/{basecoin => install-basecoin}/handlers/main.yml (100%) rename ansible/roles/{basecoin => install-basecoin}/tasks/install.yml (81%) rename ansible/roles/{basecoin => install-basecoin}/tasks/main.yml (91%) rename ansible/roles/{basecoin => install-basecoin}/templates/basecoin.conf.j2 (58%) rename ansible/roles/{basecoin => install-basecoin}/templates/basecoin.systemd.j2 (53%) rename ansible/roles/{basecoin => install-basecoin}/vars/Debian.yml (100%) rename ansible/roles/{basecoin => install-basecoin}/vars/RedHat.yml (100%) rename ansible/roles/{tendermint => install-tendermint}/defaults/main.yml (74%) rename ansible/roles/{tendermint => install-tendermint}/handlers/main.yml (100%) rename ansible/roles/{tendermint => install-tendermint}/tasks/install.yml (85%) rename ansible/roles/{tendermint => install-tendermint}/tasks/main.yml (83%) rename ansible/roles/{tendermint => install-tendermint}/templates/tendermint.conf.j2 (62%) rename ansible/roles/{tendermint => install-tendermint}/templates/tendermint.systemd.j2 (71%) rename ansible/roles/{tendermint => install-tendermint}/vars/Debian.yml (100%) rename ansible/roles/{tendermint => install-tendermint}/vars/RedHat.yml (100%) create mode 100644 ansible/roles/start/defaults/main.yml create mode 100644 ansible/roles/start/tasks/main.yml create mode 100644 ansible/roles/stop/defaults/main.yml create mode 100644 ansible/roles/stop/tasks/main.yml delete mode 100644 ansible/roles/tendermint/tasks/genesis.yml delete mode 100644 ansible/roles/tendermint/tasks/start.yml delete mode 100644 ansible/roles/tendermint/templates/genesis.json.j2 create mode 100644 ansible/start.yml create mode 100644 ansible/stop.yml delete mode 100644 terraforce/scripts/copy_run.sh delete mode 100644 terraforce/scripts/init.sh delete mode 100644 terraforce/scripts/query.sh delete mode 100644 terraforce/scripts/reset.sh delete mode 100644 terraforce/scripts/restart.sh delete mode 100644 terraforce/scripts/start.sh delete mode 100644 terraforce/scripts/stop.sh create mode 100644 terraform-aws/README.md rename {terraforce => terraform-digitalocean}/README.md (100%) rename {terraforce => terraform-digitalocean}/cluster/main.tf (100%) rename {terraforce => terraform-digitalocean}/cluster/outputs.tf (100%) rename {terraforce => terraform-digitalocean}/cluster/variables.tf (100%) rename {terraforce => terraform-digitalocean}/main.tf (96%) rename {terraforce/transact => transact}/transact.go (100%) diff --git a/ansible/README.md b/ansible/README.md index 2ef5a7a9..0ce68cad 100644 --- a/ansible/README.md +++ b/ansible/README.md @@ -1,4 +1,4 @@ -# Ansible playbook for Tendermint on DigitalOcean +# Ansible playbook for Tendermint ![Ansible plus Tendermint](img/a_plus_t.png) @@ -7,42 +7,39 @@ * [Running the playbook](#Running the playbook) * [Example playbook that configures a Tendermint on Ubuntu](#example-playbook-that-configures-a-tendermint-on-ubuntu) -The playbook in this folder contains [ansible](http://www.ansible.com/) roles which: +The playbooks in this folder run [ansible](http://www.ansible.com/) roles which: -* installs tendermint -* configures tendermint -* configures tendermint service -* installs basecoin -* configures basecoin +* install and configure tendermint +* install and configure basecoin +* start/stop tendermint and basecoin ## Prerequisites * Ansible 2.0 or higher -* DigitalOcean API Token * SSH key to the servers + +Optional for DigitalOcean droplets: +* DigitalOcean API Token * python dopy package Head over to the [Terraform folder](https://github.com/tendermint/tools) for a description on how to get a DigitalOcean API Token. -The DigitalOcean inventory script comes from the ansible team at https://github.com/ansible/ansible. You can get the latest version from the contrib/inventory folder. +Optional for Amazon AWS instances: +* Amazon AWS API access key ID and secret access key. + +The cloud inventory scripts come from the ansible team at https://github.com/ansible/ansible. You can get the latest version from the contrib/inventory folder. ## Ansible setup -Ansible requires a "command machine" or "local machine" or "orchestrator machine" to run on. This can be your laptop or any machine that runs linux. (It does not have to be part of the DigitalOcean network.) +Ansible requires a "command machine" or "local machine" or "orchestrator machine" to run on. This can be your laptop or any machine that runs linux. (It does not have to be part of the cloud network that hosts your servers.) + +Note: The below commands use the Ubuntu/Debian `apt-get` command. To make it compatible with RedHat/CentOS, replace it with `yum`. -Example on RedHat/CentOS: ``` -sudo yum install ansible python-pip -sudo pip install dopy +sudo apt-get install ansible ``` -Example on Ubuntu/Debian: -``` -sudo apt-get install ansible python-pip -sudo pip install dopy -``` - -To make life easier, you can start an SSH Agent and load your SSH key(s) into it. This way ansible will have an uninterrupted way of connecting to the droplets. +To make life easier, you can start an SSH Agent and load your SSH key(s). This way ansible will have an uninterrupted way of connecting to tour servers. ``` ssh-agent > ~/.ssh/ssh.env @@ -53,6 +50,21 @@ ssh-add private.key Subsequently, as long as the agent is running, you can use `source ~/.ssh/ssh.env` to load the keys to the current session. +### Optional cloud dependencies + +If you are using a cloud provider to host your servers, you need the below dependencies installed on your local machine. + +DigitalOcean inventory dependencies: +``` +sudo apt-get install python-pip +sudo pip install dopy +``` + +Amazon AWS inventory dependencies: +``` +sudo apt-get install python-boto +``` + ## Refreshing the DigitalOcean inventory If you just finished creating droplets, the local DigitalOcean inventory cache is not up-to-date. To refresh it, run: @@ -62,23 +74,61 @@ DO_API_TOKEN="" python -u inventory/digital_ocean.py --refresh-cache 1> /dev/null ``` -## Running the playbook +## Refreshing the Amazon AWS inventory -The playbook is locked down to only run if the environment variable `TF_VAR_TESTNET_NAME` is populated. This is a precaution so you don't accidentally run the playbook on all your DigitalOcean droplets. - -The variable `TF_VAR_TESTNET_NAME` contains the testnet name defined when the droplets were created using Terraform. +If you just finished creating Amazon AWS EC2 instances, the local AWS inventory cache is not up-to-date. To refresh it, run: ``` +AWS_ACCESS_KEY_ID='' +AWS_SECRET_ACCESS_KEY='' +python -u inventory/ec2.py --refresh-cache 1> /dev/null +``` + +Note you don't need the access key and secret key set, if you are running ansible on an Amazon AMI instance with the proper IAM permissions set. + +## Running the playbook + +The playbook is locked down to only run if the environment variable `TF_VAR_TESTNET_NAME` is populated. This is a precaution so you don't accidentally run the playbook on all your servers. + +The variable `TF_VAR_TESTNET_NAME` contains the testnet name which ansible translates into an ansible group. If you used Terraform to create the servers, it was the testnet name used there. + +If the playbook cannot connect to the servers because of public key denial, your SSH Agent is not set up properly. Alternatively you can add the SSH key to ansible using the `--private-key` option. + +### DigitalOcean +``` +DO_API_TOKEN="" TF_VAR_TESTNET_NAME="testnet-servers" ansible-playbook -i inventory/digital_ocean.py install.yml ``` -If the playbook cannot connect to the servers because of public key denial, your SSH Agent is not set up properly. Alternatively you can add the SSH key to ansible using the `--private-key` option. +### Amazon AWS +``` +AWS_ACCESS_KEY_ID='' +AWS_SECRET_ACCESS_KEY='' +TF_VAR_TESTNET_NAME="testnet-servers" +ansible-playbook -i inventory/ec2.py install.yml +``` -## Starting the cluster +### Installing custom versions + +By default ansible installs the tendermint and basecoin binary versions defined in its [default variables](#Default variables). If you built your own version of the binaries, you can tell ansible to install that instead. + +``` +GOPATH="" +go get -u github.com/tendermint/tendermint/cmd/tendermint +go get -u github.com/tendermint/basecoin/cmd/basecoin + +DO_API_TOKEN="" +TF_VAR_TESTNET_NAME="testnet-servers" +ansible-playbook -i inventory/digital_ocean.py install.yml -e tendermint_release_install=false -e basecoin_release_install=false +``` + +## Starting the servers To be continued... -## Role details +## Default variables + To be continued... + diff --git a/ansible/config.yml b/ansible/config.yml new file mode 100644 index 00000000..53376c91 --- /dev/null +++ b/ansible/config.yml @@ -0,0 +1,7 @@ +--- + +- hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" + user: root + roles: + - { role: config, testnet_name: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" } + diff --git a/ansible/group_vars/all b/ansible/group_vars/all new file mode 100644 index 00000000..6fdc88ed --- /dev/null +++ b/ansible/group_vars/all @@ -0,0 +1,45 @@ +--- +#tendermint_release_install: true +#tendermint_version: 0.10.0-rc1 +#tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/tendermint/v{{tendermint_version}}/tendermint_{{tendermint_version}}_linux_amd64.zip" + +##If tendermint_release_install == false, copy the binary from here +#tendermint_binary: "{{ lookup('env','GOPATH') | default('') }}/bin/tendermint" + +#tendermint_user: tendermint +#tendermint_group: tendermint + +## Upstart start/stop conditions can vary by distribution and environment +#tendermint_upstart_start_on: start on runlevel [345] +#tendermint_upstart_stop_on: stop on runlevel [!345] + +#tendermint_home: /var/lib/tendermint +#tendermint_log_file: /var/log/tendermint.log + +#basecoin_release_install: true +#basecoin_version: 0.4.0 +#basecoin_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/basecoin/v{{basecoin_version}}/basecoin_{{basecoin_version}}_linux_amd64.zip" + +##If basecoin_release_install == false, copy the binary from here +#basecoin_binary: "{{ lookup('env','GOPATH') | default('') }}/bin/basecoin" + +#basecoin_user: basecoin +#basecoin_group: basecoin + +## Upstart start/stop conditions can vary by distribution and environment +#basecoin_upstart_start_on: start on runlevel [345] +#basecoin_upstart_stop_on: stop on runlevel [!345] + +#basecoin_home: /var/lib/basecoin +#basecoin_log_file: /var/log/basecoin.log + +#basecoin_inprocess: false + +#Used by the config role +#testnet_name: test-chain + + +basecoin_inprocess: false +tendermint_release_install: false +basecoin_release_install: false + diff --git a/ansible/install.yml b/ansible/install.yml index ccd82330..bc5d15a7 100644 --- a/ansible/install.yml +++ b/ansible/install.yml @@ -1,9 +1,11 @@ --- - hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" - vars: - testnet_name: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" user: root roles: - - tendermint - - basecoin + - install-tendermint + - install-basecoin + - cleanupconfig + - { role: config, testnet_name: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" } + - start + diff --git a/ansible/inventory/ec2.ini b/ansible/inventory/ec2.ini new file mode 100644 index 00000000..e11a69cc --- /dev/null +++ b/ansible/inventory/ec2.ini @@ -0,0 +1,209 @@ +# Ansible EC2 external inventory script settings +# + +[ec2] + +# to talk to a private eucalyptus instance uncomment these lines +# and edit edit eucalyptus_host to be the host name of your cloud controller +#eucalyptus = True +#eucalyptus_host = clc.cloud.domain.org + +# AWS regions to make calls to. Set this to 'all' to make request to all regions +# in AWS and merge the results together. Alternatively, set this to a comma +# separated list of regions. E.g. 'us-east-1,us-west-1,us-west-2' and do not +# provide the 'regions_exclude' option. If this is set to 'auto', AWS_REGION or +# AWS_DEFAULT_REGION environment variable will be read to determine the region. +regions = all +regions_exclude = us-gov-west-1, cn-north-1 + +# When generating inventory, Ansible needs to know how to address a server. +# Each EC2 instance has a lot of variables associated with it. Here is the list: +# http://docs.pythonboto.org/en/latest/ref/ec2.html#module-boto.ec2.instance +# Below are 2 variables that are used as the address of a server: +# - destination_variable +# - vpc_destination_variable + +# This is the normal destination variable to use. If you are running Ansible +# from outside EC2, then 'public_dns_name' makes the most sense. If you are +# running Ansible from within EC2, then perhaps you want to use the internal +# address, and should set this to 'private_dns_name'. The key of an EC2 tag +# may optionally be used; however the boto instance variables hold precedence +# in the event of a collision. +destination_variable = public_dns_name + +# This allows you to override the inventory_name with an ec2 variable, instead +# of using the destination_variable above. Addressing (aka ansible_ssh_host) +# will still use destination_variable. Tags should be written as 'tag_TAGNAME'. +#hostname_variable = tag_Name + +# For server inside a VPC, using DNS names may not make sense. When an instance +# has 'subnet_id' set, this variable is used. If the subnet is public, setting +# this to 'ip_address' will return the public IP address. For instances in a +# private subnet, this should be set to 'private_ip_address', and Ansible must +# be run from within EC2. The key of an EC2 tag may optionally be used; however +# the boto instance variables hold precedence in the event of a collision. +# WARNING: - instances that are in the private vpc, _without_ public ip address +# will not be listed in the inventory until You set: +# vpc_destination_variable = private_ip_address +vpc_destination_variable = ip_address + +# The following two settings allow flexible ansible host naming based on a +# python format string and a comma-separated list of ec2 tags. Note that: +# +# 1) If the tags referenced are not present for some instances, empty strings +# will be substituted in the format string. +# 2) This overrides both destination_variable and vpc_destination_variable. +# +#destination_format = {0}.{1}.example.com +#destination_format_tags = Name,environment + +# To tag instances on EC2 with the resource records that point to them from +# Route53, set 'route53' to True. +route53 = False + +# To use Route53 records as the inventory hostnames, uncomment and set +# to equal the domain name you wish to use. You must also have 'route53' (above) +# set to True. +# route53_hostnames = .example.com + +# To exclude RDS instances from the inventory, uncomment and set to False. +#rds = False + +# To exclude ElastiCache instances from the inventory, uncomment and set to False. +#elasticache = False + +# Additionally, you can specify the list of zones to exclude looking up in +# 'route53_excluded_zones' as a comma-separated list. +# route53_excluded_zones = samplezone1.com, samplezone2.com + +# By default, only EC2 instances in the 'running' state are returned. Set +# 'all_instances' to True to return all instances regardless of state. +all_instances = False + +# By default, only EC2 instances in the 'running' state are returned. Specify +# EC2 instance states to return as a comma-separated list. This +# option is overridden when 'all_instances' is True. +# instance_states = pending, running, shutting-down, terminated, stopping, stopped + +# By default, only RDS instances in the 'available' state are returned. Set +# 'all_rds_instances' to True return all RDS instances regardless of state. +all_rds_instances = False + +# Include RDS cluster information (Aurora etc.) +include_rds_clusters = False + +# By default, only ElastiCache clusters and nodes in the 'available' state +# are returned. Set 'all_elasticache_clusters' and/or 'all_elastic_nodes' +# to True return all ElastiCache clusters and nodes, regardless of state. +# +# Note that all_elasticache_nodes only applies to listed clusters. That means +# if you set all_elastic_clusters to false, no node will be return from +# unavailable clusters, regardless of the state and to what you set for +# all_elasticache_nodes. +all_elasticache_replication_groups = False +all_elasticache_clusters = False +all_elasticache_nodes = False + +# API calls to EC2 are slow. For this reason, we cache the results of an API +# call. Set this to the path you want cache files to be written to. Two files +# will be written to this directory: +# - ansible-ec2.cache +# - ansible-ec2.index +cache_path = ~/.ansible/tmp + +# The number of seconds a cache file is considered valid. After this many +# seconds, a new API call will be made, and the cache file will be updated. +# To disable the cache, set this value to 0 +cache_max_age = 300 + +# Organize groups into a nested/hierarchy instead of a flat namespace. +nested_groups = False + +# Replace - tags when creating groups to avoid issues with ansible +replace_dash_in_groups = True + +# If set to true, any tag of the form "a,b,c" is expanded into a list +# and the results are used to create additional tag_* inventory groups. +expand_csv_tags = False + +# The EC2 inventory output can become very large. To manage its size, +# configure which groups should be created. +group_by_instance_id = True +group_by_region = True +group_by_availability_zone = True +group_by_aws_account = False +group_by_ami_id = True +group_by_instance_type = True +group_by_instance_state = False +group_by_key_pair = True +group_by_vpc_id = True +group_by_security_group = True +group_by_tag_keys = True +group_by_tag_none = True +group_by_route53_names = True +group_by_rds_engine = True +group_by_rds_parameter_group = True +group_by_elasticache_engine = True +group_by_elasticache_cluster = True +group_by_elasticache_parameter_group = True +group_by_elasticache_replication_group = True + +# If you only want to include hosts that match a certain regular expression +# pattern_include = staging-* + +# If you want to exclude any hosts that match a certain regular expression +# pattern_exclude = staging-* + +# Instance filters can be used to control which instances are retrieved for +# inventory. For the full list of possible filters, please read the EC2 API +# docs: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeInstances.html#query-DescribeInstances-filters +# Filters are key/value pairs separated by '=', to list multiple filters use +# a list separated by commas. See examples below. + +# If you want to apply multiple filters simultaneously, set stack_filters to +# True. Default behaviour is to combine the results of all filters. Stacking +# allows the use of multiple conditions to filter down, for example by +# environment and type of host. +stack_filters = False + +# Retrieve only instances with (key=value) env=staging tag +# instance_filters = tag:env=staging + +# Retrieve only instances with role=webservers OR role=dbservers tag +# instance_filters = tag:role=webservers,tag:role=dbservers + +# Retrieve only t1.micro instances OR instances with tag env=staging +# instance_filters = instance-type=t1.micro,tag:env=staging + +# You can use wildcards in filter values also. Below will list instances which +# tag Name value matches webservers1* +# (ex. webservers15, webservers1a, webservers123 etc) +# instance_filters = tag:Name=webservers1* + +# An IAM role can be assumed, so all requests are run as that role. +# This can be useful for connecting across different accounts, or to limit user +# access +# iam_role = role-arn + +# A boto configuration profile may be used to separate out credentials +# see http://boto.readthedocs.org/en/latest/boto_config_tut.html +# boto_profile = some-boto-profile-name + + +[credentials] + +# The AWS credentials can optionally be specified here. Credentials specified +# here are ignored if the environment variable AWS_ACCESS_KEY_ID or +# AWS_PROFILE is set, or if the boto_profile property above is set. +# +# Supplying AWS credentials here is not recommended, as it introduces +# non-trivial security concerns. When going down this route, please make sure +# to set access permissions for this file correctly, e.g. handle it the same +# way as you would a private SSH key. +# +# Unlike the boto and AWS configure files, this section does not support +# profiles. +# +# aws_access_key_id = AXXXXXXXXXXXXXX +# aws_secret_access_key = XXXXXXXXXXXXXXXXXXX +# aws_security_token = XXXXXXXXXXXXXXXXXXXXXXXXXXXX diff --git a/ansible/inventory/ec2.py b/ansible/inventory/ec2.py new file mode 100644 index 00000000..9614c5fe --- /dev/null +++ b/ansible/inventory/ec2.py @@ -0,0 +1,1595 @@ +#!/usr/bin/env python + +''' +EC2 external inventory script +================================= + +Generates inventory that Ansible can understand by making API request to +AWS EC2 using the Boto library. + +NOTE: This script assumes Ansible is being executed where the environment +variables needed for Boto have already been set: + export AWS_ACCESS_KEY_ID='AK123' + export AWS_SECRET_ACCESS_KEY='abc123' + +optional region environement variable if region is 'auto' + +This script also assumes there is an ec2.ini file alongside it. To specify a +different path to ec2.ini, define the EC2_INI_PATH environment variable: + + export EC2_INI_PATH=/path/to/my_ec2.ini + +If you're using eucalyptus you need to set the above variables and +you need to define: + + export EC2_URL=http://hostname_of_your_cc:port/services/Eucalyptus + +If you're using boto profiles (requires boto>=2.24.0) you can choose a profile +using the --boto-profile command line argument (e.g. ec2.py --boto-profile prod) or using +the AWS_PROFILE variable: + + AWS_PROFILE=prod ansible-playbook -i ec2.py myplaybook.yml + +For more details, see: http://docs.pythonboto.org/en/latest/boto_config_tut.html + +When run against a specific host, this script returns the following variables: + - ec2_ami_launch_index + - ec2_architecture + - ec2_association + - ec2_attachTime + - ec2_attachment + - ec2_attachmentId + - ec2_block_devices + - ec2_client_token + - ec2_deleteOnTermination + - ec2_description + - ec2_deviceIndex + - ec2_dns_name + - ec2_eventsSet + - ec2_group_name + - ec2_hypervisor + - ec2_id + - ec2_image_id + - ec2_instanceState + - ec2_instance_type + - ec2_ipOwnerId + - ec2_ip_address + - ec2_item + - ec2_kernel + - ec2_key_name + - ec2_launch_time + - ec2_monitored + - ec2_monitoring + - ec2_networkInterfaceId + - ec2_ownerId + - ec2_persistent + - ec2_placement + - ec2_platform + - ec2_previous_state + - ec2_private_dns_name + - ec2_private_ip_address + - ec2_publicIp + - ec2_public_dns_name + - ec2_ramdisk + - ec2_reason + - ec2_region + - ec2_requester_id + - ec2_root_device_name + - ec2_root_device_type + - ec2_security_group_ids + - ec2_security_group_names + - ec2_shutdown_state + - ec2_sourceDestCheck + - ec2_spot_instance_request_id + - ec2_state + - ec2_state_code + - ec2_state_reason + - ec2_status + - ec2_subnet_id + - ec2_tenancy + - ec2_virtualization_type + - ec2_vpc_id + +These variables are pulled out of a boto.ec2.instance object. There is a lack of +consistency with variable spellings (camelCase and underscores) since this +just loops through all variables the object exposes. It is preferred to use the +ones with underscores when multiple exist. + +In addition, if an instance has AWS Tags associated with it, each tag is a new +variable named: + - ec2_tag_[Key] = [Value] + +Security groups are comma-separated in 'ec2_security_group_ids' and +'ec2_security_group_names'. +''' + +# (c) 2012, Peter Sankauskas +# +# This file is part of Ansible, +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + +###################################################################### + +import sys +import os +import argparse +import re +from time import time +import boto +from boto import ec2 +from boto import rds +from boto import elasticache +from boto import route53 +from boto import sts +import six + +from ansible.module_utils import ec2 as ec2_utils + +HAS_BOTO3 = False +try: + import boto3 + HAS_BOTO3 = True +except ImportError: + pass + +from six.moves import configparser +from collections import defaultdict + +try: + import json +except ImportError: + import simplejson as json + + +class Ec2Inventory(object): + + def _empty_inventory(self): + return {"_meta": {"hostvars": {}}} + + def __init__(self): + ''' Main execution path ''' + + # Inventory grouped by instance IDs, tags, security groups, regions, + # and availability zones + self.inventory = self._empty_inventory() + + self.aws_account_id = None + + # Index of hostname (address) to instance ID + self.index = {} + + # Boto profile to use (if any) + self.boto_profile = None + + # AWS credentials. + self.credentials = {} + + # Read settings and parse CLI arguments + self.parse_cli_args() + self.read_settings() + + # Make sure that profile_name is not passed at all if not set + # as pre 2.24 boto will fall over otherwise + if self.boto_profile: + if not hasattr(boto.ec2.EC2Connection, 'profile_name'): + self.fail_with_error("boto version must be >= 2.24 to use profile") + + # Cache + if self.args.refresh_cache: + self.do_api_calls_update_cache() + elif not self.is_cache_valid(): + self.do_api_calls_update_cache() + + # Data to print + if self.args.host: + data_to_print = self.get_host_info() + + elif self.args.list: + # Display list of instances for inventory + if self.inventory == self._empty_inventory(): + data_to_print = self.get_inventory_from_cache() + else: + data_to_print = self.json_format_dict(self.inventory, True) + + print(data_to_print) + + def is_cache_valid(self): + ''' Determines if the cache files have expired, or if it is still valid ''' + + if os.path.isfile(self.cache_path_cache): + mod_time = os.path.getmtime(self.cache_path_cache) + current_time = time() + if (mod_time + self.cache_max_age) > current_time: + if os.path.isfile(self.cache_path_index): + return True + + return False + + def read_settings(self): + ''' Reads the settings from the ec2.ini file ''' + + scriptbasename = __file__ + scriptbasename = os.path.basename(scriptbasename) + scriptbasename = scriptbasename.replace('.py', '') + + defaults = { + 'ec2': { + 'ini_path': os.path.join(os.path.dirname(__file__), '%s.ini' % scriptbasename) + } + } + + if six.PY3: + config = configparser.ConfigParser() + else: + config = configparser.SafeConfigParser() + ec2_ini_path = os.environ.get('EC2_INI_PATH', defaults['ec2']['ini_path']) + ec2_ini_path = os.path.expanduser(os.path.expandvars(ec2_ini_path)) + config.read(ec2_ini_path) + + # is eucalyptus? + self.eucalyptus_host = None + self.eucalyptus = False + if config.has_option('ec2', 'eucalyptus'): + self.eucalyptus = config.getboolean('ec2', 'eucalyptus') + if self.eucalyptus and config.has_option('ec2', 'eucalyptus_host'): + self.eucalyptus_host = config.get('ec2', 'eucalyptus_host') + + # Regions + self.regions = [] + configRegions = config.get('ec2', 'regions') + if (configRegions == 'all'): + if self.eucalyptus_host: + self.regions.append(boto.connect_euca(host=self.eucalyptus_host).region.name, **self.credentials) + else: + configRegions_exclude = config.get('ec2', 'regions_exclude') + for regionInfo in ec2.regions(): + if regionInfo.name not in configRegions_exclude: + self.regions.append(regionInfo.name) + else: + self.regions = configRegions.split(",") + if 'auto' in self.regions: + env_region = os.environ.get('AWS_REGION') + if env_region is None: + env_region = os.environ.get('AWS_DEFAULT_REGION') + self.regions = [env_region] + + # Destination addresses + self.destination_variable = config.get('ec2', 'destination_variable') + self.vpc_destination_variable = config.get('ec2', 'vpc_destination_variable') + + if config.has_option('ec2', 'hostname_variable'): + self.hostname_variable = config.get('ec2', 'hostname_variable') + else: + self.hostname_variable = None + + if config.has_option('ec2', 'destination_format') and \ + config.has_option('ec2', 'destination_format_tags'): + self.destination_format = config.get('ec2', 'destination_format') + self.destination_format_tags = config.get('ec2', 'destination_format_tags').split(',') + else: + self.destination_format = None + self.destination_format_tags = None + + # Route53 + self.route53_enabled = config.getboolean('ec2', 'route53') + if config.has_option('ec2', 'route53_hostnames'): + self.route53_hostnames = config.get('ec2', 'route53_hostnames') + else: + self.route53_hostnames = None + self.route53_excluded_zones = [] + if config.has_option('ec2', 'route53_excluded_zones'): + self.route53_excluded_zones.extend( + config.get('ec2', 'route53_excluded_zones', '').split(',')) + + # Include RDS instances? + self.rds_enabled = True + if config.has_option('ec2', 'rds'): + self.rds_enabled = config.getboolean('ec2', 'rds') + + # Include RDS cluster instances? + if config.has_option('ec2', 'include_rds_clusters'): + self.include_rds_clusters = config.getboolean('ec2', 'include_rds_clusters') + else: + self.include_rds_clusters = False + + # Include ElastiCache instances? + self.elasticache_enabled = True + if config.has_option('ec2', 'elasticache'): + self.elasticache_enabled = config.getboolean('ec2', 'elasticache') + + # Return all EC2 instances? + if config.has_option('ec2', 'all_instances'): + self.all_instances = config.getboolean('ec2', 'all_instances') + else: + self.all_instances = False + + # Instance states to be gathered in inventory. Default is 'running'. + # Setting 'all_instances' to 'yes' overrides this option. + ec2_valid_instance_states = [ + 'pending', + 'running', + 'shutting-down', + 'terminated', + 'stopping', + 'stopped' + ] + self.ec2_instance_states = [] + if self.all_instances: + self.ec2_instance_states = ec2_valid_instance_states + elif config.has_option('ec2', 'instance_states'): + for instance_state in config.get('ec2', 'instance_states').split(','): + instance_state = instance_state.strip() + if instance_state not in ec2_valid_instance_states: + continue + self.ec2_instance_states.append(instance_state) + else: + self.ec2_instance_states = ['running'] + + # Return all RDS instances? (if RDS is enabled) + if config.has_option('ec2', 'all_rds_instances') and self.rds_enabled: + self.all_rds_instances = config.getboolean('ec2', 'all_rds_instances') + else: + self.all_rds_instances = False + + # Return all ElastiCache replication groups? (if ElastiCache is enabled) + if config.has_option('ec2', 'all_elasticache_replication_groups') and self.elasticache_enabled: + self.all_elasticache_replication_groups = config.getboolean('ec2', 'all_elasticache_replication_groups') + else: + self.all_elasticache_replication_groups = False + + # Return all ElastiCache clusters? (if ElastiCache is enabled) + if config.has_option('ec2', 'all_elasticache_clusters') and self.elasticache_enabled: + self.all_elasticache_clusters = config.getboolean('ec2', 'all_elasticache_clusters') + else: + self.all_elasticache_clusters = False + + # Return all ElastiCache nodes? (if ElastiCache is enabled) + if config.has_option('ec2', 'all_elasticache_nodes') and self.elasticache_enabled: + self.all_elasticache_nodes = config.getboolean('ec2', 'all_elasticache_nodes') + else: + self.all_elasticache_nodes = False + + # boto configuration profile (prefer CLI argument then environment variables then config file) + self.boto_profile = self.args.boto_profile or os.environ.get('AWS_PROFILE') + if config.has_option('ec2', 'boto_profile') and not self.boto_profile: + self.boto_profile = config.get('ec2', 'boto_profile') + + # AWS credentials (prefer environment variables) + if not (self.boto_profile or os.environ.get('AWS_ACCESS_KEY_ID') or + os.environ.get('AWS_PROFILE')): + if config.has_option('credentials', 'aws_access_key_id'): + aws_access_key_id = config.get('credentials', 'aws_access_key_id') + else: + aws_access_key_id = None + if config.has_option('credentials', 'aws_secret_access_key'): + aws_secret_access_key = config.get('credentials', 'aws_secret_access_key') + else: + aws_secret_access_key = None + if config.has_option('credentials', 'aws_security_token'): + aws_security_token = config.get('credentials', 'aws_security_token') + else: + aws_security_token = None + if aws_access_key_id: + self.credentials = { + 'aws_access_key_id': aws_access_key_id, + 'aws_secret_access_key': aws_secret_access_key + } + if aws_security_token: + self.credentials['security_token'] = aws_security_token + + # Cache related + cache_dir = os.path.expanduser(config.get('ec2', 'cache_path')) + if self.boto_profile: + cache_dir = os.path.join(cache_dir, 'profile_' + self.boto_profile) + if not os.path.exists(cache_dir): + os.makedirs(cache_dir) + + cache_name = 'ansible-ec2' + cache_id = self.boto_profile or os.environ.get('AWS_ACCESS_KEY_ID', self.credentials.get('aws_access_key_id')) + if cache_id: + cache_name = '%s-%s' % (cache_name, cache_id) + self.cache_path_cache = os.path.join(cache_dir, "%s.cache" % cache_name) + self.cache_path_index = os.path.join(cache_dir, "%s.index" % cache_name) + self.cache_max_age = config.getint('ec2', 'cache_max_age') + + if config.has_option('ec2', 'expand_csv_tags'): + self.expand_csv_tags = config.getboolean('ec2', 'expand_csv_tags') + else: + self.expand_csv_tags = False + + # Configure nested groups instead of flat namespace. + if config.has_option('ec2', 'nested_groups'): + self.nested_groups = config.getboolean('ec2', 'nested_groups') + else: + self.nested_groups = False + + # Replace dash or not in group names + if config.has_option('ec2', 'replace_dash_in_groups'): + self.replace_dash_in_groups = config.getboolean('ec2', 'replace_dash_in_groups') + else: + self.replace_dash_in_groups = True + + # IAM role to assume for connection + if config.has_option('ec2', 'iam_role'): + self.iam_role = config.get('ec2', 'iam_role') + else: + self.iam_role = None + + # Configure which groups should be created. + group_by_options = [ + 'group_by_instance_id', + 'group_by_region', + 'group_by_availability_zone', + 'group_by_ami_id', + 'group_by_instance_type', + 'group_by_instance_state', + 'group_by_key_pair', + 'group_by_vpc_id', + 'group_by_security_group', + 'group_by_tag_keys', + 'group_by_tag_none', + 'group_by_route53_names', + 'group_by_rds_engine', + 'group_by_rds_parameter_group', + 'group_by_elasticache_engine', + 'group_by_elasticache_cluster', + 'group_by_elasticache_parameter_group', + 'group_by_elasticache_replication_group', + 'group_by_aws_account', + ] + for option in group_by_options: + if config.has_option('ec2', option): + setattr(self, option, config.getboolean('ec2', option)) + else: + setattr(self, option, True) + + # Do we need to just include hosts that match a pattern? + try: + pattern_include = config.get('ec2', 'pattern_include') + if pattern_include and len(pattern_include) > 0: + self.pattern_include = re.compile(pattern_include) + else: + self.pattern_include = None + except configparser.NoOptionError: + self.pattern_include = None + + # Do we need to exclude hosts that match a pattern? + try: + pattern_exclude = config.get('ec2', 'pattern_exclude') + if pattern_exclude and len(pattern_exclude) > 0: + self.pattern_exclude = re.compile(pattern_exclude) + else: + self.pattern_exclude = None + except configparser.NoOptionError: + self.pattern_exclude = None + + # Do we want to stack multiple filters? + if config.has_option('ec2', 'stack_filters'): + self.stack_filters = config.getboolean('ec2', 'stack_filters') + else: + self.stack_filters = False + + # Instance filters (see boto and EC2 API docs). Ignore invalid filters. + self.ec2_instance_filters = defaultdict(list) + if config.has_option('ec2', 'instance_filters'): + + filters = [f for f in config.get('ec2', 'instance_filters').split(',') if f] + + for instance_filter in filters: + instance_filter = instance_filter.strip() + if not instance_filter or '=' not in instance_filter: + continue + filter_key, filter_value = [x.strip() for x in instance_filter.split('=', 1)] + if not filter_key: + continue + self.ec2_instance_filters[filter_key].append(filter_value) + + def parse_cli_args(self): + ''' Command line argument processing ''' + + parser = argparse.ArgumentParser(description='Produce an Ansible Inventory file based on EC2') + parser.add_argument('--list', action='store_true', default=True, + help='List instances (default: True)') + parser.add_argument('--host', action='store', + help='Get all the variables about a specific instance') + parser.add_argument('--refresh-cache', action='store_true', default=False, + help='Force refresh of cache by making API requests to EC2 (default: False - use cache files)') + parser.add_argument('--profile', '--boto-profile', action='store', dest='boto_profile', + help='Use boto profile for connections to EC2') + self.args = parser.parse_args() + + def do_api_calls_update_cache(self): + ''' Do API calls to each region, and save data in cache files ''' + + if self.route53_enabled: + self.get_route53_records() + + for region in self.regions: + self.get_instances_by_region(region) + if self.rds_enabled: + self.get_rds_instances_by_region(region) + if self.elasticache_enabled: + self.get_elasticache_clusters_by_region(region) + self.get_elasticache_replication_groups_by_region(region) + if self.include_rds_clusters: + self.include_rds_clusters_by_region(region) + + self.write_to_cache(self.inventory, self.cache_path_cache) + self.write_to_cache(self.index, self.cache_path_index) + + def connect(self, region): + ''' create connection to api server''' + if self.eucalyptus: + conn = boto.connect_euca(host=self.eucalyptus_host, **self.credentials) + conn.APIVersion = '2010-08-31' + else: + conn = self.connect_to_aws(ec2, region) + return conn + + def boto_fix_security_token_in_profile(self, connect_args): + ''' monkey patch for boto issue boto/boto#2100 ''' + profile = 'profile ' + self.boto_profile + if boto.config.has_option(profile, 'aws_security_token'): + connect_args['security_token'] = boto.config.get(profile, 'aws_security_token') + return connect_args + + def connect_to_aws(self, module, region): + connect_args = self.credentials + + # only pass the profile name if it's set (as it is not supported by older boto versions) + if self.boto_profile: + connect_args['profile_name'] = self.boto_profile + self.boto_fix_security_token_in_profile(connect_args) + + if self.iam_role: + sts_conn = sts.connect_to_region(region, **connect_args) + role = sts_conn.assume_role(self.iam_role, 'ansible_dynamic_inventory') + connect_args['aws_access_key_id'] = role.credentials.access_key + connect_args['aws_secret_access_key'] = role.credentials.secret_key + connect_args['security_token'] = role.credentials.session_token + + conn = module.connect_to_region(region, **connect_args) + # connect_to_region will fail "silently" by returning None if the region name is wrong or not supported + if conn is None: + self.fail_with_error("region name: %s likely not supported, or AWS is down. connection to region failed." % region) + return conn + + def get_instances_by_region(self, region): + ''' Makes an AWS EC2 API call to the list of instances in a particular + region ''' + + try: + conn = self.connect(region) + reservations = [] + if self.ec2_instance_filters: + if self.stack_filters: + filters_dict = {} + for filter_key, filter_values in self.ec2_instance_filters.items(): + filters_dict[filter_key] = filter_values + reservations.extend(conn.get_all_instances(filters=filters_dict)) + else: + for filter_key, filter_values in self.ec2_instance_filters.items(): + reservations.extend(conn.get_all_instances(filters={filter_key: filter_values})) + else: + reservations = conn.get_all_instances() + + # Pull the tags back in a second step + # AWS are on record as saying that the tags fetched in the first `get_all_instances` request are not + # reliable and may be missing, and the only way to guarantee they are there is by calling `get_all_tags` + instance_ids = [] + for reservation in reservations: + instance_ids.extend([instance.id for instance in reservation.instances]) + + max_filter_value = 199 + tags = [] + for i in range(0, len(instance_ids), max_filter_value): + tags.extend(conn.get_all_tags(filters={'resource-type': 'instance', 'resource-id': instance_ids[i:i + max_filter_value]})) + + tags_by_instance_id = defaultdict(dict) + for tag in tags: + tags_by_instance_id[tag.res_id][tag.name] = tag.value + + if (not self.aws_account_id) and reservations: + self.aws_account_id = reservations[0].owner_id + + for reservation in reservations: + for instance in reservation.instances: + instance.tags = tags_by_instance_id[instance.id] + self.add_instance(instance, region) + + except boto.exception.BotoServerError as e: + if e.error_code == 'AuthFailure': + error = self.get_auth_error_message() + else: + backend = 'Eucalyptus' if self.eucalyptus else 'AWS' + error = "Error connecting to %s backend.\n%s" % (backend, e.message) + self.fail_with_error(error, 'getting EC2 instances') + + def get_rds_instances_by_region(self, region): + ''' Makes an AWS API call to the list of RDS instances in a particular + region ''' + + if not HAS_BOTO3: + self.fail_with_error("Working with RDS instances requires boto3 - please install boto3 and try again", + "getting RDS instances") + + client = ec2_utils.boto3_inventory_conn('client', 'rds', region, **self.credentials) + db_instances = client.describe_db_instances() + + try: + conn = self.connect_to_aws(rds, region) + if conn: + marker = None + while True: + instances = conn.get_all_dbinstances(marker=marker) + marker = instances.marker + for index, instance in enumerate(instances): + # Add tags to instances. + instance.arn = db_instances['DBInstances'][index]['DBInstanceArn'] + tags = client.list_tags_for_resource(ResourceName=instance.arn)['TagList'] + instance.tags = {} + for tag in tags: + instance.tags[tag['Key']] = tag['Value'] + + self.add_rds_instance(instance, region) + if not marker: + break + except boto.exception.BotoServerError as e: + error = e.reason + + if e.error_code == 'AuthFailure': + error = self.get_auth_error_message() + if not e.reason == "Forbidden": + error = "Looks like AWS RDS is down:\n%s" % e.message + self.fail_with_error(error, 'getting RDS instances') + + def include_rds_clusters_by_region(self, region): + if not HAS_BOTO3: + self.fail_with_error("Working with RDS clusters requires boto3 - please install boto3 and try again", + "getting RDS clusters") + + client = ec2_utils.boto3_inventory_conn('client', 'rds', region, **self.credentials) + + marker, clusters = '', [] + while marker is not None: + resp = client.describe_db_clusters(Marker=marker) + clusters.extend(resp["DBClusters"]) + marker = resp.get('Marker', None) + + account_id = boto.connect_iam().get_user().arn.split(':')[4] + c_dict = {} + for c in clusters: + # remove these datetime objects as there is no serialisation to json + # currently in place and we don't need the data yet + if 'EarliestRestorableTime' in c: + del c['EarliestRestorableTime'] + if 'LatestRestorableTime' in c: + del c['LatestRestorableTime'] + + if self.ec2_instance_filters == {}: + matches_filter = True + else: + matches_filter = False + + try: + # arn:aws:rds:::: + tags = client.list_tags_for_resource( + ResourceName='arn:aws:rds:' + region + ':' + account_id + ':cluster:' + c['DBClusterIdentifier']) + c['Tags'] = tags['TagList'] + + if self.ec2_instance_filters: + for filter_key, filter_values in self.ec2_instance_filters.items(): + # get AWS tag key e.g. tag:env will be 'env' + tag_name = filter_key.split(":", 1)[1] + # Filter values is a list (if you put multiple values for the same tag name) + matches_filter = any(d['Key'] == tag_name and d['Value'] in filter_values for d in c['Tags']) + + if matches_filter: + # it matches a filter, so stop looking for further matches + break + + except Exception as e: + if e.message.find('DBInstanceNotFound') >= 0: + # AWS RDS bug (2016-01-06) means deletion does not fully complete and leave an 'empty' cluster. + # Ignore errors when trying to find tags for these + pass + + # ignore empty clusters caused by AWS bug + if len(c['DBClusterMembers']) == 0: + continue + elif matches_filter: + c_dict[c['DBClusterIdentifier']] = c + + self.inventory['db_clusters'] = c_dict + + def get_elasticache_clusters_by_region(self, region): + ''' Makes an AWS API call to the list of ElastiCache clusters (with + nodes' info) in a particular region.''' + + # ElastiCache boto module doesn't provide a get_all_intances method, + # that's why we need to call describe directly (it would be called by + # the shorthand method anyway...) + try: + conn = self.connect_to_aws(elasticache, region) + if conn: + # show_cache_node_info = True + # because we also want nodes' information + response = conn.describe_cache_clusters(None, None, None, True) + + except boto.exception.BotoServerError as e: + error = e.reason + + if e.error_code == 'AuthFailure': + error = self.get_auth_error_message() + if not e.reason == "Forbidden": + error = "Looks like AWS ElastiCache is down:\n%s" % e.message + self.fail_with_error(error, 'getting ElastiCache clusters') + + try: + # Boto also doesn't provide wrapper classes to CacheClusters or + # CacheNodes. Because of that we can't make use of the get_list + # method in the AWSQueryConnection. Let's do the work manually + clusters = response['DescribeCacheClustersResponse']['DescribeCacheClustersResult']['CacheClusters'] + + except KeyError as e: + error = "ElastiCache query to AWS failed (unexpected format)." + self.fail_with_error(error, 'getting ElastiCache clusters') + + for cluster in clusters: + self.add_elasticache_cluster(cluster, region) + + def get_elasticache_replication_groups_by_region(self, region): + ''' Makes an AWS API call to the list of ElastiCache replication groups + in a particular region.''' + + # ElastiCache boto module doesn't provide a get_all_intances method, + # that's why we need to call describe directly (it would be called by + # the shorthand method anyway...) + try: + conn = self.connect_to_aws(elasticache, region) + if conn: + response = conn.describe_replication_groups() + + except boto.exception.BotoServerError as e: + error = e.reason + + if e.error_code == 'AuthFailure': + error = self.get_auth_error_message() + if not e.reason == "Forbidden": + error = "Looks like AWS ElastiCache [Replication Groups] is down:\n%s" % e.message + self.fail_with_error(error, 'getting ElastiCache clusters') + + try: + # Boto also doesn't provide wrapper classes to ReplicationGroups + # Because of that we can't make use of the get_list method in the + # AWSQueryConnection. Let's do the work manually + replication_groups = response['DescribeReplicationGroupsResponse']['DescribeReplicationGroupsResult']['ReplicationGroups'] + + except KeyError as e: + error = "ElastiCache [Replication Groups] query to AWS failed (unexpected format)." + self.fail_with_error(error, 'getting ElastiCache clusters') + + for replication_group in replication_groups: + self.add_elasticache_replication_group(replication_group, region) + + def get_auth_error_message(self): + ''' create an informative error message if there is an issue authenticating''' + errors = ["Authentication error retrieving ec2 inventory."] + if None in [os.environ.get('AWS_ACCESS_KEY_ID'), os.environ.get('AWS_SECRET_ACCESS_KEY')]: + errors.append(' - No AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY environment vars found') + else: + errors.append(' - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment vars found but may not be correct') + + boto_paths = ['/etc/boto.cfg', '~/.boto', '~/.aws/credentials'] + boto_config_found = list(p for p in boto_paths if os.path.isfile(os.path.expanduser(p))) + if len(boto_config_found) > 0: + errors.append(" - Boto configs found at '%s', but the credentials contained may not be correct" % ', '.join(boto_config_found)) + else: + errors.append(" - No Boto config found at any expected location '%s'" % ', '.join(boto_paths)) + + return '\n'.join(errors) + + def fail_with_error(self, err_msg, err_operation=None): + '''log an error to std err for ansible-playbook to consume and exit''' + if err_operation: + err_msg = 'ERROR: "{err_msg}", while: {err_operation}'.format( + err_msg=err_msg, err_operation=err_operation) + sys.stderr.write(err_msg) + sys.exit(1) + + def get_instance(self, region, instance_id): + conn = self.connect(region) + + reservations = conn.get_all_instances([instance_id]) + for reservation in reservations: + for instance in reservation.instances: + return instance + + def add_instance(self, instance, region): + ''' Adds an instance to the inventory and index, as long as it is + addressable ''' + + # Only return instances with desired instance states + if instance.state not in self.ec2_instance_states: + return + + # Select the best destination address + if self.destination_format and self.destination_format_tags: + dest = self.destination_format.format(*[getattr(instance, 'tags').get(tag, '') for tag in self.destination_format_tags]) + elif instance.subnet_id: + dest = getattr(instance, self.vpc_destination_variable, None) + if dest is None: + dest = getattr(instance, 'tags').get(self.vpc_destination_variable, None) + else: + dest = getattr(instance, self.destination_variable, None) + if dest is None: + dest = getattr(instance, 'tags').get(self.destination_variable, None) + + if not dest: + # Skip instances we cannot address (e.g. private VPC subnet) + return + + # Set the inventory name + hostname = None + if self.hostname_variable: + if self.hostname_variable.startswith('tag_'): + hostname = instance.tags.get(self.hostname_variable[4:], None) + else: + hostname = getattr(instance, self.hostname_variable) + + # set the hostname from route53 + if self.route53_enabled and self.route53_hostnames: + route53_names = self.get_instance_route53_names(instance) + for name in route53_names: + if name.endswith(self.route53_hostnames): + hostname = name + + # If we can't get a nice hostname, use the destination address + if not hostname: + hostname = dest + # to_safe strips hostname characters like dots, so don't strip route53 hostnames + elif self.route53_enabled and self.route53_hostnames and hostname.endswith(self.route53_hostnames): + hostname = hostname.lower() + else: + hostname = self.to_safe(hostname).lower() + + # if we only want to include hosts that match a pattern, skip those that don't + if self.pattern_include and not self.pattern_include.match(hostname): + return + + # if we need to exclude hosts that match a pattern, skip those + if self.pattern_exclude and self.pattern_exclude.match(hostname): + return + + # Add to index + self.index[hostname] = [region, instance.id] + + # Inventory: Group by instance ID (always a group of 1) + if self.group_by_instance_id: + self.inventory[instance.id] = [hostname] + if self.nested_groups: + self.push_group(self.inventory, 'instances', instance.id) + + # Inventory: Group by region + if self.group_by_region: + self.push(self.inventory, region, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'regions', region) + + # Inventory: Group by availability zone + if self.group_by_availability_zone: + self.push(self.inventory, instance.placement, hostname) + if self.nested_groups: + if self.group_by_region: + self.push_group(self.inventory, region, instance.placement) + self.push_group(self.inventory, 'zones', instance.placement) + + # Inventory: Group by Amazon Machine Image (AMI) ID + if self.group_by_ami_id: + ami_id = self.to_safe(instance.image_id) + self.push(self.inventory, ami_id, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'images', ami_id) + + # Inventory: Group by instance type + if self.group_by_instance_type: + type_name = self.to_safe('type_' + instance.instance_type) + self.push(self.inventory, type_name, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'types', type_name) + + # Inventory: Group by instance state + if self.group_by_instance_state: + state_name = self.to_safe('instance_state_' + instance.state) + self.push(self.inventory, state_name, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'instance_states', state_name) + + # Inventory: Group by key pair + if self.group_by_key_pair and instance.key_name: + key_name = self.to_safe('key_' + instance.key_name) + self.push(self.inventory, key_name, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'keys', key_name) + + # Inventory: Group by VPC + if self.group_by_vpc_id and instance.vpc_id: + vpc_id_name = self.to_safe('vpc_id_' + instance.vpc_id) + self.push(self.inventory, vpc_id_name, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'vpcs', vpc_id_name) + + # Inventory: Group by security group + if self.group_by_security_group: + try: + for group in instance.groups: + key = self.to_safe("security_group_" + group.name) + self.push(self.inventory, key, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'security_groups', key) + except AttributeError: + self.fail_with_error('\n'.join(['Package boto seems a bit older.', + 'Please upgrade boto >= 2.3.0.'])) + + # Inventory: Group by AWS account ID + if self.group_by_aws_account: + self.push(self.inventory, self.aws_account_id, dest) + if self.nested_groups: + self.push_group(self.inventory, 'accounts', self.aws_account_id) + + # Inventory: Group by tag keys + if self.group_by_tag_keys: + for k, v in instance.tags.items(): + if self.expand_csv_tags and v and ',' in v: + values = map(lambda x: x.strip(), v.split(',')) + else: + values = [v] + + for v in values: + if v: + key = self.to_safe("tag_" + k + "=" + v) + else: + key = self.to_safe("tag_" + k) + self.push(self.inventory, key, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'tags', self.to_safe("tag_" + k)) + if v: + self.push_group(self.inventory, self.to_safe("tag_" + k), key) + + # Inventory: Group by Route53 domain names if enabled + if self.route53_enabled and self.group_by_route53_names: + route53_names = self.get_instance_route53_names(instance) + for name in route53_names: + self.push(self.inventory, name, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'route53', name) + + # Global Tag: instances without tags + if self.group_by_tag_none and len(instance.tags) == 0: + self.push(self.inventory, 'tag_none', hostname) + if self.nested_groups: + self.push_group(self.inventory, 'tags', 'tag_none') + + # Global Tag: tag all EC2 instances + self.push(self.inventory, 'ec2', hostname) + + self.inventory["_meta"]["hostvars"][hostname] = self.get_host_info_dict_from_instance(instance) + self.inventory["_meta"]["hostvars"][hostname]['ansible_ssh_host'] = dest + + def add_rds_instance(self, instance, region): + ''' Adds an RDS instance to the inventory and index, as long as it is + addressable ''' + + # Only want available instances unless all_rds_instances is True + if not self.all_rds_instances and instance.status != 'available': + return + + # Select the best destination address + dest = instance.endpoint[0] + + if not dest: + # Skip instances we cannot address (e.g. private VPC subnet) + return + + # Set the inventory name + hostname = None + if self.hostname_variable: + if self.hostname_variable.startswith('tag_'): + hostname = instance.tags.get(self.hostname_variable[4:], None) + else: + hostname = getattr(instance, self.hostname_variable) + + # If we can't get a nice hostname, use the destination address + if not hostname: + hostname = dest + + hostname = self.to_safe(hostname).lower() + + # Add to index + self.index[hostname] = [region, instance.id] + + # Inventory: Group by instance ID (always a group of 1) + if self.group_by_instance_id: + self.inventory[instance.id] = [hostname] + if self.nested_groups: + self.push_group(self.inventory, 'instances', instance.id) + + # Inventory: Group by region + if self.group_by_region: + self.push(self.inventory, region, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'regions', region) + + # Inventory: Group by availability zone + if self.group_by_availability_zone: + self.push(self.inventory, instance.availability_zone, hostname) + if self.nested_groups: + if self.group_by_region: + self.push_group(self.inventory, region, instance.availability_zone) + self.push_group(self.inventory, 'zones', instance.availability_zone) + + # Inventory: Group by instance type + if self.group_by_instance_type: + type_name = self.to_safe('type_' + instance.instance_class) + self.push(self.inventory, type_name, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'types', type_name) + + # Inventory: Group by VPC + if self.group_by_vpc_id and instance.subnet_group and instance.subnet_group.vpc_id: + vpc_id_name = self.to_safe('vpc_id_' + instance.subnet_group.vpc_id) + self.push(self.inventory, vpc_id_name, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'vpcs', vpc_id_name) + + # Inventory: Group by security group + if self.group_by_security_group: + try: + if instance.security_group: + key = self.to_safe("security_group_" + instance.security_group.name) + self.push(self.inventory, key, hostname) + if self.nested_groups: + self.push_group(self.inventory, 'security_groups', key) + + except AttributeError: + self.fail_with_error('\n'.join(['Package boto seems a bit older.', + 'Please upgrade boto >= 2.3.0.'])) + + # Inventory: Group by engine + if self.group_by_rds_engine: + self.push(self.inventory, self.to_safe("rds_" + instance.engine), hostname) + if self.nested_groups: + self.push_group(self.inventory, 'rds_engines', self.to_safe("rds_" + instance.engine)) + + # Inventory: Group by parameter group + if self.group_by_rds_parameter_group: + self.push(self.inventory, self.to_safe("rds_parameter_group_" + instance.parameter_group.name), hostname) + if self.nested_groups: + self.push_group(self.inventory, 'rds_parameter_groups', self.to_safe("rds_parameter_group_" + instance.parameter_group.name)) + + # Global Tag: all RDS instances + self.push(self.inventory, 'rds', hostname) + + self.inventory["_meta"]["hostvars"][hostname] = self.get_host_info_dict_from_instance(instance) + self.inventory["_meta"]["hostvars"][hostname]['ansible_ssh_host'] = dest + + def add_elasticache_cluster(self, cluster, region): + ''' Adds an ElastiCache cluster to the inventory and index, as long as + it's nodes are addressable ''' + + # Only want available clusters unless all_elasticache_clusters is True + if not self.all_elasticache_clusters and cluster['CacheClusterStatus'] != 'available': + return + + # Select the best destination address + if 'ConfigurationEndpoint' in cluster and cluster['ConfigurationEndpoint']: + # Memcached cluster + dest = cluster['ConfigurationEndpoint']['Address'] + is_redis = False + else: + # Redis sigle node cluster + # Because all Redis clusters are single nodes, we'll merge the + # info from the cluster with info about the node + dest = cluster['CacheNodes'][0]['Endpoint']['Address'] + is_redis = True + + if not dest: + # Skip clusters we cannot address (e.g. private VPC subnet) + return + + # Add to index + self.index[dest] = [region, cluster['CacheClusterId']] + + # Inventory: Group by instance ID (always a group of 1) + if self.group_by_instance_id: + self.inventory[cluster['CacheClusterId']] = [dest] + if self.nested_groups: + self.push_group(self.inventory, 'instances', cluster['CacheClusterId']) + + # Inventory: Group by region + if self.group_by_region and not is_redis: + self.push(self.inventory, region, dest) + if self.nested_groups: + self.push_group(self.inventory, 'regions', region) + + # Inventory: Group by availability zone + if self.group_by_availability_zone and not is_redis: + self.push(self.inventory, cluster['PreferredAvailabilityZone'], dest) + if self.nested_groups: + if self.group_by_region: + self.push_group(self.inventory, region, cluster['PreferredAvailabilityZone']) + self.push_group(self.inventory, 'zones', cluster['PreferredAvailabilityZone']) + + # Inventory: Group by node type + if self.group_by_instance_type and not is_redis: + type_name = self.to_safe('type_' + cluster['CacheNodeType']) + self.push(self.inventory, type_name, dest) + if self.nested_groups: + self.push_group(self.inventory, 'types', type_name) + + # Inventory: Group by VPC (information not available in the current + # AWS API version for ElastiCache) + + # Inventory: Group by security group + if self.group_by_security_group and not is_redis: + + # Check for the existence of the 'SecurityGroups' key and also if + # this key has some value. When the cluster is not placed in a SG + # the query can return None here and cause an error. + if 'SecurityGroups' in cluster and cluster['SecurityGroups'] is not None: + for security_group in cluster['SecurityGroups']: + key = self.to_safe("security_group_" + security_group['SecurityGroupId']) + self.push(self.inventory, key, dest) + if self.nested_groups: + self.push_group(self.inventory, 'security_groups', key) + + # Inventory: Group by engine + if self.group_by_elasticache_engine and not is_redis: + self.push(self.inventory, self.to_safe("elasticache_" + cluster['Engine']), dest) + if self.nested_groups: + self.push_group(self.inventory, 'elasticache_engines', self.to_safe(cluster['Engine'])) + + # Inventory: Group by parameter group + if self.group_by_elasticache_parameter_group: + self.push(self.inventory, self.to_safe("elasticache_parameter_group_" + cluster['CacheParameterGroup']['CacheParameterGroupName']), dest) + if self.nested_groups: + self.push_group(self.inventory, 'elasticache_parameter_groups', self.to_safe(cluster['CacheParameterGroup']['CacheParameterGroupName'])) + + # Inventory: Group by replication group + if self.group_by_elasticache_replication_group and 'ReplicationGroupId' in cluster and cluster['ReplicationGroupId']: + self.push(self.inventory, self.to_safe("elasticache_replication_group_" + cluster['ReplicationGroupId']), dest) + if self.nested_groups: + self.push_group(self.inventory, 'elasticache_replication_groups', self.to_safe(cluster['ReplicationGroupId'])) + + # Global Tag: all ElastiCache clusters + self.push(self.inventory, 'elasticache_clusters', cluster['CacheClusterId']) + + host_info = self.get_host_info_dict_from_describe_dict(cluster) + + self.inventory["_meta"]["hostvars"][dest] = host_info + + # Add the nodes + for node in cluster['CacheNodes']: + self.add_elasticache_node(node, cluster, region) + + def add_elasticache_node(self, node, cluster, region): + ''' Adds an ElastiCache node to the inventory and index, as long as + it is addressable ''' + + # Only want available nodes unless all_elasticache_nodes is True + if not self.all_elasticache_nodes and node['CacheNodeStatus'] != 'available': + return + + # Select the best destination address + dest = node['Endpoint']['Address'] + + if not dest: + # Skip nodes we cannot address (e.g. private VPC subnet) + return + + node_id = self.to_safe(cluster['CacheClusterId'] + '_' + node['CacheNodeId']) + + # Add to index + self.index[dest] = [region, node_id] + + # Inventory: Group by node ID (always a group of 1) + if self.group_by_instance_id: + self.inventory[node_id] = [dest] + if self.nested_groups: + self.push_group(self.inventory, 'instances', node_id) + + # Inventory: Group by region + if self.group_by_region: + self.push(self.inventory, region, dest) + if self.nested_groups: + self.push_group(self.inventory, 'regions', region) + + # Inventory: Group by availability zone + if self.group_by_availability_zone: + self.push(self.inventory, cluster['PreferredAvailabilityZone'], dest) + if self.nested_groups: + if self.group_by_region: + self.push_group(self.inventory, region, cluster['PreferredAvailabilityZone']) + self.push_group(self.inventory, 'zones', cluster['PreferredAvailabilityZone']) + + # Inventory: Group by node type + if self.group_by_instance_type: + type_name = self.to_safe('type_' + cluster['CacheNodeType']) + self.push(self.inventory, type_name, dest) + if self.nested_groups: + self.push_group(self.inventory, 'types', type_name) + + # Inventory: Group by VPC (information not available in the current + # AWS API version for ElastiCache) + + # Inventory: Group by security group + if self.group_by_security_group: + + # Check for the existence of the 'SecurityGroups' key and also if + # this key has some value. When the cluster is not placed in a SG + # the query can return None here and cause an error. + if 'SecurityGroups' in cluster and cluster['SecurityGroups'] is not None: + for security_group in cluster['SecurityGroups']: + key = self.to_safe("security_group_" + security_group['SecurityGroupId']) + self.push(self.inventory, key, dest) + if self.nested_groups: + self.push_group(self.inventory, 'security_groups', key) + + # Inventory: Group by engine + if self.group_by_elasticache_engine: + self.push(self.inventory, self.to_safe("elasticache_" + cluster['Engine']), dest) + if self.nested_groups: + self.push_group(self.inventory, 'elasticache_engines', self.to_safe("elasticache_" + cluster['Engine'])) + + # Inventory: Group by parameter group (done at cluster level) + + # Inventory: Group by replication group (done at cluster level) + + # Inventory: Group by ElastiCache Cluster + if self.group_by_elasticache_cluster: + self.push(self.inventory, self.to_safe("elasticache_cluster_" + cluster['CacheClusterId']), dest) + + # Global Tag: all ElastiCache nodes + self.push(self.inventory, 'elasticache_nodes', dest) + + host_info = self.get_host_info_dict_from_describe_dict(node) + + if dest in self.inventory["_meta"]["hostvars"]: + self.inventory["_meta"]["hostvars"][dest].update(host_info) + else: + self.inventory["_meta"]["hostvars"][dest] = host_info + + def add_elasticache_replication_group(self, replication_group, region): + ''' Adds an ElastiCache replication group to the inventory and index ''' + + # Only want available clusters unless all_elasticache_replication_groups is True + if not self.all_elasticache_replication_groups and replication_group['Status'] != 'available': + return + + # Skip clusters we cannot address (e.g. private VPC subnet or clustered redis) + if replication_group['NodeGroups'][0]['PrimaryEndpoint'] is None or \ + replication_group['NodeGroups'][0]['PrimaryEndpoint']['Address'] is None: + return + + # Select the best destination address (PrimaryEndpoint) + dest = replication_group['NodeGroups'][0]['PrimaryEndpoint']['Address'] + + # Add to index + self.index[dest] = [region, replication_group['ReplicationGroupId']] + + # Inventory: Group by ID (always a group of 1) + if self.group_by_instance_id: + self.inventory[replication_group['ReplicationGroupId']] = [dest] + if self.nested_groups: + self.push_group(self.inventory, 'instances', replication_group['ReplicationGroupId']) + + # Inventory: Group by region + if self.group_by_region: + self.push(self.inventory, region, dest) + if self.nested_groups: + self.push_group(self.inventory, 'regions', region) + + # Inventory: Group by availability zone (doesn't apply to replication groups) + + # Inventory: Group by node type (doesn't apply to replication groups) + + # Inventory: Group by VPC (information not available in the current + # AWS API version for replication groups + + # Inventory: Group by security group (doesn't apply to replication groups) + # Check this value in cluster level + + # Inventory: Group by engine (replication groups are always Redis) + if self.group_by_elasticache_engine: + self.push(self.inventory, 'elasticache_redis', dest) + if self.nested_groups: + self.push_group(self.inventory, 'elasticache_engines', 'redis') + + # Global Tag: all ElastiCache clusters + self.push(self.inventory, 'elasticache_replication_groups', replication_group['ReplicationGroupId']) + + host_info = self.get_host_info_dict_from_describe_dict(replication_group) + + self.inventory["_meta"]["hostvars"][dest] = host_info + + def get_route53_records(self): + ''' Get and store the map of resource records to domain names that + point to them. ''' + + if self.boto_profile: + r53_conn = route53.Route53Connection(profile_name=self.boto_profile) + else: + r53_conn = route53.Route53Connection() + all_zones = r53_conn.get_zones() + + route53_zones = [zone for zone in all_zones if zone.name[:-1] not in self.route53_excluded_zones] + + self.route53_records = {} + + for zone in route53_zones: + rrsets = r53_conn.get_all_rrsets(zone.id) + + for record_set in rrsets: + record_name = record_set.name + + if record_name.endswith('.'): + record_name = record_name[:-1] + + for resource in record_set.resource_records: + self.route53_records.setdefault(resource, set()) + self.route53_records[resource].add(record_name) + + def get_instance_route53_names(self, instance): + ''' Check if an instance is referenced in the records we have from + Route53. If it is, return the list of domain names pointing to said + instance. If nothing points to it, return an empty list. ''' + + instance_attributes = ['public_dns_name', 'private_dns_name', + 'ip_address', 'private_ip_address'] + + name_list = set() + + for attrib in instance_attributes: + try: + value = getattr(instance, attrib) + except AttributeError: + continue + + if value in self.route53_records: + name_list.update(self.route53_records[value]) + + return list(name_list) + + def get_host_info_dict_from_instance(self, instance): + instance_vars = {} + for key in vars(instance): + value = getattr(instance, key) + key = self.to_safe('ec2_' + key) + + # Handle complex types + # state/previous_state changed to properties in boto in https://github.com/boto/boto/commit/a23c379837f698212252720d2af8dec0325c9518 + if key == 'ec2__state': + instance_vars['ec2_state'] = instance.state or '' + instance_vars['ec2_state_code'] = instance.state_code + elif key == 'ec2__previous_state': + instance_vars['ec2_previous_state'] = instance.previous_state or '' + instance_vars['ec2_previous_state_code'] = instance.previous_state_code + elif isinstance(value, (int, bool)): + instance_vars[key] = value + elif isinstance(value, six.string_types): + instance_vars[key] = value.strip() + elif value is None: + instance_vars[key] = '' + elif key == 'ec2_region': + instance_vars[key] = value.name + elif key == 'ec2__placement': + instance_vars['ec2_placement'] = value.zone + elif key == 'ec2_tags': + for k, v in value.items(): + if self.expand_csv_tags and ',' in v: + v = list(map(lambda x: x.strip(), v.split(','))) + key = self.to_safe('ec2_tag_' + k) + instance_vars[key] = v + elif key == 'ec2_groups': + group_ids = [] + group_names = [] + for group in value: + group_ids.append(group.id) + group_names.append(group.name) + instance_vars["ec2_security_group_ids"] = ','.join([str(i) for i in group_ids]) + instance_vars["ec2_security_group_names"] = ','.join([str(i) for i in group_names]) + elif key == 'ec2_block_device_mapping': + instance_vars["ec2_block_devices"] = {} + for k, v in value.items(): + instance_vars["ec2_block_devices"][os.path.basename(k)] = v.volume_id + else: + pass + # TODO Product codes if someone finds them useful + # print key + # print type(value) + # print value + + instance_vars[self.to_safe('ec2_account_id')] = self.aws_account_id + + return instance_vars + + def get_host_info_dict_from_describe_dict(self, describe_dict): + ''' Parses the dictionary returned by the API call into a flat list + of parameters. This method should be used only when 'describe' is + used directly because Boto doesn't provide specific classes. ''' + + # I really don't agree with prefixing everything with 'ec2' + # because EC2, RDS and ElastiCache are different services. + # I'm just following the pattern used until now to not break any + # compatibility. + + host_info = {} + for key in describe_dict: + value = describe_dict[key] + key = self.to_safe('ec2_' + self.uncammelize(key)) + + # Handle complex types + + # Target: Memcached Cache Clusters + if key == 'ec2_configuration_endpoint' and value: + host_info['ec2_configuration_endpoint_address'] = value['Address'] + host_info['ec2_configuration_endpoint_port'] = value['Port'] + + # Target: Cache Nodes and Redis Cache Clusters (single node) + if key == 'ec2_endpoint' and value: + host_info['ec2_endpoint_address'] = value['Address'] + host_info['ec2_endpoint_port'] = value['Port'] + + # Target: Redis Replication Groups + if key == 'ec2_node_groups' and value: + host_info['ec2_endpoint_address'] = value[0]['PrimaryEndpoint']['Address'] + host_info['ec2_endpoint_port'] = value[0]['PrimaryEndpoint']['Port'] + replica_count = 0 + for node in value[0]['NodeGroupMembers']: + if node['CurrentRole'] == 'primary': + host_info['ec2_primary_cluster_address'] = node['ReadEndpoint']['Address'] + host_info['ec2_primary_cluster_port'] = node['ReadEndpoint']['Port'] + host_info['ec2_primary_cluster_id'] = node['CacheClusterId'] + elif node['CurrentRole'] == 'replica': + host_info['ec2_replica_cluster_address_' + str(replica_count)] = node['ReadEndpoint']['Address'] + host_info['ec2_replica_cluster_port_' + str(replica_count)] = node['ReadEndpoint']['Port'] + host_info['ec2_replica_cluster_id_' + str(replica_count)] = node['CacheClusterId'] + replica_count += 1 + + # Target: Redis Replication Groups + if key == 'ec2_member_clusters' and value: + host_info['ec2_member_clusters'] = ','.join([str(i) for i in value]) + + # Target: All Cache Clusters + elif key == 'ec2_cache_parameter_group': + host_info["ec2_cache_node_ids_to_reboot"] = ','.join([str(i) for i in value['CacheNodeIdsToReboot']]) + host_info['ec2_cache_parameter_group_name'] = value['CacheParameterGroupName'] + host_info['ec2_cache_parameter_apply_status'] = value['ParameterApplyStatus'] + + # Target: Almost everything + elif key == 'ec2_security_groups': + + # Skip if SecurityGroups is None + # (it is possible to have the key defined but no value in it). + if value is not None: + sg_ids = [] + for sg in value: + sg_ids.append(sg['SecurityGroupId']) + host_info["ec2_security_group_ids"] = ','.join([str(i) for i in sg_ids]) + + # Target: Everything + # Preserve booleans and integers + elif isinstance(value, (int, bool)): + host_info[key] = value + + # Target: Everything + # Sanitize string values + elif isinstance(value, six.string_types): + host_info[key] = value.strip() + + # Target: Everything + # Replace None by an empty string + elif value is None: + host_info[key] = '' + + else: + # Remove non-processed complex types + pass + + return host_info + + def get_host_info(self): + ''' Get variables about a specific host ''' + + if len(self.index) == 0: + # Need to load index from cache + self.load_index_from_cache() + + if self.args.host not in self.index: + # try updating the cache + self.do_api_calls_update_cache() + if self.args.host not in self.index: + # host might not exist anymore + return self.json_format_dict({}, True) + + (region, instance_id) = self.index[self.args.host] + + instance = self.get_instance(region, instance_id) + return self.json_format_dict(self.get_host_info_dict_from_instance(instance), True) + + def push(self, my_dict, key, element): + ''' Push an element onto an array that may not have been defined in + the dict ''' + group_info = my_dict.setdefault(key, []) + if isinstance(group_info, dict): + host_list = group_info.setdefault('hosts', []) + host_list.append(element) + else: + group_info.append(element) + + def push_group(self, my_dict, key, element): + ''' Push a group as a child of another group. ''' + parent_group = my_dict.setdefault(key, {}) + if not isinstance(parent_group, dict): + parent_group = my_dict[key] = {'hosts': parent_group} + child_groups = parent_group.setdefault('children', []) + if element not in child_groups: + child_groups.append(element) + + def get_inventory_from_cache(self): + ''' Reads the inventory from the cache file and returns it as a JSON + object ''' + + with open(self.cache_path_cache, 'r') as f: + json_inventory = f.read() + return json_inventory + + def load_index_from_cache(self): + ''' Reads the index from the cache file sets self.index ''' + + with open(self.cache_path_index, 'rb') as f: + self.index = json.load(f) + + def write_to_cache(self, data, filename): + ''' Writes data in JSON format to a file ''' + + json_data = self.json_format_dict(data, True) + with open(filename, 'w') as f: + f.write(json_data) + + def uncammelize(self, key): + temp = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', key) + return re.sub('([a-z0-9])([A-Z])', r'\1_\2', temp).lower() + + def to_safe(self, word): + ''' Converts 'bad' characters in a string to underscores so they can be used as Ansible groups ''' + regex = "[^A-Za-z0-9\_" + if not self.replace_dash_in_groups: + regex += "\-" + return re.sub(regex + "]", "_", word) + + def json_format_dict(self, data, pretty=False): + ''' Converts a dict to a JSON object and dumps it as a formatted + string ''' + + if pretty: + return json.dumps(data, sort_keys=True, indent=2) + else: + return json.dumps(data) + + +if __name__ == '__main__': + # Run the script + Ec2Inventory() diff --git a/ansible/reinit.yml b/ansible/reinit.yml new file mode 100644 index 00000000..de3263bb --- /dev/null +++ b/ansible/reinit.yml @@ -0,0 +1,8 @@ +--- + +- hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" + user: root + roles: + - cleanupconfig + - { role: config, testnet_name: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" } + diff --git a/ansible/reset.yml b/ansible/reset.yml new file mode 100644 index 00000000..b5f92b4e --- /dev/null +++ b/ansible/reset.yml @@ -0,0 +1,9 @@ +--- + +- hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" + user: root + roles: + - stop + - cleanupconfig + - { role: config, testnet_name: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" } + - start diff --git a/ansible/restart.yml b/ansible/restart.yml new file mode 100644 index 00000000..2a5ccda8 --- /dev/null +++ b/ansible/restart.yml @@ -0,0 +1,7 @@ +--- + +- hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" + user: root + roles: + - stop + - start diff --git a/ansible/roles/basecoin/tasks/start.yml b/ansible/roles/basecoin/tasks/start.yml deleted file mode 100644 index 5bbbc04a..00000000 --- a/ansible/roles/basecoin/tasks/start.yml +++ /dev/null @@ -1,26 +0,0 @@ ---- - -- name: copy genesis file - template: > - src=genesis.json.j2 - dest={{tendermint_home}}/genesis.json - owner={{tendermint_user}} - group={{tendermint_group}} - mode=0644 - register: genesis_file_copied - -- name: get validators number from genesis file - shell: cat {{tendermint_home}}/genesis.json | jq ".validators | length" - register: num_validators - when: genesis_file_copied|changed - -- name: restart tendermint if number of validators greater than 0 - shell: echo "restarting ..." - when: genesis_file_copied|changed and num_validators.stdout|int > 0 - notify: restart tendermint - -- service: > - name=tendermint - state=started - enabled=yes - when: tendermint_manage_service diff --git a/ansible/roles/cleanupconfig/defaults/main.yml b/ansible/roles/cleanupconfig/defaults/main.yml new file mode 100644 index 00000000..bb7be858 --- /dev/null +++ b/ansible/roles/cleanupconfig/defaults/main.yml @@ -0,0 +1,6 @@ +--- +tendermint_home: /var/lib/tendermint + +basecoin_home: /var/lib/basecoin +basecoin_inprocess: false + diff --git a/ansible/roles/cleanupconfig/tasks/basecoin.yml b/ansible/roles/cleanupconfig/tasks/basecoin.yml new file mode 100644 index 00000000..3c500e7d --- /dev/null +++ b/ansible/roles/cleanupconfig/tasks/basecoin.yml @@ -0,0 +1,5 @@ +--- + +- name: clear basecoin configuration folder + file: "path={{basecoin_home}}/.basecoin state=absent" + diff --git a/ansible/roles/cleanupconfig/tasks/main.yml b/ansible/roles/cleanupconfig/tasks/main.yml new file mode 100644 index 00000000..5eaf36e3 --- /dev/null +++ b/ansible/roles/cleanupconfig/tasks/main.yml @@ -0,0 +1,9 @@ +--- + +- include: tendermint.yml + when: not basecoin_inprocess|bool + tags: config-tendermint + +- include: basecoin.yml + tags: config-basecoin + diff --git a/ansible/roles/cleanupconfig/tasks/tendermint.yml b/ansible/roles/cleanupconfig/tasks/tendermint.yml new file mode 100644 index 00000000..7321cab9 --- /dev/null +++ b/ansible/roles/cleanupconfig/tasks/tendermint.yml @@ -0,0 +1,5 @@ +--- + +- name: clear tendermint configuration folder + file: "path={{tendermint_home}}/.tendermint state=absent" + diff --git a/ansible/roles/config/defaults/main.yml b/ansible/roles/config/defaults/main.yml new file mode 100644 index 00000000..994b4666 --- /dev/null +++ b/ansible/roles/config/defaults/main.yml @@ -0,0 +1,12 @@ +--- +tendermint_user: tendermint +tendermint_group: tendermint +tendermint_home: /var/lib/tendermint + +basecoin_user: basecoin +basecoin_group: basecoin +basecoin_home: /var/lib/basecoin +basecoin_inprocess: false + +testnet_name: test-chain + diff --git a/ansible/roles/config/tasks/basecoin.yml b/ansible/roles/config/tasks/basecoin.yml new file mode 100644 index 00000000..344a89bd --- /dev/null +++ b/ansible/roles/config/tasks/basecoin.yml @@ -0,0 +1,43 @@ +--- + +- name: set basecoin configuration folder + file: "path={{basecoin_home}}/.basecoin state=directory mode=0700 owner={{basecoin_user}} group={{basecoin_group}}" + +- name: generate basecoin keys + when: basecoin_inprocess|bool + shell: "tendermint gen_validator > {{basecoin_home}}/.basecoin/priv_validator.json && chmod 0400 {{basecoin_home}}/.basecoin/priv_validator.json" + args: + warn: no + creates: "{{basecoin_home}}/.basecoin/priv_validator.json" + become: yes + become_user: "{{basecoin_user}}" + +- name: gather basecoin public keys + when: basecoin_inprocess|bool + command: "jq '.pub_key | .data' {{basecoin_home}}/.basecoin/priv_validator.json" + become: yes + become_user: "{{basecoin_user}}" + register: basecoinpubkeys + changed_when: false + +- name: register basecoin public keys as host facts + when: basecoin_inprocess|bool + set_fact: "basecoin_pubkey={{basecoinpubkeys.stdout_lines[0]}}" + connection: local + +- name: copy basecoin genesis.json - genesis_time will be updated + when: basecoin_inprocess|bool + template: + src: genesis-basecoin.json.j2 + dest: "{{basecoin_home}}/.basecoin/genesis.json" + become: yes + become_user: "{{basecoin_user}}" + +- name: copy basecoin config.toml + when: basecoin_inprocess|bool + template: + src: config.toml.j2 + dest: "{{basecoin_home}}/.basecoin/config.toml" + become: yes + become_user: "{{basecoin_user}}" + diff --git a/ansible/roles/config/tasks/main.yml b/ansible/roles/config/tasks/main.yml new file mode 100644 index 00000000..5eaf36e3 --- /dev/null +++ b/ansible/roles/config/tasks/main.yml @@ -0,0 +1,9 @@ +--- + +- include: tendermint.yml + when: not basecoin_inprocess|bool + tags: config-tendermint + +- include: basecoin.yml + tags: config-basecoin + diff --git a/ansible/roles/config/tasks/tendermint.yml b/ansible/roles/config/tasks/tendermint.yml new file mode 100644 index 00000000..90ae9a4c --- /dev/null +++ b/ansible/roles/config/tasks/tendermint.yml @@ -0,0 +1,38 @@ +--- + +- name: set tendermint configuration folder + file: "path={{tendermint_home}}/.tendermint state=directory mode=0700 owner={{tendermint_user}} group={{tendermint_group}}" + +- name: generate tendermint keys + shell: "tendermint gen_validator > {{tendermint_home}}/.tendermint/priv_validator.json && chmod 0400 {{tendermint_home}}/.tendermint/priv_validator.json" + args: + warn: no + creates: "{{tendermint_home}}/.tendermint/priv_validator.json" + become: yes + become_user: "{{tendermint_user}}" + +- name: gather tendermint public keys + command: "jq '.pub_key | .data' {{tendermint_home}}/.tendermint/priv_validator.json" + become: yes + become_user: "{{tendermint_user}}" + register: tendermintpubkeys + changed_when: false + +- name: register tendermint public keys as host facts + set_fact: "tendermint_pubkey={{tendermintpubkeys.stdout_lines[0]}}" + connection: local + +- name: copy tendermint genesis.json - genesis_time will be updated + template: + src: genesis-tendermint.json.j2 + dest: "{{tendermint_home}}/.tendermint/genesis.json" + become: yes + become_user: "{{tendermint_user}}" + +- name: copy tendermint config.toml + template: + src: config.toml.j2 + dest: "{{tendermint_home}}/.tendermint/config.toml" + become: yes + become_user: "{{tendermint_user}}" + diff --git a/ansible/roles/config/templates/config.toml.j2 b/ansible/roles/config/templates/config.toml.j2 new file mode 100644 index 00000000..4560c963 --- /dev/null +++ b/ansible/roles/config/templates/config.toml.j2 @@ -0,0 +1,16 @@ +# This is a TOML config file. +# For more information, see https://github.com/toml-lang/toml + +proxy_app = "tcp://127.0.0.1:46658" +moniker = "{{inventory_hostname}}" +fast_sync = true +db_backend = "leveldb" +log_level = "debug" + +[rpc] +laddr = "tcp://{{ do_private_ip | default('0.0.0.0') }}:46657" + +[p2p] +laddr = "tcp://{{inventory_hostname}}:46656" +{% set comma = joiner(",") %}seeds = "{% for host in groups[testnet_name]|difference(inventory_hostname) %}{{ comma() }}{{hostvars[host]["inventory_hostname"]}}:46656{% endfor %}" + diff --git a/ansible/roles/config/templates/genesis-basecoin.json.j2 b/ansible/roles/config/templates/genesis-basecoin.json.j2 new file mode 100644 index 00000000..f3998a2c --- /dev/null +++ b/ansible/roles/config/templates/genesis-basecoin.json.j2 @@ -0,0 +1,32 @@ +{ + "app_options": { + "accounts": [{ + "pub_key": { + "type": "ed25519", + "data": "619D3678599971ED29C7529DDD4DA537B97129893598A17C82E3AC9A8BA95279" + }, + "coins": [ + { + "denom": "mycoin", + "amount": 9007199254740992 + } + ] + }] + }, + "genesis_time":"{{ansible_date_time.iso8601_micro}}", + "chain_id":"{{testnet_name}}", + "validators": + [ +{% set comma = joiner(",") %} +{% for host in groups[testnet_name] %} + {{ comma() }} + { + "pub_key":{"type":"ed25519","data":{{hostvars[host]["basecoin_pubkey"]}}}, + "amount":10, + "name":"{{hostvars[host]["ansible_hostname"]}}" + } +{% endfor %} + ], + "app_hash":"" +} + diff --git a/ansible/roles/config/templates/genesis-tendermint.json.j2 b/ansible/roles/config/templates/genesis-tendermint.json.j2 new file mode 100644 index 00000000..fb4dacbd --- /dev/null +++ b/ansible/roles/config/templates/genesis-tendermint.json.j2 @@ -0,0 +1,32 @@ +{ + "app_options": { + "accounts": [{ + "pub_key": { + "type": "ed25519", + "data": "619D3678599971ED29C7529DDD4DA537B97129893598A17C82E3AC9A8BA95279" + }, + "coins": [ + { + "denom": "mycoin", + "amount": 9007199254740992 + } + ] + }] + }, + "genesis_time":"{{ansible_date_time.iso8601}}", + "chain_id":"{{testnet_name}}", + "validators": + [ +{% set comma = joiner(",") %} +{% for host in groups[testnet_name] %} + {{ comma() }} + { + "pub_key":{"type":"ed25519","data":{{hostvars[host]["tendermint_pubkey"]}}}, + "amount":10, + "name":"{{hostvars[host]["ansible_hostname"]}}" + } +{% endfor %} + ], + "app_hash":"" +} + diff --git a/ansible/roles/basecoin/ansible.cfg b/ansible/roles/install-basecoin/ansible.cfg similarity index 100% rename from ansible/roles/basecoin/ansible.cfg rename to ansible/roles/install-basecoin/ansible.cfg diff --git a/ansible/roles/basecoin/defaults/main.yml b/ansible/roles/install-basecoin/defaults/main.yml similarity index 74% rename from ansible/roles/basecoin/defaults/main.yml rename to ansible/roles/install-basecoin/defaults/main.yml index 0be7753e..3fded383 100644 --- a/ansible/roles/basecoin/defaults/main.yml +++ b/ansible/roles/install-basecoin/defaults/main.yml @@ -1,5 +1,5 @@ --- -basecoin_release_install: false +basecoin_release_install: true basecoin_version: 0.4.0 basecoin_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/basecoin/v{{basecoin_version}}/basecoin_{{basecoin_version}}_linux_amd64.zip" @@ -12,12 +12,9 @@ basecoin_group: basecoin # Upstart start/stop conditions can vary by distribution and environment basecoin_upstart_start_on: start on runlevel [345] basecoin_upstart_stop_on: stop on runlevel [!345] -basecoin_manage_service: true -basecoin_use_upstart: true -basecoin_use_systemd: false -basecoin_upstart_template: "basecoin.conf.j2" -basecoin_systemd_template: "basecoin.systemd.j2" basecoin_home: /var/lib/basecoin basecoin_log_file: /var/log/basecoin.log +basecoin_inprocess: false + diff --git a/ansible/roles/install-basecoin/files/key.json b/ansible/roles/install-basecoin/files/key.json new file mode 100644 index 00000000..c557b220 --- /dev/null +++ b/ansible/roles/install-basecoin/files/key.json @@ -0,0 +1,11 @@ +{ + "address": "1B1BE55F969F54064628A63B9559E7C21C925165", + "priv_key": { + "type": "ed25519", + "data": "C70D6934B4F55F1B7BC33B56B9CA8A2061384AFC19E91E44B40C4BBA182953D1619D3678599971ED29C7529DDD4DA537B97129893598A17C82E3AC9A8BA95279" + }, + "pub_key": { + "type": "ed25519", + "data": "619D3678599971ED29C7529DDD4DA537B97129893598A17C82E3AC9A8BA95279" + } +} \ No newline at end of file diff --git a/ansible/roles/install-basecoin/files/key2.json b/ansible/roles/install-basecoin/files/key2.json new file mode 100644 index 00000000..4ccb43f6 --- /dev/null +++ b/ansible/roles/install-basecoin/files/key2.json @@ -0,0 +1,11 @@ +{ + "address": "1DA7C74F9C219229FD54CC9F7386D5A3839F0090", + "priv_key": { + "type": "ed25519", + "data": "34BAE9E65CE8245FAD035A0E3EED9401BDE8785FFB3199ACCF8F5B5DDF7486A8352195DA90CB0B90C24295B90AEBA25A5A71BC61BAB2FE2387241D439698B7B8" + }, + "pub_key": { + "type": "ed25519", + "data": "352195DA90CB0B90C24295B90AEBA25A5A71BC61BAB2FE2387241D439698B7B8" + } +} \ No newline at end of file diff --git a/ansible/roles/basecoin/handlers/main.yml b/ansible/roles/install-basecoin/handlers/main.yml similarity index 100% rename from ansible/roles/basecoin/handlers/main.yml rename to ansible/roles/install-basecoin/handlers/main.yml diff --git a/ansible/roles/basecoin/tasks/install.yml b/ansible/roles/install-basecoin/tasks/install.yml similarity index 81% rename from ansible/roles/basecoin/tasks/install.yml rename to ansible/roles/install-basecoin/tasks/install.yml index 92ea01f5..1ac0b39b 100644 --- a/ansible/roles/basecoin/tasks/install.yml +++ b/ansible/roles/install-basecoin/tasks/install.yml @@ -69,7 +69,7 @@ changed_when: false - name: copy and unpack release binary - when: basecoin_release_install + when: basecoin_release_install|bool unarchive: > src={{basecoin_download}} dest=/usr/local/bin @@ -77,33 +77,38 @@ mode=0755 - name: copy compiled binary - when: not basecoin_release_install + when: not basecoin_release_install|bool copy: > src={{basecoin_binary}} dest=/usr/local/bin mode=0755 -- name: initialize basecoin - command: "basecoin init" - become: yes - become_user: "{{basecoin_user}}" - - name: copy upstart script template: > - src={{basecoin_upstart_template}} + src=basecoin.conf.j2 dest=/etc/init/basecoin.conf owner=root group=root mode=0644 - when: basecoin_use_upstart + when: "ansible_service_mgr == 'upstart'" - name: copy systemd script template: > - src={{basecoin_systemd_template}} + src=basecoin.systemd.j2 dest=/etc/systemd/system/basecoin.service owner=root group=root mode=0644 - when: basecoin_use_systemd + when: "ansible_service_mgr == 'systemd'" notify: - reload systemd + +- name: Create example folder + file: path=/usr/share/basecoin/example-keys state=directory + +- name: Copy example keys + copy: "src={{item}} dest=/usr/share/basecoin/example-keys/{{item}}" + with_items: + - key.json + - key2.json + diff --git a/ansible/roles/basecoin/tasks/main.yml b/ansible/roles/install-basecoin/tasks/main.yml similarity index 91% rename from ansible/roles/basecoin/tasks/main.yml rename to ansible/roles/install-basecoin/tasks/main.yml index 73bc8379..6f77828d 100644 --- a/ansible/roles/basecoin/tasks/main.yml +++ b/ansible/roles/install-basecoin/tasks/main.yml @@ -5,4 +5,4 @@ - "{{ ansible_os_family }}-{{ ansible_distribution_major_version}}.yml" - "{{ ansible_os_family }}.yml" - include: install.yml -#- include: start.yml + diff --git a/ansible/roles/basecoin/templates/basecoin.conf.j2 b/ansible/roles/install-basecoin/templates/basecoin.conf.j2 similarity index 58% rename from ansible/roles/basecoin/templates/basecoin.conf.j2 rename to ansible/roles/install-basecoin/templates/basecoin.conf.j2 index bb9c822b..61fcb0f0 100644 --- a/ansible/roles/basecoin/templates/basecoin.conf.j2 +++ b/ansible/roles/install-basecoin/templates/basecoin.conf.j2 @@ -6,7 +6,7 @@ stop on {{ basecoin_upstart_stop_on }} script # Use su to become tendermint user non-interactively on old Upstart versions (see http://superuser.com/a/234541/76168) - exec su -s /bin/sh -c 'TMROOT={{basecoin_home}} exec "$0" "$@" >> {{ basecoin_log_file }} 2>&1' {{basecoin_user}} -- /usr/local/bin/basecoin start --without-tendermint + exec su -s /bin/sh -c 'BCHOME={{basecoin_home}}/.basecoin exec "$0" "$@" >> {{ basecoin_log_file }} 2>&1' {{basecoin_user}} -- /usr/local/bin/basecoin start{{basecoin_inprocess|bool | ternary('',' --without-tendermint')}} end script respawn diff --git a/ansible/roles/basecoin/templates/basecoin.systemd.j2 b/ansible/roles/install-basecoin/templates/basecoin.systemd.j2 similarity index 53% rename from ansible/roles/basecoin/templates/basecoin.systemd.j2 rename to ansible/roles/install-basecoin/templates/basecoin.systemd.j2 index d6925f8d..26d347dc 100644 --- a/ansible/roles/basecoin/templates/basecoin.systemd.j2 +++ b/ansible/roles/install-basecoin/templates/basecoin.systemd.j2 @@ -4,12 +4,12 @@ Requires=network-online.target After=network-online.target [Service] -Environment="TMROOT={{tendermint_home}}" +Environment="BCHOME={{basecoin_home}}/.basecoin" Restart=on-failure -User={{ tendermint_user }} -Group={{ tendermint_group }} +User={{ basecoin_user }} +Group={{ basecoin_group }} PermissionsStartOnly=true -ExecStart=/usr/local/bin/basecoin start --without-tendermint +ExecStart=/usr/local/bin/basecoin start{{basecoin_inprocess|bool | ternary('',' --without-tendermint')}} ExecReload=/bin/kill -HUP $MAINPID KillSignal=SIGINT diff --git a/ansible/roles/basecoin/vars/Debian.yml b/ansible/roles/install-basecoin/vars/Debian.yml similarity index 100% rename from ansible/roles/basecoin/vars/Debian.yml rename to ansible/roles/install-basecoin/vars/Debian.yml diff --git a/ansible/roles/basecoin/vars/RedHat.yml b/ansible/roles/install-basecoin/vars/RedHat.yml similarity index 100% rename from ansible/roles/basecoin/vars/RedHat.yml rename to ansible/roles/install-basecoin/vars/RedHat.yml diff --git a/ansible/roles/tendermint/defaults/main.yml b/ansible/roles/install-tendermint/defaults/main.yml similarity index 74% rename from ansible/roles/tendermint/defaults/main.yml rename to ansible/roles/install-tendermint/defaults/main.yml index d8f72eec..69fc1b96 100644 --- a/ansible/roles/tendermint/defaults/main.yml +++ b/ansible/roles/install-tendermint/defaults/main.yml @@ -1,5 +1,5 @@ --- -tendermint_release_install: false +tendermint_release_install: true tendermint_version: 0.10.0-rc1 tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/tendermint/v{{tendermint_version}}/tendermint_{{tendermint_version}}_linux_amd64.zip" @@ -12,11 +12,6 @@ tendermint_group: tendermint # Upstart start/stop conditions can vary by distribution and environment tendermint_upstart_start_on: start on runlevel [345] tendermint_upstart_stop_on: stop on runlevel [!345] -tendermint_manage_service: true -tendermint_use_upstart: true -tendermint_use_systemd: false -tendermint_upstart_template: "tendermint.conf.j2" -tendermint_systemd_template: "tendermint.systemd.j2" tendermint_home: /var/lib/tendermint tendermint_log_file: /var/log/tendermint.log diff --git a/ansible/roles/tendermint/handlers/main.yml b/ansible/roles/install-tendermint/handlers/main.yml similarity index 100% rename from ansible/roles/tendermint/handlers/main.yml rename to ansible/roles/install-tendermint/handlers/main.yml diff --git a/ansible/roles/tendermint/tasks/install.yml b/ansible/roles/install-tendermint/tasks/install.yml similarity index 85% rename from ansible/roles/tendermint/tasks/install.yml rename to ansible/roles/install-tendermint/tasks/install.yml index 80647c2f..e8826b23 100644 --- a/ansible/roles/tendermint/tasks/install.yml +++ b/ansible/roles/install-tendermint/tasks/install.yml @@ -69,7 +69,7 @@ changed_when: false - name: copy and unpack release binary - when: tendermint_release_install + when: tendermint_release_install|bool unarchive: > src={{tendermint_download}} dest=/usr/local/bin @@ -77,33 +77,28 @@ mode=0755 - name: copy compiled binary - when: not tendermint_release_install + when: not tendermint_release_install|bool copy: > src={{tendermint_binary}} dest=/usr/local/bin mode=0755 -- name: initialize tendermint - command: "tendermint init" - become: yes - become_user: "{{tendermint_user}}" - - name: copy upstart script template: > - src={{tendermint_upstart_template}} + src=tendermint.conf.j2 dest=/etc/init/tendermint.conf owner=root group=root mode=0644 - when: tendermint_use_upstart + when: "ansible_service_mgr == 'upstart'" - name: copy systemd script template: > - src={{tendermint_systemd_template}} + src=tendermint.systemd.j2 dest=/etc/systemd/system/tendermint.service owner=root group=root mode=0644 - when: tendermint_use_systemd + when: "ansible_service_mgr == 'systemd'" notify: - reload systemd diff --git a/ansible/roles/tendermint/tasks/main.yml b/ansible/roles/install-tendermint/tasks/main.yml similarity index 83% rename from ansible/roles/tendermint/tasks/main.yml rename to ansible/roles/install-tendermint/tasks/main.yml index 8a7450b6..6f77828d 100644 --- a/ansible/roles/tendermint/tasks/main.yml +++ b/ansible/roles/install-tendermint/tasks/main.yml @@ -5,5 +5,4 @@ - "{{ ansible_os_family }}-{{ ansible_distribution_major_version}}.yml" - "{{ ansible_os_family }}.yml" - include: install.yml -- include: genesis.yml -#- include: start.yml + diff --git a/ansible/roles/tendermint/templates/tendermint.conf.j2 b/ansible/roles/install-tendermint/templates/tendermint.conf.j2 similarity index 62% rename from ansible/roles/tendermint/templates/tendermint.conf.j2 rename to ansible/roles/install-tendermint/templates/tendermint.conf.j2 index d65cebb7..362094a2 100644 --- a/ansible/roles/tendermint/templates/tendermint.conf.j2 +++ b/ansible/roles/install-tendermint/templates/tendermint.conf.j2 @@ -6,7 +6,7 @@ stop on {{ tendermint_upstart_stop_on }} script # Use su to become tendermint user non-interactively on old Upstart versions (see http://superuser.com/a/234541/76168) - exec su -s /bin/sh -c 'TMROOT={{tendermint_home}} exec "$0" "$@" >> {{ tendermint_log_file }} 2>&1' {{ tendermint_user }} -- /usr/local/bin/tendermint node --moniker={{inventory_hostname}} + exec su -s /bin/sh -c 'TMHOME={{tendermint_home}}/.tendermint exec "$0" "$@" >> {{ tendermint_log_file }} 2>&1' {{ tendermint_user }} -- /usr/local/bin/tendermint node end script respawn diff --git a/ansible/roles/tendermint/templates/tendermint.systemd.j2 b/ansible/roles/install-tendermint/templates/tendermint.systemd.j2 similarity index 71% rename from ansible/roles/tendermint/templates/tendermint.systemd.j2 rename to ansible/roles/install-tendermint/templates/tendermint.systemd.j2 index e1580350..2e22a563 100644 --- a/ansible/roles/tendermint/templates/tendermint.systemd.j2 +++ b/ansible/roles/install-tendermint/templates/tendermint.systemd.j2 @@ -4,12 +4,12 @@ Requires=network-online.target After=network-online.target [Service] -Environment="TMROOT={{tendermint_home}}" +Environment="TMHOME={{tendermint_home}}/.tendermint" Restart=on-failure User={{ tendermint_user }} Group={{ tendermint_group }} PermissionsStartOnly=true -ExecStart=/usr/local/bin/tendermint node --moniker={{inventory_hostname}} +ExecStart=/usr/local/bin/tendermint node ExecReload=/bin/kill -HUP $MAINPID KillSignal=SIGINT diff --git a/ansible/roles/tendermint/vars/Debian.yml b/ansible/roles/install-tendermint/vars/Debian.yml similarity index 100% rename from ansible/roles/tendermint/vars/Debian.yml rename to ansible/roles/install-tendermint/vars/Debian.yml diff --git a/ansible/roles/tendermint/vars/RedHat.yml b/ansible/roles/install-tendermint/vars/RedHat.yml similarity index 100% rename from ansible/roles/tendermint/vars/RedHat.yml rename to ansible/roles/install-tendermint/vars/RedHat.yml diff --git a/ansible/roles/start/defaults/main.yml b/ansible/roles/start/defaults/main.yml new file mode 100644 index 00000000..313a992d --- /dev/null +++ b/ansible/roles/start/defaults/main.yml @@ -0,0 +1,3 @@ +--- +basecoin_inprocess: false + diff --git a/ansible/roles/start/tasks/main.yml b/ansible/roles/start/tasks/main.yml new file mode 100644 index 00000000..603f597e --- /dev/null +++ b/ansible/roles/start/tasks/main.yml @@ -0,0 +1,9 @@ +--- + +- name: start basecoin + service: name=basecoin state=started + +- name: start tendermint + when: not basecoin_inprocess|bool + service: name=tendermint state=started + diff --git a/ansible/roles/stop/defaults/main.yml b/ansible/roles/stop/defaults/main.yml new file mode 100644 index 00000000..313a992d --- /dev/null +++ b/ansible/roles/stop/defaults/main.yml @@ -0,0 +1,3 @@ +--- +basecoin_inprocess: false + diff --git a/ansible/roles/stop/tasks/main.yml b/ansible/roles/stop/tasks/main.yml new file mode 100644 index 00000000..0636018e --- /dev/null +++ b/ansible/roles/stop/tasks/main.yml @@ -0,0 +1,9 @@ +--- + +- name: stop tendermint + when: not basecoin_inprocess|bool + service: name=tendermint state=stopped + +- name: stop basecoin + service: name=basecoin state=stopped + diff --git a/ansible/roles/tendermint/tasks/genesis.yml b/ansible/roles/tendermint/tasks/genesis.yml deleted file mode 100644 index f00c160d..00000000 --- a/ansible/roles/tendermint/tasks/genesis.yml +++ /dev/null @@ -1,19 +0,0 @@ ---- -- name: gather tendermint public keys - command: "jq '.pub_key | .data' {{tendermint_home}}/.tendermint/priv_validator.json" - become: yes - become_user: "{{tendermint_user}}" - register: tendermintpubkeys - -- name: register public keys as host facts - set_fact: "pubkey={{tendermintpubkeys.stdout_lines[0]}}" - connection: local - -- name: copy genesis.json - template: - src: genesis.json.j2 - dest: "{{tendermint_home}}/.tendermint/genesis.json" - become: yes - become_user: "{{tendermint_user}}" - - diff --git a/ansible/roles/tendermint/tasks/start.yml b/ansible/roles/tendermint/tasks/start.yml deleted file mode 100644 index 5bbbc04a..00000000 --- a/ansible/roles/tendermint/tasks/start.yml +++ /dev/null @@ -1,26 +0,0 @@ ---- - -- name: copy genesis file - template: > - src=genesis.json.j2 - dest={{tendermint_home}}/genesis.json - owner={{tendermint_user}} - group={{tendermint_group}} - mode=0644 - register: genesis_file_copied - -- name: get validators number from genesis file - shell: cat {{tendermint_home}}/genesis.json | jq ".validators | length" - register: num_validators - when: genesis_file_copied|changed - -- name: restart tendermint if number of validators greater than 0 - shell: echo "restarting ..." - when: genesis_file_copied|changed and num_validators.stdout|int > 0 - notify: restart tendermint - -- service: > - name=tendermint - state=started - enabled=yes - when: tendermint_manage_service diff --git a/ansible/roles/tendermint/templates/genesis.json.j2 b/ansible/roles/tendermint/templates/genesis.json.j2 deleted file mode 100644 index a1655fc8..00000000 --- a/ansible/roles/tendermint/templates/genesis.json.j2 +++ /dev/null @@ -1,16 +0,0 @@ -{ - "genesis_time":"{{ansible_date_time.iso8601}}", - "chain_id":"{{testnet_name}}", - "validators": - [ -{% for host in groups[testnet_name] %} - { - "pub_key":{"type":"ed25519","data":{{hostvars[host]["pubkey"]}}}, - "amount":10, - "name":"{{hostvars[host]["ansible_hostname"]}}" - } -{% endfor %} - ], - "app_hash":"" -} - diff --git a/ansible/start.yml b/ansible/start.yml new file mode 100644 index 00000000..1df2e484 --- /dev/null +++ b/ansible/start.yml @@ -0,0 +1,7 @@ +--- + +- hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" + user: root + roles: + - start + diff --git a/ansible/stop.yml b/ansible/stop.yml new file mode 100644 index 00000000..3a5dbcc9 --- /dev/null +++ b/ansible/stop.yml @@ -0,0 +1,7 @@ +--- + +- hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" + user: root + roles: + - stop + diff --git a/create-digitalocean-testnet.sh b/create-digitalocean-testnet.sh index 93047031..a0a32470 100755 --- a/create-digitalocean-testnet.sh +++ b/create-digitalocean-testnet.sh @@ -2,10 +2,16 @@ # This is an example set of commands that uses Terraform and Ansible to create a testnet on Digital Ocean. # Prerequisites: terraform, ansible, DigitalOcean API token, ssh-agent running with the same SSH keys added that are set up during terraform - +# Optional: GOPATH if you build the app yourself #export DO_API_TOKEN="" +#export GOPATH="" -TF_VAR_TESTNET_NAME="$1" +### +# Find out TF_VAR_TESTNET_NAME (testnet name) +### +if [ $# -gt 0 ]; then + TF_VAR_TESTNET_NAME="$1" +fi if [ -z "$TF_VAR_TESTNET_NAME" ]; then echo "Usage: $0 " @@ -14,15 +20,38 @@ if [ -z "$TF_VAR_TESTNET_NAME" ]; then exit fi -cd terraforce +### +# Build Digital Ocean infrastructure +### +SERVERS=2 +cd terraform-digitalocean terraform init terraform env new "$TF_VAR_TESTNET_NAME" -terraform apply -var servers=4 -var DO_API_TOKEN="$DO_API_TOKEN" +terraform apply -var servers=$SERVERS -var DO_API_TOKEN="$DO_API_TOKEN" cd .. +### +# Build applications (optional) +### +if [ -n "$GOPATH" ]; then + go get -u github.com/tendermint/tendermint/cmd/tendermint + go get -u github.com/tendermint/basecoin/cmd/basecoin + ANSIBLE_ADDITIONAL_VARS="-e tendermint_release_install=false -e basecoin_release_intall=false" +fi + +### +# Deploy application +### #Note that SSH Agent needs to be running with SSH keys added or ansible-playbook requires the --private-key option. cd ansible python -u inventory/digital_ocean.py --refresh-cache 1> /dev/null -ansible-playbook -i inventory/digital_ocean.py install.yml +ansible-playbook -i inventory/digital_ocean.py install.yml $ANSIBLE_ADDITIONAL_VARS +cd .. + +### +# Start application +### +cd ansible +ansible-playbook -i inventory/digital_ocean.py start.yml cd .. diff --git a/terraforce/scripts/copy_run.sh b/terraforce/scripts/copy_run.sh deleted file mode 100644 index 31c8eb11..00000000 --- a/terraforce/scripts/copy_run.sh +++ /dev/null @@ -1,10 +0,0 @@ -#! /bin/bash -set -u - -N=$1 # number of nodes -RUN=$2 # path to run script - -N_=$((N-1)) - -# stop all tendermint -terraforce scp --user root --ssh-key $HOME/.ssh/id_rsa --machines "[0-$N_]" $RUN run.sh diff --git a/terraforce/scripts/init.sh b/terraforce/scripts/init.sh deleted file mode 100644 index 15b8e324..00000000 --- a/terraforce/scripts/init.sh +++ /dev/null @@ -1,43 +0,0 @@ -#! /bin/bash -set -u - -N=$1 # number of nodes -TESTNET=$2 # path to folder containing testnet info -CONFIG=$3 # path to folder containing `bins` and `run.sh` files - -if [[ ! -f $CONFIG/bins ]]; then - echo "config folder ($CONFIG) must contain bins file" - exit 1 -fi -if [[ ! -f $CONFIG/run.sh ]]; then - echo "config folder ($CONFIG) must contain run.sh file" - exit 1 -fi - -KEY=$HOME/.ssh/id_rsa - -FLAGS="-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" - -N_=$((N-1)) # 0-based index - -MACH_ROOT="$TESTNET/mach?" - - -# mkdir -terraforce ssh --user root --ssh-key $KEY --machines "[0-$N_]" mkdir .tendermint - -# copy over genesis/priv_val -terraforce scp --user root --ssh-key $KEY --iterative --machines "[0-$N_]" "$MACH_ROOT/priv_validator.json" .tendermint/priv_validator.json -terraforce scp --user root --ssh-key $KEY --iterative --machines "[0-$N_]" "$MACH_ROOT/genesis.json" .tendermint/genesis.json - -# copy the run script -terraforce scp --user root --ssh-key $KEY --machines "[0-$N_]" $CONFIG/run.sh run.sh - -# copy the binaries -while read line; do - local_bin=$(eval echo $line) - remote_bin=$(basename $local_bin) - echo $local_bin - terraforce scp --user root --ssh-key $KEY --machines "[0-$N_]" $local_bin $remote_bin - terraforce ssh --user root --ssh-key $KEY --machines "[0-$N_]" chmod +x $remote_bin -done <$CONFIG/bins diff --git a/terraforce/scripts/query.sh b/terraforce/scripts/query.sh deleted file mode 100644 index c77cf61d..00000000 --- a/terraforce/scripts/query.sh +++ /dev/null @@ -1,11 +0,0 @@ -#! /bin/bash -set -u - -N=$1 # number of nodes -QUERY=$2 - -N_=$((N-1)) - -# start all tendermint nodes -terraforce ssh --user root --ssh-key $HOME/.ssh/id_rsa --machines "[0-$N_]" curl -s localhost:46657/$QUERY - diff --git a/terraforce/scripts/reset.sh b/terraforce/scripts/reset.sh deleted file mode 100644 index 2bef5324..00000000 --- a/terraforce/scripts/reset.sh +++ /dev/null @@ -1,10 +0,0 @@ -#! /bin/bash -set -u - -N=$1 # number of nodes - -N_=$((N-1)) - -# stop all tendermint -terraforce ssh --user root --ssh-key $HOME/.ssh/id_rsa --machines "[0-$N_]" rm -rf .tendermint/data -terraforce ssh --user root --ssh-key $HOME/.ssh/id_rsa --machines "[0-$N_]" ./tendermint unsafe_reset_priv_validator diff --git a/terraforce/scripts/restart.sh b/terraforce/scripts/restart.sh deleted file mode 100644 index 03ff1918..00000000 --- a/terraforce/scripts/restart.sh +++ /dev/null @@ -1,9 +0,0 @@ -#! /bin/bash -set -u - -N=$1 # number of nodes - -N_=$((N-1)) - -# start -terraforce ssh --user root --ssh-key $HOME/.ssh/id_rsa --machines "[0-$N_]" SEEDS=$(terraform output seeds) bash run.sh diff --git a/terraforce/scripts/start.sh b/terraforce/scripts/start.sh deleted file mode 100644 index e72a8da6..00000000 --- a/terraforce/scripts/start.sh +++ /dev/null @@ -1,10 +0,0 @@ -#! /bin/bash -set -u - -N=$1 # number of nodes - -N_=$((N-1)) - -# start all tendermint nodes -terraforce ssh --user root --ssh-key $HOME/.ssh/id_rsa --machines "[0-$N_]" SEEDS=$(terraform output seeds) bash run.sh - diff --git a/terraforce/scripts/stop.sh b/terraforce/scripts/stop.sh deleted file mode 100644 index bdb55869..00000000 --- a/terraforce/scripts/stop.sh +++ /dev/null @@ -1,9 +0,0 @@ -#! /bin/bash -set -u - -N=$1 # number of nodes - -N_=$((N-1)) - -# stop all tendermint -terraforce ssh --user root --ssh-key $HOME/.ssh/id_rsa --machines "[0-$N_]" killall tendermint diff --git a/terraform-aws/README.md b/terraform-aws/README.md new file mode 100644 index 00000000..5e23c5b4 --- /dev/null +++ b/terraform-aws/README.md @@ -0,0 +1,4 @@ +# Terraform for Amazon AWS + +To be done... + diff --git a/terraforce/README.md b/terraform-digitalocean/README.md similarity index 100% rename from terraforce/README.md rename to terraform-digitalocean/README.md diff --git a/terraforce/cluster/main.tf b/terraform-digitalocean/cluster/main.tf similarity index 100% rename from terraforce/cluster/main.tf rename to terraform-digitalocean/cluster/main.tf diff --git a/terraforce/cluster/outputs.tf b/terraform-digitalocean/cluster/outputs.tf similarity index 100% rename from terraforce/cluster/outputs.tf rename to terraform-digitalocean/cluster/outputs.tf diff --git a/terraforce/cluster/variables.tf b/terraform-digitalocean/cluster/variables.tf similarity index 100% rename from terraforce/cluster/variables.tf rename to terraform-digitalocean/cluster/variables.tf diff --git a/terraforce/main.tf b/terraform-digitalocean/main.tf similarity index 96% rename from terraforce/main.tf rename to terraform-digitalocean/main.tf index d83d10e6..dec255b1 100644 --- a/terraforce/main.tf +++ b/terraform-digitalocean/main.tf @@ -1,4 +1,4 @@ -#DigitalOcean Terraform Configuration +#Terraform Configuration variable "DO_API_TOKEN" { description = "DigitalOcean Access Token" diff --git a/terraforce/transact/transact.go b/transact/transact.go similarity index 100% rename from terraforce/transact/transact.go rename to transact/transact.go From 457516b19406ee2ac6c90768849e6c22dc83a198 Mon Sep 17 00:00:00 2001 From: Greg Szabo Date: Wed, 31 May 2017 23:46:02 -0400 Subject: [PATCH 3/7] tendermint+basecoin configuration fixes --- ansible/README.md | 41 +++++++--- ansible/Vagrantfile | 2 - ansible/group_vars/all | 78 +++++++++++++------ ansible/reinit.yml | 8 -- ansible/reset.yml | 2 +- ansible/roles/config/defaults/main.yml | 4 +- ansible/roles/config/tasks/basecoin.yml | 3 +- ansible/roles/config/tasks/tendermint.yml | 2 +- ansible/roles/config/templates/config.toml.j2 | 2 +- .../config/templates/genesis-basecoin.json.j2 | 37 +++++---- .../templates/genesis-tendermint.json.j2 | 16 +--- .../roles/install-basecoin/defaults/main.yml | 8 +- .../roles/install-basecoin/tasks/install.yml | 4 +- .../templates/basecoin.conf.j2 | 4 +- .../install-tendermint/defaults/main.yml | 10 +-- .../templates/tendermint.conf.j2 | 4 +- .../templates/tendermint.systemd.j2 | 2 +- ansible/roles/stop/tasks/main.yml | 2 +- terraform-digitalocean/cluster/main.tf | 6 ++ terraform-digitalocean/cluster/outputs.tf | 14 +++- terraform-digitalocean/main.tf | 14 +--- 21 files changed, 143 insertions(+), 120 deletions(-) delete mode 100644 ansible/reinit.yml diff --git a/ansible/README.md b/ansible/README.md index 0ce68cad..53bc15e1 100644 --- a/ansible/README.md +++ b/ansible/README.md @@ -9,9 +9,10 @@ The playbooks in this folder run [ansible](http://www.ansible.com/) roles which: -* install and configure tendermint -* install and configure basecoin -* start/stop tendermint and basecoin +* install tendermint +* install basecoin +* configure tendermint and basecoin +* start/stop tendermint and basecoin and reset their configuration ## Prerequisites @@ -27,19 +28,19 @@ Head over to the [Terraform folder](https://github.com/tendermint/tools) for a d Optional for Amazon AWS instances: * Amazon AWS API access key ID and secret access key. -The cloud inventory scripts come from the ansible team at https://github.com/ansible/ansible. You can get the latest version from the contrib/inventory folder. +The cloud inventory scripts come from the ansible team at their [GitHub](https://github.com/ansible/ansible) page. You can get the latest version from the contrib/inventory folder. ## Ansible setup Ansible requires a "command machine" or "local machine" or "orchestrator machine" to run on. This can be your laptop or any machine that runs linux. (It does not have to be part of the cloud network that hosts your servers.) -Note: The below commands use the Ubuntu/Debian `apt-get` command. To make it compatible with RedHat/CentOS, replace it with `yum`. +Note: All the below commands use the Ubuntu/Debian `apt-get` command. To make it compatible with RedHat/CentOS, replace it with `yum`. ``` sudo apt-get install ansible ``` -To make life easier, you can start an SSH Agent and load your SSH key(s). This way ansible will have an uninterrupted way of connecting to tour servers. +To make life easier, you can start an SSH Agent and load your SSH key(s). This way ansible will have an uninterrupted way of connecting to your servers. ``` ssh-agent > ~/.ssh/ssh.env @@ -84,7 +85,7 @@ AWS_SECRET_ACCESS_KEY='' python -u inventory/ec2.py --refresh-cache 1> /dev/null ``` -Note you don't need the access key and secret key set, if you are running ansible on an Amazon AMI instance with the proper IAM permissions set. +Note: you don't need the access key and secret key set, if you are running ansible on an Amazon AMI instance with the proper IAM permissions set. ## Running the playbook @@ -111,7 +112,7 @@ ansible-playbook -i inventory/ec2.py install.yml ### Installing custom versions -By default ansible installs the tendermint and basecoin binary versions defined in its [default variables](#Default variables). If you built your own version of the binaries, you can tell ansible to install that instead. +By default ansible installs the tendermint and basecoin binary versions defined in its [default variables](#Default variables). If you build your own version of the binaries, you can tell ansible to install that instead. ``` GOPATH="" @@ -123,12 +124,28 @@ TF_VAR_TESTNET_NAME="testnet-servers" ansible-playbook -i inventory/digital_ocean.py install.yml -e tendermint_release_install=false -e basecoin_release_install=false ``` -## Starting the servers +Alternatively you can change the variable settings in `group_vars/all`. -To be continued... +## Other commands and roles + +There are few extra playbooks to make life easier managing your servers. + +* install.yml - the all-in-one playbook to install and configure tendermint + basecoin +* reset.yml - stop the application, reset the configuration (blockchain), then start the application again +* stop.yml - stop the application +* start.yml - start the application +* restart.yml - restart the application + +The roles are self-sufficient under the `roles/` folder. + +* install-tendermint - install the tendermint application. It can install release packages or custom-compiled binaries. +* install-basecoin - install the basecoin application. It can install release packages or custom-compiled binaries. +* cleanupconfig - delete all tendermint and basecoin configuration. +* config - configure tendermint and basecoin +* stop - stop the application. +* start - start the application. ## Default variables - -To be continued... +Default variables are documented under `group_vars/all`. diff --git a/ansible/Vagrantfile b/ansible/Vagrantfile index 83ad0159..117d7e18 100644 --- a/ansible/Vagrantfile +++ b/ansible/Vagrantfile @@ -14,7 +14,5 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| config.vm.provision :ansible do |ansible| ansible.playbook = "install.yml" - ansible.verbose = 'vv' - ansible.sudo = true end end diff --git a/ansible/group_vars/all b/ansible/group_vars/all index 6fdc88ed..61b08ab2 100644 --- a/ansible/group_vars/all +++ b/ansible/group_vars/all @@ -1,45 +1,77 @@ --- -#tendermint_release_install: true -#tendermint_version: 0.10.0-rc1 -#tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/tendermint/v{{tendermint_version}}/tendermint_{{tendermint_version}}_linux_amd64.zip" +### +### Tendermint installation +### -##If tendermint_release_install == false, copy the binary from here +## This file shows and sets the global defaults for the role variables. + +## tendermint_release_install indicates if the install-tendermint role should install a release version or a private build of the tendermint app +## +#tendermint_release_install: true + +## tendermint_download stores the link to the specific tendermint release to install +## +#tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/tendermint/v0.10.0-rc1/tendermint_0.10.0-rc1_linux_amd64.zip" + +## tendermint_binary stores the path to a private tendermint binary to install +## #tendermint_binary: "{{ lookup('env','GOPATH') | default('') }}/bin/tendermint" +## Details of the linux user the tendermint app uses +## #tendermint_user: tendermint #tendermint_group: tendermint - -## Upstart start/stop conditions can vary by distribution and environment -#tendermint_upstart_start_on: start on runlevel [345] -#tendermint_upstart_stop_on: stop on runlevel [!345] - #tendermint_home: /var/lib/tendermint + +## tendermint_log_file stores the path to the tendermint application log +## #tendermint_log_file: /var/log/tendermint.log -#basecoin_release_install: true -#basecoin_version: 0.4.0 -#basecoin_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/basecoin/v{{basecoin_version}}/basecoin_{{basecoin_version}}_linux_amd64.zip" +### +### Basecoin installation +### -##If basecoin_release_install == false, copy the binary from here +## basecoin_release_install indicates if the install-basecoin role should install a release version or a private build of the basecoin app +## +#basecoin_release_install: true + +## basecoin_download stores the link to the specific basecoin release to install +## +#basecoin_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/basecoin/v0.4.0/basecoin_0.4.0_linux_amd64.zip" + +## basecoin_binary stores the path to a private basecoin binary to install +## #basecoin_binary: "{{ lookup('env','GOPATH') | default('') }}/bin/basecoin" +## Details of the linux user the basecoin app uses +## #basecoin_user: basecoin #basecoin_group: basecoin - -## Upstart start/stop conditions can vary by distribution and environment -#basecoin_upstart_start_on: start on runlevel [345] -#basecoin_upstart_stop_on: stop on runlevel [!345] - #basecoin_home: /var/lib/basecoin + +## basecoin_log_file stores the path to the basecoin application log +## #basecoin_log_file: /var/log/basecoin.log +### +### Basecoin configuration +### + +## basecoin_inprocess indicates if basecoin should run tendermint in-process +## #basecoin_inprocess: false -#Used by the config role -#testnet_name: test-chain +### +### Development settings +### +## Used by the config role to find seed IPs and public keys and set the chain_id in genesis.json and config.toml +## +#testnet_name: testnet1 -basecoin_inprocess: false -tendermint_release_install: false -basecoin_release_install: false +## Used by the config role to add a lot of mycoins to wallet 0x1B1BE55F969F54064628A63B9559E7C21C925165. +## Use /usr/share/basecoin/dev-keys/key.json to access them. +## Tendermint data has to be cleared when setting or resetting this key. +## +#dev_money: false diff --git a/ansible/reinit.yml b/ansible/reinit.yml deleted file mode 100644 index de3263bb..00000000 --- a/ansible/reinit.yml +++ /dev/null @@ -1,8 +0,0 @@ ---- - -- hosts: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" - user: root - roles: - - cleanupconfig - - { role: config, testnet_name: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" } - diff --git a/ansible/reset.yml b/ansible/reset.yml index b5f92b4e..a49f9d3d 100644 --- a/ansible/reset.yml +++ b/ansible/reset.yml @@ -4,6 +4,6 @@ user: root roles: - stop - - cleanupconfig + - { role: cleanupconfig, when: not reconfig|default(false)|bool } - { role: config, testnet_name: "{{ lookup('env','TF_VAR_TESTNET_NAME') }}" } - start diff --git a/ansible/roles/config/defaults/main.yml b/ansible/roles/config/defaults/main.yml index 994b4666..95060fd4 100644 --- a/ansible/roles/config/defaults/main.yml +++ b/ansible/roles/config/defaults/main.yml @@ -8,5 +8,5 @@ basecoin_group: basecoin basecoin_home: /var/lib/basecoin basecoin_inprocess: false -testnet_name: test-chain - +testnet_name: testnet1 +dev_money: false diff --git a/ansible/roles/config/tasks/basecoin.yml b/ansible/roles/config/tasks/basecoin.yml index 344a89bd..d47434e0 100644 --- a/ansible/roles/config/tasks/basecoin.yml +++ b/ansible/roles/config/tasks/basecoin.yml @@ -22,11 +22,10 @@ - name: register basecoin public keys as host facts when: basecoin_inprocess|bool - set_fact: "basecoin_pubkey={{basecoinpubkeys.stdout_lines[0]}}" + set_fact: "pubkey={{basecoinpubkeys.stdout_lines[0]}}" connection: local - name: copy basecoin genesis.json - genesis_time will be updated - when: basecoin_inprocess|bool template: src: genesis-basecoin.json.j2 dest: "{{basecoin_home}}/.basecoin/genesis.json" diff --git a/ansible/roles/config/tasks/tendermint.yml b/ansible/roles/config/tasks/tendermint.yml index 90ae9a4c..04678776 100644 --- a/ansible/roles/config/tasks/tendermint.yml +++ b/ansible/roles/config/tasks/tendermint.yml @@ -19,7 +19,7 @@ changed_when: false - name: register tendermint public keys as host facts - set_fact: "tendermint_pubkey={{tendermintpubkeys.stdout_lines[0]}}" + set_fact: "pubkey={{tendermintpubkeys.stdout_lines[0]}}" connection: local - name: copy tendermint genesis.json - genesis_time will be updated diff --git a/ansible/roles/config/templates/config.toml.j2 b/ansible/roles/config/templates/config.toml.j2 index 4560c963..6ba8d6d0 100644 --- a/ansible/roles/config/templates/config.toml.j2 +++ b/ansible/roles/config/templates/config.toml.j2 @@ -8,7 +8,7 @@ db_backend = "leveldb" log_level = "debug" [rpc] -laddr = "tcp://{{ do_private_ip | default('0.0.0.0') }}:46657" +laddr = "tcp://127.0.0.1:46657" [p2p] laddr = "tcp://{{inventory_hostname}}:46656" diff --git a/ansible/roles/config/templates/genesis-basecoin.json.j2 b/ansible/roles/config/templates/genesis-basecoin.json.j2 index f3998a2c..e1e73b70 100644 --- a/ansible/roles/config/templates/genesis-basecoin.json.j2 +++ b/ansible/roles/config/templates/genesis-basecoin.json.j2 @@ -1,4 +1,23 @@ { + "genesis_time":"{{ansible_date_time.iso8601}}", + "chain_id":"{{testnet_name}}", +{% if basecoin_inprocess|bool %} + "validators": + [ +{% set comma = joiner(",") %} +{% for host in groups[testnet_name] %} + {{ comma() }} + { + "pub_key":{"type":"ed25519","data":{{hostvars[host]["pubkey"]}}}, + "amount":10, + "name":"{{hostvars[host]["ansible_hostname"]}}" + } +{% endfor %} + ], +{% endif %} + "app_hash":"" +{% if dev_money|bool %} + , "app_options": { "accounts": [{ "pub_key": { @@ -12,21 +31,7 @@ } ] }] - }, - "genesis_time":"{{ansible_date_time.iso8601_micro}}", - "chain_id":"{{testnet_name}}", - "validators": - [ -{% set comma = joiner(",") %} -{% for host in groups[testnet_name] %} - {{ comma() }} - { - "pub_key":{"type":"ed25519","data":{{hostvars[host]["basecoin_pubkey"]}}}, - "amount":10, - "name":"{{hostvars[host]["ansible_hostname"]}}" - } -{% endfor %} - ], - "app_hash":"" + } +{% endif %} } diff --git a/ansible/roles/config/templates/genesis-tendermint.json.j2 b/ansible/roles/config/templates/genesis-tendermint.json.j2 index fb4dacbd..3b68cc6b 100644 --- a/ansible/roles/config/templates/genesis-tendermint.json.j2 +++ b/ansible/roles/config/templates/genesis-tendermint.json.j2 @@ -1,18 +1,4 @@ { - "app_options": { - "accounts": [{ - "pub_key": { - "type": "ed25519", - "data": "619D3678599971ED29C7529DDD4DA537B97129893598A17C82E3AC9A8BA95279" - }, - "coins": [ - { - "denom": "mycoin", - "amount": 9007199254740992 - } - ] - }] - }, "genesis_time":"{{ansible_date_time.iso8601}}", "chain_id":"{{testnet_name}}", "validators": @@ -21,7 +7,7 @@ {% for host in groups[testnet_name] %} {{ comma() }} { - "pub_key":{"type":"ed25519","data":{{hostvars[host]["tendermint_pubkey"]}}}, + "pub_key":{"type":"ed25519","data":{{hostvars[host]["pubkey"]}}}, "amount":10, "name":"{{hostvars[host]["ansible_hostname"]}}" } diff --git a/ansible/roles/install-basecoin/defaults/main.yml b/ansible/roles/install-basecoin/defaults/main.yml index 3fded383..af0be146 100644 --- a/ansible/roles/install-basecoin/defaults/main.yml +++ b/ansible/roles/install-basecoin/defaults/main.yml @@ -1,18 +1,12 @@ --- basecoin_release_install: true -basecoin_version: 0.4.0 -basecoin_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/basecoin/v{{basecoin_version}}/basecoin_{{basecoin_version}}_linux_amd64.zip" +basecoin_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/basecoin/v0.4.0/basecoin_0.4.0_linux_amd64.zip" -#If basecoin_release_install == false, copy the binary from here basecoin_binary: "{{ lookup('env','GOPATH') | default('') }}/bin/basecoin" basecoin_user: basecoin basecoin_group: basecoin -# Upstart start/stop conditions can vary by distribution and environment -basecoin_upstart_start_on: start on runlevel [345] -basecoin_upstart_stop_on: stop on runlevel [!345] - basecoin_home: /var/lib/basecoin basecoin_log_file: /var/log/basecoin.log diff --git a/ansible/roles/install-basecoin/tasks/install.yml b/ansible/roles/install-basecoin/tasks/install.yml index 1ac0b39b..2007fadc 100644 --- a/ansible/roles/install-basecoin/tasks/install.yml +++ b/ansible/roles/install-basecoin/tasks/install.yml @@ -104,10 +104,10 @@ - reload systemd - name: Create example folder - file: path=/usr/share/basecoin/example-keys state=directory + file: path=/usr/share/basecoin/dev-keys state=directory - name: Copy example keys - copy: "src={{item}} dest=/usr/share/basecoin/example-keys/{{item}}" + copy: "src={{item}} dest=/usr/share/basecoin/dev-keys/{{item}}" with_items: - key.json - key2.json diff --git a/ansible/roles/install-basecoin/templates/basecoin.conf.j2 b/ansible/roles/install-basecoin/templates/basecoin.conf.j2 index 61fcb0f0..ac850da6 100644 --- a/ansible/roles/install-basecoin/templates/basecoin.conf.j2 +++ b/ansible/roles/install-basecoin/templates/basecoin.conf.j2 @@ -1,8 +1,8 @@ # Basecoin (Upstart unit) description "Basecoin" -start on {{ basecoin_upstart_start_on }} -stop on {{ basecoin_upstart_stop_on }} +start on runlevel [2345] +stop on runlevel [!2345] script # Use su to become tendermint user non-interactively on old Upstart versions (see http://superuser.com/a/234541/76168) diff --git a/ansible/roles/install-tendermint/defaults/main.yml b/ansible/roles/install-tendermint/defaults/main.yml index 69fc1b96..ab1c114f 100644 --- a/ansible/roles/install-tendermint/defaults/main.yml +++ b/ansible/roles/install-tendermint/defaults/main.yml @@ -1,18 +1,14 @@ --- tendermint_release_install: true -tendermint_version: 0.10.0-rc1 -tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/tendermint/v{{tendermint_version}}/tendermint_{{tendermint_version}}_linux_amd64.zip" +tendermint_download: "https://s3-us-west-2.amazonaws.com/tendermint/binaries/tendermint/v0.10.0-rc1/tendermint_0.10.0-rc1_linux_amd64.zip" -#If tendermint_release_install == false, copy the binary from here tendermint_binary: "{{ lookup('env','GOPATH') | default('') }}/bin/tendermint" tendermint_user: tendermint tendermint_group: tendermint -# Upstart start/stop conditions can vary by distribution and environment -tendermint_upstart_start_on: start on runlevel [345] -tendermint_upstart_stop_on: stop on runlevel [!345] - tendermint_home: /var/lib/tendermint tendermint_log_file: /var/log/tendermint.log +basecoin_inprocess: false + diff --git a/ansible/roles/install-tendermint/templates/tendermint.conf.j2 b/ansible/roles/install-tendermint/templates/tendermint.conf.j2 index 362094a2..513b1625 100644 --- a/ansible/roles/install-tendermint/templates/tendermint.conf.j2 +++ b/ansible/roles/install-tendermint/templates/tendermint.conf.j2 @@ -1,8 +1,8 @@ # Tendermint (Upstart unit) description "Tendermint" -start on {{ tendermint_upstart_start_on }} -stop on {{ tendermint_upstart_stop_on }} +{{basecoin_inprocess|bool | ternary('','start on (runlevel [2345] and started basecoin)')}} +{{basecoin_inprocess|bool | ternary('','stop on (runlevel [!2345] and stopping basecoin)')}} script # Use su to become tendermint user non-interactively on old Upstart versions (see http://superuser.com/a/234541/76168) diff --git a/ansible/roles/install-tendermint/templates/tendermint.systemd.j2 b/ansible/roles/install-tendermint/templates/tendermint.systemd.j2 index 2e22a563..20c5d44b 100644 --- a/ansible/roles/install-tendermint/templates/tendermint.systemd.j2 +++ b/ansible/roles/install-tendermint/templates/tendermint.systemd.j2 @@ -1,6 +1,6 @@ [Unit] Description=Tendermint -Requires=network-online.target +Requires=network-online.target{{basecoin_inprocess|bool | ternary('',' basecoin.target')}} After=network-online.target [Service] diff --git a/ansible/roles/stop/tasks/main.yml b/ansible/roles/stop/tasks/main.yml index 0636018e..de462a67 100644 --- a/ansible/roles/stop/tasks/main.yml +++ b/ansible/roles/stop/tasks/main.yml @@ -1,7 +1,7 @@ --- - name: stop tendermint - when: not basecoin_inprocess|bool + #when: not basecoin_inprocess|bool service: name=tendermint state=stopped - name: stop basecoin diff --git a/terraform-digitalocean/cluster/main.tf b/terraform-digitalocean/cluster/main.tf index 43166e7d..b9be67c5 100644 --- a/terraform-digitalocean/cluster/main.tf +++ b/terraform-digitalocean/cluster/main.tf @@ -23,3 +23,9 @@ resource "digitalocean_droplet" "cluster" { } +#resource "digitalocean_floating_ip" "cluster" { +# droplet_id = "${element(digitalocean_droplet.cluster.*.id,count.index)}" +# region = "${element(digitalocean_droplet.cluster.*.region,count.index)}" +# count = "${var.servers}" +#} + diff --git a/terraform-digitalocean/cluster/outputs.tf b/terraform-digitalocean/cluster/outputs.tf index 59ecb9fb..90255cfc 100644 --- a/terraform-digitalocean/cluster/outputs.tf +++ b/terraform-digitalocean/cluster/outputs.tf @@ -1,19 +1,25 @@ -// The cluster name, e.g cdn +// The cluster name output "name" { value = "${var.name}" } -// The list of cluster instance ids +// The list of cluster instance IDs output "instances" { value = ["${digitalocean_droplet.cluster.*.id}"] } -// The list of cluster instance ips +// The list of cluster instance private IPs output "private_ips" { value = ["${digitalocean_droplet.cluster.*.ipv4_address_private}"] } -// The list of cluster instance ips +// The list of cluster instance public IPs output "public_ips" { value = ["${digitalocean_droplet.cluster.*.ipv4_address}"] } + +#// The list of cluster floating IPs +#output "floating_ips" { +# value = ["${digitalocean_floating_ip.cluster.*.ip_address}"] +#} + diff --git a/terraform-digitalocean/main.tf b/terraform-digitalocean/main.tf index dec255b1..bd08af89 100644 --- a/terraform-digitalocean/main.tf +++ b/terraform-digitalocean/main.tf @@ -37,15 +37,7 @@ output "public_ips" { value = "${module.cluster.public_ips}" } -output "private_ips" { - value = "${join(",",module.cluster.private_ips)}" -} - -output "seeds" { - value = "${join(":46656,",module.cluster.public_ips)}:46656" -} - -output "rpcs" { - value = "${join(":46657,",module.cluster.public_ips)}:46657" -} +#output "floating_ips" { +# value = "${module.cluster.floating_ips}" +#} From ab5802a50f707994c40172cb0fbd5b44486cff7f Mon Sep 17 00:00:00 2001 From: Greg Szabo Date: Wed, 31 May 2017 23:49:20 -0400 Subject: [PATCH 4/7] Fixed typo in README.md --- terraform-digitalocean/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/terraform-digitalocean/README.md b/terraform-digitalocean/README.md index 298b0c66..54adc749 100644 --- a/terraform-digitalocean/README.md +++ b/terraform-digitalocean/README.md @@ -27,6 +27,7 @@ After initialization it's good measure to create a new Terraform environment for ``` TESTNET_NAME="testnet-servers" terraform env new "$TESTNET_NAME" +``` ## Execution From 07baf56cde630f16a4d50f6c7eb68fd042c41ccc Mon Sep 17 00:00:00 2001 From: Greg Szabo Date: Thu, 1 Jun 2017 00:08:22 -0400 Subject: [PATCH 5/7] Typo fixes and enhancements to README.md --- terraform-digitalocean/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/terraform-digitalocean/README.md b/terraform-digitalocean/README.md index 54adc749..cbdab472 100644 --- a/terraform-digitalocean/README.md +++ b/terraform-digitalocean/README.md @@ -6,7 +6,7 @@ This is a generic [Terraform](https://www.terraform.io/) configuration that sets * Install [HashiCorp Terraform](https://www.terraform.io) on a linux machine. * Create a [DigitalOcean API token](https://cloud.digitalocean.com/settings/api/tokens) with read and write capability. -* Set an SSH key at the [DigitalOcean security page](https://cloud.digitalocean.com/settings/security). +* Set an SSH key at the [DigitalOcean security page](https://cloud.digitalocean.com/settings/security). {Here](https://www.digitalocean.com/community/tutorials/how-to-use-ssh-keys-with-digitalocean-droplets)'s a tutorial. * Find out your SSH key ID at DigitalOcean by querying the below command on your linux box: ``` @@ -34,13 +34,15 @@ terraform env new "$TESTNET_NAME" The below command will create 4 nodes in DigitalOcean. They will be named `testnet-servers-node0` to `testnet-servers-node3` and they will be tagged as `testnet-servers`. ``` DO_API_TOKEN="" -terraform apply -var TESTNET_NAME="testnet-servers" -var servers=4 -var DO_API_TOKEN="$DO_API_TOKEN" +SSH_ID="" +terraform apply -var TESTNET_NAME="testnet-servers" -var servers=4 -var DO_API_TOKEN="$DO_API_TOKEN" -var ssh_keys=[$SSH_ID] ``` -Alternatively you can use the default settings. The number of default servers is 7 and the testnet name is `tf-testnet1`. Variables can also be defined as environment variables instead of the command-line. Environment variables that start with `TF_VAR_` will be translated into the Terraform configuration. For example the number of servers can be overriden by setting the `TF_VAR_servers` variable. +Alternatively you can use the default settings. The number of default servers is 4 and the testnet name is `tf-testnet1`. Variables can also be defined as environment variables instead of the command-line. Environment variables that start with `TF_VAR_` will be translated into the Terraform configuration. For example the number of servers can be overriden by setting the `TF_VAR_servers` variable. ``` TF_VAR_DO_API_TOKEN="" +TF_VAR_TESTNET_NAME="testnet-servers" terraform-apply ``` From ee74f9a3a8a9a721bffa6c49516889ad134887a9 Mon Sep 17 00:00:00 2001 From: Greg Szabo Date: Thu, 1 Jun 2017 00:11:38 -0400 Subject: [PATCH 6/7] Enhancements to README.md --- terraform-digitalocean/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/terraform-digitalocean/README.md b/terraform-digitalocean/README.md index cbdab472..b6534794 100644 --- a/terraform-digitalocean/README.md +++ b/terraform-digitalocean/README.md @@ -34,10 +34,12 @@ terraform env new "$TESTNET_NAME" The below command will create 4 nodes in DigitalOcean. They will be named `testnet-servers-node0` to `testnet-servers-node3` and they will be tagged as `testnet-servers`. ``` DO_API_TOKEN="" -SSH_ID="" -terraform apply -var TESTNET_NAME="testnet-servers" -var servers=4 -var DO_API_TOKEN="$DO_API_TOKEN" -var ssh_keys=[$SSH_ID] +SSH_IDS="[ \"\" ]" +terraform apply -var TESTNET_NAME="testnet-servers" -var servers=4 -var DO_API_TOKEN="$DO_API_TOKEN" -var ssh_keys=$SSH_IDS ``` +Note: `ssh_keys` is a list of strings. You can add multiple keys. For example: `["1234567","9876543"]`. + Alternatively you can use the default settings. The number of default servers is 4 and the testnet name is `tf-testnet1`. Variables can also be defined as environment variables instead of the command-line. Environment variables that start with `TF_VAR_` will be translated into the Terraform configuration. For example the number of servers can be overriden by setting the `TF_VAR_servers` variable. ``` From 92438185fc8beb5701e8ba07db70fd8b7f10f954 Mon Sep 17 00:00:00 2001 From: Greg Szabo Date: Sat, 3 Jun 2017 01:10:44 -0400 Subject: [PATCH 7/7] Clarified Ansible installation instructions and added slacknotification.py script. --- ansible/README.md | 42 +++++++++++++++++++++++++++++++++++-- devops/README.md | 16 ++++++++++++++ devops/slacknotification.py | 41 ++++++++++++++++++++++++++++++++++++ 3 files changed, 97 insertions(+), 2 deletions(-) create mode 100644 devops/README.md create mode 100644 devops/slacknotification.py diff --git a/ansible/README.md b/ansible/README.md index 53bc15e1..1dee149e 100644 --- a/ansible/README.md +++ b/ansible/README.md @@ -34,12 +34,25 @@ The cloud inventory scripts come from the ansible team at their [GitHub](https:/ Ansible requires a "command machine" or "local machine" or "orchestrator machine" to run on. This can be your laptop or any machine that runs linux. (It does not have to be part of the cloud network that hosts your servers.) -Note: All the below commands use the Ubuntu/Debian `apt-get` command. To make it compatible with RedHat/CentOS, replace it with `yum`. +Use the official [Ansible installation guide](http://docs.ansible.com/ansible/intro_installation.html) to install Ansible. Here are a few examples on basic installation commands: +Ubuntu/Debian: ``` sudo apt-get install ansible ``` +CentOS/RedHat: +``` +sudo yum install epel-release +sudo yum install ansible +``` + +Mac OSX: +``` +sudo easy_install pip +sudo pip install ansible +``` + To make life easier, you can start an SSH Agent and load your SSH key(s). This way ansible will have an uninterrupted way of connecting to your servers. ``` @@ -55,17 +68,42 @@ Subsequently, as long as the agent is running, you can use `source ~/.ssh/ssh.en If you are using a cloud provider to host your servers, you need the below dependencies installed on your local machine. -DigitalOcean inventory dependencies: +#### DigitalOcean inventory dependencies: + +Ubuntu/Debian: ``` sudo apt-get install python-pip sudo pip install dopy ``` +CentOS/RedHat: +``` +sudo yum install python-pip +sudo pip install dopy +``` + +Mac OSX: +``` +sudo pip install dopy +``` + Amazon AWS inventory dependencies: + +Ubuntu/Debian: ``` sudo apt-get install python-boto ``` +CentOS/RedHat: +``` +sudo yum install python-boto +``` + +Mac OSX: +``` +sudo pip install boto +``` + ## Refreshing the DigitalOcean inventory If you just finished creating droplets, the local DigitalOcean inventory cache is not up-to-date. To refresh it, run: diff --git a/devops/README.md b/devops/README.md new file mode 100644 index 00000000..675271ae --- /dev/null +++ b/devops/README.md @@ -0,0 +1,16 @@ +# DevOps tools + +This folder contains tools that are used for automated testnet deployments. + +## slacknotification.py + +A small script that can send Slack messages. + +Requirements: slackclient python library + +Install slackclient by running as root: +``` +pip install slackclient +``` + + diff --git a/devops/slacknotification.py b/devops/slacknotification.py new file mode 100644 index 00000000..ee5987e2 --- /dev/null +++ b/devops/slacknotification.py @@ -0,0 +1,41 @@ +import os +from slackclient import SlackClient +import argparse + +if __name__ == '__main__': + parser = argparse.ArgumentParser(description="Slack notification script") + parser.add_argument('--channel','-c', required=True, help="Slack channel.") + parser.add_argument('--message','-m', required=True, help="The message to send.") + parser.add_argument('--username', required=False, help="Username used on Slack") + parser.add_argument('--api_token', required=False, help="Slack API token. Can be set in SLACK_API_TOKEN environment variable too.") + parser.add_argument('--icon_emoji','-i', required=False, help="Icon for the message.") + args = parser.parse_args() + + username = args.username + api_token=args.api_token + if api_token is None: + api_token=os.getenv("SLACK_API_TOKEN") + message = args.message + channel = args.channel + icon_emoji = args.icon_emoji + + slack_client = SlackClient(api_token) + apitest = slack_client.api_call("api.test") + if not apitest['ok']: + raise ValueError("api.test error: {0}".format(apitest['error'])) + + authtest = slack_client.api_call("auth.test") + if not authtest['ok']: + raise ValueError("auth.test error: {0}".format(authtest['error'])) + + if username is None: + username = authtest['user'] + + if icon_emoji is None: + result = slack_client.api_call("chat.postMessage", channel=channel, text=message, username=username, icon_emoji=icon_emoji) + else: + result = slack_client.api_call("chat.postMessage", channel=channel, text=message, username=username) + + if not result['ok']: + raise ValueError("Message error: {0}".format(result['error'])) +