Bug 1802412

Summary:	Block Storage Backup Guide should use OpenStack CLI commands instead of cinder CLI commands where possible
Product:	Red Hat OpenStack	Reporter:	Darin Sorrentino <dsorrent>
Component:	documentation	Assignee:	Ian Frangs <ifrangs>
Status:	CLOSED COMPLETED	QA Contact:	RHOS Documentation Team <rhos-docs>
Severity:	low	Docs Contact:
Priority:	low
Version:	16.0 (Train)	CC:	amoralej, ifrangs, lmarsh, senrique
Target Milestone:	---	Keywords:	Documentation
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2023-07-28 04:35:09 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:	1713701
Bug Blocks:

Description Darin Sorrentino 2020-02-13 05:41:02 UTC

Description of problem:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/block_storage_backup_guide/index

Throughout this document, the cinder commands should be updated to use the openstack CLI:

OLD: cinder list
NEW: openstack volume list

OLD: cinder backup-create _VOLUME_
NEW: openstack volume backup create _VOLUME_

OLD: cinder backup-list
NEW: openstack volume backup list

OLD: cinder --os-auth-url _KEYSTONEURL_ --os-tenant-name _TENANTNAME_ --os-username _USERNAME_ --os-password _PASSWD_ backup-create _VOLUME_
NEW: openstack --os-auth-url _KEYSTONEURL_ --os-project-name _TENANTNAME_ --os-username _USERNAME_ --os-password _PASSWD_ volume backup create _VOLUME_

OLD: cinder backup-export _BACKUPID_
NEW: Command currently does not have a unified CLI equivalent.

3.1.4

This section talks about forcing a backup of an in-use volume, however, the example also includes the --incremental flag which is not necessary to force a volume backup.

cinder backup-create _VOLUME_ --incremental --force

To avoid confusion, I'd recommend removing the --incremental flag from the example -OR- adding to the documentation that this example is also performing an incremental backup as opposed to a full backup.

OLD: cinder backup-create _VOLUME_ --incremental --force
NEW: openstack volume backup create --force --incremental _VOLUME_

OLD: cinder snapshot-list --volume-id _VOLUME_ID_
NEW: openstack volume snapshot list --volume [_VOLUME_NAME_ or _VOLUME_ID_]

OLD: cinder snapshot-show _SNAPSHOT_NAME_
NEW: openstack volume snapshot show [_SNAPSHOT_NAME_ or _SNAPSHOT_ID_]

OLD: cinder backup-create _VOLUME_ --snapshot-id=_SNAPSHOT_ID_
NEW: openstack volume backup create --snapshot [_SNAPSHOT_NAME_ or _SNAPSHOT_ID_] _VOLUME_ 

OLD:  cinder backup-create _VOLUME_ --incremental
NEW: openstack volume backup create --incremental _VOLUME_

OLD: cinder quota-show TENANT_ID
NEW: openstack quota show [_PROJECT_ID_ or _PROJECT_NAME_]

OLD: cinder quota-update --backups MAXNUM TENANT_ID
NEW: openstack quota set --backups MAXNUM TENANT_ID

OLD: cinder quota-update --backup-gigabytes MAXGB TENANT_ID
NEW: openstack quota set --backup-gigabytes MAXGB TENANT_ID

OLD: cinder quota-usage TENANT_ID
NEW: There is no new command for this, however, when I executed this command
after creating a couple backups, the In_use shows 0.

OLD: cinder backup-list
NEW: openstack volume backup list

OLD: cinder backup-restore _BACKUP_ID_
NEW: There's no equivalent command to this.  This creates a new volume from the backup.

OLD: cinder backup-delete _BACKUP_ID_
NEW: openstack volume backup delete _BACKUP_ID_

OLD: cinder backup-restore _BACKUP_ID --volume VOLUME_ID_
NEW: openstack volume backup restore _BACKUP_ID_ _VOLUME_
** The document should be updated to state that a restore can not be performed on an attached volume.

Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 3 Ian Frangs 2022-12-13 15:48:54 UTC

I will look at addressing these in the 17.0 Block Storage Backup Guide and replacing all those commands with their openstack client counterparts for those cinder CLI commands that have them.