terraform-aws-icon-registration

Features

This module helps with registering a node on the ICON Blockchain. It does three main things.

• Creates an elastic IP that will be your main IP that your node will use to run and applies a number of tags on the resource so it can be queried to be attached to instances later
• Puts the necessary details.json file in a bucket publicly accessible along with logos
• Runs preptools to register the node or update the info

Make sure you have 2000 ICX registration fee in your wallet for mainnet and you have testnet tokens for testnet

Using this module

Fill out the appropriate values in terraform.tfvars.example then move to terraform.tfvars if running directly.

Really this module should be used from a scaffolding like terragrunt like in (terragrunt-aws-icon)[https://github.com/insight-infrastructure/terragrunt-aws-icon]

Terraform Versions

For Terraform v0.12.0+

Usage

module "this" {
    source = "github.com/insight-infrastructure/terraform-aws-icon-registration.git?ref=v0.1.0"
    network_name = "testnet"

    // Path needs to be filled in otherwise registration doesn't work
    //  keystore_path = "/Users/.../Documents/keystore"

    organization_name    = "Insight-CI"
    organization_country = "USA"
    # This needs to be three letter country code per https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
    organization_email = "hunter@gmail.com"
    # Needs to be real email
    organization_city = "A city"
    # No qualifiers
    organization_website = "https://google.com"
    # Needs to begin in https / http - can be google...

    // All the logos are complete paths to the image on your local drive
    logo_256 = "/Users/.../logo_256"
    logo_1024 = "/Users/.../logo_1024"
    logo_svg = "/Users/.../logo_svg"

    // If you have already have an IP, you can enter it here / uncomment and a new IP will not be provisioned with the
    // existing IP being brought
    //  ip = "1.2.3.4"
    // ------------------Details - Doesn't really matter
    server_type = "cloud"
    region      = "us-east-1"

    keystore_password = var.keystore_password
    keystore_path     = var.keystore_path

    logo_256  = var.logo_256
    logo_1024 = var.logo_1024

    logo_svg = var.logo_svg
}

Examples

• defaults

Known Issues

No issue is creating limit on this module.

Providers

Name	Version
google	n/a
google-beta	n/a
random	n/a

Inputs

Name	Description	Type	Default	Required
bucket_name	The bucket name for static content - blank for team name	string	""	no
details_endpoint	Endpoint you have details and logos	string	""	no
facebook	Link to social media account - https://...	string	""	no
gcp_project_id	The name of the gcp project to create - required for cloud / content provider = gcp	string	"icon-testing"	no
gcp_project_name	The display name of the gcp project to create - required for cloud / content provider = gcp	string	"icon-testing"	no
gcp_website_location	(Optional, Default: 'US') The GCS location	string	"US"	no
gcp_website_storage_class	The Storage Class of the new bucket. Supported values include: STANDARD, MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE	string	"STANDARD"	no
github	Link to social media account - https://...	string	""	no
keybase	Link to social media account - https://...	string	""	no
keystore_password	The keystore password	string	n/a	yes
keystore_path	the path to your keystore	string	n/a	yes
labels	Map of labels	map(string)	{}	no
logo_1024	Path to png logo	string	""	no
logo_256	Path to png logo	string	""	no
logo_svg	Path to svg logo	string	""	no
name	Name of the resources	string	""	no
network_name	mainnet or testnet - Don't mess this up!!!!!!!!	string	"mainnet"	no
organization_city	No qualifiers	string	""	no
organization_country	This needs to be three letter country code per https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3	string	""	no
organization_email	Needs to be real email	string	""	no
organization_name	Any string - your team name	string	""	no
organization_website	Needs to begin in https / http - can be google...	string	""	no
public_ip	Optional if you are registering an IP from a different network - only creates details content, leave blank and insert cloud provdier to create ip	string	n/a	yes
reddit	Link to social media account - https://...	string	""	no
server_type	Link to social media account - https://...	string	"cloud"	no
skip_registration	Bool to skip registration	bool	false	no
static_content_provider	The provider	string	""	no
steemit	Link to social media account - https://...	string	""	no
tags	Additional tags to include	map(string)	{}	no
telegram	Link to social media account - https://...	string	""	no
twitter	Link to social media account - https://...	string	""	no
wechat	Link to social media account - https://...	string	""	no
youtube	Link to social media account - https://...	string	""	no

Outputs

Name	Description
bucket_name	n/a
details_content	n/a
details_endpoint	n/a
id	n/a
network_name	n/a
public_ip	n/a
registration_command	n/a
registration_json	n/a
update_registration_command	n/a

Testing

This module has been packaged with terratest tests

To run them:

1. Install Go
2. Run make test-init from the root of this repo
3. Run make test again from root

Authors

Module managed by robc-io

Credits

• Anton Babenko

License

Apache 2 Licensed. See LICENSE for full details.