summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: Patch acceptance policy after neutron CLI deprecationAkihiro Motoki2017-02-241-0/+7
| | | | | | | | | | | Neutron CLI itself is now deprecated. It means a kind of feature freeze and we don't accept any changes on adding/changing/dropping the existing commands. The only exception is bug fixes on the deprecated neutron CLI. It is better to document our policy on neutron CLI chnages. Change-Id: I5f063c7eddbc9a91f587d5d3610092d07150f726
* doc: Fix warningAkihiro Motoki2017-02-241-2/+2
| | | | | | | tox -e docs fails with sphinx warning. This fixes a warning "WARNING: Title underline too short" Change-Id: I7259e5f0df42aa8434443cf742932b0843f019e2
* Add BGP VPN OSC commandsÉdouard Thuleau2017-02-091-0/+383
| | | | | Change-Id: Ib1ba356e994a98712e00a11ff045df67fbe4c7ea Closes-Bug: #1650204
* Merge "Add documentation for FWaaS v2 OSC plugin commands"Jenkins2017-01-133-0/+808
|\
| * Add documentation for FWaaS v2 OSC plugin commandsYushiro FURUKAWA2017-01-063-0/+808
| | | | | | | | | | | | | | | | | | This commit adds a Firewall-as-a-Service v2[1] CLI usage. [1]http://specs.openstack.org/openstack/neutron-specs/specs/newton/fwaas-api-2.0.html Change-Id: Ib271acad29229d78beebc2f1c2bd285c630768df Partial-Implements: blueprint fwaas-api-2.0 Related-Bug: #1609686
* | Replace 'os' to 'openstack' for all command exampleYushiro FURUKAWA2017-01-071-7/+7
|/ | | | | | Trivial-fix Change-Id: I670dd1240328859d5f10bb4d4ef878f1c8a0ed69
* Clarify how to do client-side development for repos in neutron governanceArmando Migliaccio2016-12-061-18/+19
| | | | Change-Id: I90085b47b2e960fbd75e936fb3ee5c0553b0a8e2
* Devref: Transition to OSC updateRichard Theis2016-11-071-11/+13
| | | | | | | Devref update for the transition to OSC. Change-Id: Iff65be64d7225565ba33aebc8f9949c6d4ea509e Partial-Bug: 1521291
* Merge "Make trunk commands handle description for trunk resources"Jenkins2016-09-011-0/+10
|\
| * Make trunk commands handle description for trunk resourcesArmando Migliaccio2016-08-291-0/+10
| | | | | | | | | | | | | | Depends-on: Ie3149e206fe8a83631dd9d42d344fea3f03dc0db Partially-implements: blueprint vlan-aware-vms Change-Id: Ie721beb78a4a3b6da9e0f68167b91be043b7034e
* | Devref: Newton mid-cycle updates for transition to OSCRichard Theis2016-08-301-21/+38
|/ | | | | | | | | | Update the "Transition to OpenStack Client" devref based on Newton mid-cycle [1]. [1] https://etherpad.openstack.org/p/newton-neutron-midcycle-workitems Change-Id: Ie1b4eec30cbee5d41971450b676f7c898a667f0b Related-Bug: #1521291
* Merge "Update docs to use Identity v3"Jenkins2016-08-182-11/+48
|\
| * Update docs to use Identity v3Clenimar Filemon2016-08-092-11/+48
| | | | | | | | | | | | | | | | The docs currently show deprecated forms of client creation. Update them to use keystoneauth Session and Identity v3. Change-Id: I3ec285e9b02db870276bae6a9b7e1278e5d306f6 Closes-Bug: #1566448
* | Merge "Update OSC transition status"Jenkins2016-08-111-6/+6
|\ \
| * | Update OSC transition statusRichard Theis2016-08-101-6/+6
| |/ | | | | | | | | | | Update the OSC transition devref with the latest status. Change-Id: I6f9956975e70cc38544eb97191fa626772605ff1
* | Add documentation for OSC plugin commandsAbhishek Raut2016-07-303-0/+205
|/ | | | | | | | | This patch adds a new path under neutronclient docs to document the newly added OSC commands. All new CLI commands added via the openstack client plugin must now provide a user guide to these commands under doc/source/usage/osc/v2 Change-Id: Id16d2fb0712fe6dd4a45a765bf7b65410302f5b8
* Trivial: missing comma in the docsClenimar Filemon2016-07-011-2/+2
| | | | Change-Id: Ib4719a651d78a875c70769f9b8611f1f6c103673
* Update for API bindingsDariusz Smigiel2016-05-261-2/+2
| | | | | | | | All occurrences of tenant replaced with project (where applicable). Partially Implements blueprint: keystone-v3 Change-Id: I4919745aa59863f99c7740e730d8cbfd91c2f646
* Devref: Add dynamic routing to OSC transitionRichard Theis2016-05-091-6/+9
| | | | | | | Add dynamic routing commands to OSC transition devref. Change-Id: Ifa8c2ece88e185f932cb812d1393750ce93585e9 Related-Bug: #1521291
* Merge "Devref Update: Transition to OpenStack Client"Jenkins2016-04-201-12/+12
|\
| * Devref Update: Transition to OpenStack ClientRichard Theis2016-03-291-12/+12
| | | | | | | | | | | | | | | | | | Update the "Transition to OpenStack Client" devref with the following: - Status update per start of Newton release - Change developer references to use github for latest information Change-Id: I17111b833a83395f379ed8e93091cd1956b80dbd Related-Bug: #1521291
* | Devref: Newton updates for transition to OSCRichard Theis2016-04-071-21/+14
|/ | | | | | | | | | | | | Update the "Transition to OpenStack Client" devref with the plan for handling network resources in Newton. In particular, this update clarifies the OpenStack project where the commands will reside. This update attempts to capture some of the information in [1] and to address packaging concerns. [1] https://etherpad.openstack.org/p/osc-neutron-support Change-Id: I95e579ab23377a6cf36fc7a50356ab406d350053 Related-Bug: #1521291
* Merge "Devref Update: Transition to OpenStack Client"Jenkins2016-03-021-56/+106
|\
| * Devref Update: Transition to OpenStack ClientRichard Theis2016-02-261-56/+106
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Update the "Transition to OpenStack Client" devref with information about the new OSC command specs process. This process can be used to propose new networking commands while deferring their implementation. This process may help speed the overall transition to OSC. This update also includes information about the OSC neutron support etherpad which provides detailed status for the transition. And finally, updates were made to the overall transition plan based on discussions at the midcycle. Change-Id: I46bc066d2169a1e20af13baac7131ffa2eedd7c8 Related-Bug: #1521291
* | Add wrapper classes for return-request-id-to-callerHirofumi Ichihara2016-02-261-0/+10
|/ | | | | | | | | | | | | | | Added wrapper classes which are inherited from base data types tuple, dict and str. Each of these wrapper classes contain a 'request_ids' attribute which is populated with a 'x-openstack-request-id' received in a header from a response body. This change is required to return 'request_id' from client to log request_id mappings of cross projects[1]. [1]: http://specs.openstack.org/openstack/openstack-specs/specs/return-request-id.html Change-Id: I55fcba61c4efb308f575e95e154aba23e5dd5245 Implements: blueprint return-request-id-to-caller
* Fix code-block for python code in docHirofumi Ichihara2016-01-251-1/+3
| | | | Change-Id: Ia5cb007b0a0093e478416161763dcaa23b9cfbe4
* Merge "Devref: Transition to OpenStack Client"Jenkins2016-01-072-1/+185
|\
| * Devref: Transition to OpenStack ClientRichard Theis2016-01-052-1/+185
| | | | | | | | | | | | | | | | Add developer reference for the transitition of the neutron CLI support to the openstack CLI. Change-Id: I5f9885eab7b6d1b6f4ee0d9cf84a07a0cb9d8c9a Related-Bug: #1521291
* | Merge "Adding missing headers to the devref documents"Jenkins2015-12-215-6/+110
|\ \
| * | Adding missing headers to the devref documentsvikram.choudhary2015-12-115-6/+110
| |/ | | | | | | Change-Id: Ie7f8b8d5751ff378e999287c29c1f3e4714ea64a
* | Reworded nargs='?' explanation for better clarityvikram.choudhary2015-12-151-21/+17
|/ | | | Change-Id: Iae2c71695ed18504690cc953b4128aeaf3196275
* Merge "Add CLI option guideline"Jenkins2015-12-042-0/+247
|\
| * Add CLI option guidelineAkihiro Motoki2015-12-042-0/+247
| | | | | | | | | | | | | | | | A lot of changes have been proposed to add options to *-create/update operations. This guideline tries to clarify the conventions used in neutornclient. Change-Id: I2c66c3dcba2569fdac2e54afb49406084cbf7037
* | Merge "Add description of extra args in CLI"Jenkins2015-12-041-4/+138
|\ \ | |/
| * Add description of extra args in CLIAkihiro Motoki2015-12-041-4/+138
| | | | | | | | Change-Id: Ia732d7ba82e3e5a5698a68be8e86eed87916f7da
* | Merge "Add os-client-config to CLI usage"Jenkins2015-12-041-0/+44
|\ \ | |/
| * Add os-client-config to CLI usageAkihiro Motoki2015-12-041-0/+44
| | | | | | | | Change-Id: I5d4a3d7206c8f90f479047e8ee810496c06022d9
* | Merge "Add more contents about CLI usage"Jenkins2015-12-041-0/+136
|\ \ | |/
| * Add more contents about CLI usageAkihiro Motoki2015-12-041-0/+136
| | | | | | | | | | | | | | | | * Filtering in list operation * Changing displayed columns in list operation * Debug: display API level communication Change-Id: Ifba20559c76bf0c1b29f9ef3ac9def3882099956
* | Do not include reno releasenotes in normal documentationAkihiro Motoki2015-12-042-35/+2
|/ | | | | | | | | | | | | | | | Per the recent release note guidelines for libraries [1], reno based release notes will be moved out from the normal docs. The previous (partial) release notes are also moved to releasenotes directory. The developer documentation now has a link to the releasenote web site. In addition, having reno directive in normal sphinx document prevents users from generating our docs from release tarballs. [1] http://lists.openstack.org/pipermail/openstack-dev/2015-November/080694.html Change-Id: I817f1a7331b8664486544c82e1a9a917864601bf Closes-Bug: #1520096
* Reorganize documentation structureAkihiro Motoki2015-12-014-74/+115
| | | | | | | This reorganization is to make it easier to add more contents. It move the usage of CLI and python binding to separate pages. Change-Id: I39e0d1d18010dfd1c687c573619a09331f12241a
* Use sphinx-build -W in [docs] targetAkihiro Motoki2015-11-281-3/+4
| | | | | | | | | | | Even though [pbr] warnerrors = true is specified, somehow sphinx warnings are not treated as errors. If we use sphinx-build, -W option detects document warnings and it leads to better documentation quality. Fix a warning in the existing document too. Change-Id: Icbb39686c7a24f0040d998fb14e14c63613da190
* Add reno for release notes managementAkihiro Motoki2015-11-242-1/+7
| | | | | | | | In addition to the convention of releasenotes/source directory which used in most OpenStack project, we have the release notes in our developer documents. Change-Id: Ied07af5ee5c8929e639e17a34b559cebfe419dc4
* Move the old release notes to a separate fileAkihiro Motoki2015-11-242-27/+29
| | | | | | Preparation for reno adoption in a following patch Change-Id: Ice4f45147ae9699a5be2c60c0ed247b893881d62
* Clear the extension requirementgong yong sheng2015-08-251-11/+39
| | | | | Change-Id: If0725e009dfb98fe949b9e00349108c88cf4424a Closes-bug: #1486845
* Add document for entry point in setup.cfggong yong sheng2015-08-201-3/+10
| | | | | | | | In addition, to remove the contrib/ way to load commands since it is not implemented at all. Change-Id: Id15eb10e7cb086d55d2bcad4f719f9120c6f7d1a Closes-Bug:#1486824
* Devref documentation for client command extension supportGal Sagie2015-07-143-1/+80
| | | | | Change-Id: If71c9e2bbf888b1a68d3b7dc351f7df02f1a380f Closes-Bug: #1470622
* Add alternative login description in neutronclient docsLucas H. Xu2015-06-121-0/+12
| | | | | | | | | | A way to test it is to follow the description and create a neutron client using the alternative way Make changes based on Akihiro comments Add extra colon in line 19 Change-Id: I2f7a5a3e8f7386d24d258303b3056615da8612ad
* Stop using intersphinxAndreas Jaeger2014-09-131-4/+1
| | | | | | | | | | | | | | Remove intersphinx from the docs build as it triggers network calls that occasionally fail, and we don't really use intersphinx (links other sphinx documents out on the internet) This also removes the requirement for internet access during docs build. This can cause docs jobs to fail if the project errors out on warnings. Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb Related-Bug: #1368910
* Update theme for docsSteve Martinelli2014-07-241-2/+2
| | | | | | | | The current developer docs theme used is out of sync with the other openstack projects. This patch will update the docs to provide a more consistent look and feel when using developer docs Change-Id: I03985039381c2ba4f81a2015258f7b49bba441d9
View Lorry Controller Status