From 0770da095f9033f8e5613f2681cfd27cff6545e4 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Mon, 29 May 2023 12:21:51 +0100 Subject: [PATCH] docs: Migrate docs from cinderclient to OSC (part 1) Fix a couple of outdated references along the way. Change-Id: I9a7fb660bfd622ccdfb40bc6936493c87f6a1d25 Signed-off-by: Stephen Finucane --- doc/source/admin/volume-backups.rst | 2 +- doc/source/admin/volume-multiattach.rst | 6 +- doc/source/cli/cli-cinder-quotas.rst | 90 ++++++--------- doc/source/cli/cli-manage-volumes.rst | 146 +++++++++++------------- 4 files changed, 102 insertions(+), 142 deletions(-) diff --git a/doc/source/admin/volume-backups.rst b/doc/source/admin/volume-backups.rst index b3afd0916fb..30bd36bcb0a 100644 --- a/doc/source/admin/volume-backups.rst +++ b/doc/source/admin/volume-backups.rst @@ -158,7 +158,7 @@ Run this command to restore the state of a backup: .. code-block:: console - $ cinder backup-reset-state [--state STATE] BACKUP_ID-1 BACKUP_ID-2 ... + $ openstack volume backup set --state BACKUP Run this command to create a backup of a snapshot: diff --git a/doc/source/admin/volume-multiattach.rst b/doc/source/admin/volume-multiattach.rst index 25fcfa99167..7f0a7730514 100644 --- a/doc/source/admin/volume-multiattach.rst +++ b/doc/source/admin/volume-multiattach.rst @@ -54,8 +54,8 @@ volume type the following way: .. code-block:: console - $ cinder type-create multiattach - $ cinder type-key multiattach set multiattach=" True" + $ openstack volume type create multiattach + $ openstack volume type set --property multiattach=" True" multiattach .. note:: @@ -69,7 +69,7 @@ this: .. code-block:: console - $ cinder create --name --volume-type + $ openstack volume create --size 10 --type multiattach my-volume In addition, it is possible to retype a volume to be (or not to be) multiattach capable. Currently however we only allow retyping a volume if its status is diff --git a/doc/source/cli/cli-cinder-quotas.rst b/doc/source/cli/cli-cinder-quotas.rst index 4c2ec7435cd..b5c1d72e4be 100644 --- a/doc/source/cli/cli-cinder-quotas.rst +++ b/doc/source/cli/cli-cinder-quotas.rst @@ -88,69 +88,47 @@ Administrative users can view Block Storage service quotas. .. code-block:: console - $ openstack quota show $PROJECT_ID + $ openstack quota show --volume $PROJECT_ID +-----------------------+-------+ - | Field | Value | + | Resource | Limit | +-----------------------+-------+ - | backup-gigabytes | 1000 | - | backups | 10 | - | cores | 20 | - | fixed-ips | -1 | - | floating-ips | 50 | - | gigabytes | 1000 | - | gigabytes_lvmdriver-1 | -1 | - | health_monitors | None | - | injected-file-size | 10240 | - | injected-files | 5 | - | injected-path-size | 255 | - | instances | 10 | - | key-pairs | 100 | - | l7_policies | None | - | listeners | None | - | load_balancers | None | - | location | None | - | name | None | - | networks | 10 | - | per-volume-gigabytes | -1 | - | pools | None | - | ports | 50 | - | project | None | - | project_id | None | - | properties | 128 | - | ram | 51200 | - | rbac_policies | 10 | - | routers | 10 | - | secgroup-rules | 100 | - | secgroups | 10 | - | server-group-members | 10 | - | server-groups | 10 | - | snapshots | 10 | - | snapshots_lvmdriver-1 | -1 | - | subnet_pools | -1 | - | subnets | 10 | - | volumes | 10 | - | volumes_lvmdriver-1 | -1 | + | volumes | 10 | + | snapshots | 10 | + | gigabytes | 1000 | + | backups | 10 | + | volumes_lvmdriver-1 | -1 | + | gigabytes_lvmdriver-1 | -1 | + | snapshots_lvmdriver-1 | -1 | + | volumes___DEFAULT__ | -1 | + | gigabytes___DEFAULT__ | -1 | + | snapshots___DEFAULT__ | -1 | + | groups | 10 | + | backup-gigabytes | 1000 | + | per-volume-gigabytes | -1 | +-----------------------+-------+ - #. Show the current usage of a per-project quota: .. code-block:: console - $ cinder quota-usage $PROJECT_ID - +-----------------------+--------+----------+-------+ - | Type | In_use | Reserved | Limit | - +-----------------------+--------+----------+-------+ - | backup_gigabytes | 0 | 0 | 1000 | - | backups | 0 | 0 | 10 | - | gigabytes | 0 | 0 | 1000 | - | gigabytes_lvmdriver-1 | 0 | 0 | -1 | - | per_volume_gigabytes | 0 | 0 | -1 | - | snapshots | 0 | 0 | 10 | - | snapshots_lvmdriver-1 | 0 | 0 | -1 | - | volumes | 0 | 0 | 10 | - | volumes_lvmdriver-1 | 0 | 0 | -1 | - +-----------------------+--------+----------+-------+ + $ openstack quota show --volume --usage $PROJECT_ID + +-----------------------+-------+--------+----------+ + | Resource | Limit | In Use | Reserved | + +-----------------------+-------+--------+----------+ + | volumes | 10 | 1 | 0 | + | snapshots | 10 | 0 | 0 | + | gigabytes | 1000 | 1 | 0 | + | backups | 10 | 0 | 0 | + | volumes_lvmdriver-1 | -1 | 1 | 0 | + | gigabytes_lvmdriver-1 | -1 | 1 | 0 | + | snapshots_lvmdriver-1 | -1 | 0 | 0 | + | volumes___DEFAULT__ | -1 | 0 | 0 | + | gigabytes___DEFAULT__ | -1 | 0 | 0 | + | snapshots___DEFAULT__ | -1 | 0 | 0 | + | groups | 10 | 0 | 0 | + | backup-gigabytes | 1000 | 0 | 0 | + | per-volume-gigabytes | -1 | 0 | 0 | + +-----------------------+-------+--------+----------+ Edit and update Block Storage service quotas @@ -245,4 +223,4 @@ service quotas. .. code-block:: console - $ cinder quota-delete $PROJECT_ID + $ openstack quota delete --volume $PROJECT_ID diff --git a/doc/source/cli/cli-manage-volumes.rst b/doc/source/cli/cli-manage-volumes.rst index a317f47cadf..bd7864614ec 100644 --- a/doc/source/cli/cli-manage-volumes.rst +++ b/doc/source/cli/cli-manage-volumes.rst @@ -27,13 +27,12 @@ This example creates a ``my-new-volume`` volume based on an image. | 4b227119-68a1-4b28-8505-f94c6ea4c6dc | cirros-0.3.5-x86_64-uec-ramdisk | +--------------------------------------+---------------------------------+ - #. List the availability zones, and note the ID of the availability zone in which you want to create your volume: .. code-block:: console - $ openstack availability zone list + $ openstack availability zone list --volume +-----------+-------------+ | Zone Name | Zone Status | +-----------+-------------+ @@ -85,7 +84,6 @@ This example creates a ``my-new-volume`` volume based on an image. | bab4b0e0-ce3d-4d57-bf57-3c51319f5202 | my-new-volume | available | 8 | | +--------------------------------------+---------------+-----------+------+-------------+ - If your volume was created successfully, its status is ``available``. If its status is ``error``, you might have exceeded your quota. @@ -101,7 +99,6 @@ volume creation. #. cinder_img_volume_type (via glance image metadata) #. default volume type (via project defaults or cinder.conf) - volume-type ^^^^^^^^^^^ @@ -109,17 +106,7 @@ User can specify `volume type` when creating a volume. .. code-block:: console - $ openstack volume create -h -f {json,shell,table,value,yaml} - -c COLUMN --max-width - --noindent --prefix PREFIX --size - --type --image - --snapshot --source - --description --user - --project - --availability-zone - --property - - + $ openstack volume create --type ... cinder_img_volume_type ^^^^^^^^^^^^^^^^^^^^^^ @@ -132,71 +119,67 @@ a volume from the image. .. code-block:: console - $ openstack image list - +----------------------------------+---------------------------------+--------+ - | ID | Name | Status | - +----------------------------------+---------------------------------+--------+ - | 376bd633-c9c9-4c5d-a588-342f4f66 | cirros-0.3.5-x86_64-uec | active | - | d086 | | | - | 2c20fce7-2e68-45ee-ba8d- | cirros-0.3.5-x86_64-uec-ramdisk | active | - | beba27a91ab5 | | | - | a5752de4-9faf-4c47-acbc- | cirros-0.3.5-x86_64-uec-kernel | active | - | 78a5efa7cc6e | | | - +----------------------------------+---------------------------------+--------+ + $ openstack image list + +--------------------------------------+---------------------------------+--------+ + | ID | Name | Status | + +--------------------------------------+---------------------------------+--------+ + | 376bd633-c9c9-4c5d-a588-342f4f66d086 | cirros-0.3.5-x86_64-uec | active | + | 2c20fce7-2e68-45ee-ba8d-beba27a91ab5 | cirros-0.3.5-x86_64-uec-ramdisk | active | + | a5752de4-9faf-4c47-acbc-78a5efa7cc6e | cirros-0.3.5-x86_64-uec-kernel | active | + +--------------------------------------+---------------------------------+--------+ + $ openstack image show 376bd633-c9c9-4c5d-a588-342f4f66d086 + +------------------------+------------------------------------------------------+ + | Field | Value | + +------------------------+------------------------------------------------------+ + | checksum | eb9139e4942121f22bbc2afc0400b2a | + | cinder_img_volume_type | nfstype | + | container_format | ami | + | created_at | 2016-10-13T03:28:55Z | + | disk_format | ami | + | file | /v2/images/376bd633-c9c9-4c5d-a588-342f4f66d086/file | + | id | 376bd633-c9c9-4c5d-a588-342f4f66d086 | + | min_disk | 0 | + | min_ram | 0 | + | name | cirros-0.3.5-x86_64-uec | + | owner | 88ba456e3a884c318394737765e0ef4d | + | properties | kernel_id='a5752de4-9faf-4c47-acbc-78a5efa7cc6e', | + | | ramdisk_id='2c20fce7-2e68-45ee-ba8d-beba27a91ab5' | + | protected | False | + | schema | /v2/schemas/image | + | size | 25165824 | + | status | active | + | tags | | + | updated_at | 2016-10-13T03:28:55Z | + | virtual_size | None | + | visibility | public | + +------------------------+------------------------------------------------------+ - $ openstack image show 376bd633-c9c9-4c5d-a588-342f4f66d086 - +------------------------+------------------------------------------------------+ - | Field | Value | - +------------------------+------------------------------------------------------+ - | checksum | eb9139e4942121f22bbc2afc0400b2a | - | cinder_img_volume_type | nfstype | - | container_format | ami | - | created_at | 2016-10-13T03:28:55Z | - | disk_format | ami | - | file | /v2/images/376bd633-c9c9-4c5d-a588-342f4f66d086/file | - | id | 376bd633-c9c9-4c5d-a588-342f4f66d086 | - | min_disk | 0 | - | min_ram | 0 | - | name | cirros-0.3.5-x86_64-uec | - | owner | 88ba456e3a884c318394737765e0ef4d | - | properties | kernel_id='a5752de4-9faf-4c47-acbc-78a5efa7cc6e', | - | | ramdisk_id='2c20fce7-2e68-45ee-ba8d-beba27a91ab5' | - | protected | False | - | schema | /v2/schemas/image | - | size | 25165824 | - | status | active | - | tags | | - | updated_at | 2016-10-13T03:28:55Z | - | virtual_size | None | - | visibility | public | - +------------------------+------------------------------------------------------+ - - $ openstack volume create --image 376bd633-c9c9-4c5d-a588-342f4f66d086 \ - --size 1 --availability-zone nova test - +---------------------+--------------------------------------+ - | Field | Value | - +---------------------+--------------------------------------+ - | attachments | [] | - | availability_zone | nova | - | bootable | false | - | consistencygroup_id | None | - | created_at | 2016-10-13T06:29:53.688599 | - | description | None | - | encrypted | False | - | id | e6e6a72d-cda7-442c-830f-f306ea6a03d5 | - | multiattach | False | - | name | test | - | properties | | - | replication_status | disabled | - | size | 1 | - | snapshot_id | None | - | source_volid | None | - | status | creating | - | type | nfstype | - | updated_at | None | - | user_id | 33fdc37314914796883706b33e587d51 | - +---------------------+--------------------------------------+ + $ openstack volume create --image 376bd633-c9c9-4c5d-a588-342f4f66d086 \ + --size 1 --availability-zone nova test + +---------------------+--------------------------------------+ + | Field | Value | + +---------------------+--------------------------------------+ + | attachments | [] | + | availability_zone | nova | + | bootable | false | + | consistencygroup_id | None | + | created_at | 2016-10-13T06:29:53.688599 | + | description | None | + | encrypted | False | + | id | e6e6a72d-cda7-442c-830f-f306ea6a03d5 | + | multiattach | False | + | name | test | + | properties | | + | replication_status | disabled | + | size | 1 | + | snapshot_id | None | + | source_volid | None | + | status | creating | + | type | nfstype | + | updated_at | None | + | user_id | 33fdc37314914796883706b33e587d51 | + +---------------------+--------------------------------------+ default volume type ^^^^^^^^^^^^^^^^^^^ @@ -209,9 +192,9 @@ default_volume_type) can be checked with the following command: .. code-block:: console - $ cinder type-default + $ openstack volume type list --default -There are 2 ways to set the default volume type: +There are two ways to set the default volume type: 1) Project specific defaults 2) default_volume_type defined in cinder.conf @@ -232,14 +215,13 @@ configured in cinder.conf is used to create volumes. Example cinder.conf file configuration. -.. code-block:: console +.. code-block:: ini [default] default_volume_type = lvmdriver-1 .. _Attach_a_volume_to_an_instance: - Attach a volume to an instance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~