Nomad

SEEKING ACTIVE MAINTAINERSHIP

It is my sincere hope that you or your organization has found some use in this project over the years that we have all worked on it together. With that said, I have largely moved on in my personal life and career path in ways that have essentially removed Ansible from daily use for me.

Rather than abandon the project, I'm calling for interested parties to fork it and take over active maintainership so that it can continue on and receive more timely attention.

The maintenance essentially consists of code review, issues, and merging pull requests as there are quite a few active contributors.

You do not necessarily need to be a developer on the project and write code, etc. to maintain it. If you are interested in taking over maintainership of this project, please reach out and let me know.

This Ansible role performs basic Nomad installation, including filesystem structure, and example configuration.

It will also bootstrap a minimal cluster of 3 server nodes, and can do this in a development environment based on Vagrant and VirtualBox. See README_VAGRANT.md for more details about the Vagrant setup.

Requirements

This role requires an Arch Linux, Debian, RHEL, or Ubuntu distribution; the role is tested with the following specific software versions:

Ansible: 2.7.10
nomad: 0.10.3
Arch Linux
CentOS: 7
Debian: 8
RHEL: 7
Ubuntu: 16.04

Role Variables

The role defines most of its variables in defaults/main.yml:

`nomad_debug`

Nomad debug mode
Default value: no

`nomad_version`

Nomad version to install
Default value: 0.10.3

`nomad_architecture_map`

This variable does not need to be changed in most cases
Default value: Dictionary translating ansible_architecture to HashiCorp architecture naming convention

`nomad_architecture`

Host architecture
Default value: determined by {{ nomad_architecture_map[ansible_architecture] }}

`nomad_pkg`

Nomad package filename
Default value: nomad_{{ nomad_version }}_linux_{{ nomad_architecture }}.zip

`nomad_zip_url`

Nomad download URL
Default value: https://releases.hashicorp.com/nomad/{{ nomad_version }}/nomad_{{ nomad_version }}_linux_{{ nomad_architecture }}.zip

`nomad_checksum_file_url`

Nomad checksum file URL
Default value: https://releases.hashicorp.com/nomad/{{ nomad_version }}/nomad_{{ nomad_version}}_SHA256SUMS

`nomad_bin_dir`

Nomad binary installation path
Default value: /usr/local/bin

`nomad_config_dir`

Nomad configuration file path
Default value: /etc/nomad.d

`nomad_data_dir`

Nomad data path
Default value: /var/nomad

`nomad_lockfile`

Nomad lockfile path
Default value: /var/lock/subsys/nomad

`nomad_run_dir`

Nomad run path
Default value: /var/run/nomad

`nomad_manage_user`

Manage Nomad user?
Default value: yes

`nomad_user`

Nomad OS username
Default value: root

`nomad_manage_group`

Manage Nomad group?
Default value: no

`nomad_group`

Nomad OS group
Default value: bin

`nomad_region`

Default region
Default value: global

`nomad_datacenter`

Nomad datacenter label
Default value: dc1

`nomad_log_level`

Logging level
Default value: INFO

`nomad_syslog_enable`

Log to syslog
Default value: true

`nomad_iface`

Nomad network interface
Default value: {{ ansible_default_ipv4.interface }}

`nomad_node_name`

Nomad node name
Default value: {{ inventory_hostname_short }}

`nomad_node_role`

Nomad node role
options: client, server, both
Default value: client

`nomad_leave_on_terminate`

Send leave on termination
Default value: yes

`nomad_leave_on_interrupt`

Send leave on interrupt
Default value: no

`nomad_disable_update_check`

Disable update check
Default value: no

`nomad_retry_max`

Max retry join attempts
Default value: 0

`nomad_retry_join`

Enable retry join?
Default value: no

`nomad_retry_interval`

Retry join interval
Default value: 30s

`nomad_rejoin_after_leave`

Rejoin after leave?
Default value: no

`nomad_enabled_schedulers`

List of enabled schedulers
Default value: service, batch, system

`nomad_num_schedulers`

Number of schedulers
Default value: {{ ansible_processor_vcpus }}

`nomad_node_gc_threshold`

Node garbage collection threshold
Default value: 24h

`nomad_job_gc_threshold`

