Commit graph

1554 commits

Author SHA1 Message Date
Shogo Saito
7f89b109cf Add plugin doc page for cyborg
This patch add cyborg (accelerator) doc page.

Change-Id: I0f3e5419ce522e620be805c0fcd829c8dfb2e317
2022-12-20 12:33:00 +00:00
Zuul
34bf2533a7 Merge "Updating the glanceclient reference doc" 2022-12-15 17:45:25 +00:00
Mridula Joshi
576e9a01a5 Updating the glanceclient reference doc
Added the missing commands from glanceclient, updated the OSC
equivalent and removed the deprecated commands.

Change-Id: I3cee7882f6712e80c6f6e568337c1f96439aa1a5
2022-12-06 07:45:34 +00:00
Zuul
29129a7715 Merge "image: Add 'image import' command" 2022-12-05 12:59:52 +00:00
Stephen Finucane
4cf22b3d76 docs: Fix typos
Change-Id: I902e8b35d4423f91dd8cdeecbcc7e60af877da75
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-12-05 10:18:56 +00:00
Stephen Finucane
199ba0bcf8 docs: Document how we manage API versions
Document that microversion auto-negotiation is acceptable. Heck, it's
downright desirable.

Change-Id: Ib256e064d1e8b6dc8273e482276dce243f9991cb
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-11-30 12:07:33 +00:00
Stephen Finucane
bb5b290478 docs: Describe common actions found in OSC
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>
2022-11-30 12:07:33 +00:00
Stephen Finucane
948198643f docs: Typo fix
Change-Id: I2d55747b1226207946f80f04b80b4685e3eea3f9
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-11-25 17:28:50 +00:00
Stephen Finucane
abf1a7cc4b docs: Small cleanup of human interface guide
Before we add more content.

Change-Id: I6cf28bdd217326db991466a21221b685124d4b99
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-11-24 13:02:10 +00:00
Stephen Finucane
4eea3408dc image: Add 'image import' command
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>
2022-11-09 16:51:54 +00:00
Stephen Finucane
1fb8d1f48b image: Add 'image stage' command
This is the equivalent of the 'image-stage' glanceclient command.

Change-Id: I10b01ef145740a2f7ffe5a8c7ce0296df0ece0bd
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-11-09 16:51:54 +00:00
Zuul
ccd9356550 Merge "quota: Add 'quota show --usage' option" 2022-10-12 11:22:09 +00:00
Zuul
8be0c641e1 Merge "quota: Add support for detailed volume quotas" 2022-10-07 17:05:55 +00:00
Zuul
eac38feef0 Merge "quota: Add 'quota delete' command" 2022-10-07 16:37:20 +00:00
Zuul
7d67a0be7f Merge "doc: Update cinder command mapping" 2022-10-07 16:32:15 +00:00
Zuul
71ef203cc6 Merge "Remove invalid note from requirements files" 2022-10-05 17:08:23 +00:00
Zuul
ec43d63182 Merge "docs: Add missing command mappings" 2022-09-30 12:31:55 +00:00
Zuul
db3610b533 Merge "remove unicode prefix from code" 2022-09-30 12:01:24 +00:00
Zuul
46ead4abea Merge "image: Add 'image task list' command" 2022-09-30 11:59:21 +00:00
Zuul
97af1b661e Merge "image: Add 'image task show' commands" 2022-09-30 11:59:18 +00:00
Stephen Finucane
04e68e0d5a quota: Add 'quota show --usage' option
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>
2022-09-30 12:40:15 +01:00
Stephen Finucane
44443f7856 quota: Add support for detailed volume quotas
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>
2022-09-30 10:55:47 +01: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
Stephen Finucane
bfdf900d0a doc: Update cinder command mapping
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>
2022-09-30 10:53:31 +01:00
Stephen Finucane
c9d445fc4b image: Add 'image task list' command
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
2022-09-21 10:43:35 +01:00
lsmman
d163a20904 image: Add 'image task show' commands
This replaces and the 'glance task-show' command. For example:

  $ image task show <TASK_ID>

