Project Setup

• Copy and edit:

  cp inventory/hosts.example inventory/hosts.yml
  cp inventory/group_vars/all.example inventory/group_vars/all
  

• inventory/hosts.yml: define hosts in network_node and ml_node with ansible_host; for ML hosts add inference_node_ip (prefer private/local address). Add groups node_net_deploy, node_ml_deploy as needed, and account groups if using per-node vars. Use inventory/hosts.example as structure reference.
• inventory/group_vars/all: set at minimum ansible_user, ansible_ssh_private_key_file. Optionally: keyring_password, seed_host, RPC/dashboard URLs, telegram_bot_token, telegram_chat_id.
• Do not commit these files (they are in .gitignore).

3. Per-node variables (if needed)

• For each node: copy inventory/group_vars/node.example → inventory/group_vars/nodeN.yml (e.g. node1.yml, node2.yml):

  cp inventory/group_vars/node.example inventory/group_vars/node1.yml
  

• Fill in: account_name, host, poc_callback_url, account_address, account_pubkey. Optionally override telegram_chat_id per node.
• Do not commit inventory/group_vars/node* files (except *.example).

4. Run playbooks (menu or direct)

• Recommended: run ./start.sh and pick an option by number (deploy, check setup, ping, etc.).
• Or run playbooks directly, e.g. deploy: playbooks/ml/deploy.yml, playbooks/network/deploy.yml; checks: playbooks/network/check.yml, playbooks/ml/check_poc.yml.

5. Verify setup (nodes)

• Verify connectivity to nodes: ./start.sh → option 3 (Ping all hosts), or:

  ansible-playbook playbooks/common/ping.yml
  

• Optionally run ./start.sh → option 2 (Check setup) or ansible-playbook playbooks/common/check_setup.yml for a fuller check.

Project configuration

• ansible.cfg: inventory = ./inventory/hosts.yml, roles_path = ./roles
• Run playbooks via menu: ./start.sh
• Logs and backups: logs/, backup/ — in .gitignore

Do not commit

• inventory/hosts.yml, inventory/hosts
• inventory/group_vars/* (except *.example)
• inventory/host_vars/
• .vault_pass, .vault_pass.txt
• backup/, logs/, local/, .env

Quick checklist

When reporting setup status, output a table with emoji: ✅ — done, ❌ — not done.

Checklist for the user:

• Ansible installed
• inventory/hosts.yml created from hosts.example and filled in
• inventory/group_vars/all created from all.example with ansible_user and key set
• If needed, inventory/group_vars/nodeN.yml created from node.example
• playbooks/common/ping.yml run successfully (nodes reachable)