chore(): Update changes from code review

Blank lines at end of documents
rewording some docs
Spacing between ansible-lint-ignore rules
Variable names
remove uneccessry info in teams.md
changed description index
changed description teams.md
This commit is contained in:
2024-08-19 16:16:59 +09:30
parent eee170f5cc
commit 1ef25b31d9
6 changed files with 33 additions and 22 deletions

View File

@ -1,5 +1,8 @@
galaxy.yml galaxy[version-incorrect] galaxy.yml galaxy[version-incorrect]
# This playbook will only ever be run against the centurion host
# N/A as the play runs on the ansible controller and should only run once.
playbooks/teams.yaml run-once[task] playbooks/teams.yaml run-once[task]
# This task only saves the report on the local machine and is deleted after uploading
playbooks/inventory.yaml risky-file-permissions # N/A as the play runs on the ansible controller using permissions of executing user.
playbooks/inventory.yaml risky-file-permissions

View File

@ -1,6 +1,6 @@
--- ---
title: Playbooks title: Playbooks
description: No Fuss Computings Companion Ansible Collection Centurion Playbooks. description: Playbooks as part of No Fuss Computings Companion Ansible Collection, Centurion
date: 2024-08-18 date: 2024-08-18
template: project.html template: project.html
about: https://github.com/nofusscomputing/ansible_collection_centurion about: https://github.com/nofusscomputing/ansible_collection_centurion
@ -10,3 +10,4 @@ Available playbooks include:
- [Inventory](./inventory.md) - [Inventory](./inventory.md)
- [Teams](./teams.md) - [Teams](./teams.md)

View File

@ -1,12 +1,12 @@
--- ---
title: Inventory title: Inventory
description: Inventory host machines and publish to Centurion ERP description: Inventory devices and publish to Centurion ERP
date: 2024-08-19 date: 2024-08-19
template: project.html template: project.html
about: https://github.com/nofusscomputing/ansible_collection_centurion about: https://github.com/nofusscomputing/ansible_collection_centurion
--- ---
The inventory playbook has been created to inventory host machines and to publish the collected inventory to Centurion ERP. The inventory includes details of all software packages installed on the host machine as well as some details regarding the host machine such as UUID and serial number. The inventory playbook has been created to inventory devices and to publish the collected inventory to Centurion ERP. The inventory includes details of all software packages installed on the host machine as well as some details regarding the host machine such as UUID and serial number.
The inventory playbook includes the [AWX Feature](../../../playbooks/awx.md) to import the playbook as a job template in AWX / Ansible Automation Platform. The inventory playbook includes the [AWX Feature](../../../playbooks/awx.md) to import the playbook as a job template in AWX / Ansible Automation Platform.
@ -28,6 +28,6 @@ The inventory playbook conducts the follwoing tasks:
- Gathers host information - Gathers host information
- Gathers sofware information - Gathers sofware information
- POSTS an inventory report to Centurion ERP - Uploads the inventory report to Centurion ERP
- Cleans any leftover files used to create the reports - Cleans any leftover files used to create the reports

View File

@ -1,6 +1,6 @@
--- ---
title: Teams title: Teams
description: Creation and patching of teams and permissions. description: Ansible Playbook for Creating and patching of Centurion ERP teams, including permissions.
date: 2024-08-18 date: 2024-08-18
template: project.html template: project.html
about: https://github.com/nofusscomputing/ansible_collection_centurion about: https://github.com/nofusscomputing/ansible_collection_centurion
@ -16,7 +16,7 @@ The following job template will be created:
!!! info !!! info
The playbook is able to work with Centurion ERP directly or using the inventory pluggin that is included in this collection. The playbook is able to work with the inventory plugin that is included in this collection.
## Play workflow ## Play workflow
@ -33,17 +33,17 @@ The teams playbook gathers information regarding centurion organisations from th
## Configuration ## Configuration
The teams playbook uses variables that are gathered from inventory The teams playbook uses variables that are gathered from inventory. The expected structure of the inventory file is:
The expected structure of the inventory file is:
```yaml ```yaml
centurion_erp: centurion_erp:
teams: teams:
- name: "organisation name" - name: "organisation name"
teams: teams:
- name: "team-name" - name: "team-name"
permissions: [] permissions: []
notes: "permissions must be a list" notes: "permissions must be a list"
``` ```
@ -57,7 +57,12 @@ centurion_erp:
team_permissions: &team-name-permissions [] team_permissions: &team-name-permissions []
team_name_notes: &team-name-notes "team_notes" team_name_notes: &team-name-notes "team_notes"
teams:
- name: "organisation name"
teams:
- name: *team-name
permissions: *team-name-permissions
notes: *team-name-notes
``` ```
!!! info "Upcoming feature"
With the release of Centurion ERP V1.1 an API request to fetch all permissions that can be applied will be available.

View File

@ -47,7 +47,7 @@
# https://github.com/nofusscomputing/ansible_collection_centurion/issues/19 # https://github.com/nofusscomputing/ansible_collection_centurion/issues/19
# This teask has been commented out due to the above issue # This task has been commented out due to the above issue
# - name: Inventory Software [l] # - name: Inventory Software [l]
# ansible.builtin.set_fact: # ansible.builtin.set_fact:
@ -166,10 +166,11 @@
type: boolean type: boolean
label: Validate SSL Certificate label: Validate SSL Certificate
required: required:
- itsm_api - centurion_api
- itsm_token - centurion_token
injectors: > injectors: >
env: env:
CENTURION_API: '{{ centurion_url }}' CENTURION_API: '{{ centurion_url }}'
CENTURION_TOKEN: '{{ centurion_token }}' CENTURION_TOKEN: '{{ centurion_token }}'
CENTURION_VALIDATE_CERTS: '{{ centurion_validate_certs | default(true) }}' CENTURION_VALIDATE_CERTS: '{{ centurion_validate_certs | default(true) }}'

View File

@ -258,10 +258,11 @@
job_type: "run" job_type: "run"
# job_tags: complete # job_tags: complete
labels: labels:
- centurion_erp
- itsm
- itam
- access - access
- centurion_erp
- itam
- itsm
- permissions - permissions
- teams - teams
use_fact_cache: true use_fact_cache: true