Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kkirsche/ansible-generator
Generate ansible directory structures quickly and easily
https://github.com/kkirsche/ansible-generator
ansible automation generator
Last synced: 4 days ago
JSON representation
Generate ansible directory structures quickly and easily
- Host: GitHub
- URL: https://github.com/kkirsche/ansible-generator
- Owner: kkirsche
- License: bsd-4-clause
- Created: 2017-08-10T13:44:02.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-08-05T11:17:24.000Z (over 2 years ago)
- Last Synced: 2024-10-13T18:18:37.918Z (28 days ago)
- Topics: ansible, automation, generator
- Language: Python
- Homepage: https://pypi.python.org/pypi/ansible-generator
- Size: 214 KB
- Stars: 70
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Ansible Generator
## Description
Ansible Generator is a python program designed to simplify creating a new
ansible playbook by creating the necessary directory structure for the user
based on ansible's best practices, as outlined in [content organization best practices](https://docs.ansible.com/ansible/2.8/user_guide/playbooks_best_practices.html#content-organization).
## Installation
### PIP (recommended)
```
pip install -U ansible-generator
```
### Source
```
git clone https://github.com/kkirsche/ansible-generator.git
cd ansible-generator
curl -sSL https://install.python-poetry.org | python3 -
poetry build
```
## Usage
### Help Text
```
usage: ansible-generate [-h] [-a] [-i INVENTORIES [INVENTORIES ...]]
[-r ROLES [ROLES ...]] [-v]
[-p PROJECTS [PROJECTS ...]] [--version]
Generate an ansible playbook directory structure
optional arguments:
-h, --help show this help message and exit
-a, --alternate-layout
-i INVENTORIES [INVENTORIES ...], --inventories INVENTORIES [INVENTORIES ...]
-r ROLES [ROLES ...], --roles ROLES [ROLES ...]
-v, --verbose
-p PROJECTS [PROJECTS ...], --projects PROJECTS [PROJECTS ...]
--version show program's version number and exit
```
#### Defaults
- `alternate-layout` --- `False`
- `verbose` --- `False`
- `inventories` --- `['production', 'staging']`
- `roles` --- `[]`
- `projects` --- `[]`
### Example
#### Current directory
```
ansible-generate
```
#### New-project
```
ansible-generate -p playbook_name
```
#### Alternate Layout
```
ansible-generate -a
```
#### Custom Inventories
```
ansible-generate -i production staging lab
```
#### Roles
This portion of the tool relies on Ansible's `ansible-galaxy` command line
application
```
ansible-generate -r role1 role2
```
#### Output
```
~/Downloads ❯❯❯ ansible-generate -i production staging lab -r common ubuntu centos -a -p network_security_baseline
creating directory /Users/example_user/Downloads/network_security_baseline/roles
creating directory /Users/example_user/Downloads/network_security_baseline/inventories/production/group_vars
creating directory /Users/example_user/Downloads/network_security_baseline/inventories/production/host_vars
creating directory /Users/example_user/Downloads/network_security_baseline/inventories/staging/group_vars
creating directory /Users/example_user/Downloads/network_security_baseline/inventories/staging/host_vars
creating directory /Users/example_user/Downloads/network_security_baseline/inventories/lab/group_vars
creating directory /Users/example_user/Downloads/network_security_baseline/inventories/lab/host_vars
creating file /Users/example_user/Downloads/network_security_baseline/inventories/production/hosts
creating file /Users/example_user/Downloads/network_security_baseline/inventories/staging/hosts
creating file /Users/example_user/Downloads/network_security_baseline/inventories/lab/hosts
creating file /Users/example_user/Downloads/network_security_baseline/site.yml
ansible galaxy output for role common:
- common was created successfully
ansible galaxy output for role ubuntu:
- ubuntu was created successfully
ansible galaxy output for role centos:
- centos was created successfully
```