github.com/technosophos/deis@v1.7.1-0.20150915173815-f9005256004b/docs/customizing_deis/cache_settings.rst (about)

     1  :title: Customizing cache
     2  :description: Learn how to tune custom Deis settings.
     3  
     4  .. _cache_settings:
     5  
     6  Customizing cache
     7  =========================
     8  The following settings are tunable for the :ref:`cache` component. Values are stored in etcd.
     9  
    10  Dependencies
    11  ------------
    12  Requires: none
    13  
    14  Required by: :ref:`controller <controller_settings>`, :ref:`registry <registry_settings>`
    15  
    16  Considerations: none
    17  
    18  Settings set by cache
    19  ---------------------
    20  The following etcd keys are set by the cache component, typically in its /bin/boot script.
    21  
    22  ================              ==============================================
    23  setting                       description
    24  ================              ==============================================
    25  /deis/cache/host              IP address of the host running cache
    26  /deis/cache/port              port used by the cache service (default: 6379)
    27  ================              ==============================================
    28  
    29  Settings used by cache
    30  ----------------------
    31  
    32  .. important::
    33  
    34     All changes require a restart.
    35  
    36  
    37  The following etcd keys are used by the cache component.
    38  
    39  ====================================      =============================================================================================================================================================================================
    40  setting                                   description
    41  ====================================      =============================================================================================================================================================================================
    42  /deis/cache/maxmemory                     maximum memory used for caching (default: 50mb)
    43  ====================================      =============================================================================================================================================================================================
    44  
    45  Using a custom cache image
    46  --------------------------
    47  You can use a custom Docker image for the cache component instead of the image
    48  supplied with Deis:
    49  
    50  .. code-block:: console
    51  
    52      $ deisctl config cache set image=myaccount/myimage:latest
    53  
    54  This will pull the image from the public Docker registry. You can also pull from a private
    55  registry:
    56  
    57  .. code-block:: console
    58  
    59      $ deisctl config cache set image=registry.mydomain.org:5000/myaccount/myimage:latest
    60  
    61  Be sure that your custom image functions in the same way as the `stock cache image`_ shipped with
    62  Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
    63  
    64  .. _`stock cache image`: https://github.com/deis/deis/tree/master/cache