summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* Merge "project cleanup"5.5.0Zuul2021-03-182-0/+13
|\
| * project cleanupArtem Goncharov2021-02-022-0/+13
| | | | | | | | | | | | | | | | | | New implementation of the project cleanup based on the sdk.project_cleanup. It is implemented as an additional OSC operation and will ideally obsolete the `openstack project purge` giving flexibility to extend services support, parallelization, filters, etc. Change-Id: Ie08877f182379f73e5ec5ad4daaf84b3092c829c
* | Update the file paths mentioned in README.rstTakashi Kajinami2021-03-151-7/+7
|/ | | | | | | This change fixes the outdated file paths, which were renamed by commit 9599ffe65d9dcd4b3aa780d346eccd1e760890bf . Change-Id: I9ec4c49711a2fde24f5527086e495c86af9ef1ce
* Merge "Remove retired Karbor support"Zuul2021-01-144-15/+0
|\
| * Remove retired Karbor supportStephen Finucane2021-01-084-15/+0
| | | | | | | | | | | | | | | | | | | | The Karbor project is being retired in Wallaby [1]. Remove the docs for its client. [1] http://lists.openstack.org/pipermail/openstack-discuss/2020-November/018643.html Change-Id: I52d0f6a76cc9bcfc8b33f0e2cd3751859770ac8a Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "Support Neutron Address Group CRUD"Zuul2021-01-111-0/+12
|\ \
| * | Support Neutron Address Group CRUDHang Yang2020-12-241-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add support for Neutron address group CRUD operations. Subsequent patches will be added to use address groups in security group rules. Change-Id: I3c313fc9329837dde67815901528a34dca98ebcc Implements: blueprint address-groups-in-sg-rules Depends-On: https://review.opendev.org/738274 Depends-On: https://review.opendev.org/745594
* | | Add 'server shelve --offload', 'server shelve --wait' optionsStephen Finucane2021-01-081-1/+1
| |/ |/| | | | | | | | | | | | | | | | | | | | | The '--offload' option allows us to explicitly request that the server be offloaded once shelved or if already shelved. The '--wait' option allows us to wait for the shelve and/or offload operations to complete before returning. It is implied when attempting to offload a server than is not yet shelved. Change-Id: Id226831e3c09bc95c34b222151b27391a844b073 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | compute: Add 'server show --topology' optionYongli He2021-01-061-0/+1
| | | | | | | | | | | | | | | | Add support for compute microversion 2.78 by adding a '--topology' option to 'openstack server show' command that retrieves server NUMA information. Change-Id: Ie22979df2ea9082ca64a4d43b571bd4025684825
* | Merge "Change 'Volume' to 'Block Storage'"Zuul2020-12-224-4/+4
|\ \
| * | Change 'Volume' to 'Block Storage'yangxi2020-03-094-4/+4
| | | | | | | | | | | | | | | | | | In volume*.rst files, 'Volume' should be instead of 'Block Storage'. Change-Id: Iafc8bfa19e87edf1ffad2340c75e9d867042cae5
* | | Merge "Remove retired Searchlight support"Zuul2020-12-093-6/+0
|\ \ \ | |_|/ |/| |
| * | Remove retired Searchlight supportGhanshyam Mann2020-12-083-6/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Searchlight project is retiring in Wallaby cycle[1]. This commit removes the support/usage of Searchlight project before its code is removed. Needed-By: https://review.opendev.org/c/openstack/searchlight/+/764526 [1] http://lists.openstack.org/pipermail/openstack-discuss/2020-November/018637.html Change-Id: Idad97343b9ce66186d50ee0560a2fded66655f9b
* | | Add documentation about login with federationpedro2020-12-022-0/+126
| | | | | | | | | | | | | | | | | | | | | | | | The documentation presents the parameters necessary to authenticate via federation (using password) and do a brief description of each parameter used in the process. Change-Id: Iae3b6d0b56ebd2bbbb94f9f3637b5086e75559a7
* | | Let autoprogram-cliff know who's runningEric Fried2020-12-011-0/+3
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | The autoprogram-cliff directive has a habit of producing text like This command is provided by the $me plugin. which doesn't make any sense. Cliff recently added a config option whereby consumers can let it know who $me is so it can suppress that message where appropriate (while still producing it for $plugin, as intended). Depends-On: https://review.opendev.org/692464 Change-Id: I0d580fb1d34dd56740eb6d976caa795e0e951047
* | Merge "Add 'openstack server evacuate' command"Zuul2020-11-091-0/+3
|\ \
| * | Add 'openstack server evacuate' commandSean Mooney2020-11-021-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | This change adds a new 'openstack server evacuate' command to provide parity with the 'nova evacuate' command. The term "evacuate" is notoriously poor, in that it implies the instance is moved rather than recreated, but it is retained since people are familiar with it now. Change-Id: I1e32ca51036c501862d8e89b3144a9695d98a06f
* | | Remove references to Python 2.7Stephen Finucane2020-11-051-8/+7
|/ / | | | | | | | | | | | | We don't support it anymore. This is just noise now. Change-Id: I3640e7d8e520db69f83f95e9c7759279f7c15008 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Remove references to setuptoolsStephen Finucane2020-10-223-5/+4
| | | | | | | | | | | | | | | | | | | | Newer versions of cliff and stevedore use importlib rather than setuptools to work with entry points. Replace any references to "setuptools' entry points mechanism" with "Python's entry points mechanism". Change-Id: Iae36155685ee37ab5e38a0c173110a5ece33d05d Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "Add server migration list CLI"Zuul2020-10-121-0/+12
|\ \
| * | Add server migration list CLIzhangbailin2020-09-241-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | Add ``openstack server migration list`` to fetch server migrations. Part of blueprint add-user-id-field-to-the-migrations-table Change-Id: I15b4a5aca8d0dee59dd293e7b1c7272cdfbeea20
* | | Remove usage of sixsongwenping2020-10-071-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With python3.x, classes can use 'metaclass=' instead of 'six.add_metaclass', 'six.iteritems' and 'six.iterkeys' can be replaced by 'items' and 'keys', 'six.moves.urllib.parse' can be replaced by 'urllib.parse', 'six.StringIO' and 'six.moves.cStringIO' can be replaced by 'io.StringIO', 'six.text_type' and 'six.string_type' are just 'str'. Change-Id: I84848c0bf8ab3c36dd821141191e2725e4e3b58b
* | | Update developing.rstlikui2020-09-081-1/+1
|/ / | | | | | | | | | | Use unittest.mock instead of mock Change-Id: Ib573e9d217b4f18ef4e7ba3ab581164be423cb26
* | Merge "image: autogenerate docs"Zuul2020-06-095-652/+29
|\ \
| * | image: autogenerate docsEric Fried2020-06-085-652/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | $namespace = openstack.image.v{1|2} The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. Some reorganization happened here. The `image` subcommand name is shared by image v1 and v2. Previously the hardcoded document had them combined and interleaved. Attempting to preserve this with autoprogram-cliff would have required significant additional infrastructure. However, since most readers care completely about one and not at all about the other, we instead split the v1 and v2 versions of these commands into separate pages. In case links to the old pages exist in the wild, they are preserved, but moved (with redirects) to a hidden directory, and populated simply with links to the new version-specific generated documents. Change-Id: I24dc6dc10671c7f1267c27002542f61f8a3c18ae
* | | Merge "identity: autogenerate docs"Zuul2020-06-0948-2449/+255
|\ \ \ | |/ /
| * | identity: autogenerate docsEric Fried2020-06-0848-2449/+255
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | $namespace = openstack.identity.v{2|3} The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. Special things: - Some reorganization happened here. Certain subcommand names, such as `endpoint` and `project`, are shared by identify v2 and v3. Previously the hardcoded documents had them combined and interleaved. Attempting to preserve this with autoprogram-cliff would have required significant additional infrastructure. However, since most readers care completely about one and not at all about the other, we instead split the v2 and v3 versions of these commands into separate pages. In case links to the old pages exist in the wild, they are preserved, but moved (with redirects) to a hidden directory, and populated simply with links to the new version-specific generated documents. - The `federation domain` and `federation project` subcommands were previously absent from the docs. They are added. These are such small commands and they seem related, so they're put into a single document. - Some pages were already being generated but were listing operations individually instead of using wildcards (possibly because they were created before wildcarding was supported by cliff). These are changed to use wildcarding. (We want to do this wherever possible as it is more future-proof in the event that more operations are added to a subcommand later.) - The `service provider` document was incorrectly titled `identity provider`. Fixed. Change-Id: I2030f9fe370038c5908b6eb6bed9692a73fe5067
* | | Merge "Add OpenStack Client for Manila docs"Zuul2020-06-082-0/+5
|\ \ \ | |/ / |/| |
| * | Add OpenStack Client for Manila docsMaari Tamm2020-06-062-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | This commit includes documentation about OSC implementation for Manila. bp openstack-client-support Change-Id: Ic91a81e16e506103c08ef42ed0f8634a2b70e1dd
* | | Merge "Switch to newer openstackdocstheme and reno versions"Zuul2020-06-051-9/+5
|\ \ \
| * | | Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-201-9/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.1 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. 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_auto_name to use 'project' as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Depends-On: https://review.opendev.org/729744 Change-Id: Id3989cabdbf2204821531b00149aa0f1cb8a4955
* | | | Remove congressAndreas Jaeger2020-06-044-10/+0
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | Congress and python-congressclient have been retired and also removed from global requirements, thus requirements-check job fails. Remove congress from this repo. Change-Id: Ibf68fee49e69264a1c46b2f456901d2620befe3c
* | | Merge "Add resource option immutable"Zuul2020-04-172-0/+40
|\ \ \
| * | | Add resource option immutableVishakha Agarwal2020-04-082-0/+40
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch adds the --immutable and --no-immutable option to the role, project and domain CLI. Related-Patch: https://review.opendev.org/#/c/712182/ Change-Id: I9c3bdd741f28bf558267fb217818d947597ce13e
* | | | Cleanup Python 2.7 supportAndreas Jaeger2020-03-301-13/+0
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | OpenStack is dropping the py2.7 support in ussuri cycle. Make a few cleanups: - Remove python 2.7 stanza from setup.py - Add python-requires to setup.cfg so that pypi and pip know about support Python version - Remove ancient sections from setup.cfg - Remove version_info setting from conf.py, openstackdocstheme does this automatically nowadays. Change-Id: I5b9c159752c932f874015f20822862c70562c2bd
* | | Adding options to user cliVishakha Agarwal2020-03-261-0/+126
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | User options [1] can be set by making POST and PATCH request for /v3/users API calls but cannot by openstack CLI because of no user options defined in create and update user CLI [2]. This patch adds the user options [1] in create user and update user CLI. [1] https://docs.openstack.org/keystone/latest/admin/resource-options.html#multi-factor-auth-rules [2] https://docs.openstack.org/api-ref/identity/v3/#create-user Change-Id: I4e41bae2e8cfbe92d52b14d856991bedcd44164f
* | | Merge "Fix faulthy state argument choice"5.1.0Zuul2020-03-241-1/+1
|\ \ \ | |/ / |/| |
| * | Fix faulthy state argument choiceBram Verschueren2019-12-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The correct state name for a failing volume snapshot deletion is 'error_deleting' instead of 'error-deleting'. [1] [1] https://opendev.org/openstack/cinder/src/commit/89d6a5042fcb2ede5a0b1112d72fae805ea52fcd/cinder/objects/fields.py#L126 Task: #37844 Story: #2007037 Change-Id: Ia99900ece4f1cd29769b22ddaa3965789d719556
* | | Merge "Now we can add description for role creation in OSC"Zuul2020-03-201-0/+4
|\ \ \
| * | | Now we can add description for role creation in OSCM V P Nitesh2018-09-181-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now user can add the description when user create's the role using OSC ``openstack role create`` command. User can add the description by adding `--description <Description>` to OSC ``openstack role create`` command. Co-Authored-By: Deepak Mourya<deepakmoriya7@gmail.com> Change-Id: I858e004c3b29c687b6a39c8a1ed5fb029eb19c67 Depends-on: I230af9cc833af13064636b5d9a7ce6334c3f6e9a Closes-Bug: #1669080
* | | | Merge "Replace port 35357 with 5000 for "auth_url""Zuul2020-03-202-7/+7
|\ \ \ \
| * | | | Replace port 35357 with 5000 for "auth_url"Nguyen Van Duc2018-09-172-7/+7
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Based on the change in Keystone Install Guide [1], this patch replace port 35357 with 5000 for "auth_url". For more details, please check similar changes which have been done on other projects: Nova [2], Neutron [3], Cinder [4], Glance [5]. [1] https://review.openstack.org/#/c/541857 [2] https://review.openstack.org/#/c/562812 [3] https://review.openstack.org/#/c/566491 [4] https://review.openstack.org/#/c/565464 [5] https://review.openstack.org/#/c/558932 Change-Id: I4faabbb107f912c7ed1cc5d3467ea5a94197d4a0
* | | | Merge "Update the content about Import Format"Zuul2020-03-201-9/+12
|\ \ \ \
| * | | | Update the content about Import Formatchenxing2018-05-221-9/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Following by https://git.openstack.org/cgit/openstack-dev/hacking/tree/HACKING.rst#n71 Change-Id: I2f32d773c12d484e8c0e435a78a3fe16d0eeae03
* | | | | Merge "Update http links in docs"Zuul2020-03-131-1/+1
|\ \ \ \ \
| * | | | | Update http links in docshuangshan2020-03-091-1/+1
| | |_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch is proposed according to the Direction 10 of doc migration(https://etherpad.openstack.org/p/doc-migration-tracking). Change-Id: I0061bf788a8da89da0077db63f6cecf2ead0d0be
* | | | | Merge "Incorrect title for service provider"Zuul2020-03-131-3/+3
|\ \ \ \ \ | |/ / / / |/| | | |
| * | | | Incorrect title for service providerGeorgina Shippey2020-01-231-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Mistakenly changed to identity provider. Change-Id: I0841a6e5ebd6a27a5375a54c56fc194dff65b370
* | | | | Remove mention of meetings from docsKendall Nelson2020-01-281-6/+5
|/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since the OpenStackClient team doesn't meet anymore, I removed the mention of meetings and added mention of the IRC channel in the communication section of the docs.. Change-Id: Iefa95878f95bf84bd9fc22ea4c914effc30dffa7
* | | | Add support for app cred access rulesColleen Murphy2020-01-172-0/+68
| |_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | This commit introduces the --access-rules option for 'application credential create' as well as new 'access rule' commands for listing, showing, and deleting access rules. bp whitelist-extension-for-app-creds Change-Id: I04834b2874ec2a70da456a380b5bef03a392effa