github.com/misfo/deis@v1.0.1-0.20141111224634-e0eee0392b8a/docs/customizing_deis/store_metadata_settings.rst (about)

     1  :title: Customizing store-metadata
     2  :description: Learn how to tune custom Deis settings.
     3  
     4  .. _store_metadata_settings:
     5  
     6  Customizing store-metadata
     7  ==========================
     8  The following settings are tunable for the :ref:`store` component's metadata service.
     9  
    10  Dependencies
    11  ------------
    12  Requires: :ref:`store-daemon <store_daemon_settings>`, :ref:`store-monitor <store_monitor_settings>`
    13  
    14  Required by: store-volume service (runs on all hosts - not a Deis component)
    15  
    16  Considerations: none
    17  
    18  Settings set by store-metadata
    19  ------------------------------
    20  The following etcd keys are set by the store-metadata component, typically in its /bin/boot script.
    21  
    22  ===================================       ==============================================
    23  setting                                   description
    24  ===================================       ==============================================
    25  /deis/store/filesystemSetupComplete       Set when the Ceph filesystem setup is complete
    26  ===================================       ==============================================
    27  
    28  Settings used by store-metadata
    29  -------------------------------
    30  The following etcd keys are used by the store-metadata component.
    31  
    32  ====================================      =================================================================================================
    33  setting                                   description
    34  ====================================      =================================================================================================
    35  /deis/store/adminKeyring                  keyring for an admin user to access the Ceph cluster (set by store-monitor)
    36  /deis/store/fsid                          Ceph filesystem ID (set by store-monitor)
    37  /deis/store/hosts/*                       deis-monitor hosts (set by store-monitor)
    38  /deis/store/monKeyring                    keyring for the monitor to access the Ceph cluster (set by store-monitor)
    39  /deis/store/monSetupComplete              set when the Ceph cluster setup is complete (set by store-monitor)
    40  /deis/store/monSetupLock                  host of store-monitor that completed setup (set by store-monitor)
    41  /deis/store/minSize                       minimum number of store-daemons necessary for the cluster to accept writes (set by store-monitor)
    42  /deis/store/pgNum                         number of Ceph placement groups for the storage pools (set by store-monitor)
    43  /deis/store/size                          number of replicas for data stored in Ceph (set by store-monitor)
    44  ====================================      =================================================================================================
    45  
    46  Using a custom store-metadata image
    47  -----------------------------------
    48  You can use a custom Docker image for the store-metadata component instead of the image
    49  supplied with Deis:
    50  
    51  .. code-block:: console
    52  
    53      $ deisctl config store-metadata set image=myaccount/myimage:latest
    54  
    55  This will pull the image from the public Docker registry. You can also pull from a private
    56  registry:
    57  
    58  .. code-block:: console
    59  
    60      $ deisctl config store-metadata set image=registry.mydomain.org:5000/myaccount/myimage:latest
    61  
    62  Be sure that your custom image functions in the same way as the `stock store-metadata image`_ shipped with
    63  Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
    64  
    65  .. _`stock store-metadata image`: https://github.com/deis/deis/tree/master/store/metadata