teloshost

This repository contains Ansible role to setup and configure a teloshost.

A teloshost is an Ubuntu server that we provision in an opinionated way. The objective is to streamline management of servers provisioned regardless of their ultimate purpose.

This ansible role ensures that:

1. Base system is configured.
2. System packages are installed.
3. Requested service installations and configurations are performed.
4. Monitoring is setup.

Requirements

Teloshost requires the following roles to be installed (if enabled):

ansible-galaxy install caddy_ansible.caddy_ansible
ansible-galaxy install dj-wasabi.telegraf
ansible-galaxy install geerlingguy.docker

Role Variables

Variables can be set in one of these locations (from least to highest presendence) among many others:

1. inventory configuration (for all hosts): all.vars.teloshost__{*}
2. inventory configuration (for specific hosts): all.hosts.<hostname>.teloshost__{*}
3. variables file: teloshost__{*}

To avoid inventory host specific timezone to be overridden by variables file, it is not advised to set this variable in anywhere else then the inventory configuration.

For further information about the variable presendence, see:

https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html#variable-precedence-where-should-i-put-a-variable

Configuration Variables

Group	Variables	Provision	Type	Default	Notes
global	inventory_hostname	static	string	provided by Ansible
global	ansible_user_id	static	string	provided by Ansible	Username used to establish the SSH connection with
global	teloshost__logfile	static	path	provided by playbook	Set to /var/log/teloshost.yaml
global	teloshost__username	static	string	provided by playbook	Set to patron
base	teloshost__base__timezone	variable	string	UTC
base	teloshost__base__ssh__authorized_keys__common	variable	list of strings	[]	A list of GitHub logins
base	teloshost__base__ssh__authorized_keys__extras	variable	list of strings	[]	A list of GitHub logins
base	teloshost__base__packages__common	static	list of strings	provided by Ansible	Default system packages to be installed.
base	teloshost__base__packages__extras	variable	list of strings	[]	List of extra system packages to be installed.
caddy	teloshost__caddy__enable	variable	boolean	false	Indication to enable Caddy service or not
docker	teloshost__docker__enable	variable	boolean	false	Indication to enable Docker service or not
docker	teloshost__docker__ctop_version	variable	string	0.7.7	Version of ctop to be installed
monitoring	teloshost__monitoring__enable	variable	boolean	true
monitoring	teloshost__monitoring__telegraf__url	variable	string
monitoring	teloshost__monitoring__telegraf__token	variable	string
monitoring	teloshost__monitoring__telegraf__bucket	variable	string
monitoring	teloshost__monitoring__telegraf__organization	variable	string

Dependencies

None

Example Playbook

- name: Setup a teloshost
  hosts: all
  become: true
  roles:
    - name: teloshost

License

MIT