Merge "[config-ref] Add POSIX/GlusterFS backup drivers"

doc/config-reference/source/block-storage/backup-drivers.rst

@@ -6,7 +6,9 @@ Backup drivers
 
    backup/ceph-backup-driver.rst
    backup/gcs-backup-driver.rst
+   backup/glusterfs-backup-driver.rst
    backup/nfs-backup-driver.rst
+   backup/posix-backup-driver.rst
    backup/swift-backup-driver.rst
    backup/tsm-backup-driver.rst
 

doc/config-reference/source/block-storage/backup/glusterfs-backup-driver.rst

@@ -0,0 +1,17 @@
+=======================
+GlusterFS backup driver
+=======================
+
+The GlusterFS backup driver backs up volumes of any type to GlusterFS.
+
+To enable the GlusterFS backup driver, include the following option in the
+``cinder.conf`` file:
+
+.. code-block:: ini
+
+    backup_driver = cinder.backup.drivers.glusterfs
+
+The following configuration options are available for the GlusterFS backup
+driver.
+
+.. include:: ../../tables/cinder-backups_glusterfs.rst

doc/config-reference/source/block-storage/backup/posix-backup-driver.rst

@@ -0,0 +1,18 @@
+================================
+POSIX file systems backup driver
+================================
+
+The POSIX file systems backup driver backs up volumes of any type to
+POSIX file systems.
+
+To enable the POSIX file systems backup driver, include the following
+option in the ``cinder.conf`` file:
+
+.. code-block:: ini
+
+    backup_driver = cinder.backup.drivers.posix
+
+The following configuration options are available for the POSIX
+file systems backup driver.
+
+.. include:: ../../tables/cinder-backups_posix.rst

doc/config-reference/source/tables/cinder-backups_glusterfs.rst

@@ -0,0 +1,24 @@
+..
+    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 backups_glusterfs 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 <hostname|ipv4addr|ipv6addr>:<gluster_vol_name> format. Eg: 1.2.3.4:backup_vol

doc/config-reference/source/tables/cinder-backups_posix.rst

@@ -0,0 +1,30 @@
+..
+    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.

doc/config-reference/source/tables/cinder-storage_glusterfs.rst

@@ -18,10 +18,6 @@
      - 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 <hostname|ipv4addr|ipv6addr>:<gluster_vol_name> format. Eg: 1.2.3.4:backup_vol
    * - ``glusterfs_mount_point_base`` = ``$state_path/mnt``
      - (String) Base dir containing mount points for gluster shares.
    * - ``glusterfs_shares_config`` = ``/etc/cinder/glusterfs_shares``

tools/autogenerate-config-flagmappings/cinder.flagmappings

@@ -14,10 +14,10 @@ backup_ceph_stripe_count backups_ceph
 backup_ceph_stripe_unit backups_ceph
 backup_ceph_user backups_ceph
 backup_compression_algorithm backups
-backup_container backups_nfs
+backup_container backups_nfs backups_posix
 backup_driver backups
-backup_enable_progress_timer backups_nfs
-backup_file_size backups_nfs
+backup_enable_progress_timer backups_nfs backups_posix
+backup_file_size backups_nfs backups_posix
 backup_gcs_block_size backups_gcs
 backup_gcs_bucket backups_gcs
 backup_gcs_bucket_location backups_gcs
@@ -37,9 +37,9 @@ backup_mount_options backups_nfs
 backup_mount_point_base backups_nfs
 backup_name_template backups
 backup_object_number_per_notification backups
-backup_posix_path backups
+backup_posix_path backups_posix
 backup_service_inithost_offload backups
-backup_sha_block_size_bytes backups_nfs
+backup_sha_block_size_bytes backups_nfs backups_posix
 backup_share backups_nfs
 backup_swift_auth backups_swift
 backup_swift_auth_insecure swift
@@ -173,8 +173,8 @@ glance_catalog_info images
 glance_core_properties images
 glance_num_retries images
 glance_request_timeout images
-glusterfs_backup_mount_point storage_glusterfs
-glusterfs_backup_share storage_glusterfs
+glusterfs_backup_mount_point backups_glusterfs
+glusterfs_backup_share backups_glusterfs
 glusterfs_mount_point_base storage_glusterfs
 glusterfs_shares_config storage_glusterfs
 goodness_function scheduler

tools/autogenerate-config-flagmappings/cinder.headers

@@ -2,6 +2,7 @@ backups backups
 backups_ceph Ceph backup driver
 backups_gcs GCS backup driver
 backups_nfs NFS backup driver
+backups_posix POSIX backup driver
 backups_swift Swift backup driver
 backups_tsm IBM Tivoli Storage Manager backup driver
 block-device block device