From a7f67960901088c09c1baa07449a8b8ea8ee3c8c Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Wed, 2 May 2018 11:09:54 -0500 Subject: [PATCH] Remove backup driver static config option tables Switch to using config-table directive. Change-Id: I902bb51e90abc9f7e0ce4bb78256b0ee0bdf7f61 --- .../backup/ceph-backup-driver.rst | 5 +- .../backup/gcs-backup-driver.rst | 5 +- .../backup/glusterfs-backup-driver.rst | 5 +- .../backup/nfs-backup-driver.rst | 6 +- .../backup/posix-backup-driver.rst | 5 +- .../backup/swift-backup-driver.rst | 5 +- .../backup/tsm-backup-driver.rst | 5 +- .../tables/cinder-backups_ceph.inc | 34 ----------- .../tables/cinder-backups_gcs.inc | 48 ---------------- .../tables/cinder-backups_glusterfs.inc | 24 -------- .../tables/cinder-backups_nfs.inc | 34 ----------- .../tables/cinder-backups_posix.inc | 30 ---------- .../tables/cinder-backups_swift.inc | 56 ------------------- .../tables/cinder-backups_tsm.inc | 26 --------- 14 files changed, 29 insertions(+), 259 deletions(-) delete mode 100644 doc/source/configuration/tables/cinder-backups_ceph.inc delete mode 100644 doc/source/configuration/tables/cinder-backups_gcs.inc delete mode 100644 doc/source/configuration/tables/cinder-backups_glusterfs.inc delete mode 100644 doc/source/configuration/tables/cinder-backups_nfs.inc delete mode 100644 doc/source/configuration/tables/cinder-backups_posix.inc delete mode 100644 doc/source/configuration/tables/cinder-backups_swift.inc delete mode 100644 doc/source/configuration/tables/cinder-backups_tsm.inc diff --git a/doc/source/configuration/block-storage/backup/ceph-backup-driver.rst b/doc/source/configuration/block-storage/backup/ceph-backup-driver.rst index 50ba6dcb6b3..a90a55cccbe 100644 --- a/doc/source/configuration/block-storage/backup/ceph-backup-driver.rst +++ b/doc/source/configuration/block-storage/backup/ceph-backup-driver.rst @@ -42,7 +42,10 @@ To enable the Ceph backup driver, include the following option in the The following configuration options are available for the Ceph backup driver. -.. include:: ../../tables/cinder-backups_ceph.inc +.. config-table:: + :config-target: Ceph backup driver + + cinder.backup.drivers.ceph This example shows the default options for the Ceph backup driver. diff --git a/doc/source/configuration/block-storage/backup/gcs-backup-driver.rst b/doc/source/configuration/block-storage/backup/gcs-backup-driver.rst index 4eeae105a5e..85f3712ed09 100644 --- a/doc/source/configuration/block-storage/backup/gcs-backup-driver.rst +++ b/doc/source/configuration/block-storage/backup/gcs-backup-driver.rst @@ -15,4 +15,7 @@ To enable the GCS backup driver, include the following option in the The following configuration options are available for the GCS backup driver. -.. include:: ../../tables/cinder-backups_gcs.inc +.. config-table:: + :config-target: GCS backup driver + + cinder.backup.drivers.google diff --git a/doc/source/configuration/block-storage/backup/glusterfs-backup-driver.rst b/doc/source/configuration/block-storage/backup/glusterfs-backup-driver.rst index eeff3aaa02c..e771443598f 100644 --- a/doc/source/configuration/block-storage/backup/glusterfs-backup-driver.rst +++ b/doc/source/configuration/block-storage/backup/glusterfs-backup-driver.rst @@ -14,4 +14,7 @@ To enable the GlusterFS backup driver, include the following option in the The following configuration options are available for the GlusterFS backup driver. -.. include:: ../../tables/cinder-backups_glusterfs.inc +.. config-table:: + :config-target: GlusterFS backup driver + + cinder.backup.drivers.glusterfs diff --git a/doc/source/configuration/block-storage/backup/nfs-backup-driver.rst b/doc/source/configuration/block-storage/backup/nfs-backup-driver.rst index 743ec0e3a62..641289a23d7 100644 --- a/doc/source/configuration/block-storage/backup/nfs-backup-driver.rst +++ b/doc/source/configuration/block-storage/backup/nfs-backup-driver.rst @@ -15,4 +15,8 @@ To enable the NFS backup driver, include the following option in the The following configuration options are available for the NFS back-end backup driver. -.. include:: ../../tables/cinder-backups_nfs.inc +.. config-table:: + :config-target: NFS backup driver + + cinder.backup.drivers.nfs + cinder.backup.drivers.posix diff --git a/doc/source/configuration/block-storage/backup/posix-backup-driver.rst b/doc/source/configuration/block-storage/backup/posix-backup-driver.rst index f754cdbcdd3..d31f10a9f6a 100644 --- a/doc/source/configuration/block-storage/backup/posix-backup-driver.rst +++ b/doc/source/configuration/block-storage/backup/posix-backup-driver.rst @@ -15,4 +15,7 @@ option in the ``cinder.conf`` file: The following configuration options are available for the POSIX file systems backup driver. -.. include:: ../../tables/cinder-backups_posix.inc +.. config-table:: + :config-target: POSIX backup driver + + cinder.backup.drivers.posix diff --git a/doc/source/configuration/block-storage/backup/swift-backup-driver.rst b/doc/source/configuration/block-storage/backup/swift-backup-driver.rst index 1dae2b45f75..6cd411ff7a7 100644 --- a/doc/source/configuration/block-storage/backup/swift-backup-driver.rst +++ b/doc/source/configuration/block-storage/backup/swift-backup-driver.rst @@ -15,7 +15,10 @@ To enable the swift backup driver, include the following option in the The following configuration options are available for the Swift back-end backup driver. -.. include:: ../../tables/cinder-backups_swift.inc +.. config-table:: + :config-target: Swift backup driver + + cinder.backup.drivers.swift To enable the swift backup driver for 1.0, 2.0, or 3.0 authentication version, specify ``1``, ``2``, or ``3`` correspondingly. For example: diff --git a/doc/source/configuration/block-storage/backup/tsm-backup-driver.rst b/doc/source/configuration/block-storage/backup/tsm-backup-driver.rst index 84529564ee3..21a5d0518b4 100644 --- a/doc/source/configuration/block-storage/backup/tsm-backup-driver.rst +++ b/doc/source/configuration/block-storage/backup/tsm-backup-driver.rst @@ -20,7 +20,10 @@ To enable the IBM TSM backup driver, include the following option in The following configuration options are available for the TSM backup driver. -.. include:: ../../tables/cinder-backups_tsm.inc +.. config-table:: + :config-target: IBM Tivoli Storage Manager backup driver + + cinder.backup.drivers.tsm This example shows the default options for the TSM backup driver. diff --git a/doc/source/configuration/tables/cinder-backups_ceph.inc b/doc/source/configuration/tables/cinder-backups_ceph.inc deleted file mode 100644 index c28f75cf572..00000000000 --- a/doc/source/configuration/tables/cinder-backups_ceph.inc +++ /dev/null @@ -1,34 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _cinder-backups_ceph: - -.. list-table:: Description of Ceph backup driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``backup_ceph_chunk_size`` = ``134217728`` - - (Integer) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store. - * - ``backup_ceph_conf`` = ``/etc/ceph/ceph.conf`` - - (String) Ceph configuration file to use. - * - ``backup_ceph_pool`` = ``backups`` - - (String) The Ceph pool where volume backups are stored. - * - ``backup_ceph_stripe_count`` = ``0`` - - (Integer) RBD stripe count to use when creating a backup image. - * - ``backup_ceph_stripe_unit`` = ``0`` - - (Integer) RBD stripe unit to use when creating a backup image. - * - ``backup_ceph_user`` = ``cinder`` - - (String) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None. - * - ``restore_discard_excess_bytes`` = ``True`` - - (Boolean) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes. diff --git a/doc/source/configuration/tables/cinder-backups_gcs.inc b/doc/source/configuration/tables/cinder-backups_gcs.inc deleted file mode 100644 index 84ffbf00620..00000000000 --- a/doc/source/configuration/tables/cinder-backups_gcs.inc +++ /dev/null @@ -1,48 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _cinder-backups_gcs: - -.. list-table:: Description of GCS backup driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``backup_gcs_block_size`` = ``32768`` - - (Integer) The size in bytes that changes are tracked for incremental backups. backup_gcs_object_size has to be multiple of backup_gcs_block_size. - * - ``backup_gcs_bucket`` = ``None`` - - (String) The GCS bucket to use. - * - ``backup_gcs_bucket_location`` = ``US`` - - (String) Location of GCS bucket. - * - ``backup_gcs_credential_file`` = ``None`` - - (String) Absolute path of GCS service account credential file. - * - ``backup_gcs_enable_progress_timer`` = ``True`` - - (Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the GCS backend storage. The default value is True to enable the timer. - * - ``backup_gcs_num_retries`` = ``3`` - - (Integer) Number of times to retry. - * - ``backup_gcs_object_size`` = ``52428800`` - - (Integer) The size in bytes of GCS backup objects. - * - ``backup_gcs_project_id`` = ``None`` - - (String) Owner project id for GCS bucket. - * - ``backup_gcs_proxy_url`` = ``None`` - - (URI) URL for http proxy access. - * - ``backup_gcs_reader_chunk_size`` = ``2097152`` - - (Integer) GCS object will be downloaded in chunks of bytes. - * - ``backup_gcs_retry_error_codes`` = ``429`` - - (List) List of GCS error codes. - * - ``backup_gcs_storage_class`` = ``NEARLINE`` - - (String) Storage class of GCS bucket. - * - ``backup_gcs_user_agent`` = ``gcscinder`` - - (String) Http user-agent string for gcs api. - * - ``backup_gcs_writer_chunk_size`` = ``2097152`` - - (Integer) GCS object will be uploaded in chunks of bytes. Pass in a value of -1 if the file is to be uploaded as a single chunk. diff --git a/doc/source/configuration/tables/cinder-backups_glusterfs.inc b/doc/source/configuration/tables/cinder-backups_glusterfs.inc deleted file mode 100644 index dbae37b0983..00000000000 --- a/doc/source/configuration/tables/cinder-backups_glusterfs.inc +++ /dev/null @@ -1,24 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _cinder-backups_glusterfs: - -.. list-table:: Description of GlusterFS backup driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``glusterfs_backup_mount_point`` = ``$state_path/backup_mount`` - - (String) Base dir containing mount point for gluster share. - * - ``glusterfs_backup_share`` = ``None`` - - (String) GlusterFS share in : format. Eg: 1.2.3.4:backup_vol diff --git a/doc/source/configuration/tables/cinder-backups_nfs.inc b/doc/source/configuration/tables/cinder-backups_nfs.inc deleted file mode 100644 index 53436a95f84..00000000000 --- a/doc/source/configuration/tables/cinder-backups_nfs.inc +++ /dev/null @@ -1,34 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _cinder-backups_nfs: - -.. list-table:: Description of NFS backup driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``backup_container`` = ``None`` - - (String) Custom directory to use for backups. - * - ``backup_enable_progress_timer`` = ``True`` - - (Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer. - * - ``backup_file_size`` = ``1999994880`` - - (Integer) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes. - * - ``backup_mount_options`` = ``None`` - - (String) Mount options passed to the NFS client. See NFS man page for details. - * - ``backup_mount_point_base`` = ``$state_path/backup_mount`` - - (String) Base dir containing mount point for NFS share. - * - ``backup_sha_block_size_bytes`` = ``32768`` - - (Integer) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes. - * - ``backup_share`` = ``None`` - - (String) NFS share in hostname:path, ipv4addr:path, or "[ipv6addr]:path" format. diff --git a/doc/source/configuration/tables/cinder-backups_posix.inc b/doc/source/configuration/tables/cinder-backups_posix.inc deleted file mode 100644 index c6113a7d3aa..00000000000 --- a/doc/source/configuration/tables/cinder-backups_posix.inc +++ /dev/null @@ -1,30 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _cinder-backups_posix: - -.. list-table:: Description of POSIX backup driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``backup_container`` = ``None`` - - (String) Custom directory to use for backups. - * - ``backup_enable_progress_timer`` = ``True`` - - (Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer. - * - ``backup_file_size`` = ``1999994880`` - - (Integer) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.backup_file_size must be a multiple of backup_sha_block_size_bytes. - * - ``backup_posix_path`` = ``$state_path/backup`` - - (String) Path specifying where to store backups. - * - ``backup_sha_block_size_bytes`` = ``32768`` - - (Integer) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes. diff --git a/doc/source/configuration/tables/cinder-backups_swift.inc b/doc/source/configuration/tables/cinder-backups_swift.inc deleted file mode 100644 index 8439b4445db..00000000000 --- a/doc/source/configuration/tables/cinder-backups_swift.inc +++ /dev/null @@ -1,56 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _cinder-backups_swift: - -.. list-table:: Description of Swift backup driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``backup_swift_auth`` = ``per_user`` - - (String) Swift authentication mechanism - * - ``backup_swift_auth_version`` = ``1`` - - (String) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0 or "3" for auth 3.0 - * - ``backup_swift_block_size`` = ``32768`` - - (Integer) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size. - * - ``backup_swift_ca_cert_file`` = ``None`` - - (String) Location of the CA certificate file to use for swift client requests. - * - ``backup_swift_container`` = ``volumebackups`` - - (String) The default Swift container to use - * - ``backup_swift_enable_progress_timer`` = ``True`` - - (Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer. - * - ``backup_swift_key`` = ``None`` - - (String) Swift key for authentication - * - ``backup_swift_object_size`` = ``52428800`` - - (Integer) The size in bytes of Swift backup objects - * - ``backup_swift_project`` = ``None`` - - (String) Swift project/account name. Required when connecting to an auth 3.0 system - * - ``backup_swift_project_domain`` = ``None`` - - (String) Swift project domain name. Required when connecting to an auth 3.0 system - * - ``backup_swift_retry_attempts`` = ``3`` - - (Integer) The number of retries to make for Swift operations - * - ``backup_swift_retry_backoff`` = ``2`` - - (Integer) The backoff time in seconds between Swift retries - * - ``backup_swift_tenant`` = ``None`` - - (String) Swift tenant/account name. Required when connecting to an auth 2.0 system - * - ``backup_swift_url`` = ``None`` - - (URI) The URL of the Swift endpoint - * - ``backup_swift_user`` = ``None`` - - (String) Swift user name - * - ``backup_swift_user_domain`` = ``None`` - - (String) Swift user domain name. Required when connecting to an auth 3.0 system - * - ``keystone_catalog_info`` = ``identity:Identity Service:publicURL`` - - (String) Info to match when looking for keystone in the service catalog. Format is: separated values of the form: :: - Only used if backup_swift_auth_url is unset - * - ``swift_catalog_info`` = ``object-store:swift:publicURL`` - - (String) Info to match when looking for swift in the service catalog. Format is: separated values of the form: :: - Only used if backup_swift_url is unset diff --git a/doc/source/configuration/tables/cinder-backups_tsm.inc b/doc/source/configuration/tables/cinder-backups_tsm.inc deleted file mode 100644 index a3cd05228f2..00000000000 --- a/doc/source/configuration/tables/cinder-backups_tsm.inc +++ /dev/null @@ -1,26 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated from the - software project's code and your changes will be overwritten. - - The tool to generate this file lives in openstack-doc-tools repository. - - Please make any changes needed in the code, then run the - autogenerate-config-doc tool from the openstack-doc-tools repository, or - ask for help on the documentation mailing list, IRC channel or meeting. - -.. _cinder-backups_tsm: - -.. list-table:: Description of IBM Tivoli Storage Manager backup driver configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[DEFAULT]** - - - * - ``backup_tsm_compression`` = ``True`` - - (Boolean) Enable or Disable compression for backups - * - ``backup_tsm_password`` = ``password`` - - (String) TSM password for the running username - * - ``backup_tsm_volume_prefix`` = ``backup`` - - (String) Volume prefix for the backup id when backing up to TSM