ara_api role: gunicorn fails to start if selinux is enforcing

ARA Records Ansible

ARA Records Ansible and makes it easier to understand and troubleshoot.

It is another recursive acronym with a focus on simplicity.

About ara

ara provides Ansible reporting by recording ansible and ansible-playbook commands regardless of how and where they run:

from most Linux distributions and even on Mac OS (as long as python >= 3.8 is available)
from tools that run Ansible like ansible-(pull|test|runner|navigator), AWX & Automation Controller (Tower), Molecule and Semaphore
from a terminal, a script or by hand
from a laptop, desktop, server, virtual machine, container or execution environment
from CI/CD platforms such as Jenkins, Rundeck and Zuul
from git forges like GitHub, GitLab, Gitea & Forgejo

The recorded results are available via an included CLI, a REST API as well as a self-hosted, local-first web reporting interface.

demo.mp4

How it works

ARA Records Ansible results to SQLite, MySQL and PostgreSQL databases with a standard callback plugin.

This plugin gathers data as Ansible runs and sends it to a Django REST API server:

Requirements

Any recent Linux distribution or Mac OS with python >=3.8 available
The ara package (containing the Ansible plugins) must be installed for the same python interpreter as Ansible itself

Getting started

For production use, consider learning about best practices, enabling authentication and ignoring what doesn't need to be recorded.

Recording playbooks without an API server

ara records to a local sqlite database by default and does not require a persistent server:

# Install ansible (or ansible-core) with ara (including API server dependencies)
python3 -m pip install --user ansible "ara[server]"

# Configure Ansible to enable ara
export ANSIBLE_CALLBACK_PLUGINS="$(python3 -m ara.setup.callback_plugins)"

# Run an Ansible playbook as usual
ansible-playbook playbook.yml

# Check out the CLI
ara playbook list
ara host list

# or the UI at http://127.0.0.1:8000
ara-manage runserver

Recording playbooks with an API server

The server includes a REST API as well a web reporting interface.

Consider running one to aggregate playbook runs from different tools, jobs or servers into a single dashboard that can be shared with friends.

Get started with the ara_api role or with the container images published by the project on DockerHub and quay.io:

# Create a directory for a volume to store settings and a sqlite database
mkdir -p ~/.ara/server

# Start an API server with docker from the image on DockerHub:
docker run --name api-server --detach --tty \
  --volume ~/.ara/server:/opt/ara -p 8000:8000 \
  docker.io/recordsansible/ara-api:latest

# or with podman from the image on quay.io:
podman run --name api-server --detach --tty \
  --volume ~/.ara/server:/opt/ara -p 8000:8000 \
  quay.io/recordsansible/ara-api:latest

Once the server is running, ara must be installed and configured to send data to it:

# Install ansible (or ansible-core) with ara (excluding API server dependencies)
python3 -m pip install --user ansible ara

# Configure Ansible to enable ara
export ANSIBLE_CALLBACK_PLUGINS="$(python3 -m ara.setup.callback_plugins)"

# Set up the ara callback to know where the API server is located
export ARA_API_CLIENT="http"
export ARA_API_SERVER="http://127.0.0.1:8000"

# Run an Ansible playbook as usual
ansible-playbook playbook.yml

# Check out the CLI
ara playbook list
ara host list

# Or browse http://127.0.0.1:8000 (running from the container)

Live demo

A live demo is deployed with the ara Ansible collection from Ansible Galaxy.

It is available at https://demo.recordsansible.org.

Documentation and changelog

Documentation for installing, configuring, running and using ara is available on ara.readthedocs.io.

Common issues may be resolved by reading the troubleshooting guide.

Changelog and release notes are available within the repository's git tags as well as the documentation.

Community and getting help

Bugs, issues and enhancements: https://github.com/ansible-community/ara/issues
IRC: #ara on Libera.chat
Matrix: Bridged from IRC via #ara:libera.chat
Slack: Bridged from IRC via https://arecordsansible.slack.com
Website and blog: https://ara.recordsansible.org
~~Twitter: https://twitter.com/recordsansible~~
Mastodon: https://fosstodon.org/@ara

Contributing

Contributions to the project are welcome and appreciated !

Get started with the contributor's documentation.

Authors

Code contributions to the project can be viewed from the git log or on GitHub.

The ara parrot logo was designed and contributed by Jason E. Rist.

Copyright

Copyright (c) 2023 The ARA Records Ansible authors

ARA Records Ansible is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

