diff --git a/doc/user_guide/config.rst b/doc/user_guide/config.rst index b95270e..faa3f88 100644 --- a/doc/user_guide/config.rst +++ b/doc/user_guide/config.rst @@ -46,7 +46,12 @@ two parts: .. image:: images/settings.png * The project ID - * The bucket name to store backup data + * The default bucket name to store backup data. + The bucket is created if not exists. Used as *container* parameter value + when Cinder CLI or API is invoked for creating a backup. + *Note for Horizon users:* make sure *Container Name* in + *Create Volume Backup* window is filled with the appropriate bucket name. + Improper or empty *Container Name* can cause a new bucket creation. * The storage class for the bucket, can be selected from drop-down list * Bucket location, a list of locations can be found in `Google Cloud storage documentation `_ diff --git a/environment_config.yaml b/environment_config.yaml index 7ca74a1..22520bc 100644 --- a/environment_config.yaml +++ b/environment_config.yaml @@ -10,13 +10,13 @@ attributes: error: 'The value should not be empty. Only letters, digits, underscore and dash symbols are allowed.' backup_gcs_bucket: value: '' - label: 'GCS bucket name' - description: '' + label: 'Default GCS bucket name' + description: 'Default GCS bucket name to use for backups. The bucket is created if not exists. Please refer to the official bucket naming guidelines https://cloud.google.com/storage/docs/naming .Used as container parameter value when Cinder CLI or API is invoked for creating a backup.' weight: 15 type: "text" regex: source: '^[A-Za-z\d_-]+$' - error: 'The value should not be empty. Only letters, digits, underscore and dash symbols are allowed.' + error: 'Default GCS bucket name to use for backups. The bucket is created if not exists. Please refer to the official bucket naming guidelines https://cloud.google.com/storage/docs/naming .Used as container parameter value when Cinder CLI or API is invoked for creating a backup. The value should not be empty. Only letters, digits, underscore and dash symbols are allowed.' backup_gcs_storage_class: value: 'NEARLINE' label: 'GCS storage class' diff --git a/specs/spec.rst b/specs/spec.rst index 45718a5..fb49a41 100644 --- a/specs/spec.rst +++ b/specs/spec.rst @@ -97,13 +97,15 @@ The settings are: * default value: '' * valid values: not empty -* GCS Bucket +* Default GCS Bucket name * name: backup_gcs_bucket - * label: GCS Bucket - * description: GCS bucket name to use for backup. Please refer to - the official bucket naming guidelines - https://cloud.google.com/storage/docs/naming + * label: Default GCS Bucket name + * description: Default GCS bucket name to use for backups. The bucket is + created if not exists. Please refer to the official bucket naming guidelines + https://cloud.google.com/storage/docs/naming . + Used as *container* parameter value when Cinder CLI or API is invoked for + creating a backup. * type: text * default value: '' * valid values: not empty