Adding in Ansible (still a WIP).
This commit is contained in:
@@ -0,0 +1,68 @@
|
||||
# Rinoa Docker_configs Collection
|
||||
|
||||
This repository contains the `rinoa.docker_configs` Ansible Collection.
|
||||
|
||||
## Tested with Ansible
|
||||
|
||||
Tested with ansible-core >=2.14 releases and the current development version of ansible-core.
|
||||
|
||||
## External requirements
|
||||
|
||||
Some modules and plugins require external libraries. Please check the requirements for each plugin or module you use in the documentation to find out which requirements are needed.
|
||||
|
||||
## Included content
|
||||
|
||||
Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/rinoa/docker_configs).
|
||||
|
||||
## Using this collection
|
||||
|
||||
```
|
||||
ansible-galaxy collection install rinoa.docker_configs
|
||||
```
|
||||
|
||||
You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format:
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
- name: rinoa.docker_configs
|
||||
```
|
||||
|
||||
To upgrade the collection to the latest available version, run the following command:
|
||||
|
||||
```bash
|
||||
ansible-galaxy collection install rinoa.docker_configs --upgrade
|
||||
```
|
||||
|
||||
You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax where `X.Y.Z` can be any [available version](https://galaxy.ansible.com/rinoa/docker_configs):
|
||||
|
||||
```bash
|
||||
ansible-galaxy collection install rinoa.docker_configs:==X.Y.Z
|
||||
```
|
||||
|
||||
See [Ansible Using Collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
|
||||
|
||||
## Release notes
|
||||
|
||||
See the [changelog](https://github.com/ansible-collections/rinoa.docker_configs/tree/main/CHANGELOG.rst).
|
||||
|
||||
## Roadmap
|
||||
|
||||
<!-- Optional. Include the roadmap for this collection, and the proposed release/versioning strategy so users can anticipate the upgrade/update cycle. -->
|
||||
|
||||
## More information
|
||||
|
||||
<!-- List out where the user can find additional information, such as working group meeting times, slack/IRC channels, or documentation for the product this collection automates. At a minimum, link to: -->
|
||||
|
||||
- [Ansible Collection overview](https://github.com/ansible-collections/overview)
|
||||
- [Ansible User guide](https://docs.ansible.com/ansible/devel/user_guide/index.html)
|
||||
- [Ansible Developer guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)
|
||||
- [Ansible Collections Checklist](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst)
|
||||
- [Ansible Community code of conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html)
|
||||
- [The Bullhorn (the Ansible Contributor newsletter)](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn)
|
||||
- [News for Maintainers](https://github.com/ansible-collections/news-for-maintainers)
|
||||
|
||||
## Licensing
|
||||
|
||||
GNU General Public License v3.0 or later.
|
||||
|
||||
See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.
|
||||
@@ -0,0 +1,57 @@
|
||||
Rinoa.Docker_configs Run Role
|
||||
========================
|
||||
|
||||
A brief description of the role is here.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Any prerequisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. host vars, group vars, etc.) should be mentioned here as well.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
|
||||
```yaml
|
||||
- name: Execute tasks on servers
|
||||
hosts: servers
|
||||
roles:
|
||||
- role: rinoa.docker_configs.run
|
||||
run_x: 42
|
||||
```
|
||||
|
||||
Another way to consume this role would be:
|
||||
|
||||
```yaml
|
||||
- name: Initialize the run role from rinoa.docker_configs
|
||||
hosts: servers
|
||||
gather_facts: false
|
||||
tasks:
|
||||
- name: Trigger invocation of run role
|
||||
ansible.builtin.include_role:
|
||||
name: rinoa.docker_configs.run
|
||||
vars:
|
||||
run_x: 42
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
# TO-DO: Update the license to the one you want to use (delete this line after setting the license)
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
- name: Debug print task-1
|
||||
ansible.builtin.debug:
|
||||
msg: "This is task-1"
|
||||
|
||||
- name: Debug print task-2
|
||||
ansible.builtin.debug:
|
||||
msg: "This is task-2"
|
||||
|
||||
- name: Debug print task-3
|
||||
ansible.builtin.debug:
|
||||
msg: "This is task-3"
|
||||
Reference in New Issue
Block a user