Merge "Recategorize cinder NFS backup options"

doc/common/tables/cinder-backups.xml

@@ -25,22 +25,10 @@
         <td><option>backup_compression_algorithm</option> = <replaceable>zlib</replaceable></td>
         <td>(StrOpt) Compression algorithm (None to disable)</td>
       </tr>
-      <tr>
-        <td><option>backup_container</option> = <replaceable>None</replaceable></td>
-        <td>(StrOpt) Custom container to use for backups.</td>
-      </tr>
       <tr>
         <td><option>backup_driver</option> = <replaceable>cinder.backup.drivers.swift</replaceable></td>
         <td>(StrOpt) Driver to use for backups.</td>
       </tr>
-      <tr>
-        <td><option>backup_enable_progress_timer</option> = <replaceable>True</replaceable></td>
-        <td>(BoolOpt) 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.</td>
-      </tr>
-      <tr>
-        <td><option>backup_file_size</option> = <replaceable>1999994880</replaceable></td>
-        <td>(IntOpt) 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.</td>
-      </tr>
       <tr>
         <td><option>backup_manager</option> = <replaceable>cinder.backup.manager.BackupManager</replaceable></td>
         <td>(StrOpt) Full class name for the Manager for volume backup</td>
@@ -49,14 +37,6 @@
         <td><option>backup_metadata_version</option> = <replaceable>2</replaceable></td>
         <td>(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.</td>
       </tr>
-      <tr>
-        <td><option>backup_mount_options</option> = <replaceable>None</replaceable></td>
-        <td>(StrOpt) Mount options passed to the NFS client. See NFS man page for details.</td>
-      </tr>
-      <tr>
-        <td><option>backup_mount_point_base</option> = <replaceable>$state_path/backup_mount</replaceable></td>
-        <td>(StrOpt) Base dir containing mount point for NFS share.</td>
-      </tr>
       <tr>
         <td><option>backup_name_template</option> = <replaceable>backup-%s</replaceable></td>
         <td>(StrOpt) Template string to be used to generate backup names</td>
@@ -65,14 +45,6 @@
         <td><option>backup_object_number_per_notification</option> = <replaceable>10</replaceable></td>
         <td>(IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent</td>
       </tr>
-      <tr>
-        <td><option>backup_sha_block_size_bytes</option> = <replaceable>32768</replaceable></td>
-        <td>(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.</td>
-      </tr>
-      <tr>
-        <td><option>backup_share</option> = <replaceable>None</replaceable></td>
-        <td>(StrOpt) NFS share in fqdn:path, ipv4addr:path, or "[ipv6addr]:path" format.</td>
-      </tr>
       <tr>
         <td><option>backup_timer_interval</option> = <replaceable>120</replaceable></td>
         <td>(IntOpt) Interval, in seconds, between two progress notifications reporting the backup status</td>

doc/common/tables/cinder-backups_nfs.xml

@@ -0,0 +1,50 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+  <!-- Warning: Do not edit this file. It is automatically
+     generated and your changes will be overwritten.
+     The tool to do so lives in openstack-doc-tools repository. -->
+  <table rules="all" xml:id="config_table_cinder_backups_nfs">
+    <caption>Description of NFS backup driver configuration options</caption>
+    <col width="50%"/>
+    <col width="50%"/>
+    <thead>
+      <tr>
+        <th>Configuration option = Default value</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th colspan="2">[DEFAULT]</th>
+      </tr>
+      <tr>
+        <td><option>backup_container</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Custom container to use for backups.</td>
+      </tr>
+      <tr>
+        <td><option>backup_enable_progress_timer</option> = <replaceable>True</replaceable></td>
+        <td>(BoolOpt) 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.</td>
+      </tr>
+      <tr>
+        <td><option>backup_file_size</option> = <replaceable>1999994880</replaceable></td>
+        <td>(IntOpt) 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.</td>
+      </tr>
+      <tr>
+        <td><option>backup_mount_options</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Mount options passed to the NFS client. See NFS man page for details.</td>
+      </tr>
+      <tr>
+        <td><option>backup_mount_point_base</option> = <replaceable>$state_path/backup_mount</replaceable></td>
+        <td>(StrOpt) Base dir containing mount point for NFS share.</td>
+      </tr>
+      <tr>
+        <td><option>backup_sha_block_size_bytes</option> = <replaceable>32768</replaceable></td>
+        <td>(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.</td>
+      </tr>
+      <tr>
+        <td><option>backup_share</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) NFS share in fqdn:path, ipv4addr:path, or "[ipv6addr]:path" format.</td>
+      </tr>
+    </tbody>
+  </table>
+</para>

tools/autogenerate-config-flagmappings/cinder.flagmappings

@@ -15,18 +15,18 @@ backup_ceph_stripe_count backups_ceph
 backup_ceph_stripe_unit backups_ceph
 backup_ceph_user backups_ceph
 backup_compression_algorithm backups
-backup_container backups
+backup_container backups_nfs
 backup_driver backups
-backup_enable_progress_timer backups
+backup_enable_progress_timer backups_nfs
-backup_file_size backups
+backup_file_size backups_nfs
 backup_manager backups
 backup_metadata_version backups
-backup_mount_options backups
+backup_mount_options backups_nfs
-backup_mount_point_base backups
+backup_mount_point_base backups_nfs
 backup_name_template backups
 backup_object_number_per_notification backups
-backup_sha_block_size_bytes backups
+backup_sha_block_size_bytes backups_nfs
-backup_share backups
+backup_share backups_nfs
 backup_swift_auth backups_swift
 backup_swift_auth_version backups_swift
 backup_swift_block_size backups_swift

tools/autogenerate-config-flagmappings/cinder.headers

@@ -1,5 +1,6 @@
 backups backups
 backups_ceph Ceph backup driver
+backups_nfs NFS backup driver
 backups_swift Swift backup driver
 backups_tsm IBM Tivoli Storage Manager backup driver
 block-device block device