mirror of
https://github.com/rocky-linux/ansible-role-pinnwand.git
synced 2024-12-21 20:08:30 +00:00
Initial commit
This commit is contained in:
parent
6b1d1f9492
commit
ea61583f85
39
README.md
39
README.md
@ -1,40 +1,3 @@
|
||||
CI Badge
|
||||
|
||||
# Ansible template role
|
||||
basic Role to use going forward because I forget pieces
|
||||
|
||||
## Getting started
|
||||
Ensure all dependencies are installed and then follow the below process
|
||||
1. `git clone repo` Get the development repository
|
||||
2. `pre-commit install` Install the pre-commit hooks
|
||||
3. Make edits as explained in the customization section
|
||||
4. `pre-commit` Make sure existing code is good
|
||||
5. `do development` Dont ask me :D
|
||||
6. `pre-commit` Make sure the edits are good to go
|
||||
7. `molecule converge`
|
||||
|
||||
## Dependencies
|
||||
This repo expects 3 things installed on the local machine
|
||||
1. [pre-commit](https://pre-commit.com/) Methodology to test yaml style
|
||||
2. [ansible-lint](https://github.com/ansible-community/ansible-lint) lint ansible code for best practices
|
||||
3. [yamllint](https://github.com/adrienverge/yamllint) Ensures all yaml is well formed
|
||||
|
||||
### Customization
|
||||
There are a few files that are required to be updated when using this template
|
||||
1. [molecule/requirements.yml](molecule/requirements.yml) - Update with any required roles or collections
|
||||
2. [molecule/default/converge.yml](molecule/default/converge.yml) - update with new role name
|
||||
3. [molecule/default/molecule.yml](molecule/default/molecule.yml) - update with desired distributions and extra playbooks
|
||||
4. [github](github) - Rename to `.github` and push, this will set up yamllint, ansible-lint and a CI check job for the `main` branch
|
||||
1. NOTE: If you are using a SAML token this may fail. You can created the files within the Github web app
|
||||
|
||||
### Optional
|
||||
The github actions are configured to automatically run the molecule tests but if you want to load them locally you will also need molecule installed on the development machine
|
||||
|
||||
## Advanced
|
||||
|
||||
There are numerous other options within the [defaults/main.yml](./defaults/main.yml) that can change other parts of the behavior of the system
|
||||
|
||||
## Changelog
|
||||
The [changelog](./CHANGELOG.md) is stored externally
|
||||
|
||||
|
||||
# Ansible role for pinnwand
|
||||
|
@ -1,11 +1,11 @@
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: Neil Hanlon
|
||||
description: Setup/Configure Pinnwand Pastebin
|
||||
company: Rocky Enterprise Software Foundation
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
issue_tracker_url: http://github.com/rocky-linux/ansible-role-pinnwand/issues
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
@ -14,7 +14,7 @@ galaxy_info:
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: MIT
|
||||
license: BSD-3-Clause
|
||||
|
||||
min_ansible_version: 2.8
|
||||
|
||||
@ -50,4 +50,3 @@ galaxy_info:
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
@ -10,4 +10,4 @@
|
||||
changed_when: false
|
||||
|
||||
roles:
|
||||
- role: ansible-role-mycoolrole
|
||||
- role: ansible-role-pinnwand
|
||||
|
@ -14,7 +14,7 @@ driver:
|
||||
# ansible-lint
|
||||
platforms:
|
||||
- name: instance
|
||||
image: "geerlingguy/docker-${MOLECULE_DISTRO:-centos7}-ansible:latest"
|
||||
image: "geerlingguy/docker-${MOLECULE_DISTRO:-centos8}-ansible:latest"
|
||||
command: ${MOLECULE_DOCKER_COMMAND:-""}
|
||||
volumes:
|
||||
- /sys/fs/cgroup:/sys/fs/cgroup:ro
|
||||
|
Loading…
Reference in New Issue
Block a user