Commit Graph

33 Commits

Author SHA1 Message Date
David Moreau Simard 4a8711e73c
opendev: Remove content and leave an URL to the GitHub repository
Change-Id: I82a3238b6a8c21e6bb8056aca22ef71af9ea2538
2021-02-25 15:16:53 -05:00
David Moreau Simard f8b6092336
Improvements to the README
- Include "what it does"
- Simplify some sections
- Update COPYRIGHT

Change-Id: I49786a7bf1dcac4a22531b0f7658cab0525d0f90
2021-02-16 12:15:40 -05:00
David Moreau Simard 5171bf9e97
misc: Use demo.recordsansible.org instead of api.demo
ara-web isn't currently in a state where we can demo it and it tends to
confuse users so remove it's mention for now.

Given that we no longer have a distinction between api and web, use
plain "demo.recordsansible.org" instead.

Change-Id: I788d5d457fc011364a7839172fbadc5c24de76d4
2021-01-17 13:14:16 -05:00
David Moreau Simard 9c79cf21a5
readme: fix .rst duplicate anchor
There was already an anchor on "documentation" which failed to parse
properly when releasing to PyPi.

Change-Id: I50c8e7954e2dad3debc8d1fefb07a425b189be73
2020-09-23 13:39:12 -04:00
Zuul a8efa9da73 Merge "readme: refresh built-in UI screenshot" 2020-09-23 14:31:35 +00:00
Zuul 8e823c99d5 Merge "readme: mention ara cli and include a screenshot" 2020-09-23 14:31:34 +00:00
David Moreau Simard bf851d8d7f
readme: refresh built-in UI screenshot
Change-Id: If84e957fb838f693167a27acbc54d5c62eb34a6e
2020-09-22 23:40:01 -04:00
David Moreau Simard a86b233f0d
readme: mention ara cli and include a screenshot
Change-Id: Ibb1a86ddb006a6ed28d8e6626b44e575d511f668
2020-09-22 23:21:11 -04:00
David Moreau Simard 5fa1377c51
docs: clarify directory in container getting started
Change-Id: Ie720dbefa0e16781edc85720ac768e6e485974b2
2020-09-22 22:00:51 -04:00
David Moreau Simard 225d21d8f3
readme: add link to ansible collection repository
The individual documentation pages for the roles have been removed so
the links were broken. Link to the collection repository instead.

Change-Id: Id857660e6664c14a109f3e1e596e49f533d461da
2020-08-25 14:28:30 -04:00
David Moreau Simard 06f888852a
docs: mention that ara works on Mac OS too
We have reports that ara works out of the box on Mac OS so include a
note about it.

Change-Id: I05a40510b1bb1b797a1ebdf471c7aecc881ba711
2020-08-25 13:46:43 -04:00
David Moreau Simard 1d9525a0a7
readme: update twitter url
Change-Id: Ie226e265f2c82b2ae80264b654d42d85be117c9a
2020-08-22 16:12:30 -04:00
David Moreau Simard ff0c9b5acd
Docs: refresh installation docs
Largely inspired by the getting started guide from the README.

- Move installation to getting-started
- Include note about API server on RHEL7/CentOS7
- Mention the Ansible collection in favor of roles
- Add link to Debian packaging
- Add container instructions

Fixes: https://github.com/ansible-community/ara/issues/99
Fixes: https://github.com/ansible-community/ara/issues/137
Change-Id: I0df4fa014038d311d5478e066da7f36e2f453ad2
2020-08-22 13:45:44 -04:00
David Moreau Simard c2ce3724a7
Refresh README
This updates the README and moves "how ara works" as well as
"what ara looks like" from the FAQs to the README where they
are more relevant.

Change-Id: Ic928b23802b393e6775b54b3e6c51982758e79d6
2020-05-07 23:17:10 -04:00
David Moreau Simard d82857d4cb
Remove f-strings to remove requirement on py36
This is a small change that removes the hard requirement for python>=3.6.

We can reconsider it in the future but for now this makes it easier for
certain users to deploy for their environment.

This also fixes wrong indentation on the settings file comment.

Change-Id: Iab84818e5e50aa1e3a0951be154718be04fb53f5
2019-11-19 10:21:00 -05:00
David Moreau Simard 89786775ad
Update slack invitation link in README
Change-Id: I1ae8df2b6e1468396371b86a59b9737a31628cfd
2019-11-04 08:46:18 -05:00
David Moreau Simard c61258ac49
docs: Refresh install steps in docs and README
- Prefer --user over virtualenv
- Move python requirements from faq to installation docs
- Mention Fedora and OpenSUSE packages

Change-Id: I5f27534500041630209ac0cf449b4f3ce25d7213
2019-10-28 13:34:42 -04:00
David Moreau Simard cab932f0ed
Switch default branch from feature/1.0 to master
This updates the doc and git branches to match master instead of
feature/1.0.

Change-Id: Ifc98157328b2f9f56055fa0cdcfea5db5180fb7f
2019-06-04 20:33:00 -04:00
David Moreau Simard 6c734132e5
Update README
- Make the intro shorter and more to the point
- Link to ara-web
- Add local dev server to the quickstart
- Include links to live demos and Ansible roles
- Test docs have been moved to contributing docs

