summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* Remove the CLI code from the Neutron client.Slawek Kaplonski2023-04-118-869/+9
| | | | | | | | | | | | | | | This project no longer provides CLI support. All code has been removed. Please use openstack CLI instead This patch removes entry point for neutron CLI too, bash completion script and CLI related functional and unit tests but it still keeps neutronclient/neutron/v2_0 module as this is used by e.g. Nova. Co-Authored-By: Slawek Kaplonski <skaplons@redhat.com> Closes-Bug: #2003861 Change-Id: I5b6c735d1ff931d7991a42b262e7faa47b75edeb
* Move network trunk commands from python-neutronclientelajkat2023-01-161-16/+0
| | | | | | | | | The depends-on patch adds trunk commands to OSC, as we can long consider trunk operations as core Networking operations. Change-Id: Ie557a5d541cf117d20f3f2b548620a74dbadb383 Depends-On: https://review.opendev.org/c/openstack/python-openstackclient/+/869447 Related-Bug: #1999774
* Set when deprecated neutron client CLI will be removedSlawek Kaplonski2021-05-271-3/+3
| | | | | | | | | | | | [1] was the last missing bit in OSC to have feature parity between OpenStack client and Neutronclient CLI tools. So now as [1] is merged we can really deprecate and specify that in Z cycle we will remove neutronclient CLI. This patch changes deprecation message to reflect that. [1] https://review.opendev.org/c/openstack/python-openstackclient/+/768210 Change-Id: Ia68af29ea15bda7330fda1b18416798a0f4cb7a4
* remove unicode from code7.3.0zhangboye2021-01-031-3/+3
| | | | Change-Id: I2521c2ba836b6a332883134112b6f99d996cc4e4
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-181-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Set openstackdocs_auto_name to use 'project' as name. Depends-On: https://review.opendev.org/728938 Change-Id: I9e1dcc5c8861ac9d800ed7425b3e3193dd13c546
* Cleanup py27 supportussuri-em7.1.1Andreas Jaeger2020-04-041-1/+0
| | | | | | | | | | | | | | Make a few cleanups: - Remove python 2.7 stanza from setup.py - Add requires on python >= 3.6 to setup.cfg so that pypi and pip know about the requirement - Remove obsolete sections from setup.cfg - Update classifiers - Update requirements, no need for python_version anymore - Remove html_last_updated_fmt from conf.py, this is not needed with openstackdocstheme anymore; update openstackdocstheme requirement Change-Id: I66d7b502349de38bc2b646ed99cf5a41471d81bf
* PDF documentation buildAkihiro Motoki2019-09-051-0/+19
| | | | | | Change-Id: I0abc5df1dfde23756bc2fd78631141ba685dc6fe Story: 2006099 Task: 35139
* doc: Remove prompt from python binding examplesAkihiro Motoki2019-05-101-36/+36
| | | | | | | | The current python binding examples have prompts of python interactive mode, but these prompts make it difficult to copy-and-paste the examples. This commit removes them. Change-Id: Ia5d35fbb585ed0d0d11c8d035196981e9dd46785
* Replace git.openstack.org URLs with opendev.org URLsjacky062019-04-281-5/+5
| | | | Change-Id: I3cc418bd8219a3d4f3ab5c018adf06b66ef36b46
* Add subnet onboard CLI6.12.0Ryan Tidwell2019-02-271-0/+17
| | | | | | | | | | This is the implementation of the "onboard network subnets" CLI. This enables the subnet onboard feature of neutron to be driven via CLI. Depends-On: https://review.openstack.org/348080 Change-Id: Ic637ed689b0d3806d2c33faa419c3a98a310effa Implements: blueprint subnet-onboard
* Update links in READMEXiaojueGuan2018-06-121-1/+1
| | | | | | Change the outdated links to the latest links in README Change-Id: I70fbe513066b9375344e80308c646e56bf927db0
* Rename python-openstacksdk to openstacksdkMonty Taylor2018-03-231-2/+2
| | | | Change-Id: If61a78de8b16f62586988f5fdeab2146f67fa3f7
* Drop neutronclient-specific cliff sphinx extensionAkihiro Motoki2018-01-292-5/+2
| | | | | | | | | | | | Previously neutronclient has its own variant of cliff sphinx extension to support cliff app autodocument (cliff-app directive). The feature has been implemented in cliff 2.10.0. This patch switches to the cliff official version. The cliff official version also contains several nice fixes around the sphinx extension. Change-Id: If542fdf88ef57ec3ce8ecc017127b5dc194e6c9a
* Merge "Add commands to support BGP VPN route control new API extension"queens-em6.7.0Zuul2018-01-251-0/+3
|\
| * Add commands to support BGP VPN route control new API extensionÉdouard Thuleau2018-01-221-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | Networking-bgpvpn API extension [0] brings new API calls. That patch adds command to OSC CLI to support them. It does not implement all the API extension, still missing new router attribute 'advertise_extra_routes' and the BGP VPN 'local_pref' attribute. [0] https://developer.openstack.org/api-ref/network/v2/index.html#port-associations Change-Id: I45a160b0caec534d517b103db91dc738c006978b Partially-Implements: blueprint routes-control Depends-On: I263e1ee6cf4e1a91be91a4a78f4a160f64d33cc6
* | Fix broken linksgaofei2018-01-241-7/+7
|/ | | | Change-Id: I4b00a24e5adb2ac6b62218d152aef88fac2d6396
* Add VPNaaS commands for OSC pluginCao Xuan Hoang2018-01-155-0/+55
| | | | | Closes-Bug: 1669252 Change-Id: I447f5c50725fc0d9d8a1574ad5e28772f472fba9
* Add Logging commands for OSC pluginYushiro FURUKAWA2018-01-111-0/+15
| | | | | | | | | This commit supports Logging CLI as OSC plugin[1]. [1] https://bugs.launchpad.net/neutron/+bug/1468366 Depends-On: Ib8668dd25ee7c5000a6dafcc7db3dbc33ad190be Partially-implements: blueprint security-group-logging Change-Id: If9a5e0e3958ea32f4c0d3573efcb3ac4101c63a6
* Merge "Add Service Graphs networking-sfc resource"Zuul2017-12-021-0/+3
|\
| * Add Service Graphs networking-sfc resourceDaire Ní Chatháin2017-10-301-0/+3
| | | | | | | | | | | | | | Co-Authored-By: Igor Duarte Cardoso <igor.duarte.cardoso@intel.com> Partial-Bug: #1587486 Depends-On: I372da15f99f3cbfb7ffd1d8bf87a79bc56180afe Change-Id: Ie54da56d2388cb375bccd883c111c5f87e293047
* | Dynamic routing CLIs OSC transitionNa2017-10-261-0/+50
|/ | | | | | | | | | | Neutron is transitioning its CLI to OSC, should update dynamic routing CLIs to align with OSC plugin. Change-Id: Ic1a633ca103d9e97e28ddf23e0f528e0261ce497 Co-Authored-By: Ryan Tidwell <ryan@6tidwells.com> Co-Authored-By: Roey Chen <roeyc@vmware.com> Partially-Implements: blueprint bgp-spinout Partial-Bug: #1560003
* Merge "Update the documentation link for doc migration"6.4.0Jenkins2017-07-245-15/+15
|\
| * Update the documentation link for doc migrationHangdong Zhang2017-07-225-15/+15
| | | | | | | | Change-Id: Ia07630b2626781d89b1957a96706e22a9e28674f
* | Merge "Add SFC cli for OSC plugin"Jenkins2017-07-241-0/+36
|\ \ | |/ |/|
| * Add SFC cli for OSC pluginMohankumar2017-07-131-0/+36
| | | | | | | | | | | | Implements: blueprint openstackclient-cli-porting Change-Id: Ifeb62bad26ffeb0bb8b548c56d2d6a620a922f78
* | doc: autogenerate neutron CLI referenceAkihiro Motoki2017-07-102-0/+49
| | | | | | | | | | | | | | | | | | | | | | This replaces the doc-migration work. We can avoid the maintenance cost by generating CLI reference for neutron CLI like this. This patch introduces a new sphinx directive to render CLI global options to achieve the goal. This can be migrated to cliff sphinxext later. Change-Id: I7089df3f7fc6475ebdd1e71221492baf12f18226
* | doc: autogenerate OSC plugin command referenceAkihiro Motoki2017-07-106-1307/+50
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Recently cliff introduced a sphinx extension directive named autoprogram-cliff which genarates command-line help automatically. By using it, we no longer need to write command-line help document separately. Also fixes minor string substitution issue in a BGPVPN command. Note that the new cliff release with the directive is not released yet, but there are several number of OSC plugin commands proposed and having a local copy would help such developers. Change-Id: I6b1aee89f406ac449fbc43e210c4ca7ad901b19b
* | doc: Improve network CLI pageAkihiro Motoki2017-07-105-35/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Move OSC first as neutron CLI is deprecated * Add more information on OSC usage (links to embeded command list and the mapping guide) * Add deprecation notice for neutron CLI This commit also makes toctree structure simpler At now, we have two index page unlinked from the top page. I thought it is good first, but it potentially makes things tricky. Let's remove such tweaks for easy maintenance. Change-Id: I7fd79f465fa6c04bf5b13f6578796d4c2d01edfd
* | doc: use new config options of openstackdocsthemeAkihiro Motoki2017-07-031-33/+8
| | | | | | | | | | | | | | | | | | | | The new simple configuration way was introduced in openstackdocstheme 1.11.0. This commit introduces the new way. Also drops unnecessary sphinx configurations like latex, texinfo and manpages. Change-Id: I587eb8cbd3e64c65dfc7247a01eca90af6adad4e
* | move existing content into the new standard structureAkihiro Motoki2017-06-2314-27/+122
| | | | | | | | | | | | This patch rearranges and reformats existing content. Change-Id: Ibcad865d2ae45696628f77b5bd5f0e6b1f6842cf
* | switch to openstackdocsthemeAkihiro Motoki2017-06-181-2/+20
| | | | | | | | Change-Id: Ic8f9b6821da7958a895dad6053d2cd1b6761a405
* | 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