This change moves over the identity v2 service to resource2/proxy2. It's
mostly a renaming and updating to fit the new API.
Change-Id: I95ab21c13bcdc24bf5daadf58f79d0f53c8bd75e
Rather than occasionally playing catch-up until the wait_for methods are
removed from the base Proxy in 1.0, we can temporarily ignore those two
names. This allows us to make the doc build fail if undocumented proxy
methods occur.
After 1.0 we should remove the special cases for wait_for names, but
leave warnings_as_errors on.
Change-Id: I8fe41ed639ec318a18db3022371b52382c53aa99
This change cleans up a couple of minor doc warnings that don't usually
get caught. I'm making this small change now so that I can turn on
warnings_as_errors in the enforcer script.
Change-Id: Ib0100116a4f7a38ad882d20a56ae99d15d49766a
Recent get_stack_* methods were left out of the documentation. This also
adjusts a doc warning about indentation being off.
Change-Id: I5bde59cfb3da4508300f5535e3c13c0265b7460f
When building packages if git is absent, do not try to get the git sha
via the git cli. That can not work.
Change-Id: I3bde4df045287cbda07c9447ef3397de74f42910
Closes-Bug: #1677463
Previously, the openstack.image.image_download method would place the
contents of a remote image into a Python variable. With this change,
the download_image method can optionally return the
requests.Response object returned by session.get(), which permits
the caller to download the image in chunks using the iter_content
method. This can prevent performance issues when dealing with
large images.
Change-Id: Ie62ebcc895ca893321a10def18ac5d74c7c843b9
The devstack config we link to in the docs has been out of date for
quite some time. I usually just comment out the IMAGE_URLS line so
it doesn't even bother, but we should actually update it. The change
falls in line with what the Heat docs recommend, and it's because of
Heat that we have this configuration line in the first place.
See
https://docs.openstack.org/developer/heat/getting_started/on_devstack.html
for their recommended config.
Change-Id: I3f55c576f0e8aefa776e40509f8b7b098665ff39
The 'wait_for_status' and 'wait_for_delete' proxy methods are heavily
used in the senlin code base. This patch revives the two proxy methods
in case we may forget to add it back when the corresponding ones in
ProxyBase are removed.
Change-Id: I1de6fe031901cf5d319496b881815f0f757c6279
This change organizes the cluster docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: Ieca92ea97d5bfcb781fcb614275d947e222a8783
This change organizes the object_store docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I495770aaaa1bf97dd728339b3dde42ad1770e384
This change organizes the workflow docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I3f220829ae7039a38bf76dee59131fce11af95f0
This change organizes the network docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I6366911a8410b43a567ca0d9afc22994639c80c8
This change organizes the telemetry docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
This also adds telemetry.alarm docs, which weren't previously included.
Change-Id: Id5d8e201f99d9f8fc78d09694e4cdc576af2fefd
This change organizes the block store docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I743562a8c9a1dc7aaceef1d14c571c7a07855802
This change introduces metric docs. There is only one method in the
proxy as of right now, so that was easy.
Change-Id: Ica327f27b26e5dd4b6744566eb09ea81a6e9583e
This change organizes the orchestration docs by topic rather than
letting autodoc organize methods by the order they appear in the
_proxy.py file.
Change-Id: Ia7df2887c0b1fa1d4eb04a9372dab247f21311a4
This change organizes the message docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
These were not previously included so they're technically all brand new.
There are some minor adjustments made to the docstrings as they weren't
known to be raising warnings before due to not actually being included
anywhere.
Change-Id: Id4b8f08015a6f00b8134fcd2a01506562d9787fb
This change organizes the key_manager docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I9caefcd9d1847da6689f6680fb420a9ea41a1c93
This change organizes the identity docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I991b810bad8e5932764186e52970748d47e0e4b4
This change organizes the image docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I798931fd3fecf51b922526fadb2ae243c4fc8c52
This change organizes the database docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I79e9ab9abb33fde72f48c10227a6b6140b2133ba
This change organizes the compute docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: Ie4955223a07c5ddbf0c5a06330521c69063bde28
This change organizes the bare_metal docs by topic rather than letting
autodoc organize methods by the order they appear in the _proxy.py file.
Change-Id: I24ec3db3fc24f1417d13c91a344e3ebeb622bb40
The Network proxy contains two methods that are mostly there for example
purposes: security_group_allow_ping and security_group_open_port.
They haven't been included in documentation due to missing docstrings,
and they aren't used anywhere in the SDK or within OSC. They're better
off as actual examples in our documentation than being within code that
we need to support throughout the future.
Change-Id: I4c6b47860b0c2b952e50d4b564451780008b631a
Per the approach on https://review.openstack.org/#/c/428276/, and in
general even outside of that change, we should have more strict
enforcement on the inclusion of our public proxy APIs in the
documentation. This tool runs as a part of our doc build, via `tox -e
docs`, and collects all of the public proxy methods and then compares
that list to the list of methods that were produced by Sphinx.
For right now this will only output warnings, but we should eventually
turn on enforcer_warnings_as_errors in doc/source/conf.py so that we can
truly enforce these things. If you don't document something, it'll kill
the doc build and then kill the docs gate job, so undocumented code
won't be accepted. We'll need to leave it off for the time
being as we transition into it.
Change-Id: I96743de7e0790da98d758415e084a26a92aa3c70
This is a second pass at cleaning up Sphinx issues with the doc build.
These ones only show themselves on a full rebuild after you blow away
doc/build/* so they weren't always seen.
Change-Id: I44e39b7e1f2bcf7a5eb420dee1569eb0b84929a4
This primarily cleans up doc files and mentions for modules which no
longer exist. There's one cleanup to a docstring in the Compute proxy
about a long class being split on two lines without a continuation
backslash.
Change-Id: I9f40d17789d7587e6964c3b655f4dae226dfc6a8
