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

     1  :title: Customizing database
     2  :description: Learn how to tune custom Deis settings.
     3  
     4  .. _database_settings:
     5  
     6  Customizing database
     7  =========================
     8  The following settings are tunable for the :ref:`database` component.
     9  
    10  Dependencies
    11  ------------
    12  Requires: :ref:`store-gateway <store_gateway_settings>`
    13  
    14  Required by: :ref:`controller <controller_settings>`
    15  
    16  Considerations: none
    17  
    18  Settings set by database
    19  ------------------------
    20  The following etcd keys are set by the database component, typically in its /bin/boot script.
    21  
    22  ===========================              =================================================================================
    23  setting                                  description
    24  ===========================              =================================================================================
    25  /deis/database/adminPass                 database admin password (default: changeme123)
    26  /deis/database/adminUser                 database admin user (default: postgres)
    27  /deis/database/bucketName                store component bucket used for database WAL logs and backups (default: db_wal)
    28  /deis/database/engine                    database engine (default: postgresql_psycopg2)
    29  /deis/database/host                      IP address of the host running database
    30  /deis/database/name                      database name (default: deis)
    31  /deis/database/password                  database password (default: changeme123)
    32  /deis/database/port                      port used by the database service (default: 5432)
    33  /deis/database/user                      database user (default: deis)
    34  ===========================              =================================================================================
    35  
    36  Settings used by database
    37  -------------------------
    38  The following etcd keys are used by the database component.
    39  
    40  ====================================      ====================================================================================
    41  setting                                   description
    42  ====================================      ====================================================================================
    43  /deis/store/gateway/accessKey             S3 API access used to access the deis store gateway (set by store-gateway)
    44  /deis/store/gateway/host                  host of the store gateway component (set by store-gateway)
    45  /deis/store/gateway/port                  port of the store gateway component (set by store-gateway)
    46  /deis/store/gateway/secretKey             S3 API secret key used to access the deis store gateway (set by store-gateway)
    47  ====================================      ====================================================================================
    48  
    49  Using a custom database image
    50  -----------------------------
    51  You can use a custom Docker image for the database component instead of the image
    52  supplied with Deis:
    53  
    54  .. code-block:: console
    55  
    56      $ deisctl config database 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 database 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 database image`_ shipped with
    66  Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
    67  
    68  .. _`stock database image`: https://github.com/deis/deis/tree/master/database