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

     1  :title: Customizing router
     2  :description: Learn how to tune custom Deis settings.
     3  
     4  .. _router_settings:
     5  
     6  Customizing router
     7  =========================
     8  The following settings are tunable for the :ref:`router` component.
     9  
    10  Dependencies
    11  ------------
    12  Requires: :ref:`builder <builder_settings>`, :ref:`controller <controller_settings>`, :ref:`store-gateway <store_gateway_settings>`
    13  
    14  Required by: none
    15  
    16  Considerations: none
    17  
    18  Settings set by router
    19  --------------------------
    20  The following etcd keys are set by the router component, typically in its /bin/boot script.
    21  
    22  =============================            ===================================================================================
    23  setting                                  description
    24  =============================            ===================================================================================
    25  /deis/router/hosts/$HOST                 IP address and port of the host running this router (there can be multiple routers)
    26  =============================            ===================================================================================
    27  
    28  Settings used by router
    29  ---------------------------
    30  The following etcd keys are used by the router component.
    31  
    32  =======================================      ==================================================================================================================================================================================================================================================================================================================================
    33  setting                                      description
    34  =======================================      ==================================================================================================================================================================================================================================================================================================================================
    35  /deis/builder/host                           host of the builder component (set by builder)
    36  /deis/builder/port                           port of the builder component (set by builder)
    37  /deis/controller/host                        host of the controller component (set by controller)
    38  /deis/controller/port                        port of the controller component (set by controller)
    39  /deis/domains/*                              domain configuration for applications (set by controller)
    40  /deis/router/bodySize                        nginx body size setting (default: 1m)
    41  /deis/router/builder/timeout/connect         proxy_connect_timeout for deis-builder (default: 10000). Unit in miliseconds
    42  /deis/router/builder/timeout/read            proxy_read_timeout for deis-builder (default: 1200000). Unit in miliseconds
    43  /deis/router/builder/timeout/send            proxy_send_timeout for deis-builder (default: 1200000). Unit in miliseconds
    44  /deis/router/builder/timeout/tcp             timeout for deis-builder (default: 1200000). Unit in miliseconds
    45  /deis/router/controller/timeout/connect      proxy_connect_timeout for deis-controller (default: 10m)
    46  /deis/router/controller/timeout/read         proxy_read_timeout for deis-controller (default: 20m)
    47  /deis/router/controller/timeout/send         proxy_send_timeout for deis-controller (default: 20m)
    48  /deis/router/gzip                            nginx gzip setting (default: on)
    49  /deis/router/gzipCompLevel                   nginx gzipCompLevel setting (default: 5)
    50  /deis/router/gzipDisable                     nginx gzipDisable setting (default: "msie6")
    51  /deis/router/gzipHttpVersion                 nginx gzipHttpVersion setting (default: 1.1)
    52  /deis/router/gzipMinLength                   nginx gzipMinLength setting (default: 256)
    53  /deis/router/gzipProxied                     nginx gzipProxied setting (default: any)
    54  /deis/router/gzipTypes                       nginx gzipTypes setting (default: "application/atom+xml application/javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component")
    55  /deis/router/gzipVary                        nginx gzipVary setting (default: on)
    56  /deis/router/gzipDisable                     nginx gzipDisable setting (default: "msie6")
    57  /deis/router/gzipTypes                       nginx gzipTypes setting (default: "application/x-javascript application/xhtml+xml application/xml application/xml+rss application/json text/css text/javascript text/plain text/xml")
    58  /deis/router/sslCert                         cluster-wide SSL certificate
    59  /deis/router/sslKey                          cluster-wide SSL private key
    60  /deis/services/*                             healthy application containers reported by deis/publisher
    61  /deis/store/gateway/host                     host of the store gateway component (set by store-gateway)
    62  /deis/store/gateway/port                     port of the store gateway component (set by store-gateway)
    63  =======================================      ==================================================================================================================================================================================================================================================================================================================================
    64  
    65  Using a custom router image
    66  ---------------------------
    67  You can use a custom Docker image for the router component instead of the image
    68  supplied with Deis:
    69  
    70  .. code-block:: console
    71  
    72      $ deisctl config router set image=myaccount/myimage:latest
    73  
    74  This will pull the image from the public Docker registry. You can also pull from a private
    75  registry:
    76  
    77  .. code-block:: console
    78  
    79      $ deisctl config router set image=registry.mydomain.org:5000/myaccount/myimage:latest
    80  
    81  Be sure that your custom image functions in the same way as the `stock router image`_ shipped with
    82  Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
    83  
    84  .. _`stock router image`: https://github.com/deis/deis/tree/master/router