Commit Graph

11 Commits

Author SHA1 Message Date
David Moreau Simard 33e4c1d841
Update README to explain ara-server was migrated back into ara
The ara-server standalone repository is being discontinued.
The clear and logical separation of components was nice but the overhead
in complexity was not worth it.

Change-Id: I9d5e3096db4972405932ae2af46ee63bfeef43b5
2019-03-02 08:47:26 -05:00
David Moreau Simard 35999a1bed
Misc updates to security and configuration documentation
- Improve docs on ARA_ENV
- Refresh outdated defaults
- Fix broken link on ara-web git repo

Change-Id: Ib882dc7415cc7b50f35a3a6bfbf1bc0fbe401dc8
2019-01-25 12:29:11 -05:00
David Moreau Simard 5a7eeb93af First iteration of authentication and security docs
This is a first iteration on basic security and authentication
documentation. It documents the security settings users might want to
pay attention to and explains how to configure them.

We're bumping the version of sphinx in order to enable the
"autosectionlabel" extension so we don't need to create explicit
labels for sections.

Change-Id: I694eb1a2aa03193335f11cbda40ed6962357c428
2019-01-24 17:07:36 +00:00
David Moreau Simard ca0137b437
Docs: SECRET_KEY is now randomly generated if it's not set
Update docs to reflect that in https://review.openstack.org/#/c/631011/
we made SECRET_KEY optional to launching ara-server by randomizing a
key if none are supplied by the configuration.

Change-Id: I469663082ed6071db250c8152430ea1e8d61b500
2019-01-21 10:56:48 -05:00
David Moreau Simard e279385bce
Add docs on how to use the API clients with ara-server
Change-Id: I1c6cee62f9ab261a06d2bc5cbbd42b1f74829e76
2018-12-21 11:31:04 -05:00
David Moreau Simard 827f3ed16b
Add documentation on how to configure ara-server
Change-Id: I59fc4def84116c4cf1c764799f00485305af9273
2018-12-21 10:49:55 -05:00
David Moreau Simard 42404c41e0
Add basic installation documentation
Change-Id: Ie656aa1591a9f7aa46bf50714589304cd3196b68
2018-12-21 10:26:15 -05:00
David Moreau Simard 0d02f3d459
Bootstrap documentation and publish it to readthedocs
Add a first bit of documentation around the workflow for recording data.

Change-Id: I9456b71c94e9097ea93394f8f7c33cd272586cc5
2018-09-26 16:48:24 -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 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