Job garbage collection threshold
Default value: 4h

`nomad_eval_gc_threshold`

Eval garbage collection threshold
Default value: 1h

`nomad_encrypt`

Encryption secret for gossip communication
Default value: ""

`nomad_authoritative_region`

Specifies the authoritative region, which provides a single source of truth for global configurations such as ACL Policies and global ACL tokens.
Default value: ""

`nomad_node_class`

Nomad node class
Default value: ""

`nomad_no_host_uuid`

Force the UUID generated by the client to be randomly generated
Default value: no

`nomad_max_kill_timeout`

Max kill timeout
Default value: 30s

`nomad_network_interface`

Nomad scheduler will choose from the IPs of this interface for allocating tasks
Default value: none

`nomad_network_speed`

Overide network link speed (0 = no overide)
Default value: 0

`nomad_cpu_total_compute`

Overide cpu compute (0 = no overide)
Default value: 0

`nomad_gc_interval`

Client garbage collection interval
Default value: 1m

`nomad_gc_disk_usage_threshold`

Disk usage threshold percentage for garbage collection
Default value: 80

`nomad_gc_inodes_usage_threshold`

Inode usage threshold percentage for garbage collection
Default value: 70

`nomad_gc_parallel_destroys`

Garbage collection max parallel destroys
Default value: 2

`nomad_reserved`

Reserved client resources
Default value: cpu: {{ nomad_reserved_cpu }}, memory: {{ nomad_reserved_memory }}, disk: {{ nomad_reserved_disk }}, ports: {{ nomad_reserved_ports }}

`nomad_reserved_cpu`

Reserved client CPU
Default value: 0

`nomad_reserved_memory`

Reserved client memory
Default value: 0

`nomad_reserved_disk`

Reserved client disk
Default value: 0

`nomad_reserved_ports`

Reserved client ports
Default value: 22

`nomad_host_volumes`

List host_volume is used to make volumes available to jobs (Stateful Workloads).
Default value: []
Example:

nomad_host_volumes:
  - name: data
    path: /var/data
    owner: root
    group: bin
    mode: 0755
    read_only: false
  - name: config
    path: /etc/conf
    owner: root
    group: bin
    mode: 0644
    read_only: false

`nomad_options`

Driver options
Key value dict
Default value: {}

`nomad_chroot_env`

chroot environment definition for the Exec and Java drivers
Key value dict
Default value: false

`nomad_meta`

Meta data
Key value dict
Default value: {}

`nomad_bind_address`

Bind interface address
Default value: {{ hostvars[inventory_hostname]['ansible_'+ nomad_iface ]['ipv4']['address'] }}

`nomad_advertise_address`

Network interface address to advertise to other nodes
Default value: {{ hostvars[inventory_hostname]['ansible_'+ nomad_iface ]['ipv4']['address'] }}

`nomad_ports`

Ports used by Nomad
Default value: http: {{ nomad_ports_http }}, rpc: {{ nomad_ports_rpc }}, serf: {{ nomad_ports_serf }}

`nomad_ports_http`

Http port
Default value: 4646

`nomad_ports_rpc`

RPC port
Default value: 4647

`nomad_ports_serf`

Serf port
Default value: 4648

`nomad_docker_enable`

Install Docker subsystem on nodes?
Default value: false

`nomad_group_name`

Ansible group that contains all cluster nodes
Default value: nomad_instances

`nomad_servers`

It's typically not necessary to manually alter this list.

List of server nodes
Default value: List of all nodes in nomad_group_name with nomad_node_role set to server or both

`nomad_gather_server_facts`

This feature makes it possible to gather the nomad_bind_address and nomad_advertise_address from servers that are currently not targeted by the playbook.

To make this possible the delegate_facts option is used. This option is broken in many Ansible versions, so this feature might not always work.

Gather facts from servers that are not currently targeted
Default value: 'no'

`nomad_use_consul`

Bootstrap nomad via native consul zero-configuration support assumes consul default ports etc.
Default value: False

`nomad_consul_address`

The address of your consul API, use it in combination with nomad_use_consul=True
Default value: localhost:8500

`nomad_consul_servers_service_name`

The name of the consul service for your nomad servers
Default value: nomad-servers

`nomad_consul_clients_service_name`