Change-Id: Ie82c66965ed220824448048cbbd434c585afe0b9
2019-06-02 21:36:35 -04:00
David Moreau Simard 942271a4a4
Move github references from openstack/ara to ansible-community/ara
Change-Id: I1942cbe9c6af51ade33168c12dbc3a7c59da3a14
2019-05-21 11:08:57 -04:00
David Moreau Simard 6d00938099
Make API server deps optional, move them to extras
This makes it so "pip install ara" would only install a minimal
amount of dependencies (pbr and requests as of this commit) required
for running the Ansible callback plugin as well as ara_record.

The server dependencies can be installed by running
"pip install ara[server]".

Fixes: https://github.com/ansible-community/ara/issues/36
Change-Id: I67769d28ec24cade7753230dffd0b049358af29a
2019-05-03 16:01:30 -04:00
David Moreau Simard 06dbe6a43e
Port ara.setup helper modules from 0.x to 1.0
0.x has helper modules to easily find the path where things are located.
These weren't originally in 1.0 mostly because ara-plugins was split
into another project.

We can add those back in for convenience now.

Change-Id: I8272fd6f43b08f71e0bce3626dbcee3ca1fc85ac
2019-04-01 18:35:34 -04:00
David Moreau Simard c291f57e3a
Streamline integration test role and make it easier to run
- Rename the "integration-tests" role to "ara_tests" in order to be
  in line with the other roles
- Add an "ansible-integration" tox environment which takes care of
  installing Ansible and running a playbook which includes the ara_tests
  role.
- Add docs and improve existing docs

Change-Id: I0d272744bb27f2c923ef992d1b64de0032849f0e
2019-03-26 12:54:46 -04:00
David Moreau Simard 7a48522615
Improve API endpoint and usage documentation
Just general improvements that felt appropriate after landing the
recent API refactor.

Change-Id: Ia345e9d7ec2f0dc38ee5bfff13c9fc7bfa206931
2019-03-20 15:27:26 -04:00
David Moreau Simard b89ce1af99 Documentation updates post-merge of plugins/server/clients
This updates some of the documentation bits that referred to individual
components like ara-server, ara-plugins and ara-clients.

Change-Id: I8ab3fdfb543786daacec22f7f1b90af4f17b5a2b
2019-03-04 22:48:46 +00:00
David Moreau Simard b0d62ba7c4
Rename references to ara-{server,plugins,clients} back to ara
This follows the fusion of the ara-{server,plugins,clients} reporitories
into a branch of the ara repository.

There are other references to clean up that will require a bit more
work (e.g, documentation) so this is a first step.
2019-03-01 15:29:19 -05:00
David Moreau Simard 3d5efff28c
Replace the ansible-integration job by the new integration jobs
ara-infra now provides a new and improved set of integration jobs
so we no longer need to have the ansible-integration job.

These new jobs test ara-server, ara-clients and ara-plugins against
a variety of operating systems and versions of Ansible.

It was convenient to be able to run these tests from ara-server by
itself, we'll re-introduce a wrapper so we can continue to do so
later.

Depends-On: https://review.openstack.org/#/c/630303
Change-Id: Iedf259e44af5165be08c5d6917e5af98b281202d
2019-01-23 13:44:28 -05:00
David Moreau Simard d671ff33b4
Update and improve README
- Add quickstart docs
- Remove scary disclaimer
- Add community info

Change-Id: Ib506baa6590ac2debc718fc42a572c747e6ac46f
2018-12-21 10:28:47 -05:00
David Moreau Simard 1f205e2ad9
Merge the tox-pep8 and tox-format jobs and use tox-linters
black and isort fit into the category of linters.
Let's run everything from the same job so we can avoid wasting time
and resources from the CI infrastructure.

Previously, tox would exit immediately if there was an error with
black, preventing isort from running. You could then run into a
situation where you also had an issue picked up by isort.

Now bash will run all linters and return the appropriate
return code at the end.

Change-Id: I81abe61be65bd9f4f828cfc5f0b7a1d9f1eb1f22
2018-10-16 17:02:32 -04:00
David Moreau Simard 64f47cf4e8
Update and improve README to be more accurate
Change-Id: I5023d09826cd8287b1449edeac92a5e6fcf7542a
2018-09-26 16:40:35 -04:00
David Moreau Simard 68cbbe24bc First iteration of callback using API
- Remove mockdata.py (using the callback is better)
- Add first iteration of callback
  Note: This will eventually be moved, it's here for simplicity
- Add test playbook/role to exercise the callback

Note: The callback will be moved to ara-plugins

Change-Id: I8f590be4cfafd4714f40f4165e2973cb803b8756
2018-06-20 12:14:56 +00:00
David Moreau Simard 23fbf95672
Add a script to create mock data
It's convenient to have a script to easily add mock data to test the
API and model with. Let's do that.

Change-Id: I0f108b19d35280faa472850bdeb9ac83f3faa505
2018-03-29 12:36:29 -04:00
David Moreau Simard 5fbbdac265
Bootstrap the repository with the basic machinery (#1)
- Make the project installable with pbr
- Use tox to run tests, build docs, runserver
- Flesh out the README a little bit
- Real docs is WIP.

Change-Id: I3dc92250cd93add0cdf11c6a67d8f1081560d4e1
2018-03-29 12:36:22 -04:00