diff --git a/.coveragerc b/.coveragerc index 3685187b80..8dc0326549 100644 --- a/.coveragerc +++ b/.coveragerc @@ -1,6 +1,7 @@ [run] branch = True source = openstackclient +omit = openstackclient/tests/* [report] ignore_errors = True diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000000..62caf9485a --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,13 @@ +# You can configure git to automatically use this file with the following config: +# git config --global blame.ignoreRevsFile .git-blame-ignore-revs + +c5b772db76c071e493a81105c7d8c0def08b2264 # trivial: Prepare for pyupgrade pre-commit hook +ed0314ac76ae58a6621077feb742efd5c14c3a62 # Blacken everything else +ac64fdb93c32972575a4523ccb23d0279ef584f5 # Blacken openstackclient.api +a3778109d0051a25901569e7bafe54915ab25f82 # Blacken openstack.common +53476e1f73d8af172207ac7089fb85fc0221859f # Blacken openstackclient.image +c51e4ef1bc350905a04690eb019d53e68fe3d633 # Blacken openstackclient.object +af6ea07703ed1c12b86995b97a9618bfa70721ee # Blacken openstackclient.identity +1face4f48b07fbc51824980e989687adaf453f0e # Blacken openstackclient.network +1ca77acc9118b433c14e03bf9fd28f2b1639c430 # Blacken openstackclient.volume +4bbf3bd3846cb3d85e243199910de82df25d35e0 # Blacken openstackclient.compute diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f91d10b7be..c76b800593 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,29 +1,28 @@ --- -default_language_version: - # force all unspecified python hooks to run python3 - python: python3 repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v3.4.0 + rev: v6.0.0 hooks: - id: trailing-whitespace - id: mixed-line-ending args: ['--fix', 'lf'] exclude: '.*\.(svg)$' - - id: check-byte-order-marker + - id: fix-byte-order-marker - id: check-executables-have-shebangs - id: check-merge-conflict - id: debug-statements - id: check-yaml files: .*\.(yaml|yml)$ - - repo: local + args: ['--unsafe'] + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.15.18 hooks: - - id: flake8 - name: flake8 - additional_dependencies: - - hacking>=2.0.0 - - flake8-import-order>=0.13 - language: python - entry: flake8 - files: '^.*\.py$' - exclude: '^(doc|releasenotes|tools)/.*$' + - id: ruff-check + args: ['--fix', '--unsafe-fixes'] + - id: ruff-format + - repo: https://opendev.org/openstack/hacking + rev: 8.1.0 + hooks: + - id: hacking + additional_dependencies: [] + exclude: '^(doc|releasenotes)/.*$' diff --git a/.zuul.yaml b/.zuul.yaml index 5372bc4da3..256d5dc364 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -1,4 +1,5 @@ --- + - job: name: osc-tox-unit-tips parent: openstack-tox @@ -6,6 +7,11 @@ Run unit tests for OpenStackClient with master branch of important libs. Takes advantage of the base tox job's install-siblings feature. + irrelevant-files: + - ^.*\.rst$ + - ^doc/.*$ + - ^releasenotes/.*$ + - ^\.pre-commit-config\.yaml$ required-projects: - openstack/cliff - openstack/keystoneauth @@ -18,14 +24,14 @@ zuul_work_dir: src/opendev.org/openstack/python-openstackclient - job: - name: osc-tox-py36-tips - parent: openstack-tox-py36 + name: osc-tox-py311-tips + parent: openstack-tox-py311 description: | Run unit tests for OpenStackClient with master branch of important libs. Takes advantage of the base tox job's install-siblings feature. # The job only tests the latest and shouldn't be run on the stable branches - branches: ^(?!stable) + branches: ^master$ required-projects: - openstack/cliff - openstack/keystoneauth @@ -38,11 +44,31 @@ zuul_work_dir: src/opendev.org/openstack/python-openstackclient - job: - name: osc-functional-devstack-base + name: osc-tox-py314-tips + parent: openstack-tox-py314 + description: | + Run unit tests for OpenStackClient with master branch of important libs. + + Takes advantage of the base tox job's install-siblings feature. + # The job only tests the latest and shouldn't be run on the stable branches + branches: ^master$ + required-projects: + - openstack/cliff + - openstack/keystoneauth + - openstack/openstacksdk + - openstack/osc-lib + - openstack/python-openstackclient + vars: + # Set work dir to openstackclient so that if it's triggered by one of the + # other repos the tests will run in the same place + zuul_work_dir: src/opendev.org/openstack/python-openstackclient + +- job: + name: osc-functional-devstack parent: devstack-tox-functional description: | - Base job for devstack-based functional tests - timeout: 9000 + Run functional tests for OpenStackClient. + timeout: 7800 irrelevant-files: - ^.*\.rst$ - ^doc/.*$ @@ -54,40 +80,17 @@ LIBS_FROM_GIT: python-openstackclient # NOTE(dtroyer): Functional tests need a bit more volume headroom VOLUME_BACKING_FILE_SIZE: 20G - devstack_local_conf: - post-config: - $CINDER_CONF: - DEFAULT: - # NOTE(dtroyer): OSC needs to support Volume v1 for a while yet so re-enable - enable_v1_api: true + Q_AGENT: openvswitch + Q_ML2_TENANT_NETWORK_TYPE: vxlan + Q_ML2_PLUGIN_MECHANISM_DRIVERS: openvswitch + devstack_plugins: + # NOTE(amotoki): Some neutron features are enabled by devstack plugin + neutron: https://opendev.org/openstack/neutron devstack_services: - ceilometer-acentral: false - ceilometer-acompute: false - ceilometer-alarm-evaluator: false - ceilometer-alarm-notifier: false - ceilometer-anotification: false - ceilometer-api: false - ceilometer-collector: false s-account: true s-container: true s-object: true s-proxy: true - osc_environment: - PYTHONUNBUFFERED: 'true' - OS_CLOUD: devstack-admin - zuul_work_dir: src/opendev.org/openstack/python-openstackclient - -# The Neutron bits are here rather than in osc-functional-devstack-base to -# simplify removing Neutron in the osc-functional-devstack-n-net job. -- job: - name: osc-functional-devstack - parent: osc-functional-devstack-base - timeout: 7800 - vars: - devstack_plugins: - # NOTE(amotoki): Some neutron features are enabled by devstack plugin - neutron: https://opendev.org/openstack/neutron - devstack_services: # Disable OVN services br-ex-tcpdump: false br-int-flows: false @@ -95,7 +98,7 @@ ovn-northd: false ovs-vswitchd: false ovsdb-server: false - q-ovn-metadata-agent: false + q-ovn-agent: false # Neutron services q-agt: true q-dhcp: true @@ -107,37 +110,21 @@ q-qos: true neutron-tag-ports-during-bulk-creation: true neutron-conntrack-helper: true - devstack_localrc: - Q_AGENT: openvswitch - Q_ML2_TENANT_NETWORK_TYPE: vxlan - Q_ML2_PLUGIN_MECHANISM_DRIVERS: openvswitch - tox_envlist: functional - -- job: - name: osc-functional-devstack-n-net - parent: osc-functional-devstack-base - timeout: 7800 - vars: - devstack_localrc: - FLAT_INTERFACE: br_flat - PUBLIC_INTERFACE: br_pub - devstack_services: - n-cell: true - n-net: true - neutron: false - neutron-segments: false - q-agt: false - q-dhcp: false - q-l3: false - q-meta: false - q-metering: false - q-qos: false - q-svc: false + neutron-ndp-proxy: true + q-trunk: true + osc_environment: + PYTHONUNBUFFERED: 'true' + OS_CLOUD: devstack-admin tox_envlist: functional + zuul_work_dir: src/opendev.org/openstack/python-openstackclient - job: name: osc-functional-devstack-tips parent: osc-functional-devstack + description: | + Run functional tests for OpenStackClient with master branch of important libs. + + Takes advantage of the base tox job's install-siblings feature. timeout: 7800 required-projects: - openstack/cliff @@ -148,120 +135,55 @@ vars: devstack_localrc: LIBS_FROM_GIT: python-openstackclient,openstacksdk,osc-lib,cliff - # This is insufficient, but leaving it here as a reminder of what may - # someday be all we need to make this work - # disable_python3_package swift - DISABLED_PYTHON3_PACKAGES: swift - devstack_services: - # Swift is not ready for python3 yet: At a minimum keystonemiddleware needs - # to be installed in the py2 env, there are probably other things too... - s-account: false - s-container: false - s-object: false - s-proxy: false - # As swift is not available for this job, c-bak service won't be functional. - # The backup related tests can be handled by other jobs having swift enabled. - # The backup service along with swift services can be enabled once swift is - # compatible with py3 - c-bak: false tox_envlist: functional tox_install_siblings: true -- secret: - name: osc-dockerhub - data: - username: osclientzuul - password: !encrypted/pkcs1-oaep - - LbIZjJiVstRVXMpoLQ3+/JcNB6lKVUWJXXo5+Outf+PKAaO7mNnv8XLiFMKnJ6ftopLyu - hWbX9rA+NddvplLQkf1xxkh7QBBU8PToLr58quI2SENUclt4tpjxbZfZu451kFSNJvNvR - E58cHHpfJZpyRnS2htXmN/Qy24gbV2w7CQxSZD2YhlcrerD8uQ8rWEnlY1wcJEaEGomtS - ZTGxsdK2TsZC2cd4b7TG7+xbl2i+hjADzwSQAgUzlLlwuG71667+IWk4SOZ7OycJTv9NN - ZTak8+CGfiMKdmsxZ1Z8uD7DC+RIklDjMWyly6zuhWzfhOmsmU0CesR50moodRUvbK79p - NZM8u0hBex5cl2EpUEwJL/FSPJXUhDMPoMoTZT/SAuXf25R9eZ9JGrKsIAlmVhpl8ifoE - 8TpPyvIHGS3YelTQjhqOX0wGb9T4ZauQCcI5Ajzy9NuCTyD9xxme9OX1zz7gMACRnVHvz - q7U7Ue90MnmGH6E2SgKjIZhyzy9Efwb7JUvH1Zb3hlrjCjEhwi9MV5FnABTEeXyYwE10s - 3o/KZg2zvdWkVG6x0dEkjpoQaNuaB7T2Na7Sm421n/z3LCzhiQGuTUjENnL6cMEtuA6Pp - BfI5+Qlg7HMwkBXNB73EPfWHzbCR3VNrzGYTy9FvhGud0/cXsuBXgps4WH63ic= - - job: name: osc-build-image parent: opendev-build-docker-image description: Build Docker images. allowed-projects: openstack/python-openstackclient requires: - - python-builder-3.7-container-image - - python-base-3.7-container-image + - python-builder-3.11-bookworm-container-image + - python-base-3.11-bookworm-container-image provides: osc-container-image - vars: &osc_image_vars + vars: docker_images: - context: . - repository: osclient/python-openstackclient - -- job: - name: osc-upload-image - parent: opendev-upload-docker-image - description: Build Docker images and upload to Docker Hub. - allowed-projects: openstack/python-openstackclient - requires: - - python-builder-3.7-container-image - - python-base-3.7-container-image - provides: osc-container-image - secrets: - - name: docker_credentials - secret: osc-dockerhub - pass-to-parent: true - vars: *osc_image_vars - -- job: - name: osc-promote-image - parent: opendev-promote-docker-image - allowed-projects: openstack/python-openstackclient - description: Promote previously uploaded Docker images. - secrets: - - name: docker_credentials - secret: osc-dockerhub - pass-to-parent: true - nodeset: - nodes: [] - vars: *osc_image_vars + tags: [] - project-template: name: osc-tox-unit-tips check: jobs: - - osc-tox-py36-tips + - osc-tox-py311-tips + - osc-tox-py314-tips gate: jobs: - - osc-tox-py36-tips + - osc-tox-py311-tips + - osc-tox-py314-tips - project: templates: - openstackclient-plugin-jobs - osc-tox-unit-tips - openstack-cover-jobs - - openstack-lower-constraints-jobs - - openstack-python3-zed-jobs + - openstack-python3-jobs + - openstack-python3-next-jobs - publish-openstack-docs-pti - check-requirements - release-notes-jobs-python3 check: jobs: - - osc-build-image + - openstackclient-check-plugins: + voting: true + - osc-build-image: + voting: false - osc-functional-devstack - # - osc-functional-devstack-n-net: - # voting: false - # # The job testing nova-network no longer works before Pike, and - # # should be disabled until the New Way of testing against old clouds - # # is ready and backported - # branches: ^(?!stable/(newton|ocata)).*$ - osc-functional-devstack-tips: # The functional-tips job only tests the latest and shouldn't be run # on the stable branches - branches: ^(?!stable) + branches: ^master$ gate: jobs: - - osc-upload-image - osc-functional-devstack - promote: - jobs: - - osc-promote-image diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f8732b7211..74b442ef66 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,13 +9,13 @@ to set up and use Gerrit: https://docs.openstack.org/contributors/code-and-documentation/quick-start.html -Bugs should be filed on StoryBoard: +Bugs should be filed on Launchpad: - https://storyboard.openstack.org/#!/project/openstack/python-openstackclient + https://bugs.launchpad.net/python-openstackclient Developers should also join the discussion on the mailing list, at: - http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/ or join the IRC channel on diff --git a/Dockerfile b/Dockerfile index bf5de3c755..6709be7514 100644 --- a/Dockerfile +++ b/Dockerfile @@ -13,12 +13,19 @@ # See the License for the specific language governing permissions and # limitations under the License. -FROM docker.io/opendevorg/python-builder:3.7 as builder +FROM docker.io/opendevorg/python-builder:3.12-bookworm AS builder COPY . /tmp/src RUN assemble -FROM docker.io/opendevorg/python-base:3.7 +FROM docker.io/opendevorg/python-base:3.12-bookworm + +LABEL org.opencontainers.image.title="python-openstackclient" +LABEL org.opencontainers.image.description="Client for OpenStack services." +LABEL org.opencontainers.image.licenses="Apache License 2.0" +LABEL org.opencontainers.image.url="https://www.openstack.org/" +LABEL org.opencontainers.image.documentation="https://docs.openstack.org/python-openstackclient/latest/" +LABEL org.opencontainers.image.source="https://opendev.org/openstack/python-openstackclient" COPY --from=builder /output/ /output RUN /output/install-from-bindep diff --git a/README.rst b/README.rst index 7f31bcdbea..af3837a351 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,3 @@ -======================== -Team and repository tags -======================== - -.. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg - :target: https://governance.openstack.org/tc/reference/tags/index.html - -.. Change things from this point on - =============== OpenStackClient =============== @@ -15,96 +6,158 @@ OpenStackClient :target: https://pypi.org/project/python-openstackclient/ :alt: Latest Version -OpenStackClient (aka OSC) is a command-line client for OpenStack that brings +OpenStackClient (OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Network, Object Store and Block Storage APIs together in a single shell with a uniform command structure. +Support for additional service APIs is provided via plugins. The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack. -* `PyPi`_ - package installation -* `Online Documentation`_ -* `Storyboard project`_ - bugs and feature requests -* `Blueprints`_ - feature specifications (historical only) -* `Source`_ -* `Developer`_ - getting started as a developer -* `Contributing`_ - contributing code -* `Testing`_ - testing code -* IRC: #openstack-sdks on OFTC (irc.oftc.net) -* License: Apache 2.0 - -.. _PyPi: https://pypi.org/project/python-openstackclient -.. _Online Documentation: https://docs.openstack.org/python-openstackclient/latest/ -.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient -.. _`Storyboard project`: https://storyboard.openstack.org/#!/project/openstack/python-openstackclient -.. _Source: https://opendev.org/openstack/python-openstackclient -.. _Developer: https://docs.openstack.org/project-team-guide/project-setup/python.html -.. _Contributing: https://docs.openstack.org/infra/manual/developers.html -.. _Testing: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html#testing -.. _Release Notes: https://docs.openstack.org/releasenotes/python-openstackclient - Getting Started =============== -OpenStack Client can be installed from PyPI using pip:: +OpenStack Client can be installed from PyPI using pip: - pip install python-openstackclient +.. code-block:: shell -There are a few variants on getting help. A list of global options and supported -commands is shown with ``--help``:: + python3 -m pip install python-openstackclient - openstack --help +You can use ``--help`` or the ``help`` command to get a list of global options +and supported commands: -There is also a ``help`` command that can be used to get help text for a specific -command:: +.. code-block:: shell + openstack --help openstack help + +You can also get help for a specific command: + +.. code-block:: shell + + openstack server create --help openstack help server create -If you want to make changes to the OpenStackClient for testing and contribution, -make any changes and then run:: +You can add support for additional services by installing their clients. For +example, to add support for the DNS service (designate): - python setup.py develop +.. code-block:: shell -or:: + python3 -m pip install python3-designateclient - pip install -e . +A ``Dockerfile`` is provided for your convenience in the repository. You can +use this to build your own container images: -Configuration -============= +.. code-block:: shell -The CLI is configured via environment variables and command-line -options as listed in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html. + git clone https://opendev.org/openstack/python-openstackclient + cd python-openstackclient + podman build . -t example.com/myuser/openstackclient -Authentication using username/password is most commonly used: +For more information the available options and commands, refer to the `Users +Guide`__. -- For a local user, your configuration will look like the one below:: +.. __: https://docs.openstack.org/python-openstackclient/latest/cli/index.html + +Configuration +============= + +OpenStack Client must be configured with authentication information in order to +communicate with a given OpenStack cloud. This configuration can be achieved +via a ``clouds.yaml`` file, a set of environment variables (often shared via an +``openrc`` file), a set of command-line options, or a combination of all three. +Your cloud provider or deployment tooling will typically provide either a +``clouds.yaml`` file or ``openrc`` file for you. If using a ``clouds.yaml`` +file, OpenStack Client expects to find it in one of the following locations: + +* If set, the path indicated by the ``OS_CLIENT_CONFIG_FILE`` environment + variable +* ``.`` (the current directory) +* ``$HOME/.config/openstack`` +* ``/etc/openstack`` + +The options you should set will depend on the configuration of your cloud and +the authentication mechanism(s) supported. For example, consider a cloud that +supports username/password authentication. Configuration for this cloud using a +``clouds.yaml`` file would look like so: + +.. code-block:: yaml + + clouds: + my-cloud: + auth: + auth_url: '' + project_name: '' + project_domain_name: '' + username: '' + user_domain_name: '' + password: '' # (optional) + region_name: '' + +The corresponding environment variables would look very similar: + +.. code-block:: shell export OS_AUTH_URL= - export OS_IDENTITY_API_VERSION=3 + export OS_REGION_NAME= export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_USERNAME= export OS_USER_DOMAIN_NAME= export OS_PASSWORD= # (optional) - The corresponding command-line options look very similar:: +Likewise, the corresponding command-line options would look very similar: - --os-auth-url - --os-identity-api-version 3 +:: + + openstack + --os-auth-url + --os-region --os-project-name --os-project-domain-name --os-username --os-user-domain-name [--os-password ] -- For a federated user, your configuration will look the so:: +.. note:: + + If a password is not provided above (in plaintext), you will be + interactively prompted to provide one securely. + +Some clouds use federated authentication. If this is the case, your +configuration will be slightly more involved. For example, to configure +username/password authentication for a federated user using a ``clouds.yaml`` +file: + +.. code-block:: yaml + + clouds: + my-cloud: + auth: + auth_url: '' + project_name: '' + project_domain_name: '' + username: '' + user_domain_name: '' + password: '' + identity_provider: '' + client_id: '' + client_secret: '' + openid_scope: '' + protocol: '' + access_token_type: '' + discovery_endpoint: '' + auth_type: 'v3oidcpassword' + region_name: '' + +The corresponding environment variables would look very similar: + +.. code-block:: shell export OS_PROJECT_NAME= export OS_PROJECT_DOMAIN_NAME= export OS_AUTH_URL= export OS_IDENTITY_API_VERSION=3 - export OS_AUTH_PLUGIN=openid export OS_AUTH_TYPE=v3oidcpassword export OS_USERNAME= export OS_PASSWORD= @@ -116,7 +169,9 @@ Authentication using username/password is most commonly used: export OS_ACCESS_TOKEN_TYPE= export OS_DISCOVERY_ENDPOINT= - The corresponding command-line options look very similar:: +Likewise, the corresponding command-line options would look very similar: + +.. code-block:: shell --os-project-name --os-project-domain-name @@ -134,5 +189,41 @@ Authentication using username/password is most commonly used: --os-access-token-type --os-discovery-endpoint -If a password is not provided above (in plaintext), you will be interactively -prompted to provide one securely. +For more information on configuring authentication, including an overview of +the many authentication mechanisms supported, refer to the `Authentication +guide`__. For more information on configuration in general, refer to the +`Configuration guide`__. + +.. __: https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html. +.. __: https://docs.openstack.org/python-openstackclient/latest/configuration/index.html + +Contributing +============ + +You can clone the repository from opendev.org:: + + git clone https://opendev.org/openstack/python-openstackclient + cd python-openstackclient + +OpenStack Client uses the same contributor process as other OpenStack projects. +For information on this process, including help on setting up you Gerrit +account and an overview of the CI process, refer to the `OpenStack Contributors +Guide`__. + +For more information on contributing to OpenStack Client itself, including +guidance on how to design new commands and how to report bugs, refer to the +`Contributors Guide`__. + +.. __: https://docs.openstack.org/python-openstackclient/latest/contributor/index.html +.. __: https://docs.opendev.org/opendev/infra-manual/latest/developers.html + +Links +----- + +* `Issue Tracker `_ +* `Code Review `_ +* `Documentation `_ +* `PyPi `_ +* `Mailing list `_ +* `Release Notes `_ +* `IRC (#openstack-sdks on OFTC (irc.oftc.net)) `_ diff --git a/bindep.txt b/bindep.txt index 4c90a026fe..8402431aed 100644 --- a/bindep.txt +++ b/bindep.txt @@ -8,3 +8,4 @@ libffi-dev [compile test platform:dpkg] libssl-dev [compile test platform:dpkg] python3-dev [compile test platform:dpkg] python3-devel [compile test platform:rpm] +libpcre2-dev [test platform:dpkg] diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index 2cdd0f5cd9..0000000000 --- a/doc/Makefile +++ /dev/null @@ -1,136 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html pdf dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " pdf to make pdf with rst2pdf" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -pdf: - $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf - @echo - @echo "Build finished. The PDFs are in $(BUILDDIR)/pdf." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NebulaDocs.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NebulaDocs.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/NebulaDocs" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NebulaDocs" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/requirements.txt b/doc/requirements.txt index 60a877970c..05a9bfa87c 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,31 +1,26 @@ -# The order of packages is significant, because pip processes them in the order -# of appearance. Changing the order has an impact on the overall integration -# process, which may cause wedges in the gate later. openstackdocstheme>=2.2.1 # Apache-2.0 reno>=3.1.0 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD # redirect tests in docs -whereto>=0.4.0 # Apache-2.0 +whereto>=0.5.0 # Apache-2.0 # Install these to generate sphinx autodocs aodhclient>=0.9.0 # Apache-2.0 gnocchiclient>=3.3.1 # Apache-2.0 osc-placement>=1.7.0 # Apache-2.0 python-barbicanclient>=4.5.2 # Apache-2.0 +python-cyborgclient>=1.2.1 # Apache-2.0 python-designateclient>=2.7.0 # Apache-2.0 python-heatclient>=1.10.0 # Apache-2.0 python-ironicclient>=2.3.0 # Apache-2.0 python-ironic-inspector-client>=1.5.0 # Apache-2.0 +python-magnumclient>=2.3.0 # Apache-2.0 python-manilaclient>=2.0.0 # Apache-2.0 python-mistralclient!=3.2.0,>=3.1.0 # Apache-2.0 -python-muranoclient>=0.8.2 # Apache-2.0 python-neutronclient>=6.7.0 # Apache-2.0 python-octaviaclient>=1.11.0 # Apache-2.0 -python-rsdclient>=1.0.1 # Apache-2.0 -python-saharaclient>=1.4.0 # Apache-2.0 -python-senlinclient>=1.1.0 # Apache-2.0 python-troveclient>=3.1.0 # Apache-2.0 python-watcherclient>=2.5.0 # Apache-2.0 python-zaqarclient>=1.0.0 # Apache-2.0 diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess index 8c0a005425..ab7dceecf9 100644 --- a/doc/source/_extra/.htaccess +++ b/doc/source/_extra/.htaccess @@ -14,3 +14,13 @@ redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/plugin-commands.html$ /py # - image pages were split into -v1 and -v2 # The unversioned page is hidden but contains links to the versioned pages so links in the wild redirect somewhere sane. redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(ec2-credentials|endpoint|image|project|role|service|token|user).html$ /python-openstackclient/$1/cli/_hidden/$2.html + +# Redirect docs from their previous flat structure to the new service/version structure +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(availability-zone|command|complete|configuration|extension|limits|module|project-cleanup|quota|versions)\.html$ /python-openstackclient/$1/cli/command-objects/common/index.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(aggregate|compute-agent|compute-service|console-connection|console-log|console-url|flavor|host|hypervisor-stats|hypervisor|keypair|server-backup|server-event|server-group|server-image|server-migration|server|usage)\.html$ /python-openstackclient/$1/cli/command-objects/compute/v2/index.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(ec2-credentials-v2|endpoint-v2|project-v2|role-v2|service-v2|token-v2|user-v2)\.html$ /python-openstackclient/$1/cli/command-objects/identity/v2/index.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(access-rules|access-token|application-credentials|catalog|consumer|credential|domain|ec2-credentials-v3|endpoint-v3|endpoint_group|federation-domain-project|federation-protocol|group|identity-provider|implied_role|limit|mapping|policy|project-v3|region|registered-limit|request-token|role-assignment|role-v3|service-provider|service-v3|token-v3|trust|user-v3)\.html$ /python-openstackclient/$1/cli/command-objects/identity/v3/index.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(image-member|image-task|image-v2)\.html$ /python-openstackclient/$1/cli/command-objects/image/v2/index.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(address-group|address-scope|default-security-group-rule|floating-ip-port-forwarding|floating-ip|ip-availability|local-ip-association|local-ip|network-agent|network-auto-allocated-topology|network-flavor-profile|network-flavor|network-l3-conntrack-helper|network-meter-rule|network-meter|network-qos-policy|network-qos-rule-type|network-qos-rule|network-rbac|network-segment|network-service-provider|network-trunk|network|network_segment_range|port|router-ndp-proxy|router|security-group-rule|security-group|subnet-pool|subnet)\.html$ /python-openstackclient/$1/cli/command-objects/network/v2/index.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(container|object-store-account|object)\.html$ /python-openstackclient/$1/cli/command-objects/object-store/v1/index.html +redirectmatch 301 ^/python-openstackclient/([^/]+)/cli/command-objects/(block-storage-cleanup|block-storage-cluster|block-storage-log-level|block-storage-manage|block-storage-resource-filter|consistency-group-snapshot|consistency-group|volume-attachment|volume-backend|volume-backup|volume-group-snapshot|volume-group-type|volume-group|volume-host|volume-message|volume-qos|volume-service|volume-snapshot|volume-transfer-request|volume-type|volume)\.html$ /python-openstackclient/$1/cli/command-objects/volume/v3/index.html diff --git a/doc/source/cli/_hidden/ec2-credentials.rst b/doc/source/cli/_hidden/ec2-credentials.rst deleted file mode 100644 index c54459d877..0000000000 --- a/doc/source/cli/_hidden/ec2-credentials.rst +++ /dev/null @@ -1,13 +0,0 @@ -=============== -ec2 credentials -=============== - -.. NOTE(efried): This page is hidden from the main TOC; it's here so links in - the wild redirect somewhere sane, because previously identity v2 and v3 were - combined in a single page. - -.. toctree:: - :maxdepth: 2 - - ../command-objects/ec2-credentials-v2 - ../command-objects/ec2-credentials-v3 diff --git a/doc/source/cli/_hidden/endpoint.rst b/doc/source/cli/_hidden/endpoint.rst deleted file mode 100644 index 744e3badcb..0000000000 --- a/doc/source/cli/_hidden/endpoint.rst +++ /dev/null @@ -1,13 +0,0 @@ -======== -endpoint -======== - -.. NOTE(efried): This page is hidden from the main TOC; it's here so links in - the wild redirect somewhere sane, because previously identity v2 and v3 were - combined in a single page. - -.. toctree:: - :maxdepth: 2 - - ../command-objects/endpoint-v2 - ../command-objects/endpoint-v3 diff --git a/doc/source/cli/_hidden/image.rst b/doc/source/cli/_hidden/image.rst deleted file mode 100644 index 85ffde6f39..0000000000 --- a/doc/source/cli/_hidden/image.rst +++ /dev/null @@ -1,13 +0,0 @@ -===== -image -===== - -.. NOTE(efried): This page is hidden from the main TOC; it's here so links in - the wild redirect somewhere sane, because previously identity v2 and v3 were - combined in a single page. - -.. toctree:: - :maxdepth: 2 - - ../command-objects/image-v1 - ../command-objects/image-v2 diff --git a/doc/source/cli/_hidden/project.rst b/doc/source/cli/_hidden/project.rst deleted file mode 100644 index 209a3129df..0000000000 --- a/doc/source/cli/_hidden/project.rst +++ /dev/null @@ -1,13 +0,0 @@ -======= -project -======= - -.. NOTE(efried): This page is hidden from the main TOC; it's here so links in - the wild redirect somewhere sane, because previously identity v2 and v3 were - combined in a single page. - -.. toctree:: - :maxdepth: 2 - - ../command-objects/project-v2 - ../command-objects/project-v3 diff --git a/doc/source/cli/_hidden/role.rst b/doc/source/cli/_hidden/role.rst deleted file mode 100644 index c85f48146c..0000000000 --- a/doc/source/cli/_hidden/role.rst +++ /dev/null @@ -1,13 +0,0 @@ -==== -role -==== - -.. NOTE(efried): This page is hidden from the main TOC; it's here so links in - the wild redirect somewhere sane, because previously identity v2 and v3 were - combined in a single page. - -.. toctree:: - :maxdepth: 2 - - ../command-objects/role-v2 - ../command-objects/role-v3 diff --git a/doc/source/cli/_hidden/service.rst b/doc/source/cli/_hidden/service.rst deleted file mode 100644 index 8b33638610..0000000000 --- a/doc/source/cli/_hidden/service.rst +++ /dev/null @@ -1,13 +0,0 @@ -======= -service -======= - -.. NOTE(efried): This page is hidden from the main TOC; it's here so links in - the wild redirect somewhere sane, because previously identity v2 and v3 were - combined in a single page. - -.. toctree:: - :maxdepth: 2 - - ../command-objects/service-v2 - ../command-objects/service-v3 diff --git a/doc/source/cli/_hidden/token.rst b/doc/source/cli/_hidden/token.rst deleted file mode 100644 index 6ebf801b76..0000000000 --- a/doc/source/cli/_hidden/token.rst +++ /dev/null @@ -1,13 +0,0 @@ -===== -token -===== - -.. NOTE(efried): This page is hidden from the main TOC; it's here so links in - the wild redirect somewhere sane, because previously identity v2 and v3 were - combined in a single page. - -.. toctree:: - :maxdepth: 2 - - ../command-objects/token-v2 - ../command-objects/token-v3 diff --git a/doc/source/cli/_hidden/user.rst b/doc/source/cli/_hidden/user.rst deleted file mode 100644 index 34eb59954f..0000000000 --- a/doc/source/cli/_hidden/user.rst +++ /dev/null @@ -1,13 +0,0 @@ -==== -user -==== - -.. NOTE(efried): This page is hidden from the main TOC; it's here so links in - the wild redirect somewhere sane, because previously identity v2 and v3 were - combined in a single page. - -.. toctree:: - :maxdepth: 2 - - ../command-objects/user-v2 - ../command-objects/user-v3 diff --git a/doc/source/cli/authentication.rst b/doc/source/cli/authentication.rst index 2e9148c356..69cd7009e0 100644 --- a/doc/source/cli/authentication.rst +++ b/doc/source/cli/authentication.rst @@ -4,10 +4,8 @@ Authentication ============== -OpenStackClient leverages `python-keystoneclient`_ authentication -plugins to support a number of different authentication methods. - -.. _`python-keystoneclient`: https://docs.openstack.org/python-keystoneclient/latest/using-sessions.html#sharing-authentication-plugins +OpenStackClient leverages *keystoneauth* authentication plugins to support a +number of different authentication methods. Authentication Process ---------------------- @@ -15,7 +13,8 @@ Authentication Process The user provides some number of authentication credential options. If an authentication type is not provided (``--os-auth-type``), the authentication options are examined to determine if one of the default -types can be used. If no match is found an error is reported and OSC exits. +types can be used. If no match is found an error is reported and +OpenStackClient exits. Note that the authentication call to the Identity service has not yet occurred. It is deferred until the last possible moment in order to @@ -25,7 +24,7 @@ processing detects an invalid command. Authentication Plugins ---------------------- -The Keystone client library implements the base set of plugins. Additional +The *keystoneauth* library implements the base set of plugins. Additional plugins may be available from the Keystone project or other sources. There are at least three authentication types that are always available: @@ -33,15 +32,15 @@ There are at least three authentication types that are always available: * **Password**: A project, username and password are used to identify the user. An optional domain may also be included. This is the most common type and is the default any time a username is supplied. An authentication - URL for the Identity service is also required. [Required: ``--os-auth-url``, - ``--os-project-name``, ``--os-username``; Optional: ``--os-password``] + URL for the Identity service is also required. + * **Token**: This is slightly different from the usual token authentication - (described below as token/endpoint) in that a token and an authentication - URL are supplied and the plugin retrieves a new token. - [Required: ``--os-auth-url``, ``--os-token``] + in that a token and an authentication URL are supplied and the plugin + retrieves a new token. + * **Others**: Other authentication plugins such as SAML, Kerberos, and OAuth1.0 - are under development and also supported. To use them, they must be selected - by supplying the ``--os-auth-type`` option. + are also supported. To use them, they must be selected by supplying the + ``--os-auth-type`` option. Detailed Process ---------------- @@ -145,5 +144,233 @@ credentials. This is useful in a Federated environment where one credential give access to many applications/services that the Federation supports. To check how to configure the OpenStackClient to allow Federated users to log in, please check -the -:ref:`Authentication using federation. ` +the :ref:`Authentication using federation. ` + +Examples +-------- + +.. todo: It would be nice to add more examples here, particularly for + complicated things like oauth2 + +``v3password`` +~~~~~~~~~~~~~~ + +Using ``clouds.yaml``: + +.. code-block:: yaml + + clouds: + demo: + auth: + auth_url: http://openstack.dev/identity + project_name: demo + project_domain_name: default + user_domain_name: default + username: demo + password: password + auth_type: v3password + +or, using command line options: + +.. code-block:: bash + + $ openstack \ + --os-auth-url "http://openstack.dev/identity" \ + --os-project-name demo \ + --os-project-domain-name default \ + --os-user-domain-name default \ + --os-auth-type=v3password \ + --os-username demo \ + --os-password password \ + server list + +or, using environment variables: + +.. code-block:: bash + + $ export OS_AUTH_URL="http://openstack.dev/identity" + $ export OS_PROJECT_NAME=demo + $ export OS_PROJECT_DOMAIN_NAME=default + $ export OS_AUTH_TYPE=v3password + $ export OS_USERNAME=demo + $ export OS_PASSWORD=password + $ openstack server list + +.. note:: + + If a password is not provided, you will be prompted for one. + +``v3applicationcredential`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Using ``clouds.yaml``: + +.. code-block:: yaml + + clouds: + demo: + auth: + auth_url: http://openstack.dev/identity + application_credential_id: ${APP_CRED_ID} + application_credential_secret: ${APP_CRED_SECRET} + auth_type: v3applicationcredential + +or, using command line options: + +.. code-block:: bash + + $ openstack \ + --os-auth-url "http://openstack.dev/identity" \ + --os-auth-type=v3applicationcredential \ + --os-application-credential-id=${APP_CRED_ID} \ + --os-application-credential-secret=${APP_CRED_SECRET} + server list + +or, using environment variables: + +.. code-block:: bash + + $ export OS_AUTH_URL="http://openstack.dev/identity" + $ export OS_AUTH_TYPE=v3applicationcredential + $ export OS_APPLICATION_CREDENTIAL_ID=${APP_CRED_ID} + $ export OS_APPLICATION_CREDENTIAL_SECRET=${APP_CRED_SECRET} + $ openstack server list + +.. note:: + + You can generate application credentials using the :program:`openstack + application credential create` command: + + .. code-block:: bash + + $ readarray -t lines <<< $(openstack application credential create test -f value -c id -c secret) + $ APP_CRED_ID=${lines[0]} + $ APP_CRED_SECRET=${lines[1]} + +``v3token`` +~~~~~~~~~~~ + +Using ``clouds.yaml``: + +.. code-block:: yaml + + clouds: + demo: + auth: + auth_url: http://openstack.dev/identity + project_name: demo + project_domain_name: default + token: ${TOKEN} + auth_type: v3token + +or, using command line options: + +.. code-block:: bash + + $ openstack \ + --os-auth-url "http://openstack.dev/identity" \ + --os-project-name demo \ + --os-project-domain-name default \ + --os-auth-type=v3token \ + --os-token ${TOKEN} \ + server list + +or, using environment variables: + +.. code-block:: bash + + $ export OS_AUTH_URL="http://openstack.dev/identity" + $ export OS_PROJECT_NAME=demo + $ export OS_PROJECT_DOMAIN_NAME=default + $ export OS_AUTH_TYPE=v3token + $ export OS_TOKEN=${TOKEN} + $ openstack server list + +.. note:: + + You can generate tokens using the :program:`openstack token issue` command: + + .. code-block:: bash + + $ TOKEN=$(openstack token issue -f value -c id) + +.. note:: + + The above examples assume you require a project-scoped token. You can omit + the project-related configuration if your user has a default project ID set. + Conversely, if requesting domain-scoped or system-scoped, you should update + these examples accordingly. If the user does not have a default project + configured and no scoping information is provided, the resulting token will + be unscoped. + +``v3totp`` +~~~~~~~~~~ + +.. note:: + + The TOTP mechanism is poorly suited to command line-driven API + interactions. Where the TOTP mechanism is configured for a cloud, it is + expected that it is to be used for initial authentication and to create a + token or application credential, which can then be used for future + interactions. + +.. note:: + + The TOTP mechanism is often combined with other mechanisms to enable + Multi-Factor Authentication, or MFA. The authentication type + ``v3multifactor`` is used in this case, while the ``v3totp`` authentication + type is specified alongside the other mechanisms in ``auth_methods``. + +Using ``clouds.yaml``: + +.. code-block:: yaml + + clouds: + demo: + auth: + auth_url: http://openstack.dev/identity + project_name: demo + project_domain_name: default + user_domain_name: default + username: demo + passcode: ${PASSCODE} + auth_type: v3totp + +or, using command line options: + +.. code-block:: bash + + $ openstack \ + --os-auth-url "http://openstack.dev/identity" \ + --os-project-name demo \ + --os-project-domain-name default \ + --os-user-domain-name default \ + --os-auth-type=v3totp \ + --os-username demo \ + --os-passcode ${PASSCODE} \ + server list + +or, using environment variables: + +.. code-block:: bash + + $ export OS_AUTH_URL="http://openstack.dev/identity" + $ export OS_PROJECT_NAME=demo + $ export OS_PROJECT_DOMAIN_NAME=default + $ export OS_AUTH_TYPE=v3totp + $ export OS_USERNAME=demo + $ export OS_PASSCODE=${PASSCODE} + $ openstack server list + +.. note:: + + The passcode will be generated by an authenticator application such FreeOTP + or Google Authenticator. Refer to your cloud provider's documentation for + information on how to configure an authenticator application, or to the + `Keystone documentation`__ if you are configuring this for your own cloud. + + .. __: https://docs.openstack.org/keystone/latest/admin/auth-totp.html + +.. note:: + + If a passcode is not provided, you will be prompted for one. diff --git a/doc/source/cli/backwards-incompatible.rst b/doc/source/cli/backwards-incompatible.rst index 9d43754e01..652ca6c29f 100644 --- a/doc/source/cli/backwards-incompatible.rst +++ b/doc/source/cli/backwards-incompatible.rst @@ -16,123 +16,145 @@ from this backwards incompatible change handling. Backwards Incompatible Changes ============================== +Release 10.0 +------------ + +1. Nova network support was removed from the networking commands. + + As Neutron has been the preferred networking solution in + Openstack for close to ten years, the old Nova network + code was finally removed. All networking API calls are still + supported, but they will only use the Neutron API endpoint. + + * Commit: https://review.opendev.org/981613 + Release 4.0 ----------- 1. Remove ``ip fixed add|remove`` commands. + Use ``server add|remove fixed ip`` commands instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612781 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612781 2. Remove ``ip floating add|remove`` commands. + Use ``server add|remove floating ip`` commands instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612781 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612781 3. Remove ``service create`` option ``--type``. Service type is a positional argument. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612798 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612798 4. Remove ``role list`` options ``--project`` and ``--user``. + Use ``role assignment list`` options ``--project`` and ``--user`` instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612798 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612798 5. Remove ``user role list`` command. + Use ``role assignment list`` options ``--project`` and ``--user`` instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612798 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612798 6. Remove ``image create|set`` option ``--owner``. + Use ``--project`` option instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/659431 + * Removed in: 4.0 + * Commit: https://review.opendev.org/659431 7. Remove ``port create|set`` options ``--device-id`` and ``--host-id``. + Use ``--device`` and ``--host`` instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/613644 + * Removed in: 4.0 + * Commit: https://review.opendev.org/613644 8. Remove ``router set`` option ``--clear-routes``. + Use ``no-route`` option instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/613644 + * Removed in: 4.0 + * Commit: https://review.opendev.org/613644 9. Remove ``security group rule create`` options ``--src-ip`` and ``--src-group``. + Use ``--remote-ip`` and ``--remote-group`` options instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/613644 + * Removed in: 4.0 + * Commit: https://review.opendev.org/613644 10. Remove ``backup`` commands. + Use ``volume backup`` commands instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612751 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612751 11. Remove ``snapshot`` commands. Use ``volume snapshot`` commands instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612751 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612751 12. Remove ``volume create`` options ``--project``, ``--user``, ``--multi-attach``. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612751 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612751 13. Change ``volume transfer request accept`` to use new option ``--auth-key`` rather than a second positional argument. - * Removed in: 4.0 - * Commit: https://review.opendev.org/612751 + * Removed in: 4.0 + * Commit: https://review.opendev.org/612751 14. Remove 'Token/Endpoint' auth plugin support (type ``token_endpoint``). + This remained as a compatibility for the ``admin_token`` auth type to support the ``--url`` global option. That option is also now removed, use ``--endpoint`` instead. - * Removed in: 4.0 - * Commit: https://review.opendev.org/ + * Removed in: 4.0 + * Commit: https://review.opendev.org/ Release 3.12 ------------ 1. Replace ``Display Name`` by ``Name`` in volume list. - Change column name ``Display Name`` to ``Name`` in ``volume list`` output. - Current ``volume list --name`` command uses ``display_name`` as search_opts - to send to cinder API, and show the result table with ``Display Name`` - as column title. Replace all ``Display Name`` by ``Name`` to be consistent - with other list commands. + Change column name ``Display Name`` to ``Name`` in ``volume list`` output. + Current ``volume list --name`` command uses ``display_name`` as search_opts + to send to cinder API, and show the result table with ``Display Name`` + as column title. Replace all ``Display Name`` by ``Name`` to be consistent + with other list commands. - Support a mapping for volume list -c ``Display Name`` (Volume v1 and v2) - and volume create/show -c ``display_name`` (Volume v1) to maintain backward - compatibility until the next major release. + Support a mapping for volume list -c ``Display Name`` (Volume v1 and v2) + and volume create/show -c ``display_name`` (Volume v1) to maintain backward + compatibility until the next major release. - * In favor of: ``openstack volume list -c Name`` - * As of: 3.12.0 - * Removed in: n/a - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1657956 - * Commit: https://review.opendev.org/#/c/423081/ + * In favor of: ``openstack volume list -c Name`` + * As of: 3.12.0 + * Removed in: n/a + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1657956 + * Commit: https://review.opendev.org/#/c/423081/ Release 3.10 ------------ 1. The ``network create`` command now requires the ``--subnet`` option when used - with Nova-network clouds. + with nova-network clouds. - * As of: 3.10 - * Commit: https://review.opendev.org/460679 + * As of: 3.10 + * Commit: https://review.opendev.org/460679 2. The positional argument ```` of the ``volume snapshot create`` command is no longer optional. @@ -142,23 +164,23 @@ Release 3.10 ``--volume`` option is not present now it defaults to the value of ````. - * As of: 3.10 - * Bug: 1659894 - * Commit: https://review.opendev.org/440497 + * As of: 3.10 + * Bug: 1659894 + * Commit: https://review.opendev.org/440497 Release 3.0 ----------- 1. Remove the ``osc_password`` authentication plugin. - This was the 'last-resort' plugin default that worked around an old default - Keystone configuration for the ``admin_endpoint`` and ``public_endpoint``. + This was the 'last-resort' plugin default that worked around an old default + Keystone configuration for the ``admin_endpoint`` and ``public_endpoint``. - * In favor of: ``password`` - * As of: 3.0 - * Removed in: n/a - * Bug: n/a - * Commit: https://review.opendev.org/332938 + * In favor of: ``password`` + * As of: 3.0 + * Removed in: n/a + * Bug: n/a + * Commit: https://review.opendev.org/332938 Releases Before 3.0 @@ -166,209 +188,209 @@ Releases Before 3.0 1. Rename command `openstack project usage list` - The `project` part of the command was pointless. + The `project` part of the command was pointless. - * In favor of: `openstack usage list` instead. - * As of: 1.0.2 - * Removed in: TBD - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1406654 - * Commit: https://review.opendev.org/#/c/147379/ + * In favor of: `openstack usage list` instead. + * As of: 1.0.2 + * Removed in: TBD + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1406654 + * Commit: https://review.opendev.org/#/c/147379/ 2. should not be optional for command `openstack service create` - Previously, the command was `openstack service create --type `, - whereas now it is: `openstack service create --name `. - This bug also affected python-keystoneclient, and keystone. + Previously, the command was `openstack service create --type `, + whereas now it is: `openstack service create --name `. + This bug also affected python-keystoneclient, and keystone. - * In favor of: making a positional argument. - * As of: 1.0.2 - * Removed in: TBD - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1404073 - * Commit: https://review.opendev.org/#/c/143242/ + * In favor of: making a positional argument. + * As of: 1.0.2 + * Removed in: TBD + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1404073 + * Commit: https://review.opendev.org/#/c/143242/ 3. Command `openstack security group rule delete` now requires rule id - Previously, the command was `openstack security group rule delete --proto - [--src-ip --dst-port ] `, - whereas now it is: `openstack security group rule delete `. + Previously, the command was `openstack security group rule delete --proto + [--src-ip --dst-port ] `, + whereas now it is: `openstack security group rule delete `. - * In favor of: Using `openstack security group rule delete `. - * As of: 1.2.1 - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1450872 - * Commit: https://review.opendev.org/#/c/179446/ + * In favor of: Using `openstack security group rule delete `. + * As of: 1.2.1 + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1450872 + * Commit: https://review.opendev.org/#/c/179446/ 4. Command `openstack image create` does not update already existing image - Previously, the image create command updated already existing image if it had - same name. It disabled possibility to create multiple images with same name - and lead to potentially unwanted update of existing images by image create - command. - Now, update code was moved from create action to set action. + Previously, the image create command updated already existing image if it had + same name. It disabled possibility to create multiple images with same name + and lead to potentially unwanted update of existing images by image create + command. + Now, update code was moved from create action to set action. - * In favor of: Create multiple images with same name (as glance does). - * As of: 1.5.0 - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1461817 - * Commit: https://review.opendev.org/#/c/194654/ + * In favor of: Create multiple images with same name (as glance does). + * As of: 1.5.0 + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1461817 + * Commit: https://review.opendev.org/#/c/194654/ 5. Command `openstack network list --dhcp` has been removed - The --dhcp option to network list is not a logical use case of listing - networks, it lists agents. Another command should be added in the future - to provide this functionality. It is highly unlikely anyone uses this - feature as we don't support any other agent commands. Use neutron - dhcp-agent-list-hosting-net command instead. + The --dhcp option to network list is not a logical use case of listing + networks, it lists agents. Another command should be added in the future + to provide this functionality. It is highly unlikely anyone uses this + feature as we don't support any other agent commands. Use neutron + dhcp-agent-list-hosting-net command instead. - * In favor of: Create network agent list command in the future - * As of: 1.6.0 - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/472613 - * Commit: https://review.opendev.org/#/c/194654/ + * In favor of: Create network agent list command in the future + * As of: 1.6.0 + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/472613 + * Commit: https://review.opendev.org/#/c/194654/ 6. Plugin interface change for default API versions - Previously, the default version was set in the parsed arguments, - but this makes it impossible to tell what has been passed in at the - command line, set in an environment variable or is just the default. - Now, the module should have a DEFAULT_API_VERSION that contains the - value and it will be set after command line argument, environment - and OCC file processing. + Previously, the default version was set in the parsed arguments, + but this makes it impossible to tell what has been passed in at the + command line, set in an environment variable or is just the default. + Now, the module should have a DEFAULT_API_VERSION that contains the + value and it will be set after command line argument, environment + and OCC file processing. - * In favor of: DEFAULT_API_VERSION - * As of: 1.2.1 - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1453229 - * Commit: https://review.opendev.org/#/c/181514/ + * In favor of: DEFAULT_API_VERSION + * As of: 1.2.1 + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1453229 + * Commit: https://review.opendev.org/#/c/181514/ 7. `image set` commands will no longer return the modified resource - Previously, modifying an image would result in the new image being displayed - to the user. To keep things consistent with other `set` commands, we will - no longer be showing the modified resource. + Previously, modifying an image would result in the new image being displayed + to the user. To keep things consistent with other `set` commands, we will + no longer be showing the modified resource. - * In favor of: Use `set` then `show` - * As of: NA - * Removed in: NA - * Bug: NA - * Commit: NA + * In favor of: Use `set` then `show` + * As of: NA + * Removed in: NA + * Bug: NA + * Commit: NA 8. `region` commands no longer support `url` - The Keystone team removed support for the `url` attribute from the client - and server side. Changes to the `create`, `set` and `list` commands for - regions have been affected. + The Keystone team removed support for the `url` attribute from the client + and server side. Changes to the `create`, `set` and `list` commands for + regions have been affected. - * In favor of: NA - * As of 1.9.0 - * Removed in: NA - * Bug: https://launchpad.net/bugs/1506841 - * Commit: https://review.opendev.org/#/c/236736/ + * In favor of: NA + * As of 1.9.0 + * Removed in: NA + * Bug: https://launchpad.net/bugs/1506841 + * Commit: https://review.opendev.org/#/c/236736/ 9. `flavor set/unset` commands will no longer return the modified resource - Previously, modifying a flavor would result in the new flavor being displayed - to the user. To keep things consistent with other `set/unset` commands, we - will no longer be showing the modified resource. + Previously, modifying a flavor would result in the new flavor being displayed + to the user. To keep things consistent with other `set/unset` commands, we + will no longer be showing the modified resource. - * In favor of: Use `set/unset` then `show` - * As of: NA - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 - * Commit: https://review.opendev.org/#/c/280663/ + * In favor of: Use `set/unset` then `show` + * As of: NA + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 + * Commit: https://review.opendev.org/#/c/280663/ 10. `security group set` commands will no longer return the modified resource - Previously, modifying a security group would result in the new security group - being displayed to the user. To keep things consistent with other `set` - commands, we will no longer be showing the modified resource. + Previously, modifying a security group would result in the new security group + being displayed to the user. To keep things consistent with other `set` + commands, we will no longer be showing the modified resource. - * In favor of: Use `set` then `show` - * As of: NA - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 - * Commit: https://review.opendev.org/#/c/281087/ + * In favor of: Use `set` then `show` + * As of: NA + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 + * Commit: https://review.opendev.org/#/c/281087/ 11. `compute agent set` commands will no longer return the modified resource - Previously, modifying an agent would result in the new agent being displayed - to the user. To keep things consistent with other `set` commands, we will - no longer be showing the modified resource. + Previously, modifying an agent would result in the new agent being displayed + to the user. To keep things consistent with other `set` commands, we will + no longer be showing the modified resource. - * In favor of: Use `set` then `show` - * As of: NA - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 - * Commit: https://review.opendev.org/#/c/281088/ + * In favor of: Use `set` then `show` + * As of: NA + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 + * Commit: https://review.opendev.org/#/c/281088/ 12. ` ` should be optional for command `openstack compute agent set` - Previously, the command was `openstack compute agent set - `, whereas now it is: `openstack compute agent set --version - --url --md5hash `. + Previously, the command was `openstack compute agent set + `, whereas now it is: `openstack compute agent set --version + --url --md5hash `. - * In favor of: making optional. - * As of: NA - * Removed in: NA - * Bug: NA - * Commit: https://review.opendev.org/#/c/328819/ + * In favor of: making optional. + * As of: NA + * Removed in: NA + * Bug: NA + * Commit: https://review.opendev.org/#/c/328819/ 13. `aggregate set` commands will no longer return the modified resource - Previously, modifying an aggregate would result in the new aggregate being - displayed to the user. To keep things consistent with other `set` commands, - we will no longer be showing the modified resource. + Previously, modifying an aggregate would result in the new aggregate being + displayed to the user. To keep things consistent with other `set` commands, + we will no longer be showing the modified resource. - * In favor of: Use `set` then `show` - * As of: NA - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 - * Commit: https://review.opendev.org/#/c/281089/ + * In favor of: Use `set` then `show` + * As of: NA + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065 + * Commit: https://review.opendev.org/#/c/281089/ 14. Output of `ip floating list` command has changed. - When using Compute v2, the original output is: + When using Compute v2, the original output is: - .. code-block:: bash + .. code-block:: bash - # ip floating list + # ip floating list - +----+--------+------------+----------+-------------+ - | ID | Pool | IP | Fixed IP | Instance ID | - +----+--------+-----------------------+-------------+ - | 1 | public | 172.24.4.1 | None | None | - +----+--------+------------+----------+-------------+ + +----+--------+------------+----------+-------------+ + | ID | Pool | IP | Fixed IP | Instance ID | + +----+--------+-----------------------+-------------+ + | 1 | public | 172.24.4.1 | None | None | + +----+--------+------------+----------+-------------+ - Now it changes to: + Now it changes to: - .. code-block:: bash + .. code-block:: bash - # ip floating list + # ip floating list - +----+---------------------+------------------+-----------+--------+ - | ID | Floating IP Address | Fixed IP Address | Server ID | Pool | - +----+---------------------+------------------+-----------+--------+ - | 1 | 172.24.4.1 | None | None | public | - +----+---------------------+------------------+-----------+--------+ + +----+---------------------+------------------+-----------+--------+ + | ID | Floating IP Address | Fixed IP Address | Server ID | Pool | + +----+---------------------+------------------+-----------+--------+ + | 1 | 172.24.4.1 | None | None | public | + +----+---------------------+------------------+-----------+--------+ - When using Network v2, which is different from Compute v2. The output is: + When using Network v2, which is different from Compute v2. The output is: - .. code-block:: bash + .. code-block:: bash - # ip floating list + # ip floating list - +--------------------------------------+---------------------+------------------+------+ - | ID | Floating IP Address | Fixed IP Address | Port | - +--------------------------------------+---------------------+------------------+------+ - | 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None | - +--------------------------------------+---------------------+------------------+------+ + +--------------------------------------+---------------------+------------------+------+ + | ID | Floating IP Address | Fixed IP Address | Port | + +--------------------------------------+---------------------+------------------+------+ + | 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None | + +--------------------------------------+---------------------+------------------+------+ - * In favor of: Use `ip floating list` command - * As of: NA - * Removed in: NA - * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1519502 - * Commit: https://review.opendev.org/#/c/277720/ + * In favor of: Use `ip floating list` command + * As of: NA + * Removed in: NA + * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1519502 + * Commit: https://review.opendev.org/#/c/277720/ For Developers ============== diff --git a/doc/source/cli/command-list.rst b/doc/source/cli/command-list.rst index 9044f69389..b920f60c84 100644 --- a/doc/source/cli/command-list.rst +++ b/doc/source/cli/command-list.rst @@ -8,4 +8,24 @@ Command List :glob: :maxdepth: 2 - command-objects/* + command-objects/common/index + command-objects/compute/v2/index + command-objects/identity/v2/index + command-objects/identity/v3/index + command-objects/image/v1/index + command-objects/image/v2/index + command-objects/network/v2/index + command-objects/object-store/v1/index + command-objects/share/v2/index + command-objects/volume/v2/index + command-objects/volume/v3/index + +.. toctree:: + :hidden: + + command-objects/identity/index + command-objects/image/index + command-objects/network/index + command-objects/object-store/index + command-objects/share/index + command-objects/volume/index diff --git a/doc/source/cli/command-objects/access-rules.rst b/doc/source/cli/command-objects/access-rules.rst deleted file mode 100644 index bc8458283f..0000000000 --- a/doc/source/cli/command-objects/access-rules.rst +++ /dev/null @@ -1,61 +0,0 @@ -=========== -access rule -=========== - -Identity v3 - -Access rules are fine-grained permissions for application credentials. An access -rule comprises of a service type, a request path, and a request method. Access -rules may only be created as attributes of application credentials, but they may -be viewed and deleted independently. - - -access rule delete ------------------- - -Delete access rule(s) - -.. program:: access rule delete -.. code:: bash - - openstack access rule delete [ ...] - -.. describe:: - - Access rule(s) to delete (ID) - -access rule list ----------------- - -List access rules - -.. program:: access rule list -.. code:: bash - - openstack access rule list - [--user ] - [--user-domain ] - -.. option:: --user - - User whose access rules to list (name or ID). If not provided, looks up the - current user's access rules. - -.. option:: --user-domain - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -access rule show ---------------------------- - -Display access rule details - -.. program:: access rule show -.. code:: bash - - openstack access rule show - -.. describe:: - - Access rule to display (ID) diff --git a/doc/source/cli/command-objects/access-token.rst b/doc/source/cli/command-objects/access-token.rst deleted file mode 100644 index 7ef9167eb3..0000000000 --- a/doc/source/cli/command-objects/access-token.rst +++ /dev/null @@ -1,10 +0,0 @@ -============ -access token -============ - -An **access token** is used by the Identity service's OS-OAUTH1 extension. It -is used by the **consumer** to request new Identity API tokens on behalf of the -authorizing **user**. Applicable to Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: access token create diff --git a/doc/source/cli/command-objects/address-group.rst b/doc/source/cli/command-objects/address-group.rst deleted file mode 100644 index c1ff6f8858..0000000000 --- a/doc/source/cli/command-objects/address-group.rst +++ /dev/null @@ -1,12 +0,0 @@ -============= -address group -============= - -An **address group** is a group of IPv4 or IPv6 address blocks which could be -referenced as a remote source or destination when creating a security group -rule. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: address group * diff --git a/doc/source/cli/command-objects/address-scope.rst b/doc/source/cli/command-objects/address-scope.rst deleted file mode 100644 index 38141d5c97..0000000000 --- a/doc/source/cli/command-objects/address-scope.rst +++ /dev/null @@ -1,11 +0,0 @@ -============= -address scope -============= - -An **address scope** is a scope of IPv4 or IPv6 addresses that belongs -to a given project and may be shared between projects. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: address scope * diff --git a/doc/source/cli/command-objects/aggregate.rst b/doc/source/cli/command-objects/aggregate.rst deleted file mode 100644 index 0f62ce8f43..0000000000 --- a/doc/source/cli/command-objects/aggregate.rst +++ /dev/null @@ -1,11 +0,0 @@ -========= -aggregate -========= - -Host aggregates provide a mechanism to group hosts according to certain -criteria. - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: aggregate * diff --git a/doc/source/cli/command-objects/application-credentials.rst b/doc/source/cli/command-objects/application-credentials.rst deleted file mode 100644 index cef3ef0dfc..0000000000 --- a/doc/source/cli/command-objects/application-credentials.rst +++ /dev/null @@ -1,13 +0,0 @@ -====================== -application credential -====================== - -Identity v3 - -With application credentials, a user can grant their applications limited -access to their cloud resources. Once created, users can authenticate with an -application credential by using the ``v3applicationcredential`` auth type. - - -.. autoprogram-cliff:: openstack.identity.v3 - :command: application credential * diff --git a/doc/source/cli/command-objects/availability-zone.rst b/doc/source/cli/command-objects/availability-zone.rst deleted file mode 100644 index bdc64f1537..0000000000 --- a/doc/source/cli/command-objects/availability-zone.rst +++ /dev/null @@ -1,11 +0,0 @@ -================= -availability zone -================= - -An **availability zone** is a logical partition of cloud block storage, -compute and network services. - -Block Storage v2, Compute v2, Network v2 - -.. autoprogram-cliff:: openstack.common - :command: availability zone list diff --git a/doc/source/cli/command-objects/catalog.rst b/doc/source/cli/command-objects/catalog.rst deleted file mode 100644 index 84cd160a0b..0000000000 --- a/doc/source/cli/command-objects/catalog.rst +++ /dev/null @@ -1,9 +0,0 @@ -======= -catalog -======= - -A **catalog** lists OpenStack services that are available on the cloud. -Applicable to Identity v2 and v3 - -.. autoprogram-cliff:: openstack.identity.v3 - :command: catalog * diff --git a/doc/source/cli/command-objects/command.rst b/doc/source/cli/command-objects/command.rst deleted file mode 100644 index 5afc4940ab..0000000000 --- a/doc/source/cli/command-objects/command.rst +++ /dev/null @@ -1,10 +0,0 @@ -======= -command -======= - -Internal - -Installed commands in the OSC process. - -.. autoprogram-cliff:: openstack.cli - :command: command * diff --git a/doc/source/cli/command-objects/common/index.rst b/doc/source/cli/command-objects/common/index.rst new file mode 100644 index 0000000000..f5882006bf --- /dev/null +++ b/doc/source/cli/command-objects/common/index.rst @@ -0,0 +1,117 @@ +=============== +Common Commands +=============== + + +availability zone +----------------- + +An **availability zone** is a logical partition of cloud block storage, +compute and network services. + +.. autoprogram-cliff:: openstack.common + :command: availability zone list + + +command +------- + +Installed commands in the OSC process. + +.. autoprogram-cliff:: openstack.cli + :command: command * + + +complete +-------- + +The ``complete`` command is inherited from the `python-cliff` library, it can +be used to generate a bash-completion script. Currently, the command will +generate a script for bash versions 3 or 4. The bash-completion script is +printed directly to standard out. + +Typical usage for this command is:: + + openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null + +It is highly recommended to install ``python-openstackclient`` from a package +(``apt-get`` or ``yum``). In some distributions the package ``bash-completion`` is shipped +as dependency, and the `openstack complete` command will be run as a post-install action, +however not every distribution include this dependency and you might need to install +``bash-completion`` package to enable autocomplete feature. + +complete +-------- + +print bash completion command + +.. program:: complete +.. code:: bash + + openstack complete + + +configuration +------------- + +.. _configuration-show: + +.. autoprogram-cliff:: openstack.common + :command: configuration show + + +extension +--------- + +Many OpenStack server APIs include API extensions that enable +additional functionality. + +.. autoprogram-cliff:: openstack.common + :command: extension * + + +limits +------ + +The Compute and Block Storage APIs have resource usage limits. + +.. autoprogram-cliff:: openstack.common + :command: limits * + + +module +------ + +Installed Python modules in the OSC process. + +.. autoprogram-cliff:: openstack.cli + :command: module * + + +project cleanup +--------------- + +Clean resources associated with a specific project based on OpenStackSDK +implementation + +.. autoprogram-cliff:: openstack.common + :command: project cleanup + + +quota +----- + +Resource quotas appear in multiple APIs, OpenStackClient presents them as a +single object with multiple properties. + +.. autoprogram-cliff:: openstack.common + :command: quota * + + +versions +-------- + +Get a list of every version of every service in a given cloud. + +.. autoprogram-cliff:: openstack.common + :command: versions show diff --git a/doc/source/cli/command-objects/complete.rst b/doc/source/cli/command-objects/complete.rst deleted file mode 100644 index 165d5d07d5..0000000000 --- a/doc/source/cli/command-objects/complete.rst +++ /dev/null @@ -1,28 +0,0 @@ -======== -complete -======== - -The ``complete`` command is inherited from the `python-cliff` library, it can -be used to generate a bash-completion script. Currently, the command will -generate a script for bash versions 3 or 4. The bash-completion script is -printed directly to standard out. - -Typical usage for this command is:: - - openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null - -It is highly recommended to install ``python-openstackclient`` from a package -(``apt-get`` or ``yum``). In some distributions the package ``bash-completion`` is shipped -as dependency, and the `openstack complete` command will be run as a post-install action, -however not every distribution include this dependency and you might need to install -``bash-completion`` package to enable autocomplete feature. - -complete --------- - -print bash completion command - -.. program:: complete -.. code:: bash - - openstack complete diff --git a/doc/source/cli/command-objects/compute-agent.rst b/doc/source/cli/command-objects/compute-agent.rst deleted file mode 100644 index 89d7492879..0000000000 --- a/doc/source/cli/command-objects/compute-agent.rst +++ /dev/null @@ -1,8 +0,0 @@ -============= -compute agent -============= - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: compute agent * diff --git a/doc/source/cli/command-objects/compute-service.rst b/doc/source/cli/command-objects/compute-service.rst deleted file mode 100644 index ac54786e5b..0000000000 --- a/doc/source/cli/command-objects/compute-service.rst +++ /dev/null @@ -1,8 +0,0 @@ -=============== -compute service -=============== - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: compute service * diff --git a/doc/source/cli/command-objects/compute/v2/index.rst b/doc/source/cli/command-objects/compute/v2/index.rst new file mode 100644 index 0000000000..dddfef2ece --- /dev/null +++ b/doc/source/cli/command-objects/compute/v2/index.rst @@ -0,0 +1,262 @@ +=================== +Compute v2 Commands +=================== + + +aggregate +--------- + +Host aggregates provide a mechanism to group hosts according to certain +criteria. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: aggregate * + + +compute agent +------------- + +.. autoprogram-cliff:: openstack.compute.v2 + :command: compute agent * + + +compute service +--------------- + +.. autoprogram-cliff:: openstack.compute.v2 + :command: compute service * + + +console connection +------------------ + +Server console connection information + +.. autoprogram-cliff:: openstack.compute.v2 + :command: console connection show + + +console log +----------- + +Server console text dump + +.. autoprogram-cliff:: openstack.compute.v2 + :command: console log * + + +console url +----------- + +Server remote console URL + +.. autoprogram-cliff:: openstack.compute.v2 + :command: console url * + + +flavor +------ + +.. autoprogram-cliff:: openstack.compute.v2 + :command: flavor * + + +host +---- + +The physical computer running a hypervisor. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: host * + + +hypervisor stats +---------------- + +.. autoprogram-cliff:: openstack.compute.v2 + :command: hypervisor stats * + + +hypervisor +---------- + +.. NOTE(efried): have to list these out one by one; 'hypervisor *' pulls in + ... stats. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: hypervisor list + +.. autoprogram-cliff:: openstack.compute.v2 + :command: hypervisor show + + +keypair +------- + +The badly named keypair is really the public key of an OpenSSH key pair to be +used for access to created servers. You can also create a private key for +access to a created server by not passing any argument to the keypair create +command. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: keypair * + + +server backup +------------- + +A server backup is a disk image created in the Image store from a running server +instance. The backup command manages the number of archival copies to retain. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server backup create + + +server event +------------ + +Server event are event record for server operations. They consist of: type +(create, delete, reboot and so on), result (success, error), start time, finish +time and so on. These are important for server maintenance. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server event * + + +server group +------------ + +Server groups provide a mechanism to group servers according to certain policy. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server group * + + +server image +------------ + +A server image is a disk image created from a running server instance. The +image is created in the Image store. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server image create + + +server migration +---------------- + +A server migration provides a way to move an instance from one +host to another. There are four types of migration operation +supported: live migration, cold migration, resize and evacuation. + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server migration * + + +server share +------------ + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server share * + + +server volume +------------- + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server volume * + + +server +------ + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server add * + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server create + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server evacuate + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server delete + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server dump create + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server list + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server lock + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server migrate* + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server pause + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server reboot + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server rebuild + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server remove * + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server rescue + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server resize* + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server restore + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server resume + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server set + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server shelve + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server show + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server ssh + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server start + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server stop + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server suspend + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server unlock + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server unpause + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server unrescue + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server unset + +.. autoprogram-cliff:: openstack.compute.v2 + :command: server unshelve + + +usage +----- + +.. autoprogram-cliff:: openstack.compute.v2 + :command: usage * diff --git a/doc/source/cli/command-objects/configuration.rst b/doc/source/cli/command-objects/configuration.rst deleted file mode 100644 index 22fd13e43d..0000000000 --- a/doc/source/cli/command-objects/configuration.rst +++ /dev/null @@ -1,10 +0,0 @@ -============= -configuration -============= - -Available for all services - -.. _configuration-show: - -.. autoprogram-cliff:: openstack.common - :command: configuration show diff --git a/doc/source/cli/command-objects/consistency-group-snapshot.rst b/doc/source/cli/command-objects/consistency-group-snapshot.rst deleted file mode 100644 index 29d5065663..0000000000 --- a/doc/source/cli/command-objects/consistency-group-snapshot.rst +++ /dev/null @@ -1,96 +0,0 @@ -========================== -consistency group snapshot -========================== - -Block Storage v2 - -consistency group snapshot create ---------------------------------- - -Create new consistency group snapshot. - -.. program:: consistency group snapshot create -.. code:: bash - - openstack consistency group snapshot create - [--consistency-group ] - [--description ] - [] - -.. option:: --consistency-group - - Consistency group to snapshot (name or ID) - (default to be the same as ) - -.. option:: --description - - Description of this consistency group snapshot - -.. _consistency_group_snapshot_create-snapshot-name: -.. describe:: - - Name of new consistency group snapshot (default to None) - -consistency group snapshot delete ---------------------------------- - -Delete consistency group snapshot(s) - -.. program:: consistency group snapshot delete -.. code:: bash - - openstack consistency group snapshot delete - [ ...] - -.. _consistency_group_snapshot_delete-consistency-group-snapshot: -.. describe:: - - Consistency group snapshot(s) to delete (name or ID) - -consistency group snapshot list -------------------------------- - -List consistency group snapshots. - -.. program:: consistency group snapshot list -.. code:: bash - - openstack consistency group snapshot list - [--all-projects] - [--long] - [--status ] - [--consistency-group ] - -.. option:: --all-projects - - Show detail for all projects. Admin only. - (defaults to False) - -.. option:: --long - - List additional fields in output - -.. option:: --status - - Filters results by a status - ("available", "error", "creating", "deleting" or "error_deleting") - -.. option:: --consistency-group - - Filters results by a consistency group (name or ID) - -consistency group snapshot show -------------------------------- - -Display consistency group snapshot details. - -.. program:: consistency group snapshot show -.. code:: bash - - openstack consistency group snapshot show - - -.. _consistency_group_snapshot_show-consistency-group-snapshot: -.. describe:: - - Consistency group snapshot to display (name or ID) diff --git a/doc/source/cli/command-objects/consistency-group.rst b/doc/source/cli/command-objects/consistency-group.rst deleted file mode 100644 index 57082c6df8..0000000000 --- a/doc/source/cli/command-objects/consistency-group.rst +++ /dev/null @@ -1,173 +0,0 @@ -================= -consistency group -================= - -Block Storage v2 - -consistency group add volume ----------------------------- - -Add volume(s) to consistency group. - -.. program:: consistency group add volume -.. code:: bash - - openstack consistency group add volume - - [ ...] - -.. _consistency_group_add_volume: -.. describe:: - - Consistency group to contain (name or ID) - -.. describe:: - - Volume(s) to add to (name or ID) - (repeat option to add multiple volumes) - -consistency group create ------------------------- - -Create new consistency group. - -.. program:: consistency group create -.. code:: bash - - openstack consistency group create - --volume-type | --consistency-group-source | --consistency-group-snapshot - [--description ] - [--availability-zone ] - [] - -.. option:: --volume-type - - Volume type of this consistency group (name or ID) - -.. option:: --consistency-group-source - - Existing consistency group (name or ID) - -.. option:: --consistency-group-snapshot - - Existing consistency group snapshot (name or ID) - -.. option:: --description - - Description of this consistency group - -.. option:: --availability-zone - - Availability zone for this consistency group - (not available if creating consistency group from source) - -.. _consistency_group_create-name: -.. describe:: - - Name of new consistency group (default to None) - -consistency group delete ------------------------- - -Delete consistency group(s). - -.. program:: consistency group delete -.. code:: bash - - openstack consistency group delete - [--force] - [ ...] - -.. option:: --force - - Allow delete in state other than error or available - -.. _consistency_group_delete-consistency-group: -.. describe:: - - Consistency group(s) to delete (name or ID) - -consistency group list ----------------------- - -List consistency groups. - -.. program:: consistency group list -.. code:: bash - - openstack consistency group list - [--all-projects] - [--long] - -.. option:: --all-projects - - Show detail for all projects. Admin only. - (defaults to False) - -.. option:: --long - - List additional fields in output - -consistency group remove volume -------------------------------- - -Remove volume(s) from consistency group. - -.. program:: consistency group remove volume -.. code:: bash - - openstack consistency group remove volume - - [ ...] - -.. _consistency_group_remove_volume: -.. describe:: - - Consistency group containing (name or ID) - -.. describe:: - - Volume(s) to remove from (name or ID) - (repeat option to remove multiple volumes) - -consistency group set ---------------------- - -Set consistency group properties. - -.. program:: consistency group set -.. code:: bash - - openstack consistency group set - [--name ] - [--description ] - - -.. option:: --name - - New consistency group name - -.. option:: --description - - New consistency group description - -.. _consistency_group_set-consistency-group: -.. describe:: - - Consistency group to modify (name or ID) - -consistency group show ----------------------- - -Display consistency group details. - -.. program:: consistency group show -.. code:: bash - - openstack consistency group show - - -.. _consistency_group_show-consistency-group: -.. describe:: - - Consistency group to display (name or ID) diff --git a/doc/source/cli/command-objects/console-log.rst b/doc/source/cli/command-objects/console-log.rst deleted file mode 100644 index 46ef370d84..0000000000 --- a/doc/source/cli/command-objects/console-log.rst +++ /dev/null @@ -1,10 +0,0 @@ -=========== -console log -=========== - -Server console text dump - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: console log * diff --git a/doc/source/cli/command-objects/console-url.rst b/doc/source/cli/command-objects/console-url.rst deleted file mode 100644 index 001ccc56c7..0000000000 --- a/doc/source/cli/command-objects/console-url.rst +++ /dev/null @@ -1,10 +0,0 @@ -=========== -console url -=========== - -Server remote console URL - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: console url * diff --git a/doc/source/cli/command-objects/consumer.rst b/doc/source/cli/command-objects/consumer.rst deleted file mode 100644 index 17cfc0c996..0000000000 --- a/doc/source/cli/command-objects/consumer.rst +++ /dev/null @@ -1,10 +0,0 @@ -======== -consumer -======== - -An **consumer** is used by the Identity service's OS-OAUTH1 extension. It -is used to create a **request token** and **access token**. Applicable to -Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: consumer * diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst deleted file mode 100644 index 83deeb8156..0000000000 --- a/doc/source/cli/command-objects/container.rst +++ /dev/null @@ -1,26 +0,0 @@ -========= -container -========= - -A **container** defines a namespace for **objects**. Applies to Object Storage v1 - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: container create - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: container delete - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: container list - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: container save - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: container set - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: container show - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: container unset diff --git a/doc/source/cli/command-objects/credential.rst b/doc/source/cli/command-objects/credential.rst deleted file mode 100644 index f490f1cfee..0000000000 --- a/doc/source/cli/command-objects/credential.rst +++ /dev/null @@ -1,8 +0,0 @@ -========== -credential -========== - -Identity v3 - -.. autoprogram-cliff:: openstack.identity.v3 - :command: credential * diff --git a/doc/source/cli/command-objects/domain.rst b/doc/source/cli/command-objects/domain.rst deleted file mode 100644 index 81a193497b..0000000000 --- a/doc/source/cli/command-objects/domain.rst +++ /dev/null @@ -1,22 +0,0 @@ -====== -domain -====== - -A **domain** is a collection of **users**, **groups**, and **projects**. Each -**group** and **project** is owned by exactly one **domain**. Applies to -Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: domain create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: domain delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: domain list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: domain set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: domain show diff --git a/doc/source/cli/command-objects/ec2-credentials-v2.rst b/doc/source/cli/command-objects/ec2-credentials-v2.rst deleted file mode 100644 index ace3d84ec5..0000000000 --- a/doc/source/cli/command-objects/ec2-credentials-v2.rst +++ /dev/null @@ -1,6 +0,0 @@ -============================= -ec2 credentials (Identity v2) -============================= - -.. autoprogram-cliff:: openstack.identity.v2 - :command: ec2 credentials * diff --git a/doc/source/cli/command-objects/ec2-credentials-v3.rst b/doc/source/cli/command-objects/ec2-credentials-v3.rst deleted file mode 100644 index 761d428050..0000000000 --- a/doc/source/cli/command-objects/ec2-credentials-v3.rst +++ /dev/null @@ -1,6 +0,0 @@ -============================= -ec2 credentials (Identity v3) -============================= - -.. autoprogram-cliff:: openstack.identity.v3 - :command: ec2 credentials * diff --git a/doc/source/cli/command-objects/endpoint-v2.rst b/doc/source/cli/command-objects/endpoint-v2.rst deleted file mode 100644 index 7badfd4080..0000000000 --- a/doc/source/cli/command-objects/endpoint-v2.rst +++ /dev/null @@ -1,6 +0,0 @@ -====================== -endpoint (Identity v2) -====================== - -.. autoprogram-cliff:: openstack.identity.v2 - :command: endpoint * diff --git a/doc/source/cli/command-objects/endpoint-v3.rst b/doc/source/cli/command-objects/endpoint-v3.rst deleted file mode 100644 index f12063fb0c..0000000000 --- a/doc/source/cli/command-objects/endpoint-v3.rst +++ /dev/null @@ -1,24 +0,0 @@ -====================== -endpoint (Identity v3) -====================== - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint add project - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint remove project - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint set - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint show diff --git a/doc/source/cli/command-objects/endpoint_group.rst b/doc/source/cli/command-objects/endpoint_group.rst deleted file mode 100644 index b0d988e17c..0000000000 --- a/doc/source/cli/command-objects/endpoint_group.rst +++ /dev/null @@ -1,10 +0,0 @@ -============== -endpoint group -============== - -A **endpoint group** is used to create groups of endpoints that then -can be used to filter the endpoints that are available to a project. -Applicable to Identity v3 - -.. autoprogram-cliff:: openstack.identity.v3 - :command: endpoint group * diff --git a/doc/source/cli/command-objects/extension.rst b/doc/source/cli/command-objects/extension.rst deleted file mode 100644 index 1002a5fff0..0000000000 --- a/doc/source/cli/command-objects/extension.rst +++ /dev/null @@ -1,10 +0,0 @@ -========= -extension -========= - -Many OpenStack server APIs include API extensions that enable -additional functionality. - - -.. autoprogram-cliff:: openstack.common - :command: extension * diff --git a/doc/source/cli/command-objects/federation-domain-project.rst b/doc/source/cli/command-objects/federation-domain-project.rst deleted file mode 100644 index 68db5705b0..0000000000 --- a/doc/source/cli/command-objects/federation-domain-project.rst +++ /dev/null @@ -1,11 +0,0 @@ -========================= -federation domain/project -========================= - -Identity v3 - -.. autoprogram-cliff:: openstack.identity.v3 - :command: federation domain * - -.. autoprogram-cliff:: openstack.identity.v3 - :command: federation project * diff --git a/doc/source/cli/command-objects/federation-protocol.rst b/doc/source/cli/command-objects/federation-protocol.rst deleted file mode 100644 index 81b3f9fcd3..0000000000 --- a/doc/source/cli/command-objects/federation-protocol.rst +++ /dev/null @@ -1,10 +0,0 @@ -=================== -federation protocol -=================== - -A **federation protocol** is used by the Identity service's OS-FEDERATION -extension. It is used by **identity providers** and **mappings**. Applicable to -Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: federation protocol * diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst deleted file mode 100644 index ee09b3ace7..0000000000 --- a/doc/source/cli/command-objects/flavor.rst +++ /dev/null @@ -1,8 +0,0 @@ -====== -flavor -====== - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: flavor * diff --git a/doc/source/cli/command-objects/floating-ip-pool.rst b/doc/source/cli/command-objects/floating-ip-pool.rst deleted file mode 100644 index ab6f83a993..0000000000 --- a/doc/source/cli/command-objects/floating-ip-pool.rst +++ /dev/null @@ -1,8 +0,0 @@ -================ -floating ip pool -================ - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: floating ip pool * diff --git a/doc/source/cli/command-objects/floating-ip-port-forwarding.rst b/doc/source/cli/command-objects/floating-ip-port-forwarding.rst deleted file mode 100644 index 052ea0cc7f..0000000000 --- a/doc/source/cli/command-objects/floating-ip-port-forwarding.rst +++ /dev/null @@ -1,9 +0,0 @@ -=========================== -floating ip port forwarding -=========================== - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: floating ip port forwarding * - diff --git a/doc/source/cli/command-objects/floating-ip.rst b/doc/source/cli/command-objects/floating-ip.rst deleted file mode 100644 index c781a1edb4..0000000000 --- a/doc/source/cli/command-objects/floating-ip.rst +++ /dev/null @@ -1,26 +0,0 @@ -=========== -floating ip -=========== - -Network v2 - -.. NOTE(efried): have to list these out one by one; 'floating ip' pulls in - ... pool and ... port forwarding. - -.. autoprogram-cliff:: openstack.network.v2 - :command: floating ip create - -.. autoprogram-cliff:: openstack.network.v2 - :command: floating ip delete - -.. autoprogram-cliff:: openstack.network.v2 - :command: floating ip list - -.. autoprogram-cliff:: openstack.network.v2 - :command: floating ip set - -.. autoprogram-cliff:: openstack.network.v2 - :command: floating ip show - -.. autoprogram-cliff:: openstack.network.v2 - :command: floating ip unset diff --git a/doc/source/cli/command-objects/group.rst b/doc/source/cli/command-objects/group.rst deleted file mode 100644 index a1071069db..0000000000 --- a/doc/source/cli/command-objects/group.rst +++ /dev/null @@ -1,8 +0,0 @@ -===== -group -===== - -Identity v3 - -.. autoprogram-cliff:: openstack.identity.v3 - :command: group * diff --git a/doc/source/cli/command-objects/host.rst b/doc/source/cli/command-objects/host.rst deleted file mode 100644 index acd5a287fe..0000000000 --- a/doc/source/cli/command-objects/host.rst +++ /dev/null @@ -1,10 +0,0 @@ -==== -host -==== - -Compute v2 - -The physical computer running a hypervisor. - -.. autoprogram-cliff:: openstack.compute.v2 - :command: host * diff --git a/doc/source/cli/command-objects/hypervisor-stats.rst b/doc/source/cli/command-objects/hypervisor-stats.rst deleted file mode 100644 index 1f5768f298..0000000000 --- a/doc/source/cli/command-objects/hypervisor-stats.rst +++ /dev/null @@ -1,8 +0,0 @@ -================ -hypervisor stats -================ - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: hypervisor stats * diff --git a/doc/source/cli/command-objects/hypervisor.rst b/doc/source/cli/command-objects/hypervisor.rst deleted file mode 100644 index 9ae82bf122..0000000000 --- a/doc/source/cli/command-objects/hypervisor.rst +++ /dev/null @@ -1,14 +0,0 @@ -========== -hypervisor -========== - -Compute v2 - -.. NOTE(efried): have to list these out one by one; 'hypervisor *' pulls in - ... stats. - -.. autoprogram-cliff:: openstack.compute.v2 - :command: hypervisor list - -.. autoprogram-cliff:: openstack.compute.v2 - :command: hypervisor show diff --git a/doc/source/cli/command-objects/identity-provider.rst b/doc/source/cli/command-objects/identity-provider.rst deleted file mode 100644 index ed85cb7ac8..0000000000 --- a/doc/source/cli/command-objects/identity-provider.rst +++ /dev/null @@ -1,10 +0,0 @@ -================= -identity provider -================= - -An **identity provider** is used by the Identity service's OS-FEDERATION -extension. It is used by **federation protocols** and **mappings**. Applicable -to Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: identity provider * diff --git a/doc/source/cli/command-objects/identity/index.rst b/doc/source/cli/command-objects/identity/index.rst new file mode 100644 index 0000000000..4057faae35 --- /dev/null +++ b/doc/source/cli/command-objects/identity/index.rst @@ -0,0 +1,9 @@ +================= +Identity Commands +================= + +.. toctree:: + :maxdepth: 1 + + v2/index + v3/index diff --git a/doc/source/cli/command-objects/identity/v2/index.rst b/doc/source/cli/command-objects/identity/v2/index.rst new file mode 100644 index 0000000000..c87ae49bc4 --- /dev/null +++ b/doc/source/cli/command-objects/identity/v2/index.rst @@ -0,0 +1,59 @@ +==================== +Identity v2 Commands +==================== + + +catalog +------- + +.. autoprogram-cliff:: openstack.identity.v2 + :command: catalog * + + +ec2 credentials (Identity v2) +----------------------------- + +.. autoprogram-cliff:: openstack.identity.v2 + :command: ec2 credentials * + + +endpoint (Identity v2) +---------------------- + +.. autoprogram-cliff:: openstack.identity.v2 + :command: endpoint * + + +project (Identity v2) +--------------------- + +.. autoprogram-cliff:: openstack.identity.v2 + :command: project * + + +role (Identity v2) +------------------ + +.. autoprogram-cliff:: openstack.identity.v2 + :command: role * + + +service (Identity v2) +--------------------- + +.. autoprogram-cliff:: openstack.identity.v2 + :command: service * + + +token (Identity v2) +------------------- + +.. autoprogram-cliff:: openstack.identity.v2 + :command: token * + + +user (Identity v2) +------------------ + +.. autoprogram-cliff:: openstack.identity.v2 + :command: user * diff --git a/doc/source/cli/command-objects/identity/v3/index.rst b/doc/source/cli/command-objects/identity/v3/index.rst new file mode 100644 index 0000000000..b4e1a0b6ac --- /dev/null +++ b/doc/source/cli/command-objects/identity/v3/index.rst @@ -0,0 +1,311 @@ +==================== +Identity v3 Commands +==================== + + +access rule +----------- + +Access rules are fine-grained permissions for application credentials. An access +rule comprises of a service type, a request path, and a request method. Access +rules may only be created as attributes of application credentials, but they may +be viewed and deleted independently. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: access rule delete + +.. autoprogram-cliff:: openstack.identity.v3 + :command: access rule list + +.. autoprogram-cliff:: openstack.identity.v3 + :command: access rule show + + +access token +------------ + +An **access token** is used by the Identity service's OS-OAUTH1 extension. It +is used by the **consumer** to request new Identity API tokens on behalf of the +authorizing **user**. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: access token create + + +application credential +---------------------- + +With application credentials, a user can grant their applications limited +access to their cloud resources. Once created, users can authenticate with an +application credential by using the ``v3applicationcredential`` auth type. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: application credential * + + +catalog +------- + +A **catalog** lists OpenStack services that are available on the cloud. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: catalog * + + +consumer +-------- + +An **consumer** is used by the Identity service's OS-OAUTH1 extension. It +is used to create a **request token** and **access token**. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: consumer * + + +credential +---------- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: credential * + + +domain +------ + +A **domain** is a collection of **users**, **groups**, and **projects**. Each +**group** and **project** is owned by exactly one **domain**. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain create + +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain delete + +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain list + +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain set + +.. autoprogram-cliff:: openstack.identity.v3 + :command: domain show + + +ec2 credentials (Identity v3) +----------------------------- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: ec2 credentials * + + +endpoint group +-------------- + +A **endpoint group** is used to create groups of endpoints that then +can be used to filter the endpoints that are available to a project. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint group * + + +endpoint (Identity v3) +---------------------- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint add project + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint create + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint delete + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint list + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint remove project + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint set + +.. autoprogram-cliff:: openstack.identity.v3 + :command: endpoint show + + +federation domain/project +------------------------- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation domain * + +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation project * + + +federation protocol +------------------- + +A **federation protocol** is used by the Identity service's OS-FEDERATION +extension. It is used by **identity providers** and **mappings**. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: federation protocol * + + +group +----- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: group * + + +identity provider +----------------- + +An **identity provider** is used by the Identity service's OS-FEDERATION +extension. It is used by **federation protocols** and **mappings**. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider * + + +implied role +------------ + +.. autoprogram-cliff:: openstack.identity.v3 + :command: implied role * + + +limit +----- + +Limits are used to specify project-specific limits thresholds of resources. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: limit * + + +mapping +------- + +A **mapping** is used by the Identity service's OS-FEDERATION +extension. It is used by **federation protocols** and **identity providers**. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping * + + +policy +------ + +A **policy** is an arbitrarily serialized policy engine rule set to be consumed +by a remote service. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: policy * + + +project (Identity v3) +--------------------- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: project * + + +region +------ + +A **region** is a general division of an OpenStack deployment. You can associate +zero or more sub-regions with a region to create a tree-like structured +hierarchy. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: region * + + +registered limit +---------------- + +Registered limits are used to define default limits for resources within a +deployment. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: registered limit * + + +request token +------------- + +A **request token** is used by the Identity service's OS-OAUTH1 extension. It +is used by the **consumer** to request **access tokens**. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: request token * + + +role assignment +--------------- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: role assignment list + + +role (Identity v3) +------------------ + +.. autoprogram-cliff:: openstack.identity.v3 + :command: role * + + +service provider +---------------- + +A **service provider** is used by the Identity service's OS-FEDERATION +extension. It is used by to register another OpenStack Identity service. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service provider * + + +service (Identity v3) +--------------------- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service create + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service delete + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service list + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service show + +.. autoprogram-cliff:: openstack.identity.v3 + :command: service set + + +token (Identity v3) +------------------- + +.. autoprogram-cliff:: openstack.identity.v3 + :command: token * + + +trust +----- + +A **trust** provide project-specific role delegation between users, with +optional impersonation. Requires the OS-TRUST extension. + +.. autoprogram-cliff:: openstack.identity.v3 + :command: trust * + + +user (Identity v3) +------------------ + +.. autoprogram-cliff:: openstack.identity.v3 + :command: user * diff --git a/doc/source/cli/command-objects/image-v2.rst b/doc/source/cli/command-objects/image-v2.rst deleted file mode 100644 index 473b26d07b..0000000000 --- a/doc/source/cli/command-objects/image-v2.rst +++ /dev/null @@ -1,6 +0,0 @@ -======== -image v2 -======== - -.. autoprogram-cliff:: openstack.image.v2 - :command: image * diff --git a/doc/source/cli/command-objects/image/index.rst b/doc/source/cli/command-objects/image/index.rst new file mode 100644 index 0000000000..12470e5d73 --- /dev/null +++ b/doc/source/cli/command-objects/image/index.rst @@ -0,0 +1,9 @@ +============== +Image Commands +============== + +.. toctree:: + :maxdepth: 1 + + v1/index + v2/index diff --git a/doc/source/cli/command-objects/image-v1.rst b/doc/source/cli/command-objects/image/v1/index.rst similarity index 52% rename from doc/source/cli/command-objects/image-v1.rst rename to doc/source/cli/command-objects/image/v1/index.rst index 4f7edc4322..fc93124405 100644 --- a/doc/source/cli/command-objects/image-v1.rst +++ b/doc/source/cli/command-objects/image/v1/index.rst @@ -1,6 +1,10 @@ -======== +================= +Image v1 Commands +================= + + image v1 -======== +-------- .. autoprogram-cliff:: openstack.image.v1 :command: image * diff --git a/doc/source/cli/command-objects/image/v2/index.rst b/doc/source/cli/command-objects/image/v2/index.rst new file mode 100644 index 0000000000..d98957acef --- /dev/null +++ b/doc/source/cli/command-objects/image/v2/index.rst @@ -0,0 +1,157 @@ +================= +Image v2 Commands +================= + + +image member +------------ + +.. autoprogram-cliff:: openstack.image.v2 + :command: image add project + +.. autoprogram-cliff:: openstack.image.v2 + :command: image remove project + +.. autoprogram-cliff:: openstack.image.v2 + :command: image member list + +.. autoprogram-cliff:: openstack.image.v2 + :command: image member get + + +image metadef +------------- + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef namespace create + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef namespace delete + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef namespace list + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef namespace set + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef namespace show + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef resource type list + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef object create + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef object show + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef object list + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef object delete + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef object update + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef object property show + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef property create + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef property list + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef property show + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef property delete + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef property set + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef namespace unset + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef resource type association create + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef resource type association delete + +.. autoprogram-cliff:: openstack.image.v2 + :command: image metadef resource type association list + + +image task +---------- + +.. autoprogram-cliff:: openstack.image.v2 + :command: image task list + +.. autoprogram-cliff:: openstack.image.v2 + :command: image task show + + +image +----- + +.. autoprogram-cliff:: openstack.image.v2 + :command: image create + +.. autoprogram-cliff:: openstack.image.v2 + :command: image delete + +.. autoprogram-cliff:: openstack.image.v2 + :command: image list + +.. autoprogram-cliff:: openstack.image.v2 + :command: image save + +.. autoprogram-cliff:: openstack.image.v2 + :command: image set + +.. autoprogram-cliff:: openstack.image.v2 + :command: image unset + +.. autoprogram-cliff:: openstack.image.v2 + :command: image show + +.. autoprogram-cliff:: openstack.image.v2 + :command: image stage + +.. autoprogram-cliff:: openstack.image.v2 + :command: image import + + +image import info +----------------- + +.. autoprogram-cliff:: openstack.image.v2 + :command: image import info + + +image stores +------------ + +.. autoprogram-cliff:: openstack.image.v2 + :command: image stores list + + +cached image +------------ + +.. autoprogram-cliff:: openstack.image.v2 + :command: cached image list + +.. autoprogram-cliff:: openstack.image.v2 + :command: cached image queue + +.. autoprogram-cliff:: openstack.image.v2 + :command: cached image delete + +.. autoprogram-cliff:: openstack.image.v2 + :command: cached image clear diff --git a/doc/source/cli/command-objects/implied_role.rst b/doc/source/cli/command-objects/implied_role.rst deleted file mode 100644 index 09532c0b02..0000000000 --- a/doc/source/cli/command-objects/implied_role.rst +++ /dev/null @@ -1,8 +0,0 @@ -============ -implied role -============ - -Identity v3 - -.. autoprogram-cliff:: openstack.identity.v3 - :command: implied role * diff --git a/doc/source/cli/command-objects/ip-availability.rst b/doc/source/cli/command-objects/ip-availability.rst deleted file mode 100644 index 94e60459b1..0000000000 --- a/doc/source/cli/command-objects/ip-availability.rst +++ /dev/null @@ -1,8 +0,0 @@ -=============== -ip availability -=============== - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: ip availability * diff --git a/doc/source/cli/command-objects/keypair.rst b/doc/source/cli/command-objects/keypair.rst deleted file mode 100644 index f8bce3756b..0000000000 --- a/doc/source/cli/command-objects/keypair.rst +++ /dev/null @@ -1,13 +0,0 @@ -======= -keypair -======= - -The badly named keypair is really the public key of an OpenSSH key pair to be -used for access to created servers. You can also create a private key for -access to a created server by not passing any argument to the keypair create -command. - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: keypair * diff --git a/doc/source/cli/command-objects/limit.rst b/doc/source/cli/command-objects/limit.rst deleted file mode 100644 index 784d0cb423..0000000000 --- a/doc/source/cli/command-objects/limit.rst +++ /dev/null @@ -1,10 +0,0 @@ -===== -limit -===== - -Identity v3 - -Limits are used to specify project-specific limits thresholds of resources. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: limit * diff --git a/doc/source/cli/command-objects/limits.rst b/doc/source/cli/command-objects/limits.rst deleted file mode 100644 index 3a0f99b376..0000000000 --- a/doc/source/cli/command-objects/limits.rst +++ /dev/null @@ -1,11 +0,0 @@ -====== -limits -====== - -The Compute and Block Storage APIs have resource usage limits. - -Compute v2, Block Storage v1 - - -.. autoprogram-cliff:: openstack.common - :command: limits * diff --git a/doc/source/cli/command-objects/local-ip-association.rst b/doc/source/cli/command-objects/local-ip-association.rst deleted file mode 100644 index 824ee4d0e6..0000000000 --- a/doc/source/cli/command-objects/local-ip-association.rst +++ /dev/null @@ -1,11 +0,0 @@ -============================================= -Local IP Associations (local_ip_associations) -============================================= - -The resource lets users assign Local IPs to user Ports. -This is a sub-resource of the Local IP resource. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: local ip association * diff --git a/doc/source/cli/command-objects/local-ip.rst b/doc/source/cli/command-objects/local-ip.rst deleted file mode 100644 index c8c5ab470d..0000000000 --- a/doc/source/cli/command-objects/local-ip.rst +++ /dev/null @@ -1,12 +0,0 @@ -===================== -Local IPs (local_ips) -===================== - -Extension that allows users to create a virtual IP that can later be assigned -to multiple ports/VMs (similar to anycast IP) and is guaranteed to only be -reachable within the same physical server/node boundaries - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: local ip * diff --git a/doc/source/cli/command-objects/mapping.rst b/doc/source/cli/command-objects/mapping.rst deleted file mode 100644 index 5653b52bb9..0000000000 --- a/doc/source/cli/command-objects/mapping.rst +++ /dev/null @@ -1,10 +0,0 @@ -======= -mapping -======= - -A **mapping** is used by the Identity service's OS-FEDERATION -extension. It is used by **federation protocols** and **identity providers**. -Applicable to Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: mapping * \ No newline at end of file diff --git a/doc/source/cli/command-objects/module.rst b/doc/source/cli/command-objects/module.rst deleted file mode 100644 index 82269f472d..0000000000 --- a/doc/source/cli/command-objects/module.rst +++ /dev/null @@ -1,10 +0,0 @@ -====== -module -====== - -Internal - -Installed Python modules in the OSC process. - -.. autoprogram-cliff:: openstack.cli - :command: module * diff --git a/doc/source/cli/command-objects/network-agent.rst b/doc/source/cli/command-objects/network-agent.rst deleted file mode 100644 index 7e721db1ea..0000000000 --- a/doc/source/cli/command-objects/network-agent.rst +++ /dev/null @@ -1,14 +0,0 @@ -============= -network agent -============= - -A **network agent** is an agent that handles various tasks used to -implement virtual networks. These agents include neutron-dhcp-agent, -neutron-l3-agent, neutron-metering-agent, and neutron-lbaas-agent, -among others. The agent is available when the alive status of the -agent is "True". - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network agent * diff --git a/doc/source/cli/command-objects/network-auto-allocated-topology.rst b/doc/source/cli/command-objects/network-auto-allocated-topology.rst deleted file mode 100644 index 436836484a..0000000000 --- a/doc/source/cli/command-objects/network-auto-allocated-topology.rst +++ /dev/null @@ -1,14 +0,0 @@ -=============================== -network auto allocated topology -=============================== - -An **auto allocated topology** allows admins to quickly set up external -connectivity for end-users. Only one auto allocated topology is allowed per -project. For more information on how to set up the resources required -for auto allocated topology review :neutron-doc:`the documentation -`. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network auto allocated topology * diff --git a/doc/source/cli/command-objects/network-flavor-profile.rst b/doc/source/cli/command-objects/network-flavor-profile.rst deleted file mode 100644 index c5e9aa0c13..0000000000 --- a/doc/source/cli/command-objects/network-flavor-profile.rst +++ /dev/null @@ -1,15 +0,0 @@ -====================== -network flavor profile -====================== - -A **network flavor profile** allows administrators to create, delete, list, -show and update network service profile, which details a framework to enable -operators to configure and users to select from different abstract -representations of a service implementation in the Networking service. -It decouples the logical configuration from its instantiation enabling -operators to create user options according to deployment needs. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network flavor profile * diff --git a/doc/source/cli/command-objects/network-flavor.rst b/doc/source/cli/command-objects/network-flavor.rst deleted file mode 100644 index 6fe7504a0d..0000000000 --- a/doc/source/cli/command-objects/network-flavor.rst +++ /dev/null @@ -1,33 +0,0 @@ -============== -network flavor -============== - -A **network flavor** extension allows the user selection of operator-curated -flavors during resource creations. It allows administrators to create network -service flavors. - -Network v2 - -.. NOTE(efried): have to list these out one by one; 'network flavor' pulls in - ... profile *. - -.. autoprogram-cliff:: openstack.network.v2 - :command: network flavor add profile - -.. autoprogram-cliff:: openstack.network.v2 - :command: network flavor create - -.. autoprogram-cliff:: openstack.network.v2 - :command: network flavor delete - -.. autoprogram-cliff:: openstack.network.v2 - :command: network flavor list - -.. autoprogram-cliff:: openstack.network.v2 - :command: network flavor remove profile - -.. autoprogram-cliff:: openstack.network.v2 - :command: network flavor set - -.. autoprogram-cliff:: openstack.network.v2 - :command: network flavor show diff --git a/doc/source/cli/command-objects/network-l3-conntrack-helper.rst b/doc/source/cli/command-objects/network-l3-conntrack-helper.rst deleted file mode 100644 index badbab6337..0000000000 --- a/doc/source/cli/command-objects/network-l3-conntrack-helper.rst +++ /dev/null @@ -1,8 +0,0 @@ -=========================== -network l3 conntrack helper -=========================== - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network l3 conntrack helper * diff --git a/doc/source/cli/command-objects/network-meter-rule.rst b/doc/source/cli/command-objects/network-meter-rule.rst deleted file mode 100644 index 616c4bc516..0000000000 --- a/doc/source/cli/command-objects/network-meter-rule.rst +++ /dev/null @@ -1,13 +0,0 @@ -================== -network meter rule -================== - -A **meter rule** sets the rule for -a meter to measure traffic for a specific IP range. -The following uses **meter** and requires the L3 -metering extension. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network meter rule * diff --git a/doc/source/cli/command-objects/network-meter.rst b/doc/source/cli/command-objects/network-meter.rst deleted file mode 100644 index 5752e6f419..0000000000 --- a/doc/source/cli/command-objects/network-meter.rst +++ /dev/null @@ -1,24 +0,0 @@ -============= -network meter -============= - -A **network meter** allows operators to measure -traffic for a specific IP range. The following commands -are specific to the L3 metering extension. - -Network v2 - -.. NOTE(efried): have to list these out one by one; 'network meter *' pulls in - ... rule *. - -.. autoprogram-cliff:: openstack.network.v2 - :command: network meter create - -.. autoprogram-cliff:: openstack.network.v2 - :command: network meter delete - -.. autoprogram-cliff:: openstack.network.v2 - :command: network meter list - -.. autoprogram-cliff:: openstack.network.v2 - :command: network meter show diff --git a/doc/source/cli/command-objects/network-qos-policy.rst b/doc/source/cli/command-objects/network-qos-policy.rst deleted file mode 100644 index af7a104070..0000000000 --- a/doc/source/cli/command-objects/network-qos-policy.rst +++ /dev/null @@ -1,11 +0,0 @@ -================== -network qos policy -================== - -A **Network QoS policy** groups a number of Network QoS rules, applied to a -network or a port. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network qos policy * diff --git a/doc/source/cli/command-objects/network-qos-rule-type.rst b/doc/source/cli/command-objects/network-qos-rule-type.rst deleted file mode 100644 index 197a86002f..0000000000 --- a/doc/source/cli/command-objects/network-qos-rule-type.rst +++ /dev/null @@ -1,11 +0,0 @@ -===================== -network qos rule type -===================== - -A **Network QoS rule type** is a specific Network QoS rule type available to be -used. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network qos rule type * diff --git a/doc/source/cli/command-objects/network-qos-rule.rst b/doc/source/cli/command-objects/network-qos-rule.rst deleted file mode 100644 index 8b715c03ab..0000000000 --- a/doc/source/cli/command-objects/network-qos-rule.rst +++ /dev/null @@ -1,28 +0,0 @@ -================ -network qos rule -================ - -A **Network QoS rule** specifies a rule defined in a Network QoS policy; its -type is defined by the parameter 'type'. Can be assigned, within a Network QoS -policy, to a port or a network. Each Network QoS policy can contain several -rules, each of them - -Network v2 - -.. NOTE(efried): have to list these out one by one; 'network qos rule *' pulls - network qos rule type *. - -.. autoprogram-cliff:: openstack.network.v2 - :command: network qos rule create - -.. autoprogram-cliff:: openstack.network.v2 - :command: network qos rule delete - -.. autoprogram-cliff:: openstack.network.v2 - :command: network qos rule list - -.. autoprogram-cliff:: openstack.network.v2 - :command: network qos rule set - -.. autoprogram-cliff:: openstack.network.v2 - :command: network qos rule show diff --git a/doc/source/cli/command-objects/network-rbac.rst b/doc/source/cli/command-objects/network-rbac.rst deleted file mode 100644 index d9e48554d3..0000000000 --- a/doc/source/cli/command-objects/network-rbac.rst +++ /dev/null @@ -1,12 +0,0 @@ -============ -network rbac -============ - -A **network rbac** is a Role-Based Access Control (RBAC) policy for -network resources. It enables both operators and users to grant access -to network resources for specific projects. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network rbac * diff --git a/doc/source/cli/command-objects/network-segment.rst b/doc/source/cli/command-objects/network-segment.rst deleted file mode 100644 index 2e9143801d..0000000000 --- a/doc/source/cli/command-objects/network-segment.rst +++ /dev/null @@ -1,28 +0,0 @@ -=============== -network segment -=============== - -A **network segment** is an isolated Layer 2 segment within a network. -A network may contain multiple network segments. Depending on the -network configuration, Layer 2 connectivity between network segments -within a network may not be guaranteed. - -Network v2 - -.. NOTE(efried): have to list these out one by one; 'network segment *' pulls - ... range *. - -.. autoprogram-cliff:: openstack.network.v2 - :command: network segment create - -.. autoprogram-cliff:: openstack.network.v2 - :command: network segment delete - -.. autoprogram-cliff:: openstack.network.v2 - :command: network segment list - -.. autoprogram-cliff:: openstack.network.v2 - :command: network segment set - -.. autoprogram-cliff:: openstack.network.v2 - :command: network segment show diff --git a/doc/source/cli/command-objects/network-service-provider.rst b/doc/source/cli/command-objects/network-service-provider.rst deleted file mode 100644 index 52d0288dd0..0000000000 --- a/doc/source/cli/command-objects/network-service-provider.rst +++ /dev/null @@ -1,13 +0,0 @@ -======================== -network service provider -======================== - -A **network service provider** is a particular driver that implements a -networking service - -Network v2 - -.. _network_service_provider_list: - -.. autoprogram-cliff:: openstack.network.v2 - :command: network service provider list diff --git a/doc/source/cli/command-objects/network.rst b/doc/source/cli/command-objects/network.rst deleted file mode 100644 index 626b11a928..0000000000 --- a/doc/source/cli/command-objects/network.rst +++ /dev/null @@ -1,33 +0,0 @@ -======= -network -======= - -A **network** is an isolated Layer 2 networking segment. There are two types -of networks, project and provider networks. Project networks are fully isolated -and are not shared with other projects. Provider networks map to existing -physical networks in the data center and provide external network access for -servers and other resources. Only an OpenStack administrator can create -provider networks. Networks can be connected via routers. - -Compute v2, Network v2 - -.. NOTE(efried): have to list these out one by one; 'network *' pulls in - ... flavor *, ... qos policy *, etc. - -.. autoprogram-cliff:: openstack.network.v2 - :command: network create - -.. autoprogram-cliff:: openstack.network.v2 - :command: network delete - -.. autoprogram-cliff:: openstack.network.v2 - :command: network list - -.. autoprogram-cliff:: openstack.network.v2 - :command: network set - -.. autoprogram-cliff:: openstack.network.v2 - :command: network show - -.. autoprogram-cliff:: openstack.network.v2 - :command: network unset diff --git a/doc/source/cli/command-objects/network/index.rst b/doc/source/cli/command-objects/network/index.rst new file mode 100644 index 0000000000..34a3f06c1e --- /dev/null +++ b/doc/source/cli/command-objects/network/index.rst @@ -0,0 +1,12 @@ +================ +Network Commands +================ + +.. toctree:: + :maxdepth: 1 + + v2/index + v2/bgpvpn/index + v2/dynamic-routing/index + v2/fwaas/index + v2/taas/index diff --git a/doc/source/cli/command-objects/network/v2/bgpvpn/index.rst b/doc/source/cli/command-objects/network/v2/bgpvpn/index.rst new file mode 100644 index 0000000000..e1ef51a478 --- /dev/null +++ b/doc/source/cli/command-objects/network/v2/bgpvpn/index.rst @@ -0,0 +1,46 @@ +========================== +Network v2 BGPVPN Commands +========================== + + +bgpvpn +------ + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn create + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn delete + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn list + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn set + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn show + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn unset + + +bgpvpn network association +--------------------------- + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn network association * + + +bgpvpn router association +-------------------------- + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn router association * + + +bgpvpn port association +------------------------ + +.. autoprogram-cliff:: openstack.network.v2.bgpvpn + :command: bgpvpn port association * diff --git a/doc/source/cli/command-objects/network/v2/dynamic-routing/index.rst b/doc/source/cli/command-objects/network/v2/dynamic-routing/index.rst new file mode 100644 index 0000000000..f44373e805 --- /dev/null +++ b/doc/source/cli/command-objects/network/v2/dynamic-routing/index.rst @@ -0,0 +1,24 @@ +=================================== +Network v2 Dynamic Routing Commands +=================================== + + +bgp peer +-------- + +.. autoprogram-cliff:: openstack.network.v2.dynamic_routing + :command: bgp peer * + + +bgp speaker +----------- + +.. autoprogram-cliff:: openstack.network.v2.dynamic_routing + :command: bgp speaker * + + +bgp dragent +----------- + +.. autoprogram-cliff:: openstack.network.v2.dynamic_routing + :command: bgp dragent * diff --git a/doc/source/cli/command-objects/network/v2/fwaas/index.rst b/doc/source/cli/command-objects/network/v2/fwaas/index.rst new file mode 100644 index 0000000000..891e5d0cc9 --- /dev/null +++ b/doc/source/cli/command-objects/network/v2/fwaas/index.rst @@ -0,0 +1,42 @@ +========================= +Network v2 FWaaS Commands +========================= + + +firewall group +-------------- + +.. NOTE(efried): have to list these out one by one; 'firewall group *' pulls in + ... policy * and ... rule *. + +.. autoprogram-cliff:: openstack.network.v2.fwaas + :command: firewall group create + +.. autoprogram-cliff:: openstack.network.v2.fwaas + :command: firewall group delete + +.. autoprogram-cliff:: openstack.network.v2.fwaas + :command: firewall group list + +.. autoprogram-cliff:: openstack.network.v2.fwaas + :command: firewall group set + +.. autoprogram-cliff:: openstack.network.v2.fwaas + :command: firewall group show + +.. autoprogram-cliff:: openstack.network.v2.fwaas + :command: firewall group unset + + +firewall group policy +--------------------- + +.. autoprogram-cliff:: openstack.network.v2.fwaas + :command: firewall group policy * + + +firewall group rule +------------------- + +.. autoprogram-cliff:: openstack.network.v2.fwaas + :command: firewall group rule * diff --git a/doc/source/cli/command-objects/network/v2/index.rst b/doc/source/cli/command-objects/network/v2/index.rst new file mode 100644 index 0000000000..1fbfb86f67 --- /dev/null +++ b/doc/source/cli/command-objects/network/v2/index.rst @@ -0,0 +1,491 @@ +=================== +Network v2 Commands +=================== + + +address group +------------- + +An **address group** is a group of IPv4 or IPv6 address blocks which could be +referenced as a remote source or destination when creating a security group +rule. + +.. autoprogram-cliff:: openstack.network.v2 + :command: address group * + + +address scope +------------- + +An **address scope** is a scope of IPv4 or IPv6 addresses that belongs +to a given project and may be shared between projects. + +.. autoprogram-cliff:: openstack.network.v2 + :command: address scope * + + +default security group rule +--------------------------- + +A **default security group rule** specifies the template of the security group +rules which will be used by neutron to create rules in every new security group. + +.. autoprogram-cliff:: openstack.network.v2 + :command: default security group rule * + + +floating ip port forwarding +--------------------------- + +.. autoprogram-cliff:: openstack.network.v2 + :command: floating ip port forwarding * + + +floating ip +----------- + +.. NOTE(efried): have to list these out one by one; 'floating ip' pulls in + ... pool and ... port forwarding. + +.. autoprogram-cliff:: openstack.network.v2 + :command: floating ip create + +.. autoprogram-cliff:: openstack.network.v2 + :command: floating ip delete + +.. autoprogram-cliff:: openstack.network.v2 + :command: floating ip list + +.. autoprogram-cliff:: openstack.network.v2 + :command: floating ip set + +.. autoprogram-cliff:: openstack.network.v2 + :command: floating ip show + +.. autoprogram-cliff:: openstack.network.v2 + :command: floating ip unset + + +ip availability +--------------- + +.. autoprogram-cliff:: openstack.network.v2 + :command: ip availability * + + +Local IP Associations (local_ip_associations) +--------------------------------------------- + +The resource lets users assign Local IPs to user Ports. +This is a sub-resource of the Local IP resource. + +.. autoprogram-cliff:: openstack.network.v2 + :command: local ip association * + + +Local IPs (local_ips) +--------------------- + +Extension that allows users to create a virtual IP that can later be assigned +to multiple ports/VMs (similar to anycast IP) and is guaranteed to only be +reachable within the same physical server/node boundaries + +.. autoprogram-cliff:: openstack.network.v2 + :command: local ip * + + +network agent +------------- + +A **network agent** is an agent that handles various tasks used to +implement virtual networks. These agents include neutron-dhcp-agent, +neutron-l3-agent, neutron-metering-agent, and neutron-lbaas-agent, +among others. The agent is available when the alive status of the +agent is "True". + +.. autoprogram-cliff:: openstack.network.v2 + :command: network agent * + + +network auto allocated topology +------------------------------- + +An **auto allocated topology** allows admins to quickly set up external +connectivity for end-users. Only one auto allocated topology is allowed per +project. For more information on how to set up the resources required +for auto allocated topology review :neutron-doc:`the documentation +`. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network auto allocated topology * + + +network flavor profile +---------------------- + +A **network flavor profile** allows administrators to create, delete, list, +show and update network service profile, which details a framework to enable +operators to configure and users to select from different abstract +representations of a service implementation in the Networking service. +It decouples the logical configuration from its instantiation enabling +operators to create user options according to deployment needs. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network flavor profile * + + +network flavor +-------------- + +A **network flavor** extension allows the user selection of operator-curated +flavors during resource creations. It allows administrators to create network +service flavors. + + +.. NOTE(efried): have to list these out one by one; 'network flavor' pulls in + ... profile *. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network flavor add profile + +.. autoprogram-cliff:: openstack.network.v2 + :command: network flavor create + +.. autoprogram-cliff:: openstack.network.v2 + :command: network flavor delete + +.. autoprogram-cliff:: openstack.network.v2 + :command: network flavor list + +.. autoprogram-cliff:: openstack.network.v2 + :command: network flavor remove profile + +.. autoprogram-cliff:: openstack.network.v2 + :command: network flavor set + +.. autoprogram-cliff:: openstack.network.v2 + :command: network flavor show + + +network l3 conntrack helper +--------------------------- + +.. autoprogram-cliff:: openstack.network.v2 + :command: network l3 conntrack helper * + + +network meter rule +------------------ + +A **meter rule** sets the rule for +a meter to measure traffic for a specific IP range. +The following uses **meter** and requires the L3 +metering extension. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network meter rule * + + +network meter +------------- + +A **network meter** allows operators to measure +traffic for a specific IP range. The following commands +are specific to the L3 metering extension. + + +.. NOTE(efried): have to list these out one by one; 'network meter *' pulls in + ... rule *. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network meter create + +.. autoprogram-cliff:: openstack.network.v2 + :command: network meter delete + +.. autoprogram-cliff:: openstack.network.v2 + :command: network meter list + +.. autoprogram-cliff:: openstack.network.v2 + :command: network meter show + + +network qos policy +------------------ + +A **Network QoS policy** groups a number of Network QoS rules, applied to a +network or a port. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network qos policy * + + +network qos rule type +--------------------- + +A **Network QoS rule type** is a specific Network QoS rule type available to be +used. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network qos rule type * + + +network qos rule +---------------- + +A **Network QoS rule** specifies a rule defined in a Network QoS policy; its +type is defined by the parameter 'type'. Can be assigned, within a Network QoS +policy, to a port or a network. Each Network QoS policy can contain several +rules, each of them + + +.. NOTE(efried): have to list these out one by one; 'network qos rule *' pulls + network qos rule type *. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network qos rule create + +.. autoprogram-cliff:: openstack.network.v2 + :command: network qos rule delete + +.. autoprogram-cliff:: openstack.network.v2 + :command: network qos rule list + +.. autoprogram-cliff:: openstack.network.v2 + :command: network qos rule set + +.. autoprogram-cliff:: openstack.network.v2 + :command: network qos rule show + + +network rbac +------------ + +A **network rbac** is a Role-Based Access Control (RBAC) policy for +network resources. It enables both operators and users to grant access +to network resources for specific projects. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network rbac * + + +network segment range +--------------------- + +A **network segment range** is a resource for tenant network segment +allocation. +A network segment range exposes the segment range management to be administered +via the Neutron API. In addition, it introduces the ability for the +administrator to control the segment ranges globally or on a per-tenant basis. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network segment range * + + +network segment +--------------- + +A **network segment** is an isolated Layer 2 segment within a network. +A network may contain multiple network segments. Depending on the +network configuration, Layer 2 connectivity between network segments +within a network may not be guaranteed. + + +.. NOTE(efried): have to list these out one by one; 'network segment *' pulls + ... range *. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network segment create + +.. autoprogram-cliff:: openstack.network.v2 + :command: network segment delete + +.. autoprogram-cliff:: openstack.network.v2 + :command: network segment list + +.. autoprogram-cliff:: openstack.network.v2 + :command: network segment set + +.. autoprogram-cliff:: openstack.network.v2 + :command: network segment show + + +network service provider +------------------------ + +A **network service provider** is a particular driver that implements a +networking service + + +.. _network_service_provider_list: + +.. autoprogram-cliff:: openstack.network.v2 + :command: network service provider list + + +network trunk +------------- + +A **network trunk** is a container to group logical ports from different +networks and provide a single trunked vNIC for servers. It consists of +one parent port which is a regular VIF and multiple subports which allow +the server to connect to more networks. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network subport list + +.. autoprogram-cliff:: openstack.network.v2 + :command: network trunk * + + +network +------- + +A **network** is an isolated Layer 2 networking segment. There are two types +of networks, project and provider networks. Project networks are fully isolated +and are not shared with other projects. Provider networks map to existing +physical networks in the data center and provide external network access for +servers and other resources. Only an OpenStack administrator can create +provider networks. Networks can be connected via routers. + + +.. NOTE(efried): have to list these out one by one; 'network *' pulls in + ... flavor *, ... qos policy *, etc. + +.. autoprogram-cliff:: openstack.network.v2 + :command: network create + +.. autoprogram-cliff:: openstack.network.v2 + :command: network delete + +.. autoprogram-cliff:: openstack.network.v2 + :command: network list + +.. autoprogram-cliff:: openstack.network.v2 + :command: network set + +.. autoprogram-cliff:: openstack.network.v2 + :command: network show + +.. autoprogram-cliff:: openstack.network.v2 + :command: network unset + + +port +---- + +A **port** is a connection point for attaching a single device, such as the +NIC of a server, to a network. The port also describes the associated network +configuration, such as the MAC and IP addresses to be used on that port. + +.. autoprogram-cliff:: openstack.network.v2 + :command: port * + + +router ndp proxy +---------------- + +An **NDP proxy** publishes a internal IPv6 address to public network. With the +**NDP proxy**, the IPv6 address can be accessed from external. It is similar +to **Floating IP** of IPv4 in functionality. + +.. autoprogram-cliff:: openstack.network.v2 + :command: router ndp proxy * + + +router +------ + +A **router** is a logical component that forwards data packets between +networks. It also provides Layer 3 and NAT forwarding to provide external +network access for servers on project networks. + +.. autoprogram-cliff:: openstack.network.v2 + :command: router * + + +security group default statefulness +----------------------------------- + +.. autoprogram-cliff:: openstack.network.v2 + :command: security group default statefulness * + + +security group rule +------------------- + +A **security group rule** specifies the network access rules for servers +and other resources on the network. + +.. autoprogram-cliff:: openstack.network.v2 + :command: security group rule * + + +security group +-------------- + +A **security group** acts as a virtual firewall for servers and other +resources on a network. It is a container for security group rules +which specify the network access rules. + + +.. NOTE(efried): have to list these out one by one; 'security group *' pulls in + ... rule *. + +.. autoprogram-cliff:: openstack.network.v2 + :command: security group create + +.. autoprogram-cliff:: openstack.network.v2 + :command: security group delete + +.. autoprogram-cliff:: openstack.network.v2 + :command: security group list + +.. autoprogram-cliff:: openstack.network.v2 + :command: security group set + +.. autoprogram-cliff:: openstack.network.v2 + :command: security group show + +.. autoprogram-cliff:: openstack.network.v2 + :command: security group unset + + +subnet pool +----------- + +A **subnet pool** contains a collection of prefixes in CIDR notation +that are available for IP address allocation. + +.. autoprogram-cliff:: openstack.network.v2 + :command: subnet pool * + + +subnet +------ + +A **subnet** is a block of IP addresses and associated configuration state. +Subnets are used to allocate IP addresses when new ports are created on a +network. + + +.. NOTE(efried): have to list these out one by one; 'subnet *' pulls in + subnet pool *. + +.. autoprogram-cliff:: openstack.network.v2 + :command: subnet create + +.. autoprogram-cliff:: openstack.network.v2 + :command: subnet delete + +.. autoprogram-cliff:: openstack.network.v2 + :command: subnet list + +.. autoprogram-cliff:: openstack.network.v2 + :command: subnet set + +.. autoprogram-cliff:: openstack.network.v2 + :command: subnet show + +.. autoprogram-cliff:: openstack.network.v2 + :command: subnet unset diff --git a/doc/source/cli/command-objects/network/v2/taas/index.rst b/doc/source/cli/command-objects/network/v2/taas/index.rst new file mode 100644 index 0000000000..034d4e526f --- /dev/null +++ b/doc/source/cli/command-objects/network/v2/taas/index.rst @@ -0,0 +1,24 @@ +======================== +Network v2 TaaS Commands +======================== + + +tap flow +-------- + +.. autoprogram-cliff:: openstack.network.v2.taas + :command: tap flow * + + +tap mirror +---------- + +.. autoprogram-cliff:: openstack.network.v2.taas + :command: tap mirror * + + +tap service +----------- + +.. autoprogram-cliff:: openstack.network.v2.taas + :command: tap service * diff --git a/doc/source/cli/command-objects/network_segment_range.rst b/doc/source/cli/command-objects/network_segment_range.rst deleted file mode 100644 index f40007f385..0000000000 --- a/doc/source/cli/command-objects/network_segment_range.rst +++ /dev/null @@ -1,14 +0,0 @@ -===================== -network segment range -===================== - -A **network segment range** is a resource for tenant network segment -allocation. -A network segment range exposes the segment range management to be administered -via the Neutron API. In addition, it introduces the ability for the -administrator to control the segment ranges globally or on a per-tenant basis. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: network segment range * diff --git a/doc/source/cli/command-objects/object-store-account.rst b/doc/source/cli/command-objects/object-store-account.rst deleted file mode 100644 index 6beb63aff8..0000000000 --- a/doc/source/cli/command-objects/object-store-account.rst +++ /dev/null @@ -1,15 +0,0 @@ -==================== -object store account -==================== - -An **object store account** represents the top-level of the hierarchy that -is comprised of **containers** and **objects**. Applies to Object Storage v1. - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object store account set - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object store account show - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object store account unset diff --git a/doc/source/cli/command-objects/object-store/index.rst b/doc/source/cli/command-objects/object-store/index.rst new file mode 100644 index 0000000000..fe8fb0842d --- /dev/null +++ b/doc/source/cli/command-objects/object-store/index.rst @@ -0,0 +1,8 @@ +======================= +Object Storage Commands +======================= + +.. toctree:: + :maxdepth: 1 + + v1/index diff --git a/doc/source/cli/command-objects/object-store/v1/index.rst b/doc/source/cli/command-objects/object-store/v1/index.rst new file mode 100644 index 0000000000..2f555b9937 --- /dev/null +++ b/doc/source/cli/command-objects/object-store/v1/index.rst @@ -0,0 +1,74 @@ +========================== +Object Storage v1 Commands +========================== + + +container +--------- + +A **container** defines a namespace for **objects**. + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container create + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container delete + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container list + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container save + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container set + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container show + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: container unset + + +object store account +-------------------- + +An **object store account** represents the top-level of the hierarchy that +is comprised of **containers** and **objects**. + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account set + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account show + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object store account unset + + +object +------ + +An **object** stores data content, such as documents, images, and so on. They +can also store custom metadata with an object. + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object create + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object delete + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object list + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object save + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object set + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object show + +.. autoprogram-cliff:: openstack.object_store.v1 + :command: object unset diff --git a/doc/source/cli/command-objects/object.rst b/doc/source/cli/command-objects/object.rst deleted file mode 100644 index 8b328bd52f..0000000000 --- a/doc/source/cli/command-objects/object.rst +++ /dev/null @@ -1,27 +0,0 @@ -====== -object -====== - -An **object** stores data content, such as documents, images, and so on. They -can also store custom metadata with an object. Applies to Object Storage v1. - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object create - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object delete - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object list - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object save - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object set - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object show - -.. autoprogram-cliff:: openstack.object_store.v1 - :command: object unset diff --git a/doc/source/cli/command-objects/policy.rst b/doc/source/cli/command-objects/policy.rst deleted file mode 100644 index 66bc2545a6..0000000000 --- a/doc/source/cli/command-objects/policy.rst +++ /dev/null @@ -1,9 +0,0 @@ -====== -policy -====== - -A **policy** is an arbitrarily serialized policy engine rule set to be consumed -by a remote service. Applies to Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: policy * diff --git a/doc/source/cli/command-objects/port.rst b/doc/source/cli/command-objects/port.rst deleted file mode 100644 index 3af5272eb2..0000000000 --- a/doc/source/cli/command-objects/port.rst +++ /dev/null @@ -1,12 +0,0 @@ -==== -port -==== - -A **port** is a connection point for attaching a single device, such as the -NIC of a server, to a network. The port also describes the associated network -configuration, such as the MAC and IP addresses to be used on that port. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: port * diff --git a/doc/source/cli/command-objects/project-cleanup.rst b/doc/source/cli/command-objects/project-cleanup.rst deleted file mode 100644 index e76e538948..0000000000 --- a/doc/source/cli/command-objects/project-cleanup.rst +++ /dev/null @@ -1,12 +0,0 @@ -=============== -project cleanup -=============== - -Clean resources associated with a specific project based on OpenStackSDK -implementation - -Block Storage v2, v3; Compute v2; Network v2; DNS v2; Orchestrate v1 - - -.. autoprogram-cliff:: openstack.common - :command: project cleanup diff --git a/doc/source/cli/command-objects/project-purge.rst b/doc/source/cli/command-objects/project-purge.rst deleted file mode 100644 index 8f10a77452..0000000000 --- a/doc/source/cli/command-objects/project-purge.rst +++ /dev/null @@ -1,11 +0,0 @@ -============= -project purge -============= - -Clean resources associated with a specific project. - -Block Storage v1, v2; Compute v2; Image v1, v2 - - -.. autoprogram-cliff:: openstack.common - :command: project purge diff --git a/doc/source/cli/command-objects/project-v2.rst b/doc/source/cli/command-objects/project-v2.rst deleted file mode 100644 index 502154d37e..0000000000 --- a/doc/source/cli/command-objects/project-v2.rst +++ /dev/null @@ -1,6 +0,0 @@ -===================== -project (Identity v2) -===================== - -.. autoprogram-cliff:: openstack.identity.v2 - :command: project * diff --git a/doc/source/cli/command-objects/project-v3.rst b/doc/source/cli/command-objects/project-v3.rst deleted file mode 100644 index 9bee6ae8cf..0000000000 --- a/doc/source/cli/command-objects/project-v3.rst +++ /dev/null @@ -1,6 +0,0 @@ -===================== -project (Identity v3) -===================== - -.. autoprogram-cliff:: openstack.identity.v3 - :command: project * diff --git a/doc/source/cli/command-objects/quota.rst b/doc/source/cli/command-objects/quota.rst deleted file mode 100644 index cab1265240..0000000000 --- a/doc/source/cli/command-objects/quota.rst +++ /dev/null @@ -1,11 +0,0 @@ -===== -quota -===== - -Resource quotas appear in multiple APIs, OpenStackClient presents them as a -single object with multiple properties. - -Block Storage v1, v2, Compute v2, Network v2 - -.. autoprogram-cliff:: openstack.common - :command: quota * diff --git a/doc/source/cli/command-objects/region.rst b/doc/source/cli/command-objects/region.rst deleted file mode 100644 index 86e7ca8ae0..0000000000 --- a/doc/source/cli/command-objects/region.rst +++ /dev/null @@ -1,10 +0,0 @@ -====== -region -====== - -A **region** is a general division of an OpenStack deployment. You can associate -zero or more sub-regions with a region to create a tree-like structured -hierarchy. Applies to Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: region * diff --git a/doc/source/cli/command-objects/registered-limit.rst b/doc/source/cli/command-objects/registered-limit.rst deleted file mode 100644 index 98a5efba9e..0000000000 --- a/doc/source/cli/command-objects/registered-limit.rst +++ /dev/null @@ -1,11 +0,0 @@ -================ -registered limit -================ - -Identity v3 - -Registered limits are used to define default limits for resources within a -deployment. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: registered limit * diff --git a/doc/source/cli/command-objects/request-token.rst b/doc/source/cli/command-objects/request-token.rst deleted file mode 100644 index ea333c4aba..0000000000 --- a/doc/source/cli/command-objects/request-token.rst +++ /dev/null @@ -1,10 +0,0 @@ -============= -request token -============= - -A **request token** is used by the Identity service's OS-OAUTH1 extension. It -is used by the **consumer** to request **access tokens**. Applicable to -Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: request token * diff --git a/doc/source/cli/command-objects/role-assignment.rst b/doc/source/cli/command-objects/role-assignment.rst deleted file mode 100644 index b29f32c690..0000000000 --- a/doc/source/cli/command-objects/role-assignment.rst +++ /dev/null @@ -1,106 +0,0 @@ -=============== -role assignment -=============== - -Identity v2, v3 - -role assignment list --------------------- - -List role assignments - -.. program:: role assignment list -.. code:: bash - - openstack role assignment list - [--role ] - [--role-domain ] - [--user ] - [--user-domain ] - [--group ] - [--group-domain ] - [--domain ] - [--project ] - [--project-domain ] - [--effective] - [--inherited] - [--names] - -.. option:: --role - - Role to filter (name or ID) - - .. versionadded:: 3 - -.. option:: --role-domain - - Domain the role belongs to (name or ID). - This can be used in case collisions between role names exist. - - .. versionadded:: 3 - -.. option:: --user - - User to filter (name or ID) - -.. option:: --user-domain - - Domain the user belongs to (name or ID). - This can be used in case collisions between user names exist. - - .. versionadded:: 3 - -.. option:: --group - - Group to filter (name or ID) - - .. versionadded:: 3 - -.. option:: --group-domain - - Domain the group belongs to (name or ID). - This can be used in case collisions between group names exist. - - .. versionadded:: 3 - -.. option:: --domain - - Domain to filter (name or ID) - - .. versionadded:: 3 - -.. option:: --project - - Project to filter (name or ID) - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - - .. versionadded:: 3 - -.. option:: --effective - - Returns only effective role assignments (defaults to False) - - .. versionadded:: 3 - -.. option:: --inherited - - Specifies if the role grant is inheritable to the sub projects - - .. versionadded:: 3 - -.. option:: --names - - Returns role assignments with names instead of IDs - -.. option:: --auth-user - - Returns role assignments for the authenticated user. - -.. option:: --auth-project - - Returns role assignments for the project to which the authenticated user - is scoped. diff --git a/doc/source/cli/command-objects/role-v2.rst b/doc/source/cli/command-objects/role-v2.rst deleted file mode 100644 index dc5bac6c65..0000000000 --- a/doc/source/cli/command-objects/role-v2.rst +++ /dev/null @@ -1,6 +0,0 @@ -================== -role (Identity v2) -================== - -.. autoprogram-cliff:: openstack.identity.v2 - :command: role * diff --git a/doc/source/cli/command-objects/role-v3.rst b/doc/source/cli/command-objects/role-v3.rst deleted file mode 100644 index e36bef773f..0000000000 --- a/doc/source/cli/command-objects/role-v3.rst +++ /dev/null @@ -1,6 +0,0 @@ -================== -role (Identity v3) -================== - -.. autoprogram-cliff:: openstack.identity.v3 - :command: role * diff --git a/doc/source/cli/command-objects/router.rst b/doc/source/cli/command-objects/router.rst deleted file mode 100644 index 6e8e05d7c0..0000000000 --- a/doc/source/cli/command-objects/router.rst +++ /dev/null @@ -1,12 +0,0 @@ -====== -router -====== - -A **router** is a logical component that forwards data packets between -networks. It also provides Layer 3 and NAT forwarding to provide external -network access for servers on project networks. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: router * diff --git a/doc/source/cli/command-objects/security-group-rule.rst b/doc/source/cli/command-objects/security-group-rule.rst deleted file mode 100644 index 429bcf270b..0000000000 --- a/doc/source/cli/command-objects/security-group-rule.rst +++ /dev/null @@ -1,11 +0,0 @@ -=================== -security group rule -=================== - -A **security group rule** specifies the network access rules for servers -and other resources on the network. - -Compute v2, Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: security group rule * diff --git a/doc/source/cli/command-objects/security-group.rst b/doc/source/cli/command-objects/security-group.rst deleted file mode 100644 index 4edc199547..0000000000 --- a/doc/source/cli/command-objects/security-group.rst +++ /dev/null @@ -1,30 +0,0 @@ -============== -security group -============== - -A **security group** acts as a virtual firewall for servers and other -resources on a network. It is a container for security group rules -which specify the network access rules. - -Compute v2, Network v2 - -.. NOTE(efried): have to list these out one by one; 'security group *' pulls in - ... rule *. - -.. autoprogram-cliff:: openstack.network.v2 - :command: security group create - -.. autoprogram-cliff:: openstack.network.v2 - :command: security group delete - -.. autoprogram-cliff:: openstack.network.v2 - :command: security group list - -.. autoprogram-cliff:: openstack.network.v2 - :command: security group set - -.. autoprogram-cliff:: openstack.network.v2 - :command: security group show - -.. autoprogram-cliff:: openstack.network.v2 - :command: security group unset diff --git a/doc/source/cli/command-objects/server-backup.rst b/doc/source/cli/command-objects/server-backup.rst deleted file mode 100644 index f2a2e2c958..0000000000 --- a/doc/source/cli/command-objects/server-backup.rst +++ /dev/null @@ -1,11 +0,0 @@ -============= -server backup -============= - -A server backup is a disk image created in the Image store from a running server -instance. The backup command manages the number of archival copies to retain. - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server backup create diff --git a/doc/source/cli/command-objects/server-event.rst b/doc/source/cli/command-objects/server-event.rst deleted file mode 100644 index 372cb40073..0000000000 --- a/doc/source/cli/command-objects/server-event.rst +++ /dev/null @@ -1,12 +0,0 @@ -============ -server event -============ - -Server event are event record for server operations. They consist of: type -(create, delete, reboot and so on), result (success, error), start time, finish -time and so on. These are important for server maintenance. - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server event * diff --git a/doc/source/cli/command-objects/server-group.rst b/doc/source/cli/command-objects/server-group.rst deleted file mode 100644 index 741eb4adaf..0000000000 --- a/doc/source/cli/command-objects/server-group.rst +++ /dev/null @@ -1,10 +0,0 @@ -============ -server group -============ - -Server groups provide a mechanism to group servers according to certain policy. - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server group * diff --git a/doc/source/cli/command-objects/server-image.rst b/doc/source/cli/command-objects/server-image.rst deleted file mode 100644 index c013ca49bb..0000000000 --- a/doc/source/cli/command-objects/server-image.rst +++ /dev/null @@ -1,11 +0,0 @@ -============ -server image -============ - -A server image is a disk image created from a running server instance. The -image is created in the Image store. - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server image create diff --git a/doc/source/cli/command-objects/server-migration.rst b/doc/source/cli/command-objects/server-migration.rst deleted file mode 100644 index 9db58e3e46..0000000000 --- a/doc/source/cli/command-objects/server-migration.rst +++ /dev/null @@ -1,12 +0,0 @@ -================ -server migration -================ - -A server migration provides a way to move an instance from one -host to another. There are four types of migration operation -supported: live migration, cold migration, resize and evacuation. - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server migration * diff --git a/doc/source/cli/command-objects/server.rst b/doc/source/cli/command-objects/server.rst deleted file mode 100644 index cf7df1dae3..0000000000 --- a/doc/source/cli/command-objects/server.rst +++ /dev/null @@ -1,89 +0,0 @@ -====== -server -====== - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server add * - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server create - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server evacuate - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server delete - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server dump create - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server list - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server lock - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server migrate* - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server pause - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server reboot - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server rebuild - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server remove * - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server rescue - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server resize* - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server restore - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server resume - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server set - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server shelve - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server show - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server ssh - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server start - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server stop - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server suspend - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server unlock - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server unpause - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server unrescue - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server unset - -.. autoprogram-cliff:: openstack.compute.v2 - :command: server unshelve diff --git a/doc/source/cli/command-objects/service-provider.rst b/doc/source/cli/command-objects/service-provider.rst deleted file mode 100644 index 47a503278c..0000000000 --- a/doc/source/cli/command-objects/service-provider.rst +++ /dev/null @@ -1,10 +0,0 @@ -================ -service provider -================ - -A **service provider** is used by the Identity service's OS-FEDERATION -extension. It is used by to register another OpenStack Identity service. -Applicable to Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service provider * diff --git a/doc/source/cli/command-objects/service-v2.rst b/doc/source/cli/command-objects/service-v2.rst deleted file mode 100644 index 6b22b7eeb6..0000000000 --- a/doc/source/cli/command-objects/service-v2.rst +++ /dev/null @@ -1,6 +0,0 @@ -===================== -service (Identity v2) -===================== - -.. autoprogram-cliff:: openstack.identity.v2 - :command: service * diff --git a/doc/source/cli/command-objects/service-v3.rst b/doc/source/cli/command-objects/service-v3.rst deleted file mode 100644 index d4b702067b..0000000000 --- a/doc/source/cli/command-objects/service-v3.rst +++ /dev/null @@ -1,18 +0,0 @@ -===================== -service (Identity v3) -===================== - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service create - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service delete - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service list - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service show - -.. autoprogram-cliff:: openstack.identity.v3 - :command: service set diff --git a/doc/source/cli/command-objects/share/index.rst b/doc/source/cli/command-objects/share/index.rst new file mode 100644 index 0000000000..9f77d773c9 --- /dev/null +++ b/doc/source/cli/command-objects/share/index.rst @@ -0,0 +1,8 @@ +=========================== +Shared File System Commands +=========================== + +.. toctree:: + :maxdepth: 1 + + v2/index diff --git a/doc/source/cli/command-objects/share/v2/index.rst b/doc/source/cli/command-objects/share/v2/index.rst new file mode 100644 index 0000000000..0abf57de31 --- /dev/null +++ b/doc/source/cli/command-objects/share/v2/index.rst @@ -0,0 +1,36 @@ +================= +Share v2 Commands +================= + +share lock +---------- + +.. autoprogram-cliff:: openstack.share.v2 + :command: share lock * + + +share message +------------- + +.. autoprogram-cliff:: openstack.share.v2 + :command: share message * + + +share security service +---------------------- + +.. autoprogram-cliff:: openstack.share.v2 + :command: share security service * + + +share service +------------- + +.. autoprogram-cliff:: openstack.share.v2 + :command: share service set + +.. autoprogram-cliff:: openstack.share.v2 + :command: share service list + +.. autoprogram-cliff:: openstack.share.v2 + :command: share service ensure shares diff --git a/doc/source/cli/command-objects/subnet-pool.rst b/doc/source/cli/command-objects/subnet-pool.rst deleted file mode 100644 index ce9649dc94..0000000000 --- a/doc/source/cli/command-objects/subnet-pool.rst +++ /dev/null @@ -1,11 +0,0 @@ -=========== -subnet pool -=========== - -A **subnet pool** contains a collection of prefixes in CIDR notation -that are available for IP address allocation. - -Network v2 - -.. autoprogram-cliff:: openstack.network.v2 - :command: subnet pool * diff --git a/doc/source/cli/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst deleted file mode 100644 index 488fc5a2f5..0000000000 --- a/doc/source/cli/command-objects/subnet.rst +++ /dev/null @@ -1,30 +0,0 @@ -====== -subnet -====== - -A **subnet** is a block of IP addresses and associated configuration state. -Subnets are used to allocate IP addresses when new ports are created on a -network. - -Network v2 - -.. NOTE(efried): have to list these out one by one; 'subnet *' pulls in - subnet pool *. - -.. autoprogram-cliff:: openstack.network.v2 - :command: subnet create - -.. autoprogram-cliff:: openstack.network.v2 - :command: subnet delete - -.. autoprogram-cliff:: openstack.network.v2 - :command: subnet list - -.. autoprogram-cliff:: openstack.network.v2 - :command: subnet set - -.. autoprogram-cliff:: openstack.network.v2 - :command: subnet show - -.. autoprogram-cliff:: openstack.network.v2 - :command: subnet unset diff --git a/doc/source/cli/command-objects/token-v2.rst b/doc/source/cli/command-objects/token-v2.rst deleted file mode 100644 index c66302bfb2..0000000000 --- a/doc/source/cli/command-objects/token-v2.rst +++ /dev/null @@ -1,7 +0,0 @@ -=================== -token (Identity v2) -=================== - - -.. autoprogram-cliff:: openstack.identity.v2 - :command: token * diff --git a/doc/source/cli/command-objects/token-v3.rst b/doc/source/cli/command-objects/token-v3.rst deleted file mode 100644 index 6b2d87a61d..0000000000 --- a/doc/source/cli/command-objects/token-v3.rst +++ /dev/null @@ -1,7 +0,0 @@ -=================== -token (Identity v3) -=================== - - -.. autoprogram-cliff:: openstack.identity.v3 - :command: token * diff --git a/doc/source/cli/command-objects/trust.rst b/doc/source/cli/command-objects/trust.rst deleted file mode 100644 index 738c640c48..0000000000 --- a/doc/source/cli/command-objects/trust.rst +++ /dev/null @@ -1,9 +0,0 @@ -===== -trust -===== - -A **trust** provide project-specific role delegation between users, with -optional impersonation. Requires the OS-TRUST extension. Applies to Identity v3. - -.. autoprogram-cliff:: openstack.identity.v3 - :command: trust * diff --git a/doc/source/cli/command-objects/usage.rst b/doc/source/cli/command-objects/usage.rst deleted file mode 100644 index c2bcde0610..0000000000 --- a/doc/source/cli/command-objects/usage.rst +++ /dev/null @@ -1,8 +0,0 @@ -===== -usage -===== - -Compute v2 - -.. autoprogram-cliff:: openstack.compute.v2 - :command: usage * diff --git a/doc/source/cli/command-objects/user-v2.rst b/doc/source/cli/command-objects/user-v2.rst deleted file mode 100644 index 966bd37620..0000000000 --- a/doc/source/cli/command-objects/user-v2.rst +++ /dev/null @@ -1,7 +0,0 @@ -================== -user (Identity v2) -================== - - -.. autoprogram-cliff:: openstack.identity.v2 - :command: user * diff --git a/doc/source/cli/command-objects/user-v3.rst b/doc/source/cli/command-objects/user-v3.rst deleted file mode 100644 index c11ff9a645..0000000000 --- a/doc/source/cli/command-objects/user-v3.rst +++ /dev/null @@ -1,7 +0,0 @@ -================== -user (Identity v3) -================== - - -.. autoprogram-cliff:: openstack.identity.v3 - :command: user * diff --git a/doc/source/cli/command-objects/versions.rst b/doc/source/cli/command-objects/versions.rst deleted file mode 100644 index ebebec192a..0000000000 --- a/doc/source/cli/command-objects/versions.rst +++ /dev/null @@ -1,8 +0,0 @@ -======== -versions -======== - -Get a list of every version of every service in a given cloud. - -.. autoprogram-cliff:: openstack.common - :command: versions show diff --git a/doc/source/cli/command-objects/volume-attachment.rst b/doc/source/cli/command-objects/volume-attachment.rst deleted file mode 100644 index 5622444638..0000000000 --- a/doc/source/cli/command-objects/volume-attachment.rst +++ /dev/null @@ -1,8 +0,0 @@ -================= -volume attachment -================= - -Block Storage v3 - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume attachment * diff --git a/doc/source/cli/command-objects/volume-backend.rst b/doc/source/cli/command-objects/volume-backend.rst deleted file mode 100644 index 4766ecabb2..0000000000 --- a/doc/source/cli/command-objects/volume-backend.rst +++ /dev/null @@ -1,8 +0,0 @@ -============== -volume backend -============== - -Block Storage v2 - -.. autoprogram-cliff:: openstack.volume.v2 - :command: volume backend * diff --git a/doc/source/cli/command-objects/volume-backup.rst b/doc/source/cli/command-objects/volume-backup.rst deleted file mode 100644 index 1c26921197..0000000000 --- a/doc/source/cli/command-objects/volume-backup.rst +++ /dev/null @@ -1,9 +0,0 @@ -============= -volume backup -============= - -Block Storage v1, v2 - -.. autoprogram-cliff:: openstack.volume.v2 - :command: volume backup * - diff --git a/doc/source/cli/command-objects/volume-group-snapshot.rst b/doc/source/cli/command-objects/volume-group-snapshot.rst deleted file mode 100644 index 02a33c1e3c..0000000000 --- a/doc/source/cli/command-objects/volume-group-snapshot.rst +++ /dev/null @@ -1,8 +0,0 @@ -===================== -volume group snapshot -===================== - -Block Storage v3 - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume group snapshot * diff --git a/doc/source/cli/command-objects/volume-group-type.rst b/doc/source/cli/command-objects/volume-group-type.rst deleted file mode 100644 index edb88dc7b0..0000000000 --- a/doc/source/cli/command-objects/volume-group-type.rst +++ /dev/null @@ -1,8 +0,0 @@ -================= -volume group type -================= - -Block Storage v3 - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume group type * diff --git a/doc/source/cli/command-objects/volume-group.rst b/doc/source/cli/command-objects/volume-group.rst deleted file mode 100644 index 50bc830f90..0000000000 --- a/doc/source/cli/command-objects/volume-group.rst +++ /dev/null @@ -1,23 +0,0 @@ -============ -volume group -============ - -Block Storage v3 - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume group create - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume group delete - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume group list - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume group failover - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume group set - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume group show diff --git a/doc/source/cli/command-objects/volume-host.rst b/doc/source/cli/command-objects/volume-host.rst deleted file mode 100644 index 350d6dec7c..0000000000 --- a/doc/source/cli/command-objects/volume-host.rst +++ /dev/null @@ -1,52 +0,0 @@ -=========== -volume host -=========== - -Block Storage v2 - -volume host failover --------------------- - -Failover volume host to different backend - -.. program:: volume host failover -.. code:: bash - - openstack volume host failover - --volume-backend - - -.. option:: --volume-backend - - The ID of the volume backend replication - target where the host will failover to (required) - -.. _volume_host_failover-host-name: -.. describe:: - - Name of volume host - -volume host set ---------------- - -Set volume host properties - -.. program:: volume host set -.. code:: bash - - openstack volume host set - [--enable | --disable] - - -.. option:: --enable - - Thaw and enable the specified volume host. - -.. option:: --disable - - Freeze and disable the specified volume host - -.. _volume_host_set-host-name: -.. describe:: - - Name of volume host diff --git a/doc/source/cli/command-objects/volume-message.rst b/doc/source/cli/command-objects/volume-message.rst deleted file mode 100644 index 5b1a8acef2..0000000000 --- a/doc/source/cli/command-objects/volume-message.rst +++ /dev/null @@ -1,8 +0,0 @@ -============== -volume message -============== - -Block Storage v3 - -.. autoprogram-cliff:: openstack.volume.v3 - :command: volume message * diff --git a/doc/source/cli/command-objects/volume-qos.rst b/doc/source/cli/command-objects/volume-qos.rst deleted file mode 100644 index 8fdbc12284..0000000000 --- a/doc/source/cli/command-objects/volume-qos.rst +++ /dev/null @@ -1,166 +0,0 @@ -========== -volume qos -========== - -Block Storage v1, v2 - -volume qos associate --------------------- - -Associate a QoS specification to a volume type - -.. program:: volume qos associate -.. code:: bash - - openstack volume qos associate - - - -.. _volume_qos_associate: -.. describe:: - - QoS specification to modify (name or ID) - -.. describe:: - - Volume type to associate the QoS (name or ID) - -volume qos create ------------------ - -Create new QoS Specification - -.. program:: volume qos create -.. code:: bash - - openstack volume qos create - [--consumer ] - [--property [...] ] - - -.. option:: --consumer - - Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both') - -.. option:: --property - - Set a property on this QoS specification (repeat option to set multiple properties) - -.. _volume_qos_create-name: -.. describe:: - - New QoS specification name - -volume qos delete ------------------ - -Delete QoS specification - -.. program:: volume qos delete -.. code:: bash - - openstack volume qos delete - [--force] - [ ...] - -.. option:: --force - - Allow to delete in-use QoS specification(s) - -.. _volume_qos_delete-qos-spec: -.. describe:: - - QoS specification(s) to delete (name or ID) - -volume qos disassociate ------------------------ - -Disassociate a QoS specification from a volume type - -.. program:: volume qos disassociate -.. code:: bash - - openstack volume qos disassociate - --volume-type | --all - - -.. option:: --volume-type - - Volume type to disassociate the QoS from (name or ID) - -.. option:: --all - - Disassociate the QoS from every volume type - -.. _volume_qos_disassociate-qos-spec: -.. describe:: - - QoS specification to modify (name or ID) - -volume qos list ---------------- - -List QoS specifications - -.. program:: volume qos list -.. code:: bash - - openstack volume qos list - -volume qos set --------------- - -Set QoS specification properties - -.. program:: volume qos set -.. code:: bash - - openstack volume qos set - [--property [...] ] - - -.. option:: --property - - Property to add or modify for this QoS specification (repeat option to set multiple properties) - -.. _volume_qos_set-qos-spec: -.. describe:: - - QoS specification to modify (name or ID) - -volume qos show ---------------- - -Display QoS specification details - -.. program:: volume qos show -.. code:: bash - - openstack volume qos show - - -.. _volume_qos_show-qos-spec: -.. describe:: - - QoS specification to display (name or ID) - -volume qos unset ----------------- - -Unset QoS specification properties - -.. program:: volume qos unset -.. code:: bash - - openstack volume qos unset - [--property [...] ] - - -.. option:: --property - - Property to remove from QoS specification (repeat option to remove multiple properties) - -.. _volume_qos_unset-qos-spec: -.. describe:: - - QoS specification to modify (name or ID) diff --git a/doc/source/cli/command-objects/volume-service.rst b/doc/source/cli/command-objects/volume-service.rst deleted file mode 100644 index 0499fb9062..0000000000 --- a/doc/source/cli/command-objects/volume-service.rst +++ /dev/null @@ -1,66 +0,0 @@ -============== -volume service -============== - -Block Storage v1, v2 - -volume service list -------------------- - -List volume service - -.. program:: volume service list -.. code:: bash - - openstack volume service list - [--host ] - [--service ] - [--long] - -.. option:: --host - - List services on specified host (name only) - -.. option:: --service - - List only specified service (name only) - -.. option:: --long - - List additional fields in output - -volume service set ------------------- - -Set volume service properties - -.. program:: volume service set -.. code:: bash - - openstack volume service set - [--enable | --disable] - [--disable-reason ] - - - -.. option:: --enable - - Enable volume service - -.. option:: --disable - - Disable volume service - -.. option:: --disable-reason - - Reason for disabling the service - (should be used with :option:`--disable` option) - -.. _volume_service_set-host: -.. describe:: - - Name of host - -.. describe:: - - Name of service (Binary name) diff --git a/doc/source/cli/command-objects/volume-snapshot.rst b/doc/source/cli/command-objects/volume-snapshot.rst deleted file mode 100644 index 21a8937018..0000000000 --- a/doc/source/cli/command-objects/volume-snapshot.rst +++ /dev/null @@ -1,223 +0,0 @@ -=============== -volume snapshot -=============== - -Block Storage v1, v2 - -volume snapshot create ----------------------- - -Create new volume snapshot - -.. program:: volume snapshot create -.. code:: bash - - openstack volume snapshot create - [--volume ] - [--description ] - [--force] - [--property [...] ] - [--remote-source [...]] - - -.. option:: --volume - - Volume to snapshot (name or ID) (default is ) - -.. option:: --description - - Description of the snapshot - -.. option:: --force - - Create a snapshot attached to an instance. Default is False - -.. option:: --property - - Set a property to this snapshot (repeat option to set multiple properties) - - *Volume version 2 only* - -.. option:: --remote-source - - The attribute(s) of the exsiting remote volume snapshot - (admin required) (repeat option to specify multiple attributes) - e.g.: '--remote-source source-name=test_name --remote-source source-id=test_id' - - *Volume version 2 only* - -.. _volume_snapshot_create-snapshot-name: -.. describe:: - - Name of the new snapshot - -volume snapshot delete ----------------------- - -Delete volume snapshot(s) - -.. program:: volume snapshot delete -.. code:: bash - - openstack volume snapshot delete - [--force] - [ ...] - -.. option:: --force - - Attempt forced removal of snapshot(s), regardless of state (defaults to False) - -.. _volume_snapshot_delete-snapshot: -.. describe:: - - Snapshot(s) to delete (name or ID) - -volume snapshot list --------------------- - -List volume snapshots - -.. program:: volume snapshot list -.. code:: bash - - openstack volume snapshot list - [--all-projects] - [--project [--project-domain ]] - [--long] - [--limit ] - [--marker ] - [--name ] - [--status ] - [--volume ] - -.. option:: --all-projects - - Include all projects (admin only) - -.. option:: --project - - Filter results by project (name or ID) (admin only) - - *Volume version 2 only* - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - - This can be used in case collisions between project names exist. - - *Volume version 2 only* - -.. option:: --long - - List additional fields in output - -.. option:: --status - - Filters results by a status. - ('available', 'error', 'creating', 'deleting' or 'error_deleting') - -.. option:: --name - - Filters results by a name. - -.. option:: --volume - - Filters results by a volume (name or ID). - -.. option:: --limit - - Maximum number of snapshots to display - - *Volume version 2 only* - -.. option:: --marker - - The last snapshot ID of the previous page - - *Volume version 2 only* - -volume snapshot set -------------------- - -Set volume snapshot properties - -.. program:: volume snapshot set -.. code:: bash - - openstack volume snapshot set - [--name ] - [--description ] - [--no-property] - [--property [...] ] - [--state ] - - -.. option:: --name - - New snapshot name - -.. option:: --description - - New snapshot description - -.. option:: --no-property - - Remove all properties from :ref:`\ ` - (specify both :option:`--no-property` and :option:`--property` to - remove the current properties before setting new properties.) - -.. option:: --property - - Property to add or modify for this snapshot (repeat option to set multiple properties) - -.. option:: --state - - New snapshot state. - ("available", "error", "creating", "deleting", or "error_deleting") (admin only) - (This option simply changes the state of the snapshot in the database with - no regard to actual status, exercise caution when using) - - *Volume version 2 only* - -.. _volume_snapshot_set-snapshot: -.. describe:: - - Snapshot to modify (name or ID) - -volume snapshot show --------------------- - -Display volume snapshot details - -.. program:: volume snapshot show -.. code:: bash - - openstack volume snapshot show - - -.. _volume_snapshot_show-snapshot: -.. describe:: - - Snapshot to display (name or ID) - -volume snapshot unset ---------------------- - -Unset volume snapshot properties - -.. program:: volume snapshot unset -.. code:: bash - - openstack volume snapshot unset - [--property ] - - -.. option:: --property - - Property to remove from snapshot (repeat option to remove multiple properties) - -.. _volume_snapshot_unset-snapshot: -.. describe:: - - Snapshot to modify (name or ID) diff --git a/doc/source/cli/command-objects/volume-transfer-request.rst b/doc/source/cli/command-objects/volume-transfer-request.rst deleted file mode 100644 index 23cd3d3e1b..0000000000 --- a/doc/source/cli/command-objects/volume-transfer-request.rst +++ /dev/null @@ -1,96 +0,0 @@ -======================= -volume transfer request -======================= - -Block Storage v1, v2 - -volume transfer request accept ------------------------------- - -Accept volume transfer request - -.. program:: volume transfer request accept -.. code:: bash - - openstack volume transfer request accept - --auth-key - - -.. option:: --auth-key - - Volume transfer request authentication key - -.. _volume_transfer_request_accept: -.. describe:: - - Volume transfer request to accept (ID only) - - Non-admin users are only able to specify the transfer request by ID. - -volume transfer request create ------------------------------- - -Create volume transfer request - -.. program:: volume transfer request create -.. code:: bash - - openstack volume transfer request create - [--name ] - - -.. option:: --name - - New transfer request name (default to None) - -.. _volume_transfer_request_create-volume: -.. describe:: - - Volume to transfer (name or ID) - -volume transfer request delete ------------------------------- - -Delete volume transfer request(s) - -.. program:: volume transfer request delete -.. code:: bash - - openstack volume transfer request delete - [ ...] - -.. _volume_transfer_request_delete-transfer-request: -.. describe:: - - Volume transfer request(s) to delete (name or ID) - -volume transfer request list ----------------------------- - -Lists all volume transfer requests - -.. program:: volume transfer request list -.. code:: bash - - openstack volume transfer request list - --all-projects - -.. option:: --all-projects - - Include all projects (admin only) - -volume transfer request show ----------------------------- - -Show volume transfer request details - -.. program:: volume transfer request show -.. code:: bash - - openstack volume transfer request show - - -.. _volume_transfer_request_show-transfer-request: -.. describe:: - - Volume transfer request to display (name or ID) diff --git a/doc/source/cli/command-objects/volume-type.rst b/doc/source/cli/command-objects/volume-type.rst deleted file mode 100644 index 2b5aff9940..0000000000 --- a/doc/source/cli/command-objects/volume-type.rst +++ /dev/null @@ -1,291 +0,0 @@ -=========== -volume type -=========== - -Block Storage v1, v2 - -volume type create ------------------- - -Create new volume type - -.. program:: volume type create -.. code:: bash - - openstack volume type create - [--description ] - [--public | --private] - [--property [...] ] - [--project ] - [--project-domain ] - [--encryption-provider ] - [--encryption-cipher ] - [--encryption-key-size ] - [--encryption-control-location ] - - -.. option:: --description - - Volume type description - - .. versionadded:: 2 - -.. option:: --public - - Volume type is accessible to the public - - .. versionadded:: 2 - -.. option:: --private - - Volume type is not accessible to the public - - .. versionadded:: 2 - -.. option:: --property - - Set a property on this volume type (repeat option to set multiple properties) - -.. option:: --project - - Allow to access private type (name or ID) - (Must be used with :option:`--private` option) - - *Volume version 2 only* - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - - *Volume version 2 only* - -.. option:: --encryption-provider - - Set the encryption provider format for this volume type - (e.g "luks" or "plain") (admin only) - - This option is required when setting encryption type of a volume. - Consider using other encryption options such as: :option:`--encryption-cipher`, - :option:`--encryption-key-size` and :option:`--encryption-control-location` - -.. option:: --encryption-cipher - - Set the encryption algorithm or mode for this volume type - (e.g "aes-xts-plain64") (admin only) - -.. option:: --encryption-key-size - - Set the size of the encryption key of this volume type - (e.g "128" or "256") (admin only) - -.. option:: --encryption-control-location - - Set the notional service where the encryption is performed - ("front-end" or "back-end") (admin only) - - The default value for this option is "front-end" when setting encryption type of - a volume. Consider using other encryption options such as: :option:`--encryption-cipher`, - :option:`--encryption-key-size` and :option:`--encryption-provider` - -.. _volume_type_create-name: -.. describe:: - - Volume type name - -volume type delete ------------------- - -Delete volume type(s) - -.. program:: volume type delete -.. code:: bash - - openstack volume type delete - [ ...] - -.. _volume_type_delete-volume-type: -.. describe:: - - Volume type(s) to delete (name or ID) - -volume type list ----------------- - -List volume types - -.. program:: volume type list -.. code:: bash - - openstack volume type list - [--long] - [--default | --public | --private] - [--encryption-type] - -.. option:: --long - - List additional fields in output - -.. option:: --public - - List only public types - - *Volume version 2 only* - -.. option:: --private - - List only private types (admin only) - - *Volume version 2 only* - -.. option:: --default - - List the default volume type - - *Volume version 2 only* - -.. option:: --encryption-type - - Display encryption information for each volume type (admin only) - -volume type set ---------------- - -Set volume type properties - -.. program:: volume type set -.. code:: bash - - openstack volume type set - [--name ] - [--description ] - [--property [...] ] - [--project ] - [--project-domain ] - [--encryption-provider ] - [--encryption-cipher ] - [--encryption-key-size ] - [--encryption-control-location ] - - -.. option:: --name - - Set volume type name - - .. versionadded:: 2 - -.. option:: --description - - Set volume type description - - .. versionadded:: 2 - -.. option:: --project - - Set volume type access to project (name or ID) (admin only) - - *Volume version 2 only* - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --property - - Set a property on this volume type (repeat option to set multiple properties) - -.. option:: --encryption-provider - - Set the encryption provider format for this volume type - (e.g "luks" or "plain") (admin only) - - This option is required when setting encryption type of a volume for the first time. - Consider using other encryption options such as: :option:`--encryption-cipher`, - :option:`--encryption-key-size` and :option:`--encryption-control-location` - -.. option:: --encryption-cipher - - Set the encryption algorithm or mode for this volume type - (e.g "aes-xts-plain64") (admin only) - -.. option:: --encryption-key-size - - Set the size of the encryption key of this volume type - (e.g "128" or "256") (admin only) - -.. option:: --encryption-control-location - - Set the notional service where the encryption is performed - ("front-end" or "back-end") (admin only) - - The default value for this option is "front-end" when setting encryption type of - a volume for the first time. Consider using other encryption options such as: - :option:`--encryption-cipher`, :option:`--encryption-key-size` and :option:`--encryption-provider` - -.. _volume_type_set-volume-type: -.. describe:: - - Volume type to modify (name or ID) - -volume type show ----------------- - -Display volume type details - -.. program:: volume type show -.. code:: bash - - openstack volume type show - [--encryption-type] - - -.. option:: --encryption-type - - Display encryption information of this volume type (admin only) - -.. _volume_type_show-volume-type: -.. describe:: - - Volume type to display (name or ID) - -volume type unset ------------------ - -Unset volume type properties - -.. program:: volume type unset -.. code:: bash - - openstack volume type unset - [--property [...] ] - [--project ] - [--project-domain ] - [--encryption-type] - - -.. option:: --property - - Property to remove from volume type (repeat option to remove multiple properties) - -.. option:: --project - - Removes volume type access from project (name or ID) (admin only) - - *Volume version 2 only* - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - - *Volume version 2 only* - -.. option:: --encryption-type - - Remove the encryption type for this volume type (admin only) - -.. _volume_type_unset-volume-type: -.. describe:: - - Volume type to modify (name or ID) diff --git a/doc/source/cli/command-objects/volume.rst b/doc/source/cli/command-objects/volume.rst deleted file mode 100644 index ac414110a0..0000000000 --- a/doc/source/cli/command-objects/volume.rst +++ /dev/null @@ -1,390 +0,0 @@ -====== -volume -====== - -Block Storage v1, v2 - -volume create -------------- - -Create new volume - -.. program:: volume create -.. code:: bash - - openstack volume create - [--size ] - [--type ] - [--image | --snapshot | --source ] - [--description ] - [--availability-zone ] - [--consistency-group ] - [--property [...] ] - [--hint [...] ] - [--bootable | --non-bootable] - [--read-only | --read-write] - - -.. option:: --size - - Volume size in GB - (Required unless --snapshot or --source is specified) - -.. option:: --type - - Set the type of volume - - Select ```` from the available types as shown - by ``volume type list``. - -.. option:: --image - - Use ```` as source of volume (name or ID) - - This is commonly used to create a boot volume for a server. - -.. option:: --snapshot - - Use ```` as source of volume (name or ID) - -.. option:: --source - - Volume to clone (name or ID) - -.. option:: --description - - Volume description - -.. option:: --availability-zone - - Create volume in ```` - -.. option:: --consistency-group - - Consistency group where the new volume belongs to - -.. option:: --property - - Set a property on this volume (repeat option to set multiple properties) - -.. option:: --hint - - Arbitrary scheduler hint key-value pairs to help boot an instance - (repeat option to set multiple hints) - -.. option:: --bootable - - Mark volume as bootable - -.. option:: --non-bootable - - Mark volume as non-bootable (default) - -.. option:: --read-only - - Set volume to read-only access mode - -.. option:: --read-write - - Set volume to read-write access mode (default) - -.. _volume_create-name: -.. describe:: - - Volume name - -volume delete -------------- - -Delete volume(s) - -.. program:: volume delete -.. code:: bash - - openstack volume delete - [--force | --purge] - [ ...] - -.. option:: --force - - Attempt forced removal of volume(s), regardless of state (defaults to False) - -.. option:: --purge - - Remove any snapshots along with volume(s) (defaults to False) - - *Volume version 2 only* - -.. _volume_delete-volume: -.. describe:: - - Volume(s) to delete (name or ID) - -volume list ------------ - -List volumes - -.. program:: volume list -.. code:: bash - - openstack volume list - [--project [--project-domain ]] - [--user [--user-domain ]] - [--name ] - [--status ] - [--all-projects] - [--long] - [--limit ] - [--marker ] - -.. option:: --project - - Filter results by ```` (name or ID) (admin only) - - *Volume version 2 only* - -.. option:: --project-domain - - Domain the project belongs to (name or ID). - - This can be used in case collisions between project names exist. - - *Volume version 2 only* - -.. option:: --user - - Filter results by ```` (name or ID) (admin only) - - *Volume version 2 only* - -.. option:: --user-domain - - Domain the user belongs to (name or ID). - - This can be used in case collisions between user names exist. - - *Volume version 2 only* - -.. option:: --name - - Filter results by volume name - -.. option:: --status - - Filter results by status - -.. option:: --all-projects - - Include all projects (admin only) - -.. option:: --long - - List additional fields in output - -.. option:: --limit - - Maximum number of volumes to display - -.. option:: --marker - - The last volume ID of the previous page - - *Volume version 2 only* - -volume migrate --------------- - -Migrate volume to a new host - -.. program:: volume migrate -.. code:: bash - - openstack volume migrate - --host - [--force-host-copy] - [--lock-volume] - - -.. option:: --host - - Destination host (takes the form: host@backend-name#pool) (required) - -.. option:: --force-host-copy - - Enable generic host-based force-migration, - which bypasses driver optimizations - -.. option:: --lock-volume - - If specified, the volume state will be locked and will not allow - a migration to be aborted (possibly by another operation) - - *Volume version 2 only* - -.. _volume_migrate-volume: -.. describe:: - - Volume to migrate (name or ID) - -volume set ----------- - -Set volume properties - -.. program:: volume set -.. code:: bash - - openstack volume set - [--name ] - [--size ] - [--description ] - [--no-property] - [--property [...] ] - [--image-property [...] ] - [--state ] - [--attached | --detached ] - [--type ] - [--retype-policy ] - [--bootable | --non-bootable] - [--read-only | --read-write] - - -.. option:: --name - - New volume name - -.. option:: --size - - Extend volume size in GB - -.. option:: --description - - New volume description - -.. option:: --no-property - - Remove all properties from :ref:`\ ` - (specify both :option:`--no-property` and :option:`--property` to - remove the current properties before setting new properties.) - -.. option:: --property - - Set a property on this volume (repeat option to set multiple properties) - -.. option:: --type - - New volume type (name or ID) - - *Volume version 2 only* - -.. option:: --retype-policy - - Migration policy while re-typing volume - ("never" or "on-demand", default is "never" ) - (available only when :option:`--type` option is specified) - - *Volume version 2 only* - -.. option:: --bootable - - Mark volume as bootable - -.. option:: --non-bootable - - Mark volume as non-bootable - -.. option:: --read-only - - Set volume to read-only access mode - -.. option:: --read-write - - Set volume to read-write access mode - -.. option:: --image-property - - Set an image property on this volume - (repeat option to set multiple image properties) - - Image properties are copied along with the image when creating a volume - using ``--image``. Note that these properties are immutable on the image - itself, this option updates the copy attached to this volume. - - *Volume version 2 only* - -.. option:: --state - - New volume state - ("available", "error", "creating", "deleting", "in-use", - "attaching", "detaching", "error_deleting" or "maintenance") (admin only) - (This option simply changes the state of the volume in the database with - no regard to actual status, exercise caution when using) - - *Volume version 2 only* - -.. option:: --attached - - Set volume attachment status to "attached" (admin only) - (This option simply changes the state of the volume in the database with - no regard to actual status, exercise caution when using) - - *Volume version 2 only* - -.. option:: --deattach - - Set volume attachment status to "detached" (admin only) - (This option simply changes the state of the volume in the database with - no regard to actual status, exercise caution when using) - - *Volume version 2 only* - -.. _volume_set-volume: -.. describe:: - - Volume to modify (name or ID) - -volume show ------------ - -Show volume details - -.. program:: volume show -.. code:: bash - - openstack volume show - - -.. _volume_show-volume: -.. describe:: - - Volume to display (name or ID) - -volume unset ------------- - -Unset volume properties - -.. program:: volume unset -.. code:: bash - - openstack volume unset - [--property ] - [--image-property ] - - -.. option:: --property - - Remove a property from volume (repeat option to remove multiple properties) - -.. option:: --image-property - - Remove an image property from volume - (repeat option to remove multiple image properties) - - *Volume version 2 only* - -.. _volume_unset-volume: -.. describe:: - - Volume to modify (name or ID) diff --git a/doc/source/cli/command-objects/volume/index.rst b/doc/source/cli/command-objects/volume/index.rst new file mode 100644 index 0000000000..9a343b96b1 --- /dev/null +++ b/doc/source/cli/command-objects/volume/index.rst @@ -0,0 +1,9 @@ +====================== +Block Storage Commands +====================== + +.. toctree:: + :maxdepth: 1 + + v2/index + v3/index diff --git a/doc/source/cli/command-objects/volume/v2/index.rst b/doc/source/cli/command-objects/volume/v2/index.rst new file mode 100644 index 0000000000..b69619c2f9 --- /dev/null +++ b/doc/source/cli/command-objects/volume/v2/index.rst @@ -0,0 +1,146 @@ +========================= +Block Storage v2 Commands +========================= + + +consistency group +----------------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group add volume + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group create + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group delete + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group list + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group remove volume + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group set + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group show + + +consistency group snapshot +-------------------------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group snapshot create + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group snapshot delete + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group snapshot list + +.. autoprogram-cliff:: openstack.volume.v2 + :command: consistency group snapshot show + + +volume backend +-------------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backend * + + +volume backup +------------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backup create + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backup delete + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backup list + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backup restore + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backup set + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backup show + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backup record export + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume backup record import + + +volume host +----------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume host * + + +volume qos +---------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume qos * + + +volume service +-------------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume service * + + +volume snapshot +--------------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume snapshot * + + +volume transfer request +----------------------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume transfer request * + + +volume type +----------- + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume type * + + +volume +------ + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume create + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume delete + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume list + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume migrate + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume set + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume show + +.. autoprogram-cliff:: openstack.volume.v2 + :command: volume unset diff --git a/doc/source/cli/command-objects/volume/v3/index.rst b/doc/source/cli/command-objects/volume/v3/index.rst new file mode 100644 index 0000000000..4c48f8c238 --- /dev/null +++ b/doc/source/cli/command-objects/volume/v3/index.rst @@ -0,0 +1,220 @@ +========================= +Block Storage v2 Commands +========================= + + +block storage +------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: block storage cleanup + + +block storage cluster +--------------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: block storage cluster * + + +Block Storage Log Level +----------------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: block storage log level * + + +Block Storage Manage +-------------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: block storage volume manageable list + +.. autoprogram-cliff:: openstack.volume.v3 + :command: block storage snapshot manageable list + + +block storage resource filter +----------------------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: block storage resource filter * + + +consistency group snapshot +-------------------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group snapshot create + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group snapshot delete + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group snapshot list + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group snapshot show + + +consistency group +----------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group add volume + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group create + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group delete + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group list + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group remove volume + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group set + +.. autoprogram-cliff:: openstack.volume.v3 + :command: consistency group show + + +volume attachment +----------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume attachment * + + +volume backend +-------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume backend * + + +volume backup +------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume backup * + + +volume group snapshot +--------------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume group snapshot * + + +volume group type +----------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume group type * + + +volume group +------------ + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume group create + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume group delete + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume group list + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume group failover + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume group set + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume group show + + +volume host +----------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume host * + + +volume message +-------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume message * + + +volume qos +---------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume qos * + + +volume service +-------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume service * + + +volume snapshot +--------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume snapshot * + + +volume transfer request +----------------------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume transfer request * + + +volume type +----------- + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume type * + + +volume +------ + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume create + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume delete + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume list + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume migrate + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume set + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume show + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume unset + + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume summary + +.. autoprogram-cliff:: openstack.volume.v3 + :command: volume revert diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst index 7e59215271..c7d60951d8 100644 --- a/doc/source/cli/commands.rst +++ b/doc/source/cli/commands.rst @@ -76,6 +76,8 @@ referring to both Compute and Volume quotas. * ``address scope``: (**Network**) a scope of IPv4 or IPv6 addresses * ``aggregate``: (**Compute**) a grouping of compute hosts * ``availability zone``: (**Compute**, **Network**, **Volume**) a logical partition of hosts or block storage or network services +* ``block storage cluster``: (**Volume**) clusters of volume services +* ``block storage resource filter``: (**Volume**) filters for volume service resources * ``catalog``: (**Identity**) service catalog * ``command``: (**Internal**) installed commands in the OSC process * ``compute agent``: (**Compute**) a cloud Compute agent available to a hypervisor @@ -97,7 +99,6 @@ referring to both Compute and Volume quotas. * ``flavor``: (**Compute**) predefined server configurations: ram, root disk and so on * ``fixed ip``: (**Compute**) - an internal IP address assigned to a server * ``floating ip``: (**Network**) - a public IP address that can be mapped to a server -* ``floating ip pool``: (**Network**) - a pool of public IP addresses * ``group``: (**Identity**) a grouping of users * ``host``: (**Compute**) - the physical computer running compute services * ``hypervisor``: (**Compute**) the virtual machine manager @@ -189,23 +190,14 @@ conflicts when creating new plugins. For a complete list check out * ``appcontainer service``: (**Application Container (Zun)**) * ``baremetal``: (**Baremetal (Ironic)**) * ``claim``: (**Messaging (Zaqar)**) -* ``cluster``: (**Clustering (Senlin)**) -* ``cluster action``: (**Clustering (Senlin)**) -* ``cluster event``: (**Clustering (Senlin)**) -* ``cluster members``: (**Clustering (Senlin)**) -* ``cluster node``: (**Clustering (Senlin)**) -* ``cluster policy``: (**Clustering (Senlin)**) -* ``cluster policy binding``: (**Clustering (Senlin)**) -* ``cluster policy type``: (**Clustering (Senlin)**) -* ``cluster profile``: (**Clustering (Senlin)**) -* ``cluster profile type``: (**Clustering (Senlin)**) -* ``cluster receiver``: (**Clustering (Senlin)**) +* ``coe ca``: (**Container Orchestration Engine (Magnum)**) +* ``coe cluster``: (**Container Orchestration Engine (Magnum)**) +* ``coe cluster template``: (**Container Orchestration Engine (Magnum)**) +* ``coe quotas``: (**Container Orchestration Engine (Magnum)**) +* ``coe service``: (**Container Orchestration Engine (Magnum)**) +* ``coe stats``: (**Container Orchestration Engine (Magnum)**) * ``cron trigger``: (**Workflow Engine (Mistral)**) * ``database flavor``: (**Database (Trove)**) -* ``dataprocessing data source``: (**Data Processing (Sahara)**) -* ``dataprocessing image``: (**Data Processing (Sahara)**) -* ``dataprocessing image tags``: (**Data Processing (Sahara)**) -* ``dataprocessing plugin``: (**Data Processing (Sahara)**) * ``loadbalancer``: (**Load Balancer (Octavia)**) * ``loadbalancer healthmonitor``: (**Load Balancer (Octavia)**) * ``loadbalancer l7policy``: (**Load Balancer (Octavia)**) @@ -224,13 +216,35 @@ conflicts when creating new plugins. For a complete list check out * ``ptr record``: (**DNS (Designate)**) * ``queue``: (**Messaging (Zaqar)**) * ``recordset``: (**DNS (Designate)**) -* ``rsd``: (**Disaggregated Hardware Resource Management (RSD)**) -* ``search`` (**Search (Searchlight)**) -* ``search facet`` (**Search (Searchlight)**) -* ``search resource type`` (**Search (Searchlight)**) * ``secret``: (**Key Manager (Barbican)**) * ``secret container``: (**Key Manager (Barbican)**) * ``secret order``: (**Key Manager (Barbican)**) +* ``share``: (**Share (Manila)**) +* ``share access``: (**Share (Manila)**) +* ``share availability zone``: (**Share (Manila)**) +* ``share backup``: (**Share (Manila)**) +* ``share export location``: (**Share (Manila)**) +* ``share group``: (**Share (Manila)**) +* ``share group snapshot``: (**Share (Manila)**) +* ``share group type``: (**Share (Manila)**) +* ``share instance``: (**Share (Manila)**) +* ``share limits show``: (**Share (Manila)**) +* ``share lock``: (**Share (Manila)**) +* ``share message``: (**Share (Manila)**) +* ``share migration``: (**Share (Manila)**) +* ``share network``: (**Share (Manila)**) +* ``share quota``: (**Share (Manila)**) +* ``share replica``: (**Share (Manila)**) +* ``share security service``: (**Share (Manila)**) +* ``share server``: (**Share (Manila)**) +* ``share server migration``: (**Share (Manila)**) +* ``share service``: (**Share (Manila)**) +* ``share snapshot``: (**Share (Manila)**) +* ``share snapshot access``: (**Share (Manila)**) +* ``share snapshot export location``: (**Share (Manila)**) +* ``share snapshot instance``: (**Share (Manila)**) +* ``share transfer``: (**Share (Manila)**) +* ``share type``: (**Share (Manila)**) * ``software config``: (**Orchestration (Heat)**) * ``software deployment``: (**Orchestration (Heat)**) * ``stack event``: (**Orchestration (Heat)**) @@ -274,7 +288,6 @@ Those actions with an opposite action are noted in parens if applicable. live server migration if possible * ``pause`` (``unpause``) - stop one or more servers and leave them in memory * ``query`` - Query resources by Elasticsearch query string or json format DSL. -* ``purge`` - clean resources associated with a specific project * ``cleanup`` - flexible clean resources associated with a specific project * ``reboot`` - forcibly reboot a server * ``rebuild`` - rebuild a server using (most of) the same arguments as in the original create diff --git a/doc/source/cli/data/cinder.csv b/doc/source/cli/data/cinder.csv index 9d79d1ba97..1b199400b4 100644 --- a/doc/source/cli/data/cinder.csv +++ b/doc/source/cli/data/cinder.csv @@ -1,5 +1,5 @@ absolute-limits,limits show --absolute,Lists absolute limits for a user. -api-version,WONTFIX,Display the server API version information. +api-version,openstack versions show --service volume,Display the server API version information. availability-zone-list,availability zone list --volume,Lists all availability zones. attachment-complete,volume attachment complete,Complete an attachment for a cinder volume. (Supported by API versions 3.44 - 3.latest) attachment-create,volume attachment create,Create an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) @@ -20,10 +20,10 @@ cgsnapshot-create,consistency group snapshot create,Creates a cgsnapshot. cgsnapshot-delete,consistency group snapshot delete,Removes one or more cgsnapshots. cgsnapshot-list,consistency group snapshot list,Lists all cgsnapshots. cgsnapshot-show,consistency group snapshot show,Shows cgsnapshot details. -cluster-disable,,Disables clustered services. (Supported by API versions 3.7 - 3.latest) -cluster-enable,,Enables clustered services. (Supported by API versions 3.7 - 3.latest) -cluster-list,,Lists clustered services with optional filtering. (Supported by API versions 3.7 - 3.latest) -cluster-show,,Show detailed information on a clustered service. (Supported by API versions 3.7 - 3.latest) +cluster-disable,block storage cluster set --disable,Disables clustered services. (Supported by API versions 3.7 - 3.latest) +cluster-enable,block storage cluster set --enable,Enables clustered services. (Supported by API versions 3.7 - 3.latest) +cluster-list,block storage cluster list,Lists clustered services with optional filtering. (Supported by API versions 3.7 - 3.latest) +cluster-show,block storage cluster show,Show detailed information on a clustered service. (Supported by API versions 3.7 - 3.latest) consisgroup-create,consistency group create,Creates a consistency group. consisgroup-create-from-src,consistency group create --consistency-group-snapshot,Creates a consistency group from a cgsnapshot or a source CG consisgroup-delete,consistency group delete,Removes one or more consistency groups. @@ -45,7 +45,7 @@ freeze-host,volume host set --disable,Freeze and disable the specified cinder-vo get-capabilities,volume backend capability show,Show capabilities of a volume backend. Admin only. get-pools,volume backend pool list,Show pool information for backends. Admin only. group-create,volume group create,Creates a group. (Supported by API versions 3.13 - 3.latest) -group-create-from-src,,Creates a group from a group snapshot or a source group. (Supported by API versions 3.14 - 3.latest) +group-create-from-src,volume group create [--source-group|--group-snapshot],Creates a group from a group snapshot or a source group. (Supported by API versions 3.14 - 3.latest) group-delete,volume group delete,Removes one or more groups. (Supported by API versions 3.13 - 3.latest) group-disable-replication,volume group set --disable-replication,Disables replication for group. (Supported by API versions 3.38 - 3.latest) group-enable-replication,volume group set --enable-replication,Enables replication for group. (Supported by API versions 3.38 - 3.latest) @@ -69,9 +69,9 @@ group-update,volume group set,Updates a group. (Supported by API versions 3.13 - image-metadata,volume set --image-property,Sets or deletes volume image metadata. image-metadata-show,volume show,Shows volume image metadata. list,volume list,Lists all volumes. -list-filters,,List enabled filters. (Supported by API versions 3.33 - 3.latest) +list-filters,block storage resource filter list,List enabled filters. (Supported by API versions 3.33 - 3.latest) manage,volume create --remote-source k=v,Manage an existing volume. -manageable-list,,Lists all manageable volumes. (Supported by API versions 3.8 - 3.latest) +manageable-list,block storage volume manageable list,Lists all manageable volumes. (Supported by API versions 3.8 - 3.latest) message-delete,volume message delete,Removes one or more messages. (Supported by API versions 3.3 - 3.latest) message-list,volume message list,Lists all messages. (Supported by API versions 3.3 - 3.latest) message-show,volume message show,Shows message details. (Supported by API versions 3.3 - 3.latest) @@ -91,36 +91,36 @@ qos-show,volume qos show,Shows a specified qos specs. quota-class-show,quota show --class,Lists quotas for a quota class. quota-class-update,quota set --class,Updates quotas for a quota class. quota-defaults,quota show --default,Lists default quotas for a tenant. -quota-delete,,Delete the quotas for a tenant. +quota-delete,quota delete --volume,Delete the quotas for a tenant. quota-show,quota show,Lists quotas for a tenant. quota-update,quota set,Updates quotas for a tenant. -quota-usage,,Lists quota usage for a tenant. +quota-usage,quota show --usage,Lists quota usage for a tenant. rate-limits,limits show --rate,Lists rate limits for a user. readonly-mode-update,volume set --read-only-mode | --read-write-mode,Updates volume read-only access-mode flag. rename,volume set --name,Renames a volume. reset-state,volume set --state,Explicitly updates the volume state. retype,volume type set --type,Changes the volume type for a volume. -revert-to-snapshot,,Revert a volume to the specified snapshot. (Supported by API versions 3.40 - 3.latest) +revert-to-snapshot,volume revert,Revert a volume to the specified snapshot. (Supported by API versions 3.40 - 3.latest) service-disable,volume service set --disable,Disables the service. service-enable,volume service set --enable,Enables the service. -service-get-log,,(Supported by API versions 3.32 - 3.latest) +service-get-log,block storage log level list,(Supported by API versions 3.32 - 3.latest) service-list,volume service list,Lists all services. Filter by host and service binary. -service-set-log,,(Supported by API versions 3.32 - 3.latest) +service-set-log,block storage log level set,(Supported by API versions 3.32 - 3.latest) set-bootable,volume set --bootable / --not-bootable,Update bootable status of a volume. show,volume show,Shows volume details. -snapshot-create,snapshot create,Creates a snapshot. -snapshot-delete,snapshot delete,Remove one or more snapshots. -snapshot-list,snapshot list,Lists all snapshots. +snapshot-create,volume snapshot create,Creates a snapshot. +snapshot-delete,volume snapshot delete,Remove one or more snapshots. +snapshot-list,volume snapshot list,Lists all snapshots. snapshot-manage,volume snapshot create --remote-source ,Manage an existing snapshot. -snapshot-manageable-list,,Lists all manageable snapshots. (Supported by API versions 3.8 - 3.latest) -snapshot-metadata,snapshot set --property k=v / snapshot unset --property k,Sets or deletes snapshot metadata. -snapshot-metadata-show,snapshot show,Shows snapshot metadata. -snapshot-metadata-update-all,snapshot set --property k=v,Updates snapshot metadata. -snapshot-rename,snapshot set --name,Renames a snapshot. -snapshot-reset-state,snapshot set --state,Explicitly updates the snapshot state. -snapshot-show,snapshot show,Shows snapshot details. +snapshot-manageable-list,block storage snapshot manageable list,Lists all manageable snapshots. (Supported by API versions 3.8 - 3.latest) +snapshot-metadata,volume snapshot set --property k=v / snapshot unset --property k,Sets or deletes snapshot metadata. +snapshot-metadata-show,volume snapshot show,Shows snapshot metadata. +snapshot-metadata-update-all,volume snapshot set --property k=v,Updates snapshot metadata. +snapshot-rename,volume snapshot set --name,Renames a snapshot. +snapshot-reset-state,volume snapshot set --state,Explicitly updates the snapshot state. +snapshot-show,volume snapshot show,Shows snapshot details. snapshot-unmanage,volume snapshot delete --remote,Stop managing a snapshot. -summary,,Get volumes summary. (Supported by API versions 3.12 - 3.latest) +summary,volume summary,Get volumes summary. (Supported by API versions 3.12 - 3.latest) thaw-host,volume host set --enable,Thaw and enable the specified cinder-volume host. transfer-accept,volume transfer accept,Accepts a volume transfer. transfer-create,volume transfer create,Creates a volume transfer. @@ -139,8 +139,8 @@ type-show,volume type show,Show volume type details. type-update,volume type set,"Updates volume type name description and/or is_public." unmanage,volume delete --remote,Stop managing a volume. upload-to-image,image create --volume,Uploads volume to Image Service as an image. -version-list,,List all API versions. (Supported by API versions 3.0 - 3.latest) -work-cleanup,,Request cleanup of services with optional filtering. (Supported by API versions 3.24 - 3.latest) +version-list,versions show --service block-storage,List all API versions. (Supported by API versions 3.0 - 3.latest) +work-cleanup,block storage cleanup,Request cleanup of services with optional filtering. (Supported by API versions 3.24 - 3.latest) bash-completion,complete,Prints arguments for bash_completion. help,help,Shows help about this program or one of its subcommands. list-extensions,extension list --volume,Lists all available os-api extensions. diff --git a/doc/source/cli/data/glance.csv b/doc/source/cli/data/glance.csv index 27585b9510..b380886d6f 100644 --- a/doc/source/cli/data/glance.csv +++ b/doc/source/cli/data/glance.csv @@ -1,60 +1,67 @@ +cache-clear,cached image clear,"Clear all images from cache, queue or both." +cache-delete,cached image delete,Delete image from cache/caching queue. +cache-list,cached image list,Get cache state. +cache-queue,cached image queue,Queue image(s) for caching. explain,WONTFIX,Describe a specific model. image-create,image create,Create a new image. -image-create-via-import,,EXPERIMENTAL: Create a new image via image import. +image-create-via-import, image create --import,"EXPERIMENTAL: Create a new image via image import using glance-direct import method. Missing support for web-download, copy-image and glance-download import methods. The OSC command is also missing support for importing image to specified store as well as all stores (--store, --stores, --all-stores) and skip or stop processing if import fails to one of the store (--allow-failure)" image-deactivate,image set --deactivate,Deactivate specified image. image-delete,image delete,Delete specified image. image-download,image save,Download a specific image. -image-import,,Initiate the image import taskflow. +image-import,image import,Initiate the image import taskflow. image-list,image list,List images you can access. image-reactivate,image set --activate,Reactivate specified image. image-show,image show,Describe a specific image. -image-stage,,Upload data for a specific image to staging. +image-stage,image stage,Upload data for a specific image to staging. image-tag-delete,image unset --tag ,Delete the tag associated with the given image. image-tag-update,image set --tag ,Update an image with the given tag. +image-tasks,,Get tasks associated with image. image-update,image set,Update an existing image. image-upload,,Upload data for a specific image. -import-info,,Print import methods available from Glance. +import-info,image import info,Show available import methods from Glance. location-add,,Add a location (and related metadata) to an image. location-delete,,Remove locations (and related metadata) from an image. location-update,,Update metadata of an image's location. -md-namespace-create,,Create a new metadata definitions namespace. -md-namespace-delete,,Delete specified metadata definitions namespace with its contents. -md-namespace-import,,Import a metadata definitions namespace from file or standard input. -md-namespace-list,,List metadata definitions namespaces. -md-namespace-objects-delete,,Delete all metadata definitions objects inside a specific namespace. -md-namespace-properties-delete,,Delete all metadata definitions property inside a specific namespace. -md-namespace-resource-type-list,,List resource types associated to specific namespace. -md-namespace-show,,Describe a specific metadata definitions namespace. -md-namespace-tags-delete,,Delete all metadata definitions tags inside a specific namespace. +md-namespace-create,image metadef namespace create,Create a new metadata definitions namespace. +md-namespace-delete,image metadef namespace delete,Delete specified metadata definitions namespace with its contents. +md-namespace-import,WONTFIX,Import a metadata definitions namespace from file or standard input. +md-namespace-list,image metadef namespace list,List metadata definitions namespaces. +md-namespace-objects-delete,image metadef object delete,Delete all metadata definitions objects inside a specific namespace. +md-namespace-properties-delete,image metadef property delete,Delete all metadata definitions property inside a specific namespace. +md-namespace-resource-type-list,image metadef resource type association list,List resource types associated to specific namespace. +md-namespace-show,image metadef namespace show,Describe a specific metadata definitions namespace. +md-namespace-tags-delete,image metadef namespace unset --all,Delete all metadata definitions tags inside a specific namespace. md-namespace-update,,Update an existing metadata definitions namespace. -md-object-create,,Create a new metadata definitions object inside a namespace. -md-object-delete,,Delete a specific metadata definitions object inside a namespace. -md-object-list,,List metadata definitions objects inside a specific namespace. -md-object-property-show,,Describe a specific metadata definitions property inside an object. -md-object-show,,Describe a specific metadata definitions object inside a namespace. -md-object-update,,Update metadata definitions object inside a namespace. -md-property-create,,Create a new metadata definitions property inside a namespace. -md-property-delete,,Delete a specific metadata definitions property inside a namespace. -md-property-list,,List metadata definitions properties inside a specific namespace. -md-property-show,,Describe a specific metadata definitions property inside a namespace. -md-property-update,,Update metadata definitions property inside a namespace. -md-resource-type-associate,,Associate resource type with a metadata definitions namespace. -md-resource-type-deassociate,,Deassociate resource type with a metadata definitions namespace. -md-resource-type-list,,List available resource type names. -md-tag-create,,Add a new metadata definitions tag inside a namespace. -md-tag-create-multiple,,Create new metadata definitions tags inside a namespace. -md-tag-delete,,Delete a specific metadata definitions tag inside a namespace. -md-tag-list,,List metadata definitions tags inside a specific namespace. -md-tag-show,,Describe a specific metadata definitions tag inside a namespace. -md-tag-update,,Rename a metadata definitions tag inside a namespace. +md-object-create,image metadef object create,Create a new metadata definitions object inside a namespace. +md-object-show,image metadef object show,Describe a specific metadata definitions object inside a namespace. +md-object-list,image metadef object list,List metadata definitions objects inside a specific namespace. +md-object-delete,image metadef object delete,Delete a specific metadata definitions object inside a namespace. +md-object-property-show,image metadef object property show,Describe a specific metadata definitions property inside an object. +md-object-update,image metadef object update,Update metadata definitions object inside a namespace. +md-property-create,image metadef property create,Create a new metadata definitions property inside a namespace. +md-property-delete,image metadef property delete,Delete a specific metadata definitions property inside a namespace. +md-property-list,image metadef property list,List metadata definitions properties inside a specific namespace. +md-property-show,image metadef property show,Describe a specific metadata definitions property inside a namespace. +md-property-update,image metadef property set,Update metadata definitions property inside a namespace. +md-resource-type-associate,image metadef resource type association create,Associate resource type with a metadata definitions namespace. +md-resource-type-deassociate,image metadef resource type association delete,Deassociate resource type with a metadata definitions namespace. +md-resource-type-list,image metadef resource type list,List available resource type names. +md-tag-create,image metadef namespace set --tag,Add a new metadata definitions tag inside a namespace. +md-tag-create-multiple,image metadef namespace set --tag tag1 --tag tag2,Create new metadata definitions tags inside a namespace. +md-tag-delete,image metadef namespace unset --tag,Delete a specific metadata definitions tag inside a namespace. +md-tag-list,image metadef namespace show,List metadata definitions tags inside a specific namespace. +md-tag-show,image metadef namespace show,Describe a specific metadata definitions tag inside a namespace. +md-tag-update,image metadef namespace set --tag,Rename a metadata definitions tag inside a namespace. member-create,image add project,Create member for a given image. member-delete,image remove project,Delete image member. -member-list,,Describe sharing permissions by image. +member-get,image member get,Show details of an image member +member-list,image member list,Describe sharing permissions by image. member-update,image set --accept --reject --status,Update the status of a member for a given image. -stores-delete,,Delete image from specific store. +stores-delete,image delete --store,Delete image from specific store. stores-info,,Print available backends from Glance. -task-create,,Create a new task. -task-list,,List tasks you can access. -task-show,,Describe a specific task. +task-create,WONTFIX,Create a new task. +task-list,image task list,List tasks you can access. +task-show,image task show,Describe a specific task. +usage,,Get quota usage information. bash-completion,complete,Prints arguments for bash_completion. help,help,Display help about this program or one of its subcommands. diff --git a/doc/source/cli/data/keystone.csv b/doc/source/cli/data/keystone.csv index bcc305515f..2a7e7f5690 100644 --- a/doc/source/cli/data/keystone.csv +++ b/doc/source/cli/data/keystone.csv @@ -1,37 +1,37 @@ -catalog,catalog show,"List service catalog, possibly filtered by service." -ec2-credentials-create,ec2 credentials create,Create EC2-compatible credentials for user per tenant. -ec2-credentials-delete,ec2 credentials delete,Delete EC2-compatible credentials. -ec2-credentials-get,ec2 credentials show,Display EC2-compatible credentials. -ec2-credentials-list,ec2 credentials list,List EC2-compatible credentials for a user. -endpoint-create,endpoint create,Create a new endpoint associated with a service. -endpoint-delete,endpoint delete,Delete a service endpoint. -endpoint-get,endpoint get,Find endpoint filtered by a specific attribute or service type. -endpoint-list,endpoint list,List configured service endpoints. -password-update,user password set,Update own password. -role-create,role create,Create new role. -role-delete,role delete,Delete role. -role-get,role show,Display role details. -role-list,role list,List all roles. -service-create,service create,Add service to Service Catalog. -service-delete,service delete,Delete service from Service Catalog. -service-get,service show,Display service from Service Catalog. -service-list,service list,List all services in Service Catalog. -tenant-create,project create,Create new tenant. -tenant-delete,project delete,Delete tenant. -tenant-get,project show,Display tenant details. -tenant-list,project list,List all tenants. -tenant-update,project set,"Update tenant name, description, enabled status." -token-get,token issue,Display the current user token. -user-create,user create,Create new user. -user-delete,user delete,Delete user. -user-get,user show,Display user details. -user-list,user list,List users. -user-password-update,user set --password,Update user password. -user-role-add,role add --user --project,Add role to user. -user-role-list,role assignment list --user --project,List roles granted to a user. -user-role-remove,role remove --user --project,Remove role from user. -user-update,user set,"Update user's name, email, and enabled status." -discover,WONTFIX,"Discover Keystone servers, supported API versions and extensions." -bootstrap,WONTFIX,"Grants a new role to a new user on a new tenant, after creating each." -bash-completion,complete,Prints all of the commands and options to stdout. -help,help,Display help about this program or one of its subcommands. +catalog,catalog show,"List service catalog, possibly filtered by service." +ec2-credentials-create,ec2 credentials create,Create EC2-compatible credentials for user per tenant. +ec2-credentials-delete,ec2 credentials delete,Delete EC2-compatible credentials. +ec2-credentials-get,ec2 credentials show,Display EC2-compatible credentials. +ec2-credentials-list,ec2 credentials list,List EC2-compatible credentials for a user. +endpoint-create,endpoint create,Create a new endpoint associated with a service. +endpoint-delete,endpoint delete,Delete a service endpoint. +endpoint-get,endpoint get,Find endpoint filtered by a specific attribute or service type. +endpoint-list,endpoint list,List configured service endpoints. +password-update,user password set,Update own password. +role-create,role create,Create new role. +role-delete,role delete,Delete role. +role-get,role show,Display role details. +role-list,role list,List all roles. +service-create,service create,Add service to Service Catalog. +service-delete,service delete,Delete service from Service Catalog. +service-get,service show,Display service from Service Catalog. +service-list,service list,List all services in Service Catalog. +tenant-create,project create,Create new tenant. +tenant-delete,project delete,Delete tenant. +tenant-get,project show,Display tenant details. +tenant-list,project list,List all tenants. +tenant-update,project set,"Update tenant name, description, enabled status." +token-get,token issue,Display the current user token. +user-create,user create,Create new user. +user-delete,user delete,Delete user. +user-get,user show,Display user details. +user-list,user list,List users. +user-password-update,user set --password,Update user password. +user-role-add,role add --user --project,Add role to user. +user-role-list,role assignment list --user --project,List roles granted to a user. +user-role-remove,role remove --user --project,Remove role from user. +user-update,user set,"Update user's name, email, and enabled status." +discover,WONTFIX,"Discover Keystone servers, supported API versions and extensions." +bootstrap,WONTFIX,"Grants a new role to a new user on a new tenant, after creating each." +bash-completion,complete,Prints all of the commands and options to stdout. +help,help,Display help about this program or one of its subcommands. diff --git a/doc/source/cli/data/neutron.csv b/doc/source/cli/data/neutron.csv index 402f4064ee..2399ed825f 100644 --- a/doc/source/cli/data/neutron.csv +++ b/doc/source/cli/data/neutron.csv @@ -188,7 +188,7 @@ qos-policy-list,network qos policy list,List QoS policies that belong to a given qos-policy-show,network qos policy show,Show information of a given qos policy. qos-policy-update,network qos policy set,Update a given qos policy. quota-default-show,quota show --default,Show default quotas for a given tenant. -quota-delete,,Delete defined quotas of a given tenant. +quota-delete,quota delete --network,Delete defined quotas of a given tenant. quota-list,quota list,List quotas of all tenants who have non-default quota values. quota-show,quota show,Show quotas for a given tenant. quota-update,quota set,Define tenant's quotas not to use defaults. @@ -230,7 +230,7 @@ subnetpool-show,subnet pool show,Show information of a given subnetpool. subnetpool-update,subnet pool set / subnet pool unset,Update subnetpool's information. tag-add,network set --tag,Add a tag into the resource. tag-remove,network unset --tag,Remove a tag on the resource. -tag-replace,,Replace all tags on the resource. +tag-replace,network set --no-tag --tag,Replace all tags on the resource. vpn-endpoint-group-create,,Create a VPN endpoint group. vpn-endpoint-group-delete,,Delete a given VPN endpoint group. vpn-endpoint-group-list,,List VPN endpoint groups that belong to a given tenant. diff --git a/doc/source/cli/data/nova.csv b/doc/source/cli/data/nova.csv index 0ab2b2fee4..ff691a5193 100644 --- a/doc/source/cli/data/nova.csv +++ b/doc/source/cli/data/nova.csv @@ -4,7 +4,7 @@ agent-delete,compute agent delete,Delete existing agent build. agent-list,compute agent list,List all builds. agent-modify,compute agent set,Modify existing agent build. aggregate-add-host,aggregate add host,Add the host to the specified aggregate. -aggregate-cache-images,,Request images be cached. (Supported by API versions '2.81' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version] +aggregate-cache-images,aggregate cache image,Request images be cached. (Supported by API versions '2.81' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version] aggregate-create,aggregate create,Create a new aggregate with the specified details. aggregate-delete,aggregate delete,Delete the aggregate. aggregate-list,aggregate list,Print a list of all aggregates. @@ -36,19 +36,19 @@ get-rdp-console,console url show --rdp,Get a rdp console to a server. get-serial-console,console url show --serial,Get a serial console to a server. get-spice-console,console url show --spice,Get a spice console to a server. get-vnc-console,console url show --novnc,Get a vnc console to a server. -host-evacuate,,Evacuate all instances from failed host. -host-evacuate-live,,Live migrate all instances off the specified host to other available hosts. -host-meta,,Set or Delete metadata on all instances of a host. -host-servers-migrate,,Cold migrate all instances off the specified host to other available hosts. +host-evacuate,WONTFIX,Evacuate all instances from failed host. +host-evacuate-live,WONTFIX,Live migrate all instances off the specified host to other available hosts. +host-meta,WONTFIX,Set or Delete metadata on all instances of a host. +host-servers-migrate,WONTFIX,Cold migrate all instances off the specified host to other available hosts. hypervisor-list,hypervisor list,List hypervisors. (Supported by API versions '2.0' - '2.latest') -hypervisor-servers,,List servers belonging to specific hypervisors. +hypervisor-servers,server list --host,List servers belonging to specific hypervisors. hypervisor-show,hypervisor show,Display the details of the specified hypervisor. hypervisor-stats,hypervisor stats show,Get hypervisor statistics over all compute nodes. -hypervisor-uptime,,Display the uptime of the specified hypervisor. +hypervisor-uptime,hypervisor show,Display the uptime of the specified hypervisor. image-create,server image create,Create a new image by taking a snapshot of a running server. instance-action,server event show,Show an action. -instance-action-list,,List actions on a server. -instance-usage-audit-log,,List/Get server usage audits. +instance-action-list,server event list,List actions on a server. +instance-usage-audit-log,WONTFIX,List/Get server usage audits. interface-attach,server add port / server add floating ip / server add fixed ip,Attach a network interface to a server. interface-detach,server remove port,Detach a network interface from a server. interface-list,port list --server,List interfaces attached to a server. @@ -65,12 +65,12 @@ live-migration-force-comp,server migration force complete,Force on-going live mi lock,server lock,Lock a server. meta,server set --property / unset,Set or delete metadata on a server. migrate,server migrate,Migrate a server. The new host will be selected by the scheduler. -migration-list,,Print a list of migrations. +migration-list,server migration list,Print a list of migrations. pause,server pause,Pause a server. quota-class-show,quota show --class,List the quotas for a quota class. quota-class-update,quota set --class,Update the quotas for a quota class. quota-defaults,quota list,List the default quotas for a tenant. -quota-delete,quota set,Delete quota for a tenant/user so their quota will Revert back to default. +quota-delete,quota delete --compute,Delete quota for a tenant/user so their quota will Revert back to default. quota-show,quota show,List the quotas for a tenant/user. quota-update,quota set,Update the quotas for a tenant/user. reboot,server reboot,Reboot a server. @@ -118,10 +118,10 @@ unshelve,server unshelve,Unshelve a server. update,server set / unset,Update the name or the description for a server. usage,usage show,Show usage data for a single tenant. usage-list,usage list,List usage data for all tenants. -version-list,,List all API versions. +version-list,versions show --service compute,List all API versions. volume-attach,server add volume,Attach a volume to a server. -volume-attachments,server show,List all the volumes attached to a server. +volume-attachments,server volume list,List all the volumes attached to a server. volume-detach,server remove volume,Detach a volume from a server. -volume-update,,Update volume attachment. +volume-update,server volume update,Update volume attachment. bash-completion,complete,Prints all of the commands and options to stdout so that the nova.bash_completion script doesn't have to hard code them. help,help,Display help about this program or one of its subcommands. diff --git a/doc/source/cli/data/swift.csv b/doc/source/cli/data/swift.csv index 681474125b..87d781e271 100644 --- a/doc/source/cli/data/swift.csv +++ b/doc/source/cli/data/swift.csv @@ -1,10 +1,10 @@ -delete,object delete / container delete,Delete a container or objects within a container. -download,object save / container save,Download objects from containers. -list,object list / container list,Lists the containers for the account or the objects for a container. -post,container create / object set / container set / object store account set,"Updates meta information for the account, container, or object." -copy,,"Copies object, optionally adds meta." -stat,object show / container show / object store account show,"Displays information for the account, container, or object." -upload,object create,Uploads files or directories to the given container. -capabilities,,List cluster capabilities. -tempurl,,Create a temporary URL. -auth,WONTFIX,Display auth related environment variables. +delete,object delete / container delete,Delete a container or objects within a container. +download,object save / container save,Download objects from containers. +list,object list / container list,Lists the containers for the account or the objects for a container. +post,container create / object set / container set / object store account set,"Updates meta information for the account, container, or object." +copy,,"Copies object, optionally adds meta." +stat,object show / container show / object store account show,"Displays information for the account, container, or object." +upload,object create,Uploads files or directories to the given container. +capabilities,,List cluster capabilities. +tempurl,,Create a temporary URL. +auth,WONTFIX,Display auth related environment variables. diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 9cb3b33a73..17e50a07d2 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -13,12 +13,3 @@ interactive decoder backwards-incompatible - -.. NOTE(efried): Everything must be in a toctree but we don't want these to - show up to the reader. - -.. toctree:: - :glob: - :hidden: - - _hidden/* diff --git a/doc/source/cli/man/openstack.rst b/doc/source/cli/man/openstack.rst index dc327a66e8..8f7124dd6d 100644 --- a/doc/source/cli/man/openstack.rst +++ b/doc/source/cli/man/openstack.rst @@ -49,7 +49,7 @@ command line. The primary difference is the use of 'project' in the name of the Refer to the keystoneclient library documentation for more details about these plugins and their options, and for a complete list of available plugins. Please bear in mind that some plugins might not support all of the functionalities of :program:`openstack`; for example the v3unscopedsaml plugin can deliver only unscoped tokens, some commands might not be available through this authentication method. -Additionally, it is possible to use Keystone's service token to authenticate, by setting the options :option:`--os-token` and :option:`--os-url` (or the environment variables :envvar:`OS_TOKEN` and :envvar:`OS_URL` respectively). This method takes precedence over authentication plugins. +Additionally, it is possible to use Keystone's service token to authenticate, by setting the options :option:`--os-token` and :option:`--os-endpoint` (or the environment variables :envvar:`OS_TOKEN` and :envvar:`OS_ENDPOINT` respectively). This method takes precedence over authentication plugins. .. NOTE:: To use the ``v3unscopedsaml`` method, the lxml package will need to be installed. @@ -106,9 +106,9 @@ OPTIONS Authentication URL -.. option:: --os-url +.. option:: --os-endpoint - Service URL, when using a service token for authentication + Service ENDPOINT, when using a service token for authentication .. option:: --os-domain-name @@ -349,7 +349,7 @@ file, but if those are incomplete it may be impossible to know which auth type is intended. The :option:`--os-auth-type` option can always be used to force a specific type. -When :option:`--os-token` and :option:`--os-url` are both present the +When :option:`--os-token` and :option:`--os-endpoint` are both present the ``token_endpoint`` auth type is selected automatically. If :option:`--os-auth-url` and :option:`--os-username` are present ``password`` auth type is selected. @@ -466,9 +466,9 @@ The following environment variables can be set to alter the behaviour of :progra - ``v3applicationcredential`` - ``v3multifactor`` -.. envvar:: OS_URL +.. envvar:: OS_ENDPOINT - Service URL (when using the service token) + Service ENDPOINT (when using the service token) .. envvar:: OS_DOMAIN_NAME @@ -593,8 +593,8 @@ The following environment variables can be set to alter the behaviour of :progra BUGS ==== -Bug reports are accepted at the python-openstackclient StoryBoard project -"https://storyboard.openstack.org/#!/project/975". +Bug reports are accepted at the python-openstackclient Launchpad project +"https://bugs.launchpad.net/python-openstackclient". AUTHORS diff --git a/doc/source/cli/plugin-commands/aodh.rst b/doc/source/cli/plugin-commands/aodh.rst new file mode 100644 index 0000000000..5d8b4332cf --- /dev/null +++ b/doc/source/cli/plugin-commands/aodh.rst @@ -0,0 +1,4 @@ +aodh +---- + +.. autoprogram-cliff:: openstack.alarming.v2 diff --git a/doc/source/cli/plugin-commands/cyborg.rst b/doc/source/cli/plugin-commands/cyborg.rst new file mode 100644 index 0000000000..aedaa6b53d --- /dev/null +++ b/doc/source/cli/plugin-commands/cyborg.rst @@ -0,0 +1,4 @@ +cyborg +------ + +.. autoprogram-cliff:: openstack.accelerator.v2 diff --git a/doc/source/cli/plugin-commands/index.rst b/doc/source/cli/plugin-commands/index.rst index 638dcbe560..2622ee58b3 100644 --- a/doc/source/cli/plugin-commands/index.rst +++ b/doc/source/cli/plugin-commands/index.rst @@ -7,42 +7,21 @@ Plugin Commands .. toctree:: :maxdepth: 1 + aodh barbican + cyborg designate gnocchi heat ironic ironic-inspector + magnum manila mistral neutron octavia placement - rsd - sahara - senlin trove watcher zaqar zun - -.. TODO(efried): Make pages for the following once they're fixed. - -.. aodh -.. # aodhclient docs build is failing with recent pyparsing -.. # autoprogram-cliff:: openstack.alarming.v2 - -.. cue -.. # cueclient is not in global-requirements -.. # list-plugins:: openstack.mb.v1 -.. # :detailed: - -.. murano -.. # the murano docs cause warnings and a broken docs build -.. # .. list-plugins:: openstack.application_catalog.v1 -.. # :detailed: - -.. tripleo -.. # tripleoclient is not in global-requirements -.. # list-plugins:: openstack.tripleoclient.v1 -.. # :detailed: diff --git a/doc/source/cli/plugin-commands/magnum.rst b/doc/source/cli/plugin-commands/magnum.rst new file mode 100644 index 0000000000..9b3f9f7e8a --- /dev/null +++ b/doc/source/cli/plugin-commands/magnum.rst @@ -0,0 +1,4 @@ +magnum +------ + +.. autoprogram-cliff:: openstack.container_infra.v1 diff --git a/doc/source/cli/plugin-commands/rsd.rst b/doc/source/cli/plugin-commands/rsd.rst deleted file mode 100644 index d28cea316f..0000000000 --- a/doc/source/cli/plugin-commands/rsd.rst +++ /dev/null @@ -1,4 +0,0 @@ -rsd ---- - -.. autoprogram-cliff:: openstack.rsd.v2 diff --git a/doc/source/cli/plugin-commands/sahara.rst b/doc/source/cli/plugin-commands/sahara.rst deleted file mode 100644 index 7c51756a3a..0000000000 --- a/doc/source/cli/plugin-commands/sahara.rst +++ /dev/null @@ -1,4 +0,0 @@ -sahara ------- - -.. autoprogram-cliff:: openstack.data_processing.v1 diff --git a/doc/source/cli/plugin-commands/senlin.rst b/doc/source/cli/plugin-commands/senlin.rst deleted file mode 100644 index 90929058f8..0000000000 --- a/doc/source/cli/plugin-commands/senlin.rst +++ /dev/null @@ -1,4 +0,0 @@ -senlin ------- - -.. autoprogram-cliff:: openstack.clustering.v1 diff --git a/doc/source/conf.py b/doc/source/conf.py index 4b60ce4a5d..6ee3145558 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # # OpenStack Command Line Client documentation build configuration file, created # by sphinx-quickstart on Wed May 16 12:05:58 2012. @@ -15,22 +14,22 @@ # -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.todo', - 'openstackdocstheme', - 'stevedore.sphinxext', - 'cliff.sphinxext', - 'sphinxcontrib.apidoc', - ] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.todo', + 'openstackdocstheme', + 'stevedore.sphinxext', + 'cliff.sphinxext', + 'sphinxcontrib.apidoc', +] # openstackdocstheme options openstackdocs_repo_name = 'openstack/python-openstackclient' -openstackdocs_use_storyboard = True openstackdocs_auto_name = False # Add project 'foo' to this list to enable the :foo-doc: role @@ -39,30 +38,30 @@ ] # Add any paths that contain templates here, relative to this directory. -#templates_path = ['_templates'] +# templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. -project = u'OpenStack Command Line Client' -copyright = u'2012-2013 OpenStack Foundation' +project = 'OpenStack Command Line Client' +copyright = '2012-2013 OpenStack Foundation' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -70,18 +69,18 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'native' @@ -94,75 +93,75 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -#html_theme_path = ["."] -#html_theme = '_theme' +# html_theme_path = ["."] +# html_theme = '_theme' html_theme = 'openstackdocs' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['_static'] +# html_static_path = ['_static'] # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'OpenStackCommandLineClientdoc' @@ -174,44 +173,46 @@ # -- Options for LaTeX output ------------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]) # . latex_documents = [ - ('index', 'OpenStackCommandLineClient.tex', - u'OpenStack Command Line Client Documentation', - u'OpenStack', 'manual'), + ( + 'index', + 'OpenStackCommandLineClient.tex', + 'OpenStack Command Line Client Documentation', + 'OpenStack', + 'manual', + ), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output ------------------------------------------- @@ -222,14 +223,14 @@ ( 'cli/man/openstack', 'openstack', - u'OpenStack Command Line Client', - [u'OpenStack contributors'], + 'OpenStack Command Line Client', + ['OpenStack contributors'], 1, ), ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ----------------------------------------------- @@ -238,21 +239,25 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'OpenStackCommandLineClient', - u'OpenStack Command Line Client Documentation', - u'OpenStack', 'OpenStackCommandLineClient', - 'One line description of project.', - 'Miscellaneous'), + ( + 'index', + 'OpenStackCommandLineClient', + 'OpenStack Command Line Client Documentation', + 'OpenStack', + 'OpenStackCommandLineClient', + 'One line description of project.', + 'Miscellaneous', + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # -- Options for cliff.sphinxext plugin --------------------------------------- @@ -260,8 +265,16 @@ autoprogram_cliff_application = 'openstack' autoprogram_cliff_ignored = [ - '--help', '--format', '--column', '--max-width', '--fit-width', - '--print-empty', '--prefix', '--noindent', '--quote'] + '--help', + '--format', + '--column', + '--max-width', + '--fit-width', + '--print-empty', + '--prefix', + '--noindent', + '--quote', +] # Prevent cliff from generating "This command is provided by the # python-openstackclient plugin." diff --git a/doc/source/contributor/command-errors.rst b/doc/source/contributor/command-errors.rst index c4adb7d190..81bd8fa447 100644 --- a/doc/source/contributor/command-errors.rst +++ b/doc/source/contributor/command-errors.rst @@ -29,8 +29,9 @@ Example This example is taken from ``keypair create`` where the ``--public-key`` option specifies a file containing the public key to upload. If the file is not found, -the IOError exception is trapped and a more specific CommandError exception is -raised that includes the name of the file that was attempted to be opened. +the ``IOError`` exception is trapped and a more specific ``CommandError`` +exception is raised that includes the name of the file that was attempted to be +opened. .. code-block:: python @@ -45,7 +46,7 @@ raised that includes the name of the file that was attempted to be opened. public_key = parsed_args.public_key if public_key: try: - with io.open( + with open( os.path.expanduser(parsed_args.public_key), "rb" ) as p: @@ -56,8 +57,8 @@ raised that includes the name of the file that was attempted to be opened. msg % (parsed_args.public_key, e), ) - keypair = compute_client.keypairs.create( - parsed_args.name, + keypair = compute_client.create_keypair( + name=parsed_args.name, public_key=public_key, ) @@ -171,10 +172,11 @@ multiple ``delete_network()`` calls. .. code-block:: python - class DeleteNetwork(common.NetworkAndComputeCommand): + class DeleteNetwork(common.NetworkDelete): """Delete network(s)""" - def update_parser_common(self, parser): + def get_parser(self, prog_name): + parser = super().get_parser(prog_name) parser.add_argument( 'network', metavar="", @@ -183,20 +185,7 @@ multiple ``delete_network()`` calls. ) return parser - def take_action(self, client, parsed_args): - ret = 0 - - for network in parsed_args.network: - try: - obj = client.find_network(network, ignore_missing=False) - client.delete_network(obj) - except Exception: - LOG.error(_("Failed to delete network with name " - "or ID %s."), network) - ret += 1 - - if ret > 0: - total = len(parsed_args.network) - msg = (_("Failed to delete %(ret)s of %(total)s networks.") - % {"ret": ret, "total": total}) - raise exceptions.CommandError(msg) + def take_action_delete(self, parsed_args): + client = self.app.client_manager.network + obj = client.find_network(network, ignore_missing=False) + client.delete_network(obj) diff --git a/doc/source/contributor/humaninterfaceguide.rst b/doc/source/contributor/humaninterfaceguide.rst index a7db380053..db6d7987b9 100644 --- a/doc/source/contributor/humaninterfaceguide.rst +++ b/doc/source/contributor/humaninterfaceguide.rst @@ -117,14 +117,14 @@ interface to the user, not the user to the interface. Commands should be discoverable via the interface itself. -To determine a list of available commands, use the :code:`-h` or -:code:`--help` options: +To determine a list of available commands, use the ``-h`` or +``--help`` options: .. code-block:: bash $ openstack --help -For help with an individual command, use the :code:`help` command: +For help with an individual command, use the ``help`` command: .. code-block:: bash @@ -167,7 +167,7 @@ Command Structure OpenStackClient has a consistent and predictable format for all of its commands. -* The top level command name is :code:`openstack` +* The top level command name is ``openstack`` * Sub-commands take the form: .. code-block:: bash @@ -185,6 +185,21 @@ Output formats: * user-friendly tables with headers, etc * machine-parsable delimited +.. note:: + + A note on terminology. An **argument** is a positional parameter to the + command. As discussed later, these should be used sparingly in + OpenStackClient. An **option** - also known as a **flag** - is a named + parameter denoted with either a hyphen and a single-letter name (``-r``) or + a double hyphen and a multiple-letter name (``--recursive``). They may or + may not also include a user-specified value (``--file foo.txt`` or + ``--file=foo.txt``). + + For more information on this topic and CLIs in general, refer to the + excellent `Command Line Interface Guidelines website`__. + + .. __: https://clig.dev/#arguments-and-flags + Global Options ~~~~~~~~~~~~~~ @@ -193,84 +208,151 @@ invocation regardless of action to be performed. They include authentication credentials and API version selection. Most global options have a corresponding environment variable that may also be used to set the value. If both are present, the command-line option takes priority. The environment variable names are derived -from the option name by dropping the leading dashes ('--'), converting each embedded -dash ('-') to an underscore ('_'), and converting to upper case. +from the option name by dropping the leading dashes (``--``), converting each embedded +dash (``-``) to an underscore (``_``), and converting to upper case. * Global options shall always have a long option name, certain common options may also have short names. Short names should be reserved for global options to limit the potential for duplication and multiple meanings between commands given the limited set of available short names. -* All long options names shall begin with two dashes ('--') and use a single dash - ('-') internally between words (:code:`--like-this`). Underscores ('_') shall not + +* All long options names shall begin with two dashes (``--``) and use a single dash + (``-``) internally between words (``--like-this``). Underscores (``_``) shall not be used in option names. + * Authentication options conform to the common CLI authentication guidelines in :ref:`authentication`. -For example, :code:`--os-username` can be set from the environment via -:code:`OS_USERNAME`. +For example, ``--os-username`` can be set from the environment via +``OS_USERNAME``. ---help -++++++ +``--help`` +++++++++++ -The standard :code:`--help` global option displays the documentation for invoking +The standard ``--help`` global option displays the documentation for invoking the program and a list of the available commands on standard output. All other options and commands are ignored when this is present. The traditional short -form help option (:code:`-h`) is also available. +form help option (``-h``) is also available. ---version -+++++++++ +``--version`` ++++++++++++++ -The standard :code:`--version` option displays the name and version on standard +The standard ``--version`` option displays the name and version on standard output. All other options and commands are ignored when this is present. -Command Object(s) and Action -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Objects and Actions +~~~~~~~~~~~~~~~~~~~ -Commands consist of an object described by one or more words followed by an action. Commands that require two objects have the primary object ahead of the action and the secondary object after the action. Any positional arguments identifying the objects shall appear in the same order as the objects. In badly formed English it is expressed as "(Take) object1 (and perform) action (using) object2 (to it)." +Commands consist of an object, described by one or more words, followed by an +action. :: - [] + -Examples: +For example: -* :code:`group add user ` -* :code:`volume type list` # Note that :code:`volume type` is a two-word - single object +* ``group create`` +* ``server set`` +* ``volume type list`` -The :code:`help` command is unique as it appears in front of a normal command -and displays the help text for that command rather than execute it. +(note that ``volume type`` is a two-word single object) + +Some commands require two objects. These commands have the primary object ahead of the +action and the secondary object after the action. In badly formed English it is +expressed as "(Take) object-1 (and perform) action (using) object-2 (to it)." :: + + + +For example: + +* ``group add user`` +* ``aggregate add host`` +* ``image remove project`` Object names are always specified in command in their singular form. This is contrary to natural language use. -Command Arguments and Options -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +``help`` +++++++++ + +The ``help`` command is unique as it appears in front of a normal command +and displays the help text for that command rather than execute it. + +Arguments +~~~~~~~~~ + +Commands that interact with a specific instance of an object should accept a +single argument. This argument should be a name or identifier for the object. +:: + + [] + +For example: + +* ``group create `` +* ``server set `` + +(note that ``volume type`` is a two-word single object) + +For commands that require two objects, the commands should accept two +arguments when interacting with specific instances of the two objects. These +arguments should appear in the same order as the objects. :: + + [ ] + +For example: + +* ``group add user `` +* ``aggregate add host `` +* ``image remove project `` + +Options +~~~~~~~ Each command may have its own set of options distinct from the global options. They follow the same style as the global options and always appear between -the command and any positional arguments the command requires. +the command and any arguments the command requires. -Command options shall only have long names. The small range of available -short names makes it hard for a single short option name to have a consistent -meaning across multiple commands. +Command options should only have long names. The small range of available short +names makes it hard for a single short option name to have a consistent meaning +across multiple commands. Option Forms ++++++++++++ -* **boolean**: boolean options shall use a form of :code:`--|--` - (preferred) or :code:`--