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

     1  :title: Customizing builder
     2  :description: Learn how to tune custom Deis settings.
     3  
     4  .. _builder_settings:
     5  
     6  Customizing builder
     7  =========================
     8  The following settings are tunable for the :ref:`builder` component. Values are stored in etcd.
     9  
    10  Dependencies
    11  ------------
    12  Requires: :ref:`controller <controller_settings>`, :ref:`registry <registry_settings>`
    13  
    14  Required by: :ref:`router <router_settings>`
    15  
    16  Settings set by builder
    17  -----------------------
    18  The following etcd keys are set by the builder component, typically in its /bin/boot script.
    19  
    20  ==================              ================================================
    21  setting                         description
    22  ==================              ================================================
    23  /deis/builder/host              IP address of the host running builder
    24  /deis/builder/port              port used by the builder service (default: 2223)
    25  ==================              ================================================
    26  
    27  Settings used by builder
    28  ---------------------------
    29  The following etcd keys are used by the builder component.
    30  
    31  ====================================      ===========================================================
    32  setting                                   description
    33  ====================================      ===========================================================
    34  /deis/builder/users/*                     user SSH keys to provision (set by controller)
    35  /deis/controller/builderKey               used to communicate with the controller (set by controller)
    36  /deis/controller/host                     host of the controller component (set by controller)
    37  /deis/controller/port                     port of the controller component (set by controller)
    38  /deis/controller/protocol                 protocol of the controller component (set by controller)
    39  /deis/registry/host                       host of the controller component (set by registry)
    40  /deis/registry/port                       port of the controller component (set by registry)
    41  /deis/services/*                          healthy application containers reported by deis/publisher
    42  /deis/slugbuilder/image                   slugbuilder image to use (default: deis/slugbuilder:latest)
    43  /deis/slugrunner/image                    slugrunner image to use (default: deis/slugrunner:latest)
    44  ====================================      ===========================================================
    45  
    46  Using a custom builder image
    47  ----------------------------
    48  You can use a custom Docker image for the builder component instead of the image
    49  supplied with Deis:
    50  
    51  .. code-block:: console
    52  
    53      $ deisctl config builder 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 builder 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 builder image`_ shipped with
    63  Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
    64  
    65  .. _`stock builder image`: https://github.com/deis/deis/tree/master/builder
    66  .. _`#985`: https://github.com/deis/deis/issues/985