github.com/deis/deis@v1.13.5-0.20170519182049-1d9e59fbdbfc/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:`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. Periods are not allowed in the name (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 a Redis cache (optional)
    39  /deis/cache/port                          port of a Redis cache (optional)
    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  If the ``/deis/registry/s3bucket`` key is supplied, the registry
    47  will use Amazon S3 as its storage backend and use the following values.
    48  
    49  ====================================      =================================================================================
    50  setting                                   description
    51  ====================================      =================================================================================
    52  /deis/registry/s3accessKey                S3 API access key. If not specified, the registry will get it from the instance role
    53  /deis/registry/s3secretKey                S3 API secret key, required if s3accessKey is specified
    54  /deis/registry/s3region                   S3 region to connect to, will use boto default if not specified
    55  /deis/registry/s3bucket                   S3 bucket to store images. Periods are not allowed in the name.
    56  /deis/registry/s3path                     path in the bucket (default: "/registry")
    57  /deis/registry/s3encrypt                  whether the object is encrypted while at rest on the server (default: true)
    58  /deis/registry/s3secure                   use secure protocol to establish connection with S3 (default: true)
    59  ====================================      =================================================================================
    60  
    61  The Deis registry component inherits from the Docker registry container, so additional configuration
    62  options can be supplied. For a full explanation of these settings, see the Docker registry `README`_.
    63  
    64  Using a custom registry image
    65  -----------------------------
    66  You can use a custom Docker image for the registry component instead of the image
    67  supplied with Deis:
    68  
    69  .. code-block:: console
    70  
    71      $ deisctl config registry set image=myaccount/myimage:latest
    72  
    73  This will pull the image from the public Docker registry. You can also pull from a private
    74  registry:
    75  
    76  .. code-block:: console
    77  
    78      $ deisctl config registry set image=registry.mydomain.org:5000/myaccount/myimage:latest
    79  
    80  Be sure that your custom image functions in the same way as the `stock registry image`_ shipped with
    81  Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
    82  
    83  .. _`stock registry image`: https://github.com/deis/deis/tree/master/registry
    84  .. _`README`: https://github.com/dotcloud/docker-registry/blob/master/README.md