Commit graph

19 commits

Author SHA1 Message Date
Stephen Finucane
674e4e620b doc: Update nova command mapping
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>
2023-02-21 12:31:11 +00:00
Zuul
eac38feef0 Merge "quota: Add 'quota delete' command" 2022-10-07 16:37:20 +00:00
Zuul
ec43d63182 Merge "docs: Add missing command mappings" 2022-09-30 12:31:55 +00:00
Stephen Finucane
45bec041b2 quota: Add 'quota delete' command
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>
2022-09-30 10:54:11 +01:00
zeze
a9b9252da3 Adding missing command mapping in docs
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
2022-09-16 01:28:46 +09:00
Yoonsoo Lim
e6adf37d12 Update the Nova CLI Mapping Guide
Update missing command in Mapping Guide.

List of updated command
[Nova CLI / OSC]
instance-action-list / server event list

Change-Id: I1436a6c1bdd881890e015cf0f1829c38378b36fa
2022-07-31 14:20:22 +09:00
Stephen Finucane
722d3216a4 docs: Add missing command mappings
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>
2022-07-07 13:47:53 +01:00
JieonLee
b3d09ffc37 Add missing command mapping in nova
nova command: instance-action
openstack command: server event show

Change-Id: I8e5dad90cfd28b1f0d65be688651918869f679e4
2021-11-21 05:05:25 +00:00
Zuul
c985e0a23b Merge "Update the Nova CLI docoder document" 2021-10-21 10:23:23 +00:00
JIHOJU
e06a4f1c20 Update the Nova CLI docoder document
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
2021-10-07 21:03:25 +09:00
choidoa-git
70fed75c85 Update the Nova CLI decoder document
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
2021-10-07 10:40:15 +00:00
Stephen Finucane
3751f1fdb6 docs: Update novaclient comparison doc
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>
2021-06-03 15:52:18 +01:00
Stephen Finucane
64c2a1a453 Add 'server shelve --offload', 'server shelve --wait' options
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>
2021-01-08 18:01:25 +00:00
Yongli He
f200799848 compute: Add 'server show --topology' option
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
2021-01-06 12:02:25 +00:00
Chen
c77a9621be Compute: Add description support for server
This patch adds functionality to configure server's description with:
1 server create
2 server set
3 server unset
4 server rebuild

Change-Id: Ic06d97b29e51828b29d7ac5172645c288e4ada9e
Story: 2002005
Task: 19640
2019-05-17 20:56:45 +00:00
Chen
29ca9904fc Fix inconsistency (nit)
Word choice of description for "host-evacuate-live" is slightly
different from that in novaclient ("migrate of" instead of "migrate off").
https://github.com/openstack/python-novaclient/blob/master/doc/source/cli/nova.rst#nova-host-evacuate-live
They are supposed to be exactly the same, so use "migrate off" to
keep consistent.

Change-Id: Ie54c6ed83b6e9a3116e1832b3fb36dd80781366d
2018-08-10 14:24:23 +08:00
Jens Harbott
30b2203dc7 Add help for nova interface-list to decoder
Running "openstack port list --server <id>" is a good replacement for
"nova interface-list <id>", add it to the decoder.

Change-Id: I656e190f4da59d9c57e9ab97d068a8a0dbd77774
2018-04-09 13:12:30 +00:00
wingwj
2b7cb1559b Remove inaccurate mapping of 'host-meta' in csv
Now we don't have a similar command to 'nova host-meta' in osc,
the 'host set/unset' in osc is used to manage host properties.
Need to remove the inaccurate mapping in nova.csv.

Change-Id: I291174a29c8e3419b62d47264dedf176262a816c
Closes-Bug: #1690902
2017-06-29 16:54:59 +08:00
Doug Hellmann
9599ffe65d reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:54:32 +02:00
Renamed from doc/source/data/nova.csv (Browse further)