Home

Welcome to the heiko wiki!

Configuration

Here are a few configuration fields and what they do.

jobs

This field expects a list of jobs in the following fashion.

- name: job_name
  init:
    - init_command_1
    - init_command_2
    ....
  commands:
    - command_1
    - command_2
    ....
  restart: true/false

name

Name field is the name of the job.

init

Commands that are run on heiko init. This field can be left empty.

commands

Commands that are run on heiko start. These are your commands that would be run on one of the nodes and restarted if the flag is set.

restart

Optional field where you specify if the command needs to be constantly restarted. If the command finishes / crashes, this flag is useful to restart it.

nodes

Nodes expects a list of nodes as follows

- name: node_name
  host: ip/hostname
  username: ssh_username
  port: port_number
  password: ssh_password

name

Name of the node that acts like an identifier in heiko.

host

Ip address of the node you want to connect to

username

Username that would be used to ssh into the machine

port

Port number is optional. Default is 22.

When using termux, it's 8022

password

Password of the user to ssh into the node.