Skip to content

Commit

Permalink
README: clarify getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
dmsimard committed Sep 16, 2023
1 parent 7b47939 commit dde7674
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,11 @@ This plugin gathers data as Ansible runs and sends it to a Django REST API serve

## Getting started

Running an API server is not required to get started: it's designed to be simple to record data to a local sqlite database without requiring a persistent service.

For production use, consider learning about [best practices](https://ara.readthedocs.io/en/latest/troubleshooting.html#improving-playbook-recording-performance), [enabling authentication](https://ara.readthedocs.io/en/latest/api-security.html#authentication) and [ignoring what doesn't need to be recorded](https://ara.readthedocs.io/en/latest/ansible-plugins-and-use-cases.html#ansible-plugins).

### Recording playbooks without an API server

![getting-started](doc/source/_static/getting-started.gif)
ara records to a local sqlite database by default and does not require a persistent server:

```bash
# Install ansible (or ansible-core) with ara (including API server dependencies)
Expand All @@ -63,8 +61,14 @@ ara host list
ara-manage runserver
```

![getting-started](doc/source/_static/getting-started.gif)

### 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](https://github.com/ansible-community/ara-collection/blob/master/roles/ara_api/README.md)
or with the [container images](https://ara.readthedocs.io/en/latest/container-images.html) published by the project on
[DockerHub](https://hub.docker.com/r/recordsansible/ara-api) and [quay.io](https://quay.io/repository/recordsansible/ara-api):
Expand Down

0 comments on commit dde7674

Please sign in to comment.