Change-Id: I74cb23e436c373fe238804b903bbeb28f643d5af
2022-09-21 10:34:15 +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
Zuul
5cf8f37a93 Merge "Fix documents for replaced configuration name" 2022-08-31 02:34:31 +00:00
Yang JianFeng
b36cd0f4c0 Add router ndp proxy commands
Depends-on: https://review.opendev.org/749036
Change-Id: I77e12cc2dfe4000bd5ae6511878c6591f52d9791
Related-Bug: #1877301
2022-08-26 08:15:43 +08:00
Stephen Finucane
8b0e467355 Remove invalid note from requirements files
This isn't true with the new dependency resolver introduced in pip 20.3.

Change-Id: Ie28fe625663c960fbffa12efb1503b8c9f8c0581
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-08-24 11:03:52 +01:00
niuke
dd648dcb5c remove unicode prefix from code
Change-Id: I0b1ca4237de61b70c694f36e1956e71a2a6b39a4
2022-08-15 12:20:20 +08:00
Snow Kim
701dd67d6c Fix documents for replaced configuration name
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
2022-08-05 19:51:32 +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
Stephen Finucane
53a7e67b41 volume: Add 'block storage resource filter list' command
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>
2022-05-13 12:42:16 +01:00
Stephen Finucane
d727a65023 volume: Add 'block storage cluster *' commands
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>
2022-05-13 11:59:23 +01:00
Zuul
f7eaaa8408 Merge "docs: Document additional 'server migration' commands" 2022-02-09 20:42:40 +00:00
Zuul
27843fc232 Merge "Add missing command mapping in nova" 2022-02-09 12:50:18 +00:00
Stephen Finucane
9c5220c97b docs: Document additional 'server migration' commands
Only 'server migration list' was being documented.

Change-Id: I038ff2bcf7bb852d619004bb00306d2d388135a7
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-02-08 15:27:58 +00:00
Nurmatov Mamatisa
26144743d9 Support Neutron Local IP CRUD
Add support for Neutron Local IP CRUD operations.

Partial-Bug: #1930200
Depends-On: https://review.opendev.org/c/openstack/neutron/+/804523
Depends-On: https://review.opendev.org/c/openstack/openstacksdk/+/804988
Change-Id: I1095100efb27b8559412469f0a9d07fc0a3db9d5
2022-01-28 17:24:04 +03:00
Dr. Jens Harbott
860d636047 Temporarily drop aodhclient from doc build
Building plugin documentation is failing for aodhclient when running
with latest pyparsing. Drop the plugin from docs for now until the issue
can be fixed.

Needed-By: https://review.opendev.org/c/openstack/requirements/+/818614/
Signed-off-by: Dr. Jens Harbott <harbott@osism.tech>
Change-Id: I1cc1efd9ff2004dd711ed9da0b1d9e8be31175f4
2021-11-24 06:51:17 +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
ryanKor
c0a0f0f3d8 Fix that the path of functional test
before change:
$ tox -e functional -- --regex functional.tests.compute.v2.test_server
after change:
$ tox -e functional -- --regex tests.functional.compute.v2.test_server

the test unit path document should be change the above line.

(fixed wrong letter)

Change-Id: I49674fb0d56ee65c1f6328b9d960b16876173e2d
2021-09-25 21:34:47 +09:00
Zuul
2dfaf62340 Merge "Update volume create documentation" 2021-08-19 04:32:51 +00:00
Zuul
3f3d8829ce Merge "volume: Add 'volume group snapshot *' commands" 2021-06-21 13:09:41 +00:00
Zuul
6abfb01895 Merge "volume: Add 'volume group type *' commands" 2021-06-21 13:09:36 +00:00
Zuul
87369984d1 Merge "volume: Add 'volume group *' commands" 2021-06-18 18:05:39 +00:00