ARA Records Ansible is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with ARA Records Ansible.  If not, see <http://www.gnu.org/licenses/>.

	# TODO: Split this out to a CLI command (django-admin command ?)

	# Ensure default base configuration/data directory exists
	if not os.path.isdir(BASE_DIR):
	logger.info(f"Creating data & configuration directory: {BASE_DIR}")
	os.makedirs(BASE_DIR, mode=0o700)

	if not os.path.exists(DEFAULT_SETTINGS) and "ARA_SETTINGS" not in os.environ:
	SETTINGS = dict(
	BASE_DIR=BASE_DIR,
	ALLOWED_HOSTS=ALLOWED_HOSTS,
	CORS_ORIGIN_WHITELIST=CORS_ORIGIN_WHITELIST,
	CORS_ORIGIN_ALLOW_ALL=CORS_ORIGIN_ALLOW_ALL,
	SECRET_KEY=SECRET_KEY,
	DATABASES=DATABASES,
	DEBUG=DEBUG,
	LOG_LEVEL=LOG_LEVEL,
	LOGGING=LOGGING,
	READ_LOGIN_REQUIRED=READ_LOGIN_REQUIRED,
	WRITE_LOGIN_REQUIRED=WRITE_LOGIN_REQUIRED,
	)
	with open(DEFAULT_SETTINGS, "w+") as settings_file:
	comment = f"""
	---
	# This is a default settings template generated by ARA.
	# To use a settings file such as this one, you need to export the
	# ARA_SETTINGS environment variable like so:
	# $ export ARA_SETTINGS="{DEFAULT_SETTINGS}"

	"""
	logger.info(f"Writing default settings to {DEFAULT_SETTINGS}")
	settings_file.write(textwrap.dedent(comment))
	yaml.dump({"default": SETTINGS}, settings_file, default_flow_style=False)

	DOCUMENTATION = """
	callback: ara
	callback_type: notification
	requirements:
	- ara
	short_description: Sends playbook execution data to the ARA API internally or over HTTP
	description:
	- Sends playbook execution data to the ARA API internally or over HTTP
	options:
	api_client:
	description: The client to use for communicating with the API
	default: offline
	env:
	- name: ARA_API_CLIENT
	ini:
	- section: ara
	key: api_client
	choices: ['offline', 'http']
	api_server:
	description: When using the HTTP client, the base URL to the ARA API server
	default: http://127.0.0.1:8000
	env:
	- name: ARA_API_SERVER
	ini:
	- section: ara
	key: api_server
	api_timeout:
	description: Timeout, in seconds, before giving up on HTTP requests
	default: 30
	env:
	- name: ARA_API_TIMEOUT
	ini:
	- section: ara
	key: api_timeout
	ignored_facts:
	description: List of host facts that will not be saved by ARA
	type: list
	default: ["ansible_env"]
	env:
	- name: ARA_IGNORED_FACTS
	ini:
	- section: ara
	key: ignored_facts
	ignored_arguments:
	description: List of Ansible arguments that will not be saved by ARA
	type: list
	default: ["extra_vars"]
	env:
	- name: ARA_IGNORED_ARGUMENTS
	ini:
	- section: ara
	key: ignored_arguments
	"""

	DOCUMENTATION = """
	---
	module: ara_record
	short_description: Ansible module to record persistent data with ARA.
	version_added: "2.0"
	author: "David Moreau-Simard <[email protected]>"
	description:
	- Ansible module to record persistent data with ARA.
	options:
	playbook_id:
	description:
	- id of the playbook to write the key to
	- if not set, the module will use the ongoing playbook's id
	required: false
	key:
	description:
	- Name of the key to write data to
	required: true
	value:
	description:
	- Value of the key written to
	required: true
	type:
	description:
	- Type of the key
	choices: [text, url, json, list, dict]
	default: text

	requirements:
	- "python >= 3.5"
	- "ara >= 1.0.0"
	"""

	EXAMPLES = """
	- name: Associate specific data to a key for a playbook
	ara_record:
	key: "foo"
	value: "bar"

	- name: Associate data to a playbook that previously ran
	ara_record:
	playbook_id: 21
	key: logs
	value: "{{ lookup('file', '/var/log/ansible.log') }}"
	type: text

	- name: Retrieve the git version of the development repository
	shell: cd dev && git rev-parse HEAD
	register: git_version
	delegate_to: localhost

	- name: Record and register the git version of the playbooks
	ara_record:
	key: "git_version"
	value: "{{ git_version.stdout }}"
	register: version

	- name: Print recorded data
	debug:
	msg: "{{ version.playbook_id }} - {{ version.key }}: {{ version.value }}

	# Write data with a type (otherwise defaults to "text")
	# This changes the behavior on how the value is presented in the web interface
	- name: Record different formats of things
	ara_record:
	key: "{{ item.key }}"
	value: "{{ item.value }}"
	type: "{{ item.type }}"
	with_items:
	- { key: "log", value: "error", type: "text" }
	- { key: "website", value: "http://domain.tld", type: "url" }
	- { key: "data", value: "{ 'key': 'value' }", type: "json" }
	- { key: "somelist", value: ['one', 'two'], type: "list" }
	- { key: "somedict", value: {'key': 'value' }, type: "dict" }
	"""


	RETURN = """
	playbook:
	description: ID of the playbook the data was recorded in
	returned: on success
	type: int
	sample: 1
	key:
	description: Key where the record is saved
	returned: on success
	type: str
	sample: log_url
	value:
	description: Value of the key
	returned: on success
	type: complex
	sample: http://logurl
	type:
	description: Type of the key
	returned: on success
	type: string
	sample: url
	created:
	description: Date the record was created (ISO-8601)
	returned: on success
	type: str
	sample: 2018-11-15T17:27:41.597234Z
	updated:
	description: Date the record was updated (ISO-8601)
	returned: on success
	type: str
	sample: 2018-11-15T17:27:41.597265Z
	"""

ansible-community / ara Goto Github PK

ara's Introduction

ARA Records Ansible

About ara

How it works

Requirements

Getting started

Recording playbooks without an API server

Recording playbooks with an API server

Live demo

Documentation and changelog

Community and getting help

Contributing

Authors

Copyright

ara's People

Contributors

Stargazers

Watchers

Forkers

ara's Issues

Migrated from https://storyboard.openstack.org/#!/story/2005197

1.

2.

3.

Migrated from https://storyboard.openstack.org/#!/story/2000852

Migrated from https://storyboard.openstack.org/#!/story/2005492

What component is this about ?

What is the idea ?

What component is this about ?

What is your ARA installation like ?

What is happening ?

What should be happening ?

Problem

Resolution

Additional data

Problem

Resolution

Additional data

Problem

Resolution

Additional data

What component is this about ?

What is your ARA installation like ?

What is happening ?

What should be happening ?

What component is this about ?

What is your ARA installation like ?

What is happening ?

What should be happening ?

Recommend Projects

Recommend Topics

Recommend Org

Jobs