testnet-ops/stack-orchestrator-setup/README.md

2.7 KiB

stack-orchestrator-setup

Prerequisites

  • Setup Ansible: To get started, follow the installation guide to setup ansible on your machine.

  • Setup user: Follow steps from Setup a user to setup a new user with passwordless sudo

Setup Stack Orchestrator

This playbook will install Docker and Stack Orchestrator (laconic-so) on the machine if they aren't already present.

Run the following commands in the stack-orchestrator-setup directory.

  • Create a new hosts.ini file:

    cp ../hosts.example.ini hosts.ini
    
  • Edit the hosts.ini file to run the playbook on a remote machine:

    [deployment_host]
    <host_name> ansible_host=<target_ip> ansible_user=<ssh_user> ansible_ssh_common_args='-o ForwardAgent=yes'
    
    • Replace <host_name> with the alias of your choice
    • Replace <target_ip> with the IP address or hostname of the target machine
    • Replace <ssh_user> with the SSH username (e.g., dev, ubuntu)
  • Verify that you are able to connect to the host using the following command

    ansible all -m ping -i hosts.ini -k
    
    # Expected output:
    
    # <host_name> | SUCCESS => {
    #  "ansible_facts": {
    #      "discovered_interpreter_python": "/usr/bin/python3.10"
    #  },
    #  "changed": false,
    #  "ping": "pong"
    # }
    
  • Execute the setup-laconic-so.yml Ansible playbook for setting up stack orchestrator and docker on the target machine:

    LANG=en_US.utf8 ansible-playbook setup-laconic-so.yml  -i hosts.ini  --extra-vars='{ "target_host": "deployment_host"}' --user $USER -kK
    

Verify Installation

  • After the installation is complete, verify if $HOME/bin is already included in your PATH by running:

    echo $PATH | grep -q "$HOME/bin" && echo "$HOME/bin is already in PATH" || echo "$HOME/bin is not in PATH"
    

    If the command outputs "$HOME/bin is not in PATH", you'll need to add it to your PATH.

  • To add $HOME/bin to your PATH, run the following command:

    export PATH="$HOME/bin:$PATH"
    
  • To make this change permanent, add the following line to your shell configuration file (~/.bashrc or ~/.zshrc, depending on your shell):

    # For bash users
    echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc
    source ~/.bashrc
    
    # For zsh users
    echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc
    source ~/.zshrc
    
  • Once the PATH is set, verify the installation by running the following commands:

    # Check version of docker
    docker --version
    
    # Check version of docker compose
    docker compose version
    
    # Check version of Stack Orchestrator
    laconic-so version