touchstone

Touchstone

Ansible Galaxy enabled role to easily make sets of plays, roles or tasks idempotent. This is critical for some sequence declarations. For example if one role does partitioning, and another does formatting. Re-applying that sequence in the future stands a good chance of wrecking your data.

Requirements

Same as stock Ansible 2.3+

Role Variables

touch_touchstone:

When true, mark the end-state or completion identified by stone_name.

stone_name:

Optional, identification string to use when multiple end-states must be tracked. For example multiple playbooks. Defaults to .touchstone.

touchstone_filepath:

Optional, directory path where the touchstone will be checked or written. Must be a permanent, and writable directory for ansible_user, i.e. not a tmpdir based /tmp. A lock file will be created/checked in this directory whether or not the touchstone is touched.

stone_touched:

A boolean value, set during the role to reflect the current touchstone state. When True, it indicates the stone was touched at least once in the past.

touchstone_template:

Optional, full path to jinja2 template used for generating the touchstone file contents.

Dependencies

A systemd-based machine with a unique /etc/machine-id.

Example Playbook

- hosts: all
  roles:
     - role: cevich.touchstone

     - role: something
       when: not stone_touched

     - role: another_thing
       when: not stone_touched

     - role: final_thing
       when: not stone_touched

     - role: cevich.touchstone
       touch_touchstone: True

License

Easily make sets of plays, roles or tasks idempotent. Copyright (C) 2017 Christopher C. Evich

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.