Skip to content

Latest commit

 

History

History
117 lines (88 loc) · 3.67 KB

README.md

File metadata and controls

117 lines (88 loc) · 3.67 KB
Raw

Azure Validator Node

This repository contains scripts and configurations to set up and manage an Azure Validator Node using Terraform and Ansible.

Overview

  • Terraform: Used to provision the necessary Azure infrastructure for the Validator Node.
  • Ansible: Used to configure the provisioned infrastructure and deploy the Validator Node.

Requirements

Before you begin, ensure you have the following installed on your local machine:

Pre-requisites

  1. Authenticate with Azure CLI:

    az login

  2. Clone the repository:

    git clone https://github.com/ten-protocol/ten-validator.git
cd ten-validator

  3. Configure Azure Subscription: Ensure your Azure subscription is set correctly:

    az account set --subscription "your-subscription-name"

Terraform Setup

Initialize and Apply Terraform Configuration

  1. Navigate to the Terraform directory:

    cd terraform

  2. Copy the example terraform.tfvars file and edit it:

    cp terraform.tfvars.example terraform.tfvars
# Edit terraform.tfvars with your preferred settings

  3. Initialize Terraform:

    terraform init

  4. Apply the Terraform configuration:

    terraform apply

    Follow the prompts to confirm the infrastructure changes.

  5. Retrieve SSH Key and Login Script:

    chmod +x get-key.sh
./get-key.sh

Ansible Deployment

Deploy the Validator Node

  1. Run the installation script: 
    chmod +x install-ten.sh
./install-ten.sh

You will need to provide the following information:

  • Host ID (public key of the validator node wallet)
  • Private Key (private key of the validator node wallet)
  • Host Public P2P Address (public IP address or DNS name of the validator node)
  • Host ssh username (default is tenuser)*
  • Host ssh password or path to ssh key file*
  • L1 WS URL (geth client, Infura, etc.websocket URL of the L1 node)
  • Postgres DB Host (leave blank if unsure or want to provision a new one)

* Note: If you used terraform to provision the VM, you can just press enter and choose the default values.

Additional Information

  • Clear Terraform State: If you need to destroy the infrastructure and clear the Terraform state, run:

    chmod +x clear.sh
./clear.sh

  • Environment Variables: Ensure that all necessary environment variables are set as per the ansible/files/node.env.example file.

  • Network Configuration: The network settings are defined in ansible/files/network_vars.yml and should not be changed unless necessary.

Troubleshooting

  • Ensure all dependencies are installed and accessible in your system's PATH.
  • Verify that your Azure CLI is authenticated and set to the correct subscription.
  • Check that your terraform.tfvars and hosts.ini files are correctly configured.

For further assistance, refer to the official documentation of each tool or reach out to the project maintainers.