terragrunt-aws-icon

Work in progress - Please get in touch

This is the second iteration of an automated deployment for running nodes and supporting infrastructure on the ICON Blockchain.

To Use

1. Export AWS keys to environment variables or profile

   • Visit this link for more information

2. Install prerequisites

   • Check this section

3. Pull in dependencies

   • make clone-all

4. Make sure you have ssh keys

   • ssh-keygen -t rsa -b 4096 -C "your_email@example.com" -f $HOME/.ssh/icon_node
   • Take note of the path that you create the keys in as you will need it in the next section

5. Fill in the necessary inputs in config files at base of directory

   • There are five files
     • global.yaml
       • Information about network and general setup
     • secrets.yaml
       • Secret values like the keystore password (yeah, we know...) and paths to ssh keys / keystore
     • account.tfvars
       • Your AWS account number
     • region.tfvars
       • The region you deploy into. Same as in global.yaml
     • node.yaml
       • The specs for your node.
   • Two files have examples that you can remove the .example file ending to get started
   • If you would like to get prompted for the inputs, run cookiecutter . and the files will be created for you.

   Make sure you choose the right network in the global.yaml file.

6. Register node

   • You will need to regster the node. Check the official docs
   • Follow this readme and fill in the appropriate information
   • make eip-register
   • Copy output and run in shell
   • This is a one time process for most people

7. Deploy node

   • We have several variations of the node deployment in various stages of development.
   • Most stable version right now is the prep-module or prep-basic
   • Developers will want to know how to deploy all the pieces individually
   • To deploy the most basic version, run:

make apply-prep-module

To turn off your node, run:

make destroy-prep-module

Areas of Development

---

To view a complete list of areas that we are working on, check this link.

Short list being:

• Improved monitoring and alerting
• DDoS protection using Envoy
• Host intrusion detection systems
• Vault secrets management
• Improved deployment and testing patterns

Get in touch with Rob if you want to help / need a walk through of the repo.

Prerequisites

---

The deployment works on both Linux and Mac. For windows you will want to install Ubuntu WSL.

• To install dependencies, first try the Makefile
  • Mac - Have brew installed then make install-deps-mac from the root of repo
  • Ubuntu - make install-deps-ubuntu
• Visit this link for more information
• Here are most of the programs - may be some dependencies of these missing, hence check link above.
  • nodejs
  • meta
  • terraform
  • terragrunt
  • packer
  • ansible
  • build-essential
  • awscli
  • pip
    • requests==2.20.0
    • preptools

Further Reading

• Developer-Tutorials
• Introductory-Tutorials
• Operator-Tutorials
• Technology-Directory