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

     1  :title: Customizing registry
     2  :description: Learn how to tune custom Deis settings.
     3  
     4  .. _registry_settings:
     5  
     6  Customizing registry
     7  =========================
     8  The following settings are tunable for the :ref:`registry` component.
     9  
    10  Dependencies
    11  ------------
    12  Requires: :ref:`cache <cache_settings>`, :ref:`store-gateway <store_gateway_settings>`
    13  
    14  Required by: :ref:`builder <builder_settings>`, :ref:`controller <controller_settings>`
    15  
    16  Considerations: none
    17  
    18  Settings set by registry
    19  --------------------------
    20  The following etcd keys are set by the registry component, typically in its /bin/boot script.
    21  
    22  ===========================              =================================================================================
    23  setting                                  description
    24  ===========================              =================================================================================
    25  /deis/registry/bucketName                store component bucket used for registry image layers (default: registry)
    26  /deis/registry/host                      IP address of the host running registry
    27  /deis/registry/port                      port used by the registry service (default: 5000)
    28  /deis/registry/protocol                  protocol for registry (default: http)
    29  ===========================              =================================================================================
    30  
    31  Settings used by registry
    32  ---------------------------
    33  The following etcd keys are used by the registry component.
    34  
    35  ====================================      =================================================================================
    36  setting                                   description
    37  ====================================      =================================================================================
    38  /deis/cache/host                          host of the cache component (set by cache)
    39  /deis/cache/port                          port of the cache component (set by cache)
    40  /deis/store/gateway/accessKey             S3 API access used to access store-gateway (set by store-gateway)
    41  /deis/store/gateway/host                  host of the store-gateway component (set by store-gateway)
    42  /deis/store/gateway/port                  port of the store-gateway component (set by store-gateway)
    43  /deis/store/gateway/secretKey             S3 API secret key used to access store-gateway (set by store-gateway)
    44  ====================================      =================================================================================
    45  
    46  The Deis registry component inherits from the Docker registry container, so additional configuration
    47  options can be supplied. For a full explanation of these settings, see the Docker registry `README`_.
    48  
    49  Using a custom registry image
    50  -----------------------------
    51  You can use a custom Docker image for the registry component instead of the image
    52  supplied with Deis:
    53  
    54  .. code-block:: console
    55  
    56      $ deisctl config registry set image=myaccount/myimage:latest
    57  
    58  This will pull the image from the public Docker registry. You can also pull from a private
    59  registry:
    60  
    61  .. code-block:: console
    62  
    63      $ deisctl config registry set image=registry.mydomain.org:5000/myaccount/myimage:latest
    64  
    65  Be sure that your custom image functions in the same way as the `stock registry image`_ shipped with
    66  Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
    67  
    68  .. _`stock registry image`: https://github.com/deis/deis/tree/master/registry
    69  .. _`README`: https://github.com/dotcloud/docker-registry/blob/master/README.md