After migrating to openstackdocstheme, some shade document became
not easy to read. This commit fixes them a bit.
- openstackdocstheme assumee only one title per page.
Use a different level of title for the title.
Otherwise, titles with the same level are not shown.
- Release notes page has a lot of sections. It leads to a long TOC
in the user guide index page.
Use maxdepth=1 explicitly for the release notes.
- Add a link to a simple example to usage.rst.
It helps users who access the user guide directly.
Change-Id: If51afa471505296b502bed3288cc9bcf30a69ba3
Move the docs around a little to allow the new templated docs.o.o site
link to things like the user and install guides in the expected location.
Change-Id: I7f3b625c04aa6cd2a7ebe5f2ce4a398cf464b1cc
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Keypairs didn't have functional tests, although they do have ansible
tests. Also, there was no normalization. Add both.
Change-Id: Ib6fab25cf4c88e5f9d224e831a8b5f297b263aea
This is a write up of an idea from several years ago which is both long
in the tooth and honestly never going to happen. Go ahead and remove it.
Change-Id: I4377cfb24c468f2333ac470a2a58fa97cf35d4bd
We aren't doing anything with microversions yet, but since we just wrote
down algorithms for version discovery, let's go ahead and talk about
how microversions should work. Also, mention that it's important to
fetch information about them as part of discovery.
Change-Id: Iadd48cd53488240e33db83797a88af689b1497dc
shade logs to some specific named loggers for various things. They are
defined and intentional, but are not documented. So let's document them.
Change-Id: If52553e5478d4e2f8a56f5d899e93fd2b4fe3c2d
Check it out - when we write presentations in presentty, we can
add them to our docs!
First given at the 2017 Boston OpenStack Summit.
Change-Id: Ia46a6f32b6b374974fba7b620b202f8eadc774a1
Every time the magic of flexible return schemas rears its ugly head, a
pony becomes a less happy pony.
It's worth noting that this changes behavior to _always_ get detailed
records. This is consistent with our other things and should not break
anyone.
Change-Id: I4932e424ec7db8b6cea014ec668b30bb29f3e1f9
Turns out usage reports are empty when there is no usage - so direct
passthrough is not so much a thing. Fix it.
Change-Id: I6a2f2e737f792ba74a191d688b3380dc333e34fe
Now that we've got glance and swift done and have started on neutron,
let's update the doc to tell people that it's the way forward.
Change-Id: I16f7ae58f5ae280bc4b1533f62bf3e3a09dbaeb0
There isn't good docs or a guide on what we're looking for with
normalization - so rather than nitpick a review to death, I just made a
patch. We should make a doc ...
Changes included:
- We need to be explicit about every key we're going to support. Some of
the limits keys are deprecated, so just don't return them.
- Change them all from camel case to underscore to match other
resources.
- Document them in model.rst
- Change the name from limits to compute_limits, since it's only limits
for the compute service.
- Allow usage by a normal user (it's not an admin function)
There will be a follow up patch to convert this to direct rest calls,
which will be fun due to the ability of this to work against other
projects.
Change-Id: Icfb118d4289263c0dd906f600e370242f191f708
The documentation build does not generate any module index, thus remove
the link to the page. The page
http://docs.openstack.org/infra/shade/py-modindex.html does not
exist.
Change-Id: Ibfc9f74bbebe3ad2c0d3d37eba3e65a44a602dfe
There are four attributes that show up by default in devstack installs.
They come from the timestamp and standard attributes extensions, so it's
possible they may not always be present. But we can make them always be
present.
Change-Id: I1a05ef735c24600821856c6ec36df11e981b3d36
We had a normalization function in _utils but it was nor documented nor
did it support strict mode. Document the normalization and be more explicit
about which things we support and don't.
Change-Id: I360af3abcfd69afebd941c5d6e359a84dc956283
Visibility can be public, private and shared - and community is coming
in O1. Make sure that we don't lose that information in our
normalization.
Change-Id: I148547e3026fe155c911d9a51cb51d8901c83650
We were returning projects un-normalized. That's no good for anybody.
Add normalization and documentation of the agreed model.
It's worth noting that because it's a project, information about project
and domain in the location dict is a bit more specific.
Change-Id: I3bbfd010883587857cf09f082124816e701fbe6f
shade defaults to returning everything under the sun in every form
possible in order to ensure maximum backwards compatability - even with
systems that are not shade itself. However, passthrough fields from
somewhere else could change at any time. This patch adds an opt-in flag
that skips returning passthrough fields anywhere other than the
properties dict.
Change-Id: I7071a406965ed373e77f9592eb76975400cb426b
Put extra keys in both the root resource and in a properties dict.
Ensure data types are correct. Make sure int, float and bool values
are returned as int and bool.
Change disabled in flavor to is_disabled for consistency with other
bools we've added. There has been no release with the addition of disabled,
so changing it now is still safe.
Add locations and direct_url to images. They're optional in glance, but
that's evil.
Let image schema attribute fall through to extra properties.
Add zone to current_location.
Add readable mappings for power_state, task_state, vm_state, launched_at
and terminated_at for Servers. Also add a non-camel-cased host_id.
This is a big patch, but it's mostly just reorganizing and adding docs.
Looking at the changes to the tests and seeing that the only change is
adding zone and properties into a couple of fixtures is a good place to
start.
Change-Id: If5674c049c8dd85ca0b3483b7c2dc82b9e139bd6
There was a point in time in the past where we were gung ho on using
Munch as a halfway house to get us to pure dicts. However, we released
1.0 before we could do that, so we're pretty stuck with them for the
forseeable future. That's not terrible - they're pretty low overhead and
work pretty well.
Depends-On: Ie10099430481ffa76f5a19557e3693189544df6b
Change-Id: I8b7dd2c4038db999280ec0c2c9c43fb9499e6d22
Add a section to our Coding Standards documentation that describes
the use of reno for shade release notes.
Change-Id: I87973c5b3f68727aa0cb1ccb9a82c90a8a32ebd1
We have pretty much settled on sticking with Munch objects for the
1.x series of shade releases. Change the documentation to note this.
Change-Id: I8b2838c3a5a40b0c74e31081bfb1ed4b0d39280f
The OpenStack Release team has created a great release notes management
tool that integrates with Sphinx. Start using it. For reference on how
to use it, see http://docs.openstack.org/developer/reno/
Change-Id: I57692d720174fedb68ab2f52d5a4c496a6d993b2
The README was discussing future design decisions as if they were
already implemented. This can be confusing for new users. This
separates that discussion into a separate doc page and clarifies
its intentions.
Also, fix sphinx doc build warnings.
Change-Id: Ie66b60d972cae25a9805804ad17632aed0932627
We should not be returning raw client objects when creating or
rebuilding a server.
The usage document is updated to indicate that access to resource
values via attribute is deprecated, and the examples in the README
now reflect dict-style access.
Change-Id: Iac38d4c0b29f867cc3cefaccf48c1c3fcd17a3d9
