From 63d3b3efcb6f35c94903f358a348eddc2b8c8228 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Sat, 6 Aug 2016 09:42:04 +0900 Subject: [PATCH] [config-ref] update Object Storage container sync configuration * Split container sync realms configuration into a separate file * Add description for no help options backport: mitaka Change-Id: I02543d9d36a8ebd3f889a0e08aacd74d9c1b9a66 Partial-Bug: #1605040 --- .../source/object-storage.rst | 1 + .../source/object-storage/configure.rst | 19 ------------------- .../object-storage/container-sync-realms.rst | 19 +++++++++++++++++++ .../swift-container-sync-realms-DEFAULT.rst | 2 +- .../swift-container-sync-realms-realm1.rst | 8 ++++---- .../swift-container-sync-realms-realm2.rst | 8 ++++---- 6 files changed, 29 insertions(+), 28 deletions(-) create mode 100644 doc/config-reference/source/object-storage/container-sync-realms.rst diff --git a/doc/config-reference/source/object-storage.rst b/doc/config-reference/source/object-storage.rst index aa4ee9efed..9e3b2b856e 100644 --- a/doc/config-reference/source/object-storage.rst +++ b/doc/config-reference/source/object-storage.rst @@ -10,6 +10,7 @@ Object Storage service object-storage/object-server.rst object-storage/object-expirer.rst object-storage/container-server.rst + object-storage/container-sync-realms.rst object-storage/configure.rst object-storage/features.rst object-storage/configure-s3.rst diff --git a/doc/config-reference/source/object-storage/configure.rst b/doc/config-reference/source/object-storage/configure.rst index 7977776ba9..d137b42555 100644 --- a/doc/config-reference/source/object-storage/configure.rst +++ b/doc/config-reference/source/object-storage/configure.rst @@ -8,25 +8,6 @@ configurations. Default configuration options appear in the ``[DEFAULT]`` section. You can override the default values by setting values in the other sections. -Container sync realms configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Find an example container sync realms configuration at -``etc/container-sync-realms.conf-sample`` in the source code repository. - -The available configuration options are: - -.. include:: ../tables/swift-container-sync-realms-DEFAULT.rst -.. include:: ../tables/swift-container-sync-realms-realm1.rst -.. include:: ../tables/swift-container-sync-realms-realm2.rst - -Sample container sync realms configuration file ------------------------------------------------ - -.. remote-code-block:: ini - - https://git.openstack.org/cgit/openstack/swift/plain/etc/container-sync-realms.conf-sample?h=stable/mitaka - Container reconciler configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/config-reference/source/object-storage/container-sync-realms.rst b/doc/config-reference/source/object-storage/container-sync-realms.rst new file mode 100644 index 0000000000..74d5cccc95 --- /dev/null +++ b/doc/config-reference/source/object-storage/container-sync-realms.rst @@ -0,0 +1,19 @@ +=================================== +Container sync realms configuration +=================================== + +Find an example container sync realms configuration at +``etc/container-sync-realms.conf-sample`` in the source code repository. + +The available configuration options are: + +.. include:: ../tables/swift-container-sync-realms-DEFAULT.rst +.. include:: ../tables/swift-container-sync-realms-realm1.rst +.. include:: ../tables/swift-container-sync-realms-realm2.rst + +Sample container sync realms configuration file +----------------------------------------------- + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/swift/plain/etc/container-sync-realms.conf-sample?h=stable/mitaka diff --git a/doc/config-reference/source/tables/swift-container-sync-realms-DEFAULT.rst b/doc/config-reference/source/tables/swift-container-sync-realms-DEFAULT.rst index 8a56f41357..47071dc315 100644 --- a/doc/config-reference/source/tables/swift-container-sync-realms-DEFAULT.rst +++ b/doc/config-reference/source/tables/swift-container-sync-realms-DEFAULT.rst @@ -10,4 +10,4 @@ * - Configuration option = Default value - Description * - ``mtime_check_interval`` = ``300`` - - No help text available for this option. + - The number of seconds between checking the modified time of this config file for changes and therefore reloading it. diff --git a/doc/config-reference/source/tables/swift-container-sync-realms-realm1.rst b/doc/config-reference/source/tables/swift-container-sync-realms-realm1.rst index e8120cef56..cb07b99cc0 100644 --- a/doc/config-reference/source/tables/swift-container-sync-realms-realm1.rst +++ b/doc/config-reference/source/tables/swift-container-sync-realms-realm1.rst @@ -10,10 +10,10 @@ * - Configuration option = Default value - Description * - ``cluster_clustername1`` = ``https://host1/v1/`` - - No help text available for this option. + - Any values in the realm section whose names begin with cluster\_ will indicate the name and endpoint of a cluster and will be used by external users in their containers' X-Container-Sync-To metadata header values with the format "realm_name/cluster_name/container_name". Realm and cluster names are considered case insensitive. * - ``cluster_clustername2`` = ``https://host2/v1/`` - - No help text available for this option. + - Any values in the realm section whose names begin with cluster\_ will indicate the name and endpoint of a cluster and will be used by external users in their containers' X-Container-Sync-To metadata header values with the format "realm_name/cluster_name/container_name". Realm and cluster names are considered case insensitive. * - ``key`` = ``realm1key`` - - No help text available for this option. + - The key is the overall cluster-to-cluster key used in combination with the external users' key that they set on their containers' X-Container-Sync-Key metadata header values. These keys will be used to sign each request the container sync daemon makes and used to validate each incoming container sync request. * - ``key2`` = ``realm1key2`` - - No help text available for this option. + - The key2 is optional and is an additional key incoming requests will be checked against. This is so you can rotate keys if you wish; you move the existing key to key2 and make a new key value. diff --git a/doc/config-reference/source/tables/swift-container-sync-realms-realm2.rst b/doc/config-reference/source/tables/swift-container-sync-realms-realm2.rst index 2a1f2b6788..b0dfe1087a 100644 --- a/doc/config-reference/source/tables/swift-container-sync-realms-realm2.rst +++ b/doc/config-reference/source/tables/swift-container-sync-realms-realm2.rst @@ -10,10 +10,10 @@ * - Configuration option = Default value - Description * - ``cluster_clustername3`` = ``https://host3/v1/`` - - No help text available for this option. + - Any values in the realm section whose names begin with cluster\_ will indicate the name and endpoint of a cluster and will be used by external users in their containers' X-Container-Sync-To metadata header values with the format "realm_name/cluster_name/container_name". Realm and cluster names are considered case insensitive. * - ``cluster_clustername4`` = ``https://host4/v1/`` - - No help text available for this option. + - Any values in the realm section whose names begin with cluster\_ will indicate the name and endpoint of a cluster and will be used by external users in their containers' X-Container-Sync-To metadata header values with the format "realm_name/cluster_name/container_name". Realm and cluster names are considered case insensitive. * - ``key`` = ``realm2key`` - - No help text available for this option. + - The key is the overall cluster-to-cluster key used in combination with the external users' key that they set on their containers' X-Container-Sync-Key metadata header values. These keys will be used to sign each request the container sync daemon makes and used to validate each incoming container sync request. * - ``key2`` = ``realm2key2`` - - No help text available for this option. + - The key2 is optional and is an additional key incoming requests will be checked against. This is so you can rotate keys if you wish; you move the existing key to key2 and make a new key value.