cinder/doc/source/cli
Alan Bishop d59e41fb3c Add support for transferring encrypted volumes
A new microversion 3.70 adds the ability to transfer a volume's
encryption key when transferring a volume to another project.

When the volume transfer is initiated, the volume's encryption
secret is essentially transferred to the cinder service.
- The cinder service creates a new encryption_key_id that contains
  a copy of the volume's encryption secret.
- The volume (and its snapshots) is updated with the new
  encryption_key_id (the one owned by the cinder service).
- The volume's original encryption_key_id (owned by the volume's
  owner) is deleted.

When the transfer is accepted, the secret is transferred to the
user accepting the transfer.
- A new encryption_key_id is generated on behalf of the new user
  that contains a copy of the volume's encryption secret.
- The volume (and its snapshots) is updated with the new
  encryption_key_id (the one owned by the user).
- The intermediate encryption_key_id owned by the cinder service
  is deleted.

When a transfer is cancelled (deleted), the same process is used
to transfer ownship back to the user that cancelled the transfer.

Implements: blueprint transfer-encrypted-volume
Change-Id: I459f06504e90025c9c0b539981d3d56a2a9394c7
2022-08-26 06:32:41 -07:00
..
cinder-manage.rst Add cinder-manage command to remove file locks 2021-08-04 14:42:29 +00:00
cinder-status.rst Fix duplicated words issue like " should should " 2020-01-06 10:53:18 +08:00
cli-cinder-quotas.rst Docs: Make links more robust 2019-08-10 10:49:23 +02:00
cli-cinder-scheduling.rst Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
cli-manage-volumes.rst Add support for transferring encrypted volumes 2022-08-26 06:32:41 -07:00
cli-set-quotas.rst Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
index.rst Base framework for cinder-status upgrade check 2018-10-17 11:51:04 -04:00
README.rst [Docs] Add documentation contribution docs 2017-08-10 15:52:46 -05:00

Cinder CLI Documentation (source/cli)

Introduction:

This directory is intended to hold any documentation that relates to Cinder's Command Line Interface. Note that this directory is intended for basic descriptions of the commands supported, similar to what you would find with a 'man page'. Tutorials or step-by-step guides should go into 'doc/source/admin' or 'doc/source/user' depending on the target audience.

The full spec for organization of documentation may be seen in the OS Manuals Migration Spec <https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html>.