Bug 1609554 - [Doc][Storage]Cinder backup Google_cloud_backup_guide - needs an update
Summary: [Doc][Storage]Cinder backup Google_cloud_backup_guide - needs an update
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 14.0 (Rocky)
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Kim Nylander
QA Contact: RHOS Documentation Team
URL:
Whiteboard:
Depends On: 1658306
Blocks: 1539297
TreeView+ depends on / blocked
 
Reported: 2018-07-29 11:54 UTC by Tzach Shefi
Modified: 2019-01-02 14:37 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-01-02 14:37:20 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Tzach Shefi 2018-07-29 11:54:03 UTC
Description of problem:  Following OSP13's guide:
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html-single/google_cloud_backup_guide/

Two problems
1. Chapter 3. step 6
"Copy the key file to /etc/cinder/ on any Controller node." 
This is misleading it ignores that fact that since OPS13 Cinder is has been dockerized such that /etc/cinder/ on controller won't help/work. 
Even more confusing is the fact that under my controller there is no /etc/cinder.. 

This is true only if you login cinder volume docker (I assume not sure)
Once inside the docker /etc/cinder is the correct place to save file

Once I logged out of docker and looked for the file (in my case gbackup.json)

[root@controller-0 ~]# find / -name gbackup.json
/var/lib/docker/overlay2/23206e451a40716f61e32b88fafd60a6cd794425607812ba4c4c3394571af666/diff/etc/cinder/gbackup.json
/var/lib/docker/overlay2/23206e451a40716f61e32b88fafd60a6cd794425607812ba4c4c3394571af666/merged/etc/cinder/gbackup.json


2. The current described flow of the guide, assumes an overcloud is already deployed, hence we are instructed to add stuff on /etc/cinder on controller. 

This might change in the future once we add tripleo heat support follow this bz1601211. Create Google auth+yaml(ch4) before overcloud is deployed.


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


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 1 Tzach Shefi 2018-07-29 12:53:27 UTC
Suspect (not 100% sure) correct path for Google auth json should probably be:
/var/lib/config-data/puppet-generated/cinder/etc/cinder/

If this is correct /etc/cinder should be replaced. 
Also on fix ownership/permissions command as well as on rsycn path.

Comment 2 Tzach Shefi 2018-07-29 12:58:49 UTC
If my file path assumption is correct. 
Some docker restart are in order to "catch" new file.

Comment 3 Tzach Shefi 2018-07-30 07:45:26 UTC
One more suggestion, if I understand correctly for Google backup to work we need this package installed -> python-google-api-client-1.4.2-4.el7ost.noarch 

Checking under Cinder volume docker this package has been automatically installed, which is great. 

However it might be a good idea to also suggest we validate/install in case it's missing.

Comment 4 Tzach Shefi 2018-07-30 09:04:05 UTC
Under section 4, where we have
/home/stack/templates/gcs-backup.yaml

parameter_defaults:
  ControllerExtraConfig: # 1
    cinder::config::cinder_config:
        DEFAULT/backup_driver
            value: cinder.backup.drivers.google
        DEFAULT/backup_gcs_credential_file
            value: /etc/cinder/Cloud-Backup.json
        DEFAULT/backup_gcs_bucket
            value: mycinderbucket
        DEFAULT/backup_gcs_project_id
            value: cloud-backup-1370
        DEFAULT/backup_gcs_user_agent
            value: myuseragent

Alan (Cinder THT guru) mentioned another problem.
Each line stating with DEFAULT should end with a colon at the end. 
https://bugzilla.redhat.com/show_bug.cgi?id=1609707#c3

Will retest with this this yaml 

parameter_defaults:
  ControllerExtraConfig: # 1
    cinder::config::cinder_config:
        DEFAULT/backup_driver:
            value: cinder.backup.drivers.google
        DEFAULT/backup_gcs_credential_file:
            value: /etc/cinder/Cloud-Backup.json
        DEFAULT/backup_gcs_bucket:
            value: mycinderbucket
        DEFAULT/backup_gcs_project_id:
            value: cloud-backup-1370
        DEFAULT/backup_gcs_user_agent:
            value: myuseragent.

Comment 5 Alan Bishop 2018-08-27 14:32:05 UTC
See bug #1609707 comment #9 for updates on the TripleO env file settings required for the feature to work. The details are unusual because TripleO thinks it is deploying cinder-backup with a Swift backend, and "extra config" hiera data is used to override the settings to specify the gcs backup driver. This may be confusing, but it's the only way it can work until full TripleO support is added. I mention this because the docs should try to clarify the confusion.

Comment 8 Kim Nylander 2018-12-31 20:46:28 UTC
Tzach, do you think we can close this BZ since these changes have been incorporated in BZ#1658306? 

Thanks.

Comment 9 Tzach Shefi 2019-01-02 09:19:58 UTC
Sure Kim, would be fine with me. 

Unsure which state to move the bz to closed/verified.

Comment 10 Kim Nylander 2019-01-02 14:36:54 UTC
Hi, Tzach. 

I linked this BZ to the main Block Storage Backup Guide BZ. 

I'll move this BZ to verified and then to closed (in case it makes a different for metrics).

Comment 11 Kim Nylander 2019-01-02 14:37:20 UTC
Content converted to AsciiDoc and checked into repo.


Note You need to log in before you can comment on or make changes to this bug.