python-openstackclient/doc
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
..
source doc: Update nova command mapping 2023-02-21 12:31:11 +00:00
test image: autogenerate docs 2020-06-08 16:34:28 -05:00
Makefile Move docs to doc. 2012-06-11 14:37:48 -07:00
requirements.txt Add plugin doc page for cyborg 2022-12-20 12:33:00 +00:00