The name of the consul service for your nomad clients
Default value: nomad-clients

`nomad_consul_token`

Token to use for consul interaction
Default value: ""

`nomad_bootstrap_expect`

Specifies the number of server nodes to wait for before bootstrapping.
Default value: `{{ nomad_servers | count or 3 }}}

`nomad_acl_enabled`

Enable ACLs
Default value: no

`nomad_acl_token_ttl`

TTL for tokens
Default value: "30s"

`nomad_acl_policy_ttl`

TTL for policies
Default value: "30s"

`nomad_acl_replication_token`

Token to use for acl replication on non authoritive servers
Default value: ""

`nomad_vault_enabled`

Enable vault
Default value: no

`nomad_vault_address`

Vault address to use
Default value: {{ vault_address | default('0.0.0.0') }}

`nomad_vault_allow_unauthenticated`

Allow users to use vault without providing their own token
Default value: yes

`nomad_vault_create_from_role`

Role to create tokens from
Default value: ""

`nomad_vault_ca_file`

Path of CA cert to use with vault
Default value: ""

`nomad_vault_ca_path`

Path of a folder containing CA cert(s) to use with vault
Default value: ""

`nomad_vault_cert_file`

Path to a certificate to use with vault
Default value: ""

`nomad_vault_key_file`

Path to a private key file to use with vault
Default value: ""

`nomad_vault_tls_server_name`

Optional string used to set SNI host when connecting to vault
Default value: ""

`nomad_vault_tls_skip_verify`

Specifies if SSL peer validation should be enforced
Default value: no

`nomad_vault_token`

Vault token used by nomad
Default value: ""

`nomad_docker_enable`

Enable docker
Default value: no

`nomad_docker_dmsetup`

Run dmsetup on ubuntu (only if docker is enabled)
Default value: yes

`nomad_ca_file`

Use a ca for tls connection, nomad_cert_file and nomad_key_file are needed
Default value: ""

`nomad_cert_file`

Use a certificate for tls connection, nomad_ca_file and nomad_key_file are needed
Default value: ""

`nomad_key_file`

Use a key for tls connection, nomad_cert_file and nomad_key_file are needed
Default value: ""

Custom Configuration Section

As Nomad loads the configuration from files and directories in lexical order, typically merging on top of previously parsed configuration files, you may set custom configurations via nomad_config_custom, which will be expanded into a file named custom.json within your nomad_config_dir which will be loaded after all other configuration by default.

An example usage for enabling vault:

  vars:
    nomad_config_custom:
      vault:
        enabled          : true
        ca_path          : "/etc/certs/ca"
        cert_file        : "/var/certs/vault.crt"
        key_file         : "/var/certs/vault.key"
        address          : "https://vault.service.consul:8200"
        create_from_role : "nomad-cluster"

Dependencies

Ansible requires GNU tar and this role performs some local use of the unarchive module, so ensure that your system has gtar/unzip installed. Jinja2 templates use ipaddr filter that need netaddr python library.

Example Playbook

Basic nomad installation is possible using the included site.yml playbook:

ansible-playbook -i <hosts> site.yml

You can also simply pass variables in using the --extra-vars option to the ansible-playbook command:

ansible-playbook -i hosts site.yml --extra-vars "nomad_datacenter=maui"

Vagrant and VirtualBox

See examples/README_VAGRANT.md for details on quick Vagrant deployments under VirtualBox for testing, etc.

License

BSD

Author Information

Brian Shumate

Contributors

Special thanks to the folks listed in CONTRIBUTORS.md for their contributions to this project.

Contributions are welcome, provided that you can agree to the terms outlined in CONTRIBUTING.md

Name		Name	Last commit message	Last commit date
Latest commit History 223 Commits
defaults		defaults
examples		examples
files		files
handlers		handlers
meta		meta
tasks		tasks
templates		templates
tests		tests
vars		vars
.gitignore		.gitignore
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS.md		CONTRIBUTORS.md
LICENSE		LICENSE
README.md		README.md
version.txt		version.txt

License

ducminhle/ansible-nomad

Folders and files

Latest commit

History

Repository files navigation

Nomad

SEEKING ACTIVE MAINTAINERSHIP

Requirements

Role Variables

nomad_debug

nomad_version

nomad_architecture_map

nomad_architecture

nomad_pkg

nomad_zip_url

nomad_checksum_file_url

nomad_bin_dir

nomad_config_dir

nomad_data_dir

nomad_lockfile

nomad_run_dir

nomad_manage_user

nomad_user

nomad_manage_group

nomad_group

nomad_region

nomad_datacenter

nomad_log_level

nomad_syslog_enable

nomad_iface

nomad_node_name

nomad_node_role

nomad_leave_on_terminate

nomad_leave_on_interrupt

nomad_disable_update_check

nomad_retry_max

nomad_retry_join

nomad_retry_interval

nomad_rejoin_after_leave

nomad_enabled_schedulers

nomad_num_schedulers

nomad_node_gc_threshold

nomad_job_gc_threshold

nomad_eval_gc_threshold

nomad_encrypt

nomad_authoritative_region

nomad_node_class

nomad_no_host_uuid

nomad_max_kill_timeout

nomad_network_interface

nomad_network_speed

nomad_cpu_total_compute

nomad_gc_interval

nomad_gc_disk_usage_threshold

nomad_gc_inodes_usage_threshold

nomad_gc_parallel_destroys

nomad_reserved

nomad_reserved_cpu

nomad_reserved_memory

nomad_reserved_disk

nomad_reserved_ports

nomad_host_volumes

nomad_options

nomad_chroot_env

nomad_meta

nomad_bind_address

nomad_advertise_address

nomad_ports

nomad_ports_http

nomad_ports_rpc

nomad_ports_serf

nomad_docker_enable

nomad_group_name

nomad_servers

nomad_gather_server_facts

nomad_use_consul

nomad_consul_address

nomad_consul_servers_service_name

nomad_consul_clients_service_name

`nomad_debug`

`nomad_version`

`nomad_architecture_map`

`nomad_architecture`

`nomad_pkg`

`nomad_zip_url`

`nomad_checksum_file_url`

`nomad_bin_dir`

`nomad_config_dir`

`nomad_data_dir`

`nomad_lockfile`

`nomad_run_dir`

`nomad_manage_user`

`nomad_user`

`nomad_manage_group`

`nomad_group`

`nomad_region`

`nomad_datacenter`

`nomad_log_level`

`nomad_syslog_enable`

`nomad_iface`

`nomad_node_name`

`nomad_node_role`

`nomad_leave_on_terminate`

`nomad_leave_on_interrupt`

`nomad_disable_update_check`

`nomad_retry_max`

`nomad_retry_join`

`nomad_retry_interval`

`nomad_rejoin_after_leave`

`nomad_enabled_schedulers`

`nomad_num_schedulers`

`nomad_node_gc_threshold`

`nomad_job_gc_threshold`

`nomad_eval_gc_threshold`

`nomad_encrypt`

`nomad_authoritative_region`

`nomad_node_class`

`nomad_no_host_uuid`

`nomad_max_kill_timeout`

`nomad_network_interface`

`nomad_network_speed`

`nomad_cpu_total_compute`

`nomad_gc_interval`

`nomad_gc_disk_usage_threshold`

`nomad_gc_inodes_usage_threshold`

`nomad_gc_parallel_destroys`

`nomad_reserved`

`nomad_reserved_cpu`

`nomad_reserved_memory`

`nomad_reserved_disk`

`nomad_reserved_ports`

`nomad_host_volumes`

`nomad_options`

`nomad_chroot_env`

`nomad_meta`

`nomad_bind_address`

`nomad_advertise_address`

`nomad_ports`

`nomad_ports_http`

`nomad_ports_rpc`

`nomad_ports_serf`

`nomad_docker_enable`

`nomad_group_name`

`nomad_servers`

`nomad_gather_server_facts`

`nomad_use_consul`

`nomad_consul_address`

`nomad_consul_servers_service_name`

`nomad_consul_clients_service_name`

`nomad_consul_token`

`nomad_bootstrap_expect`

`nomad_acl_enabled`

`nomad_acl_token_ttl`

`nomad_acl_policy_ttl`

`nomad_acl_replication_token`

`nomad_vault_enabled`

`nomad_vault_address`

`nomad_vault_allow_unauthenticated`

`nomad_vault_create_from_role`