Skip to content

Commit

Permalink
feat: Add reference information for volume types, fix related howto
Browse files Browse the repository at this point in the history
In the reference section, add a new subsection about volume types.
Explain the cbs and cbs-encrypted volume types, their encryption
support, and quality-of-service (QoS) caps.

In addition, update the volume encryption how-to guide to also refer
to the updated type names.
  • Loading branch information
fghaas committed Jun 7, 2024
1 parent 0f36a78 commit 54b2926
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/howto/openstack/cinder/encrypted-volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ $ openstack volume type list
+--------------------------------------+-----------------------+-----------+
| ID | Name | Is Public |
+--------------------------------------+-----------------------+-----------+
| a479a6b0-b283-41a5-b38b-5b08e7f902ca | volumes_hdd_encrypted | True |
| a479a6b0-b283-41a5-b38b-5b08e7f902ca | cbs-encrypted | True |
| d9dfa98a-238d-4ca0-9abf-701fceb05623 | __DEFAULT__ | True |
| 86796611-fb12-4628-b6b1-e09469e301d7 | volumes_hdd | True |
| 86796611-fb12-4628-b6b1-e09469e301d7 | cbs | True |
+--------------------------------------+-----------------------+-----------+
```

Expand All @@ -31,12 +31,12 @@ $ openstack volume type list
To create a volume with encryption, you need to explicitly specify the
`--type` option to the `openstack volume create` command. The
following example creates a volume using the `volumes_hdd_encrypted`
following example creates a volume using the `cbs-encrypted`
type, naming it `enc_drive` and setting its size to 10 GiB:

```console
$ openstack volume create \
--type volumes_hdd_encrypted \
--type cbs-encrypted \
--size 10 \
enc_drive
+---------------------+--------------------------------------+
Expand All @@ -58,7 +58,7 @@ $ openstack volume create \
| snapshot_id | None |
| source_volid | None |
| status | creating |
| type | volumes_hdd_encrypted |
| type | cbs-encrypted |
| updated_at | None |
| user_id | 966ad341f4e14920b5f589f900246ccc |
+---------------------+--------------------------------------+
Expand Down
1 change: 1 addition & 0 deletions docs/reference/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ nav:
- features
- limitations
- flavors
- volumes
- images
- quotas
- versions
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ It serves to provide general reference information about {{brand}} services.

* The **[Flavors](flavors/index.md)** reference explains our naming convention for pre-defined CPU/RAM/disk configurations ("flavors") for server instances, and their availability across {{brand}} regions.

* The **[Volume Types](volumes/index.md)** reference lists the available persistent block storage ("volume") types.

* Our **[Service Version Matrix](versions/index.md)** lists the open source software versions running in our {{brand}} regions.

## API reference
Expand Down
15 changes: 15 additions & 0 deletions docs/reference/volumes/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Volume types

The following volume types are available in {{brand}} for persistent block storage devices ("volumes") managed by OpenStack Cinder.

If you create a volume without specifying a volume type, then the default volume type applies.

The maximum IOPS specification is essentially a cap, which creates an upper bound for individual device performance under *ideal* conditions.
Actual IOPS may vary based on system load and utilization.

| Volume type name | Default | [Encryption](../../howto/openstack/cinder/encrypted-volumes.md) | max IOPS |
| ------------------------------ | ----- | ----- | ----- |
| `cbs` | :material-check: | :material-close: | 10000 |
| `cbs-encrypted` | :material-close: | :material-check: | 10000 |

It is possible --- though somewhat involved --- to [change the type of an existing volume](../../howto/openstack/cinder/retype-volumes.md) (also known as retyping).

0 comments on commit 54b2926

Please sign in to comment.