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

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