https://github.com/lvillani/ansible-tools

Keyring integration and local execution wrappers for Ansible
https://github.com/lvillani/ansible-tools

ansible

Last synced: 2 months ago
JSON representation

Keyring integration and local execution wrappers for Ansible

• Host: GitHub
• URL: https://github.com/lvillani/ansible-tools
• Owner: lvillani
• Created: 2015-05-03T12:36:10.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-03-29T10:17:14.000Z (over 4 years ago)
• Last Synced: 2024-09-30T01:42:40.263Z (3 months ago)
• Topics: ansible
• Language: Python
• Homepage:
• Size: 32.2 KB
• Stars: 18
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ansible-tools

[![PyPI Version](https://img.shields.io/pypi/v/ansible-tools.svg)](https://pypi.python.org/pypi/ansible-tools)

[![PyPI Downloads](https://img.shields.io/pypi/dm/ansible-tools.svg)](https://pypi.python.org/pypi/ansible-tools)

[![MIT License](https://img.shields.io/badge/license-mit-blue.svg)](https://choosealicense.com/licenses/mit/)

This is a set of wrappers around the `ansible`, `ansible-playbook` and `ansible-vault` commands

which integrate with the system keyring to retrieve the vault password.

It should work on both Linux and macOS.

# Installation

* On macOS, with Homebrew: `brew install lvillani/tap/ansible-tools`;

* With Pip: `pip install --user ansible-tools`;

It is best, however, to install `ansible-tools` in a Virtualenv, along with the version of Ansible

you are using.

# Overview

- `ansible-vault-helper`: Used by users to setup keyring integration, called by Ansible to obtain a

  Vault unlock password.

- `vaultify`: Wraps Ansible commands such as `ansible`, `ansible-playbook` and `ansible-playbook` so

  that the Vault is automatically unlocked with the password stored in the system's keyring.

- `ansible-local`: Wrapper to run Ansible locally.

- `ansible-mkpasswd`: Generates an encrypted password that can be used with the user module (see also

  [here](https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#how-do-i-generate-encrypted-passwords-for-the-user-module))

# Usage

Go to the same directory that contains your playbooks and then run:

    ansible-vault-helper --update

You will be prompted for a vault name (which can be anything) and the unlock password. The former is

stored in `ansible.cfg` alongside your playbooks, the latter is securely stored in your keyring.

At this point you can run Ansible as usual but precede the command with `vaultify`. That is, to

start a playbook run:

    vaultify ansible-playbook site.yml

We also ship a tool to easily apply a playbook on the current system called `ansible-local` which is

composable with `vaultify`.

# Aliases

Here's a list of handy shell aliases to make your life easier. They were tested on fish but should

work also on Bash and Zsh:

    alias v="vault"

    alias ansible="vaultify ansible"

    alias ansible-playbook="vaultify ansible-playbook"