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

     1  :title: Customizing controller
     2  :description: Learn how to tune custom Deis settings.
     3  
     4  .. _controller_settings:
     5  
     6  Customizing controller
     7  =========================
     8  The following settings are tunable for the :ref:`controller` component.
     9  
    10  Dependencies
    11  ------------
    12  Requires: :ref:`cache <cache_settings>`, :ref:`database <database_settings>`, :ref:`registry <registry_settings>`
    13  
    14  Required by: :ref:`router <router_settings>`
    15  
    16  Considerations: none
    17  
    18  Settings set by controller
    19  --------------------------
    20  The following etcd keys are set by the controller component, typically in its /bin/boot script.
    21  
    22  ===========================              =================================================================================
    23  setting                                  description
    24  ===========================              =================================================================================
    25  /deis/controller/host                    IP address of the host running controller
    26  /deis/controller/port                    port used by the controller service (default: 8000)
    27  /deis/controller/protocol                protocol for controller (default: http)
    28  /deis/controller/secretKey               used for secrets (default: randomly generated)
    29  /deis/controller/builderKey              used by builder to authenticate with the controller (default: randomly generated)
    30  /deis/builder/users/*                    stores user SSH keys (used by builder)
    31  /deis/domains/*                          domain configuration for applications (used by router)
    32  ===========================              =================================================================================
    33  
    34  Settings used by controller
    35  ---------------------------
    36  The following etcd keys are used by the controller component.
    37  
    38  ====================================      ======================================================
    39  setting                                   description
    40  ====================================      ======================================================
    41  /deis/controller/registrationEnabled      enable registration for new Deis users (default: true)
    42  /deis/controller/webEnabled               enable controller web UI (default: false)
    43  /deis/cache/host                          host of the cache component (set by cache)
    44  /deis/cache/port                          port of the cache component (set by cache)
    45  /deis/database/host                       host of the database component (set by database)
    46  /deis/database/port                       port of the database component (set by database)
    47  /deis/database/engine                     database engine (set by database)
    48  /deis/database/name                       database name (set by database)
    49  /deis/database/user                       database user (set by database)
    50  /deis/database/password                   database password (set by database)
    51  /deis/registry/host                       host of the registry component (set by registry)
    52  /deis/registry/port                       port of the registry component (set by registry)
    53  /deis/registry/protocol                   protocol of the registry component (set by registry)
    54  ====================================      ======================================================
    55  
    56  Using a custom controller image
    57  -------------------------------
    58  You can use a custom Docker image for the controller component instead of the image
    59  supplied with Deis:
    60  
    61  .. code-block:: console
    62  
    63      $ deisctl config controller set image=myaccount/myimage:latest
    64  
    65  This will pull the image from the public Docker registry. You can also pull from a private
    66  registry:
    67  
    68  .. code-block:: console
    69  
    70      $ deisctl config controller set image=registry.mydomain.org:5000/myaccount/myimage:latest
    71  
    72  Be sure that your custom image functions in the same way as the `stock controller image`_ shipped with
    73  Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
    74  
    75  .. _`stock controller image`: https://github.com/deis/deis/tree/master/controller