cinder/doc/source/configuration/tables/cinder-backups_gcs.inc
Jay S. Bryant 986a6a015f [DOC BLD FIX] Name files for inclusion properly
The Sphinx build was issuing hundreds of warning for
duplicate labels.  The reason for this was because
all of the tables we had were named as .rst files.
This would cause Sphinx to process them twice and it would
think there were duplicated sections.

There were two ways this could be handled:  1) Exclude the tables
directory from the docs build. 2) Name the files as they should
have always been so they weren't build twice.  Given that
option 1 just masked the problem, I am implementing this
patch using option 2.

So, all the tables we are including in our documentation
have been named from .rst to .inc and the .. include::
directives that use them have also been updated to use
the new file name.

Change-Id: If395eb652f7e3b789bcbd5e6d6d05954c23d8d8a
2017-08-04 15:33:52 -05:00

49 lines
2.3 KiB
PHP

..
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.