This change adds information about keystone policy support in the
following places:
* api-ref: add notes to the Nodes reference, indicating that
password and configdrive contents may be hidden in responses
* deploy security guide: add a section about limiting API access
by using the new policies and roles
* deploy install guide: add instructions for creating the necessary
Roles with the Identity service
* dev quickstart guide: use devstack "demo" user throughout the guide,
and add a note about why. Incidentally, switch to using "openstack"
client instead of "ironic" and "nova" clients.
Partial-bug: #1526752
Change-Id: I392cabbf04badabd8ae7bb00a914b0a06db3d421
This commit does several things, which were just easier to do together.
- Adds a new "misc" page describing the /v1/lookup and /v1/heartbeat
resources.
- Adds descriptions of the node.resource_class and
node.network_interface fields that were introduced into the API but
not into the documentation.
- Introduces a new script, api-ref/regenerate-samples.sh, which can be
used with Ironic to automate the generation of most of the sample files
used in the api-ref documententation.
- Corrects several errors in the sample JSON files that rendered errors
when using them with curl for POST, PUT, or PATCH.
- Uses the aforementioned regenerate-samples.sh script to regenerate
most of the JSON result samples, ensuring that they are all up to date
with the v1.22 API microversion.
- Removes a few old/incorrect "Error Code" listings.
- Updates the index page to remove extraneous wording.
Change-Id: I764cbb43be15f05ba681de6ce1be1ae7c022173d
Currently, there is a node_uuid parameter that describes specifically
a node UUID in response body. Let's use just uuid.
Change-Id: I43ffe017188c1f15a0c6d8007d4bd463e867b774
This updates the API root documentation, which was non-existent,
and the Node documentation significantly, replacing many of the samples
and adding more verbiage to each property.
It's not perfect, but this is vastly more correct than the current docs.
Change-Id: Iaeb1c80ac0655fc0d73fa495ed43e3c02b345495
Per this email[0], it's time to migrate our API docs into our tree.
This copies the sphinx extension from nova into our tree as well, which
will be later split into its own python module. At that time we can cut
over to the module and drop it from our tree.
The conf.py and the tox environment are also cribbed from nova.
[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
Change-Id: I683cc4d6459d77c42951a06247b6f9ff8f8456bd
