bionic (5) container-sync-realms.conf.5.gz

Provided by: swift-container_2.17.1-0ubuntu1_all bug

NAME

       container-sync-realms.conf - configuration file for the OpenStack Swift container sync realms

SYNOPSIS

       container-sync-realms.conf

DESCRIPTION

       This  is  the  configuration  file  used  by  the  Object storage Swift to perform container to container
       synchronization. This configuration file is used to configure  clusters  to  allow/accept  sync  requests
       to/from  other  clusters. Using this configuration file, the user specifies where to sync their container
       to along with a secret synchronization key.

       You   can   find    more    information    about    container    to    container    synchronization    at
       https://docs.openstack.org/swift/latest/overview_container_sync.html

       The  configuration  file  follows the python-pastedeploy syntax. The file is divided into sections, which
       are enclosed by square brackets. Each section will contain a certain number of key/value parameters which
       are described later.

       Any line that begins with a '#' symbol is ignored.

       You    can    find    more    information    about    python-pastedeploy    configuration    format    at
       http://pythonpaste.org/deploy/#config-format

GLOBAL SECTION

       This is indicated by section named [DEFAULT]. Below are the parameters that are  acceptable  within  this
       section.

       mtime_check_interval
              The  number  of  seconds  between  checking  the modified time of this config file for changes and
              therefore reloading it. The default value is 300.

REALM SECTIONS

       Each section name is the name of a sync realm, for example [realm1].  A sync realm is a set  of  clusters
       that  have  agreed  to  allow  container  syncing  with  each other.  Realm names will be considered case
       insensitive. Below are the parameters that are acceptable within this section.

       cluster_clustername1
              Any values in the realm section whose name begin with cluster_ will indicate the name and endpoint
              of  a cluster and will be used by external users in their container's X-Container-Sync-To metadata
              header values with the format as "realm_name/cluster_name/container_name".  The Realm and  cluster
              names are considered to be case insensitive.

       cluster_clustername2
              Any values in the realm section whose name begin with cluster_ will indicate the name and endpoint
              of a cluster and will be used by external users in their container's X-Container-Sync-To  metadata
              header  values with the format as "realm_name/cluster_name/container_name".  The Realm and cluster
              names are considered to be case insensitive.

              The endpoint is what the container sync daemon will use when sending out requests to that cluster.
              Keep  in  mind  this  endpoint must be reachable by all container servers, since that is where the
              container sync daemon runs. Note that the endpoint ends with /v1/  and  that  the  container  sync
              daemon will then add the account/container/obj name after that.

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

EXAMPLE

       [DEFAULT]
       mtime_check_interval = 300

       [realm1]
       key = realm1key
       key2 = realm1key2
       cluster_clustername1 = https://host1/v1/
       cluster_clustername2 = https://host2/v1/

       [realm2]
       key = realm2key
       key2 = realm2key2
       cluster_clustername3 = https://host3/v1/
       cluster_clustername4 = https://host4/v1/

DOCUMENTATION

       More  in depth documentation in regards to swift-container-sync and also about OpenStack Swift as a whole
       can    be    found    at     https://docs.openstack.org/swift/latest/overview_container_sync.html     and
       https://docs.openstack.org/swift/latest/

SEE ALSO

       swift-container-sync(1)