openstack/python-openstackclient
Code Issues Proposed changes
713d92df4e
python-openstackclient/doc/source/plugin-commands.rst

85 lines
1.6 KiB
ReStructuredText
Raw Normal View History

autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
=================
Plugin Commands
=================
update heat object and command doc Many OpenStack client heat command patches are in progress, seems like good time to also update some of the highlevel doc. Added new objects for orchestration and software openstack orchestration resource type list/show openstack software config create/delete/show/list Added new action for restore openstack stack snapshot create/delete/list/show/restore Added link to CLI reference for complete plugin syntax and details Removed deprecated tasker client Change-Id: I2c94a5981954edcba95f364a0f909c799f1c403b Blueprint: heat-support-python-openstackclient
2015-12-10 15:14:01 -06:00
Note: To see the complete syntax for the plugin commands, see the `CLI_Ref`_
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
.. list-plugins:: openstack.cli.extension
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# aodh
.. list-plugins:: openstack.alarming.v2
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# barbican
.. list-plugins:: openstack.key_manager.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# congress
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
.. list-plugins:: openstack.congressclient.v1
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# cue
.. # cueclient is not in global-requirements
.. # list-plugins:: openstack.mb.v1
.. # :detailed:
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# designate
.. list-plugins:: openstack.dns.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# gnocchi
.. # gnocchiclient is not in global-requirements
.. # list-plugins:: openstack.metric.v1
.. # :detailed:
# heat
.. list-plugins:: openstack.orchestration.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# ironic
.. list-plugins:: openstack.baremetal.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# ironic-inspector
.. list-plugins:: openstack.baremetal_introspection.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# mistral
.. list-plugins:: openstack.workflow_engine.v2
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
update heat object and command doc Many OpenStack client heat command patches are in progress, seems like good time to also update some of the highlevel doc. Added new objects for orchestration and software openstack orchestration resource type list/show openstack software config create/delete/show/list Added new action for restore openstack stack snapshot create/delete/list/show/restore Added link to CLI reference for complete plugin syntax and details Removed deprecated tasker client Change-Id: I2c94a5981954edcba95f364a0f909c799f1c403b Blueprint: heat-support-python-openstackclient
2015-12-10 15:14:01 -06:00
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# murano
.. list-plugins:: openstack.application_catalog.v1
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
:detailed:
Add python-neutronclient to OSC plugins Neutron is transitioning its CLI to OSC. Some CLIs will reside within python-openstackclient while others will be OSC plugins within python-neutronclient. Depends-On: I9a20bc7a3d8aa7b631fb0fd534fc5705c23326ce Change-Id: I2d8d369739d1df1597201368dd2158e07c8d2baf Related-Bug: #1521291
2016-04-22 12:30:19 -05:00
# neutron
.. list-plugins:: openstack.neutronclient.v2
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# sahara
.. list-plugins:: openstack.data_processing.v1
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# searchlight
.. list-plugins:: openstack.search.v1
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# senlin
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
.. list-plugins:: openstack.clustering.v1
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# tripleo
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
.. # tripleoclient is not in global-requirements
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. # list-plugins:: openstack.tripleoclient.v1
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
.. # :detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
# watcher
.. # watcherclient is not in global-requirements
.. # list-plugins:: openstack.infra_optim.v1
.. # :detailed:
# zaqar
.. list-plugins:: openstack.messaging.v1
:detailed:
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
update heat object and command doc Many OpenStack client heat command patches are in progress, seems like good time to also update some of the highlevel doc. Added new objects for orchestration and software openstack orchestration resource type list/show openstack software config create/delete/show/list Added new action for restore openstack stack snapshot create/delete/list/show/restore Added link to CLI reference for complete plugin syntax and details Removed deprecated tasker client Change-Id: I2c94a5981954edcba95f364a0f909c799f1c403b Blueprint: heat-support-python-openstackclient
2015-12-10 15:14:01 -06:00
.. _CLI_Ref: http://docs.openstack.org/cli-reference/openstack.html
Copy Permalink