summaryrefslogtreecommitdiff
path: root/doc/source/cli/data
Commit message (Collapse)AuthorAgeFilesLines
* 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-171-2/+2
| | | | | | | | | 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-171-1/+1
| | | | | | | | | 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-161-2/+2
| | | | | | | | | 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-161-1/+1
| | | | | | This command allows users to revert a volume to a given snapshot. Change-Id: If35ee394d654f5264558a281c835affff524ca50
* Add volume summary commandwhoami-rajat2023-01-131-1/+1
| | | | | | | | | 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 "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
* | 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>
* | 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 "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
* | 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-131-1/+1
| | | | | | | | | | | | | | | | | | | | | 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-131-4/+4
| | | | | | | | | | | | | | | | | 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>
* Add missing command mapping in novaJieonLee2021-11-211-1/+1
| | | | | | | nova command: instance-action openstack command: server event show Change-Id: I8e5dad90cfd28b1f0d65be688651918869f679e4
* Merge "Update the Nova CLI docoder document"Zuul2021-10-211-4/+4
|\
| * Update the Nova CLI docoder documentJIHOJU2021-10-071-4/+4
| | | | | | | | | | | | | | | | There are several update in CLI decoder document. - Change flavor set/unset to flavor set/unset --property - Update the mapping with flavor-update, interface-attach, and interface-detach Change-Id: I1db50188b3643d3fe28689dc73b3f63806defd29
* | Update the Nova CLI decoder documentchoidoa-git2021-10-071-15/+15
|/ | | | | | | | | | | | | | | | | | | | | | | | In this patch, Update missing command in Mapping Guide. List of updated commands (Nova CLI / OSC) - server-migration-list / server migration list - server-migration-show / server migration show - live-migration-abort / server migration abort - live-migration-force-complete / server migration force complete - migration-list / server migration list - evacuate / server evacuate - flavor-access-add / flavor set --project - flavor-access-list / flavor show - flavor-access-remove / flavor unset - server-tag-add / server set --tag - server-tag-delete / server unset --tag - server-tag-delete-all / server unset --tag - server-tag-list / server list --tag - server-tag-set / server set --tag - quota-class-show / quota show --class Change-Id: Id1b4980fbc0f6e8e58bfae6f393f9336c6a7e3b1
* volume: Add 'volume group snapshot *' commandsStephen Finucane2021-06-101-4/+4
| | | | | | | | | | | | | | These mirror the 'cinder group-snapshot-*' commands, with arguments copied across essentially verbatim. The only significant departure is the replacement of "tenant" terminology with "project". volume group snapshot create volume group snapshot delete volume group snapshot list volume group snapshot show Change-Id: Ia5084749b7c1a5a936fd6d6e8d89b9b80969f68c Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* volume: Add 'volume group type *' commandsStephen Finucane2021-06-031-8/+8
| | | | | | | | | | | | | | | | | | These mirror the 'cinder group-type-*' commands, with arguments copied across essentially verbatim. The only significant departure is the merging of some commands, such as 'group-type-default' and 'group-type-list' into 'group type list', and 'group-type-update' and 'group-type-key' into 'group type set/unset'. volume group type create volume group type delete volume group type list volume group type show volume group type set volume group type unset Change-Id: Iee6ee2f1f276e6ef6f75a74f8f2980f14c0d5e2f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* volume: Add 'volume group *' commandsStephen Finucane2021-06-031-9/+9
| | | | | | | | | | | | | | | | | | | These mirror the 'cinder group-*' commands, with arguments copied across essentially verbatim. The only significant departures are the replacement of "tenant" terminology with "project" and the merging of the various volume group replication action commands into the parent volume group (e.g. 'openstack volume group set --enable-replication' instead of 'cinder group enable-replication') volume group create volume group delete volume group list volume group show volume group set volume group failover Change-Id: I3b2c0cb92b8a53cc1c0cefa3313b80f59c9e5835 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* volume: Add missing 'volume backup *' optionsStephen Finucane2021-06-031-1/+1
| | | | | | | | | | | | | | | | | | | Add a couple of missing options to each command: volume backup create --no-incremental --property --availability-zone volume backup set --property Most of these are version dependent so we add the relevant version checks as part of this work. While we're here, we also make the formatting a little easier on the eye in places. Change-Id: I328d5c981cb32b2ee9a4b1bd43aa36b22347ff63 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* volume: Add 'volume message *' commandsStephen Finucane2021-06-031-3/+3
| | | | | | | | | | | | | This patch implements the necessary commands to utilize the Messages API introduced in Cinder API version 3.3. Version 3.5 built upon this by implementing pagination support for these commands which is present in this patch as well. volume message get volume message list volume message delete Change-Id: I64aa0b4a8d4468baa8c63e5e30ee31de68df999d
* volume: Add 'volume attachment *' commandsStephen Finucane2021-06-031-6/+6
| | | | | | | | | | | | | | | | | | | | These mirror the 'cinder attachment-*' commands, with arguments copied across essentially verbatim. The only significant departure is the replacement of "tenant" terminology with "project". volume attachment create volume attachment delete volume attachment list volume attachment complete volume attachment set volume attachment show Full support for filtering is deferred for now since that's a more complicated change that requires additional commands be added first. TODOs are included to this effect. Change-Id: If47c2b56fe65ee2cee07c000d6ae3688d5ef3b42 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Update neutronclient comparison docStephen Finucane2021-06-031-8/+26
| | | | | | | | Done manually by looking at the help text for the 'neutron' client (version 7.1.1) and identifying gaps. Change-Id: Ib029b2c236f79a0ca6f64834f069db2be4332ea8 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Update glanceclient comparison docStephen Finucane2021-06-031-0/+36
| | | | | | | | Done manually by looking at the help text for the 'glance' client (version 3.1.1) and identifying gaps. Change-Id: Ic46bbdef7182e5f707cd5083868886ce60c7eb47 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Update novaclient comparison docStephen Finucane2021-06-031-26/+11
| | | | | | | | Done manually by looking at the help text for the 'nova' client (version 17.0.0) and identifying gaps. Change-Id: I23a4947a13d5e576c5aa66902686df60379ffda0 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Update cinderclient comparison docStephen Finucane2021-06-031-104/+146
| | | | | | | | Done manually by looking at the help text for the 'cinder' client (version 7.0.0) and identifying gaps. Change-Id: Ib16c7e9dfa47a93d8b077f0e3e5bbd5bf8984ec3 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* 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 "Remove deprecated image commands"Zuul2019-06-211-24/+24
|\
| * Remove deprecated image commandsDean Troyer2019-05-191-24/+24
| | | | | | | | | | | | | | * Remove ``image create|set`` option ``--owner`` Change-Id: I1fabab98c8660eba6d0dd75e74544c6c9d432b9e Signed-off-by: Dean Troyer <dtroyer@gmail.com>
* | Merge "Compute: Add description support for server"Zuul2019-06-051-1/+2
|\ \ | |/ |/|
View Lorry Controller Status