summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* volume: Add 'volume qos set --no-property' optionStephen Finucane2023-05-171-0/+7
| | | | | | | | | Supporting "--no-property" option will apply user a convenient way to clean all properties of volume qos in a short command. The patch adds "--no-property" option in "volume qos set" command and update related test cases and docs. Change-Id: I1fb5b4f0a923bbf557a3af3f63809bde9e84ffd4
* Blacken everything elseStephen Finucane2023-05-101-66/+81
| | | | | | | | | | Black used with the '-l 79 -S' flags. A future change will ignore this commit in git-blame history by adding a 'git-blame-ignore-revs' file. Change-Id: I356643d06b2cd408ccaedfe02b858aea55388949 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Address pre-commit issuesStephen Finucane2023-05-102-47/+47
| | | | | | | | | We'd like to use pre-commit as our 'pep8' target. Before we do that, we need to address some issues that have crept in over the time since pre-commit was first added. Change-Id: I3bb383a00a44007eaa241e037e38aea16bd517b2 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Docs: Update glance command mappingyaeeee2023-03-251-4/+4
| | | | | | | | | | | | | | | | | Update missing command in glance Mapping Guide. List of updated command [Glance CLI / OSC] md-namespace-create / image metadef namespace create md-namespace-delete / image metadef namespace delete md-namespace-list / image metadef namespace list md-namespace-show / image metadef namespace show Co-authored-by: sujin01 <a5870771@gmail.com> Co-authored-by: heesom <heesom.hs@gmail.com> Co-authored-by: mpicea <jjh77745997@gmail.com> Change-Id: I4d50b0ae820ea0c8feb1719bbbd9eb06d22cbe20
* doc: Update nova command mappingStephen Finucane2023-02-211-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are a number of commands we're never going to implement: host-evacuate host-evacuate-live host-servers-migrate As noted in Dan Smith's blog [1], these are wrapper commands or meta operations that call a particular action - namely 'evacuate', 'live-migration', and 'migrate' in old novaclient parlance - for each server on a particular host. These commands have historically been confusing. The underlying server commands have been implemented as 'server evacuate', 'server migrate --live', and 'server migrate', respectively. If a user wants to call these for each server on the host, they can do so with a little bit of shell scripting (hint: you want 'server list --host') or use something more suitable for this kind of task such as Puppet or Ansible. host-meta As above, this is equivalent to calling 'meta' for all servers on the host. Combine 'server set --property' with 'server list --host' instead (or use Ansible). instance-usage-audit-log This corresponds to the '/os-instance_usage_audit_log' API which is intended for use by OpenStack Telemetry. There's no user-facing application of this. The remaining entries are updated to include their implementations. We simply missed updating the mapping doc when implementing them. With this, the OSC implementation of the nova API is *documented* as being complete, as opposed to merely actually being complete 😉 [1] https://www.danplanet.com/blog/2016/03/03/evacuate-in-nova-one-command-to-confuse-us-all/ Change-Id: If08d501dd66c561956266d3b3f21dfd3559d8394 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Add options to create volume group from source6.1.0whoami-rajat2023-02-171-1/+1
| | | | | | | | This patch adds ``--source-group`` and ``--group-snapshot`` options to the ``volume group create`` command to allow creating group from a source group or a group snapshot. Change-Id: I87482a5dd43c519dfdcf981635aa879914a70a5c
* Add block storage manageable list commandswhoami-rajat2023-02-172-2/+13
| | | | | | | | | This patch adds the ``block storage volume manageable list`` and ``block storage snapshot manageable list`` commands that allow operators to list the volumes and snapshots on a particular host or cluster for management under OpenStack. Change-Id: I328dada5a0dc4e9e44c0d51db5cf3f224e27f88f
* Add block storage cleanup commandwhoami-rajat2023-02-172-1/+9
| | | | | | | | | This patch adds the ``block storage cleanup`` command that allow operators to cleanup resources (volumes and snapshots) with failed operations by requesting services in other hosts in the same cluster to cleanup resources of a failed service. Change-Id: I1375223f525021db5201fa0a9f9a647d17dd01f7
* Add block storage log level {list, set} commandswhoami-rajat2023-02-162-2/+10
| | | | | | | | | This patch adds the ``block storage log level list`` and ``block storage log level set`` commands that allow operators to list the current log levels of cinder services and also enables them to set a particular log level. Change-Id: I16cd8084fb505a9e68a35a936ef3b8b1f3cdc712
* Add volume revert commandwhoami-rajat2023-02-162-1/+4
| | | | | | This command allows users to revert a volume to a given snapshot. Change-Id: If35ee394d654f5264558a281c835affff524ca50
* Merge "Add volume summary command"Zuul2023-01-312-1/+6
|\
| * Add volume summary commandwhoami-rajat2023-01-132-1/+6
| | | | | | | | | | | | | | | | | | This patch adds the ``volume summary`` command which shows the total size, total count and metadata of all volumes. This command is available from microversion 3.12 and the metadata info is available from microversion 3.36. Change-Id: I6472337e8b1dc91aad5fbe416673a5d5a5d5fa88
* | Merge "Move network trunk commands from python-neutronclient"Zuul2023-01-311-0/+16
|\ \ | |/ |/|
| * Move network trunk commands from python-neutronclientelajkat2023-01-161-0/+16
| | | | | | | | | | | | | | | | | | | | | | Network trunk commands originally were added to python-neutronclient, although we can long consider these operations core Networking operations. This patch is not a blind copy but also changes the original code to use openstacksdk python bindings instead of the binding code in python-neutronclient as that is already deprecated. Change-Id: Ic4bc35c296a95d5dae92e9fc1cab3a3fa8f103cd Related-Bug: #1999774
* | Merge "Add plugin doc page for cyborg"Zuul2022-12-203-0/+6
|\ \
| * | Add plugin doc page for cyborgShogo Saito2022-12-203-0/+6
| | | | | | | | | | | | | | | | | | This patch add cyborg (accelerator) doc page. Change-Id: I0f3e5419ce522e620be805c0fcd829c8dfb2e317
* | | Merge "docs: Fix typos"Zuul2022-12-201-2/+2
|\ \ \ | |/ / |/| |
| * | docs: Fix typosStephen Finucane2022-12-051-2/+2
| | | | | | | | | | | | | | | Change-Id: I902e8b35d4423f91dd8cdeecbcc7e60af877da75 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "Updating the glanceclient reference doc"Zuul2022-12-151-1/+8
|\ \ \
| * | | Updating the glanceclient reference docMridula Joshi2022-12-061-1/+8
| | |/ | |/| | | | | | | | | | | | | | | | Added the missing commands from glanceclient, updated the OSC equivalent and removed the deprecated commands. Change-Id: I3cee7882f6712e80c6f6e568337c1f96439aa1a5
* | | Merge "image: Add 'image import' command"Zuul2022-12-051-1/+1
|\ \ \
| * | | image: Add 'image import' commandStephen Finucane2022-11-091-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Note that we require some additional functionality in SDK for this to work properly, but it's a start. Change-Id: I87f94db6cced67f36f71685e791416f9eed16bd0 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | | docs: Document how we manage API versionsStephen Finucane2022-11-301-1/+133
| |_|/ |/| | | | | | | | | | | | | | | | | | | | Document that microversion auto-negotiation is acceptable. Heck, it's downright desirable. Change-Id: Ib256e064d1e8b6dc8273e482276dce243f9991cb Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | docs: Describe common actions found in OSCStephen Finucane2022-11-301-23/+240
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Off the back of a recent post to openstack-discuss [1], list the common actions used in OSC along with some conditions around their expected use and implementation. [1] https://lists.openstack.org/pipermail/openstack-discuss/2022-November/031284.html Change-Id: Id6610d678e7b3b12afdd89a674fbbe7090f64444 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | docs: Typo fixStephen Finucane2022-11-251-1/+1
| | | | | | | | | | | | | | | Change-Id: I2d55747b1226207946f80f04b80b4685e3eea3f9 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | docs: Small cleanup of human interface guideStephen Finucane2022-11-241-37/+43
|/ / | | | | | | | | | | | | Before we add more content. Change-Id: I6cf28bdd217326db991466a21221b685124d4b99 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | image: Add 'image stage' commandStephen Finucane2022-11-091-1/+1
|/ | | | | | | This is the equivalent of the 'image-stage' glanceclient command. Change-Id: I10b01ef145740a2f7ffe5a8c7ce0296df0ece0bd Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Merge "quota: Add 'quota show --usage' option"Zuul2022-10-121-1/+1
|\
| * quota: Add 'quota show --usage' optionStephen Finucane2022-09-301-1/+1
| | | | | | | | | | | | | | | | | | | | | | Provide an more sane way to get usage information for a particular project's quotas. This requires using the 'Lister' command type since the 'ShowOne' command type only allows for simple key-value pair output. We also add a note indicating that the '<project>' argument is optional. Change-Id: Ic7342cf08f024cc690049414c5eef5b9a7594677 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "quota: Add support for detailed volume quotas"Zuul2022-10-071-1/+1
|\ \ | |/
| * quota: Add support for detailed volume quotasStephen Finucane2022-09-301-1/+1
| | | | | | | | | | | | | | | | We were stating that this was not supported. That is not true. Correct the oversight. Change-Id: Ib9d9db641a18e142be0a1eccff783e7cccdf2db5 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "quota: Add 'quota delete' command"Zuul2022-10-073-3/+3
|\ \ | |/
| * quota: Add 'quota delete' commandStephen Finucane2022-09-303-3/+3
| | | | | | | | | | | | | | | | | | We had previously indicated that people use 'quota set' for unsetting a project's quotas, however, there was nothing that actually allowed us to do this. Correct that oversight. Change-Id: I04057e766b8ccf94bf219972249b68dc2bb796d4 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "doc: Update cinder command mapping"Zuul2022-10-071-1/+1
|\ \ | |/
| * doc: Update cinder command mappingStephen Finucane2022-09-301-1/+1
| | | | | | | | | | | | | | | | | | I had incorrectly marked the 'api-version' command as WONTFIX. Turns out we already support this, albeit via keystone as opposed to a cinder-specific API. Change-Id: I804ef1ca5a0f4df844d8c2229688c4edbac45aa9 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "docs: Add missing command mappings"Zuul2022-09-302-6/+6
|\ \
| * | docs: Add missing command mappingsStephen Finucane2022-07-072-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The 'neutron tag-replace' command is equivalent to the 'openstack network set --no-tag --tag <tag> [--tag <tag> ...]' command. '--no-tag' will unset all tags while '--tag <tag>' will set a new tag and can be specified multiple times. The 'nova hypervisor-uptime' command is equivalent to the 'openstack hypervisor show' command. Before compute microversion 2.88, the nova command was using a different API that returned an almost identical output to 'nova hypervisor-show' except it included an 'uptime' field. Since 2.88, this field is returned in the standard call. OSC abstracts this detail away so the 'uptime' field is always present, removing the need for a separate command. The 'nova migration-list' command is implemented as 'openstack server migration list' (simply omit the '--server' filter). The 'nova volume-update' command is implemented as 'openstack server volume update'. The 'nova volume-attachments' command is actually available as 'openstack server volume list', though you can also use 'server show'. The 'nova aggregate-cache-images' corresponds to an internal API that only glance should be using. It doesn't need to be exposed via openstackclient. Change-Id: Icdbc42762230954f6f7f2064b6228416af41d45a Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "remove unicode prefix from code"Zuul2022-09-301-8/+8
|\ \ \
| * | | remove unicode prefix from codeniuke2022-08-151-8/+8
| | | | | | | | | | | | | | | | Change-Id: I0b1ca4237de61b70c694f36e1956e71a2a6b39a4
* | | | Merge "image: Add 'image task list' command"Zuul2022-09-301-2/+2
|\ \ \ \
| * | | | image: Add 'image task list' commandStephen Finucane2022-09-211-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This replaces the 'glance task-list' command. $ openstack image task list We also indicate that the 'image task create' command will never be implemented. This is an admin-only API that isn't really intended to be used by humans thus it does not need an OSC command implementation. Change-Id: Id8a943a5443782fc70c0fbf3639f5aa17b9d30af
* | | | | Merge "image: Add 'image task show' commands"Zuul2022-09-301-1/+1
|\ \ \ \ \ | |/ / / / | | | | / | |_|_|/ |/| | |
| * | | image: Add 'image task show' commandslsmman2022-09-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This replaces and the 'glance task-show' command. For example: $ image task show <TASK_ID> Change-Id: I74cb23e436c373fe238804b903bbeb28f643d5af
* | | | Adding missing command mapping in docszeze2022-09-163-3/+3
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | nova command: version-list openstack command: versions show --service compute cinder command: version-list openstack command: versions show --service block-storage glance command: member-list openstack command: image member list Change-Id: I3c68dbd47dc92ed190ae9abaa90dfcddef072728
* | | Merge "Fix documents for replaced configuration name"Zuul2022-08-312-7/+7
|\ \ \
| * | | Fix documents for replaced configuration nameSnow Kim2022-08-052-7/+7
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since 4.0, '--os-url' global option is no longer supported. And this option had been replaced to '--os-endpoint' - Refer Change-Id: I1b9fbb96e447889a41b705324725a2ffc8ecfd9f - Refer Docs: doc/source/cli/backwards-incompatible.rs I fixed in documents as below - OPTIONS: '--os-url' to '--os-endpoint' - ENVIRONMENT VARIABLES: 'OS_URL' to 'OS_ENDPOINT' - and relevant sentence Change-Id: Ibb0cddf34375df941678ee07a005d81399ec7195
* | | Add router ndp proxy commandsYang JianFeng2022-08-261-0/+12
| |/ |/| | | | | | | | | Depends-on: https://review.opendev.org/749036 Change-Id: I77e12cc2dfe4000bd5ae6511878c6591f52d9791 Related-Bug: #1877301
* | Update the Nova CLI Mapping GuideYoonsoo Lim2022-07-311-1/+1
|/ | | | | | | | | | Update missing command in Mapping Guide. List of updated command [Nova CLI / OSC] instance-action-list / server event list Change-Id: I1436a6c1bdd881890e015cf0f1829c38378b36fa
* volume: Add 'block storage resource filter list' commandStephen Finucane2022-05-133-1/+10
| | | | | | | | | | | | | | | | | | | | | These are based on the 'cinder list-filters' command, which accepts an optional '--resource {resource}' option to limit the listed filters to a single resource type. block storage resource filter list block storage resource filter show We used the 'block storage resource filter' terminology rather than simply 'resource filter' to highlight the fact that this is specific to the block storage service. Note that while this feature is a bit weird, good documentation can be found at [1]. [1] https://docs.openstack.org/cinder/latest/admin/generalized_filters.html Change-Id: I21e7c0ea427aef1f6665394d4b8e9a1f30d6dbb1 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* volume: Add 'block storage cluster *' commandsStephen Finucane2022-05-133-4/+13
| | | | | | | | | | | | | | | | | These mirror the 'cinder cluster-*' commands, with arguments copied across essentially verbatim. The only significant departure is the replacement of "tenant" terminology with "project". block storage cluster list block storage cluster set block storage cluster show We used the 'block storage' terminology rather than simply 'volume' to allow us to start distinguishing between the volume service and a volume resource. Change-Id: I9105a9e4a139af4929e3b1f3a6de6c9a53e0b598 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
View Lorry Controller Status