github.com/guilhermebr/docker@v1.4.2-0.20150428121140-67da055cebca/docs/sources/docker-hub-enterprise/adminguide.md (about)

     1  page_title: Docker Hub Enterprise: Admin guide
     2  page_description: Documentation describing administration of Docker Hub Enterprise
     3  page_keywords: docker, documentation, about, technology, hub, enterprise
     4  
     5  # Docker Hub Enterprise Administrator's Guide
     6  
     7  This guide covers tasks and functions an administrator of Docker Hub Enterprise
     8  (DHE) will need to know about, such as reporting, logging, system management,
     9  performance metrics, etc.
    10  For tasks DHE users need to accomplish, such as using DHE to push and pull
    11  images, please visit the [User's Guide](./userguide).
    12  
    13  ## Reporting
    14  
    15  ### System Health
    16  
    17  ![System Health page</admin/metrics/>](../assets/admin-metrics.png)
    18  
    19  The "System Health" tab displays resource utilization metrics for the DHE host
    20  as well as for each of its contained services. The CPU and RAM usage meters at
    21  the top indicate overall resource usage for the host, while detailed time-series
    22  charts are provided below for each service. You can mouse-over the charts or
    23  meters to see detailed data points.
    24  
    25  Clicking on a service name (i.e., "load_balancer", "admin_server", etc.) will
    26  display the network, CPU, and memory (RAM) utilization data for the specified
    27  service. See below for a
    28  [detailed explanation of the available services](#services).
    29  
    30  ### Logs
    31  
    32  ![System Logs page</admin/logs/>](../assets/admin-logs.png)
    33  
    34  Click the "Logs" tab to view all logs related to your DHE instance. You will see
    35  log sections on this page for each service in your DHE instance. Older or newer
    36  logs can be loaded by scrolling up or down. See below for a
    37  [detailed explanation of the available services](#services).
    38  
    39  DHE's log files can be found on the host in `/usr/local/etc/dhe/logs/`. The
    40  files are limited to a maximum size of 64mb. They are rotated every two weeks,
    41  when the aggregator sends logs to the collection server, or they are rotated if
    42  a logfile would exceed 64mb without rotation. Log files are named `<component
    43  name>-<timestamp at rotation>`, where the "component name" is the service it
    44  provides (`manager`, `admin-server`, etc.).
    45  
    46  ### Usage statistics and crash reports
    47  
    48  During normal use, DHE generates usage statistics and crash reports. This
    49  information is collected by Docker, Inc. to help us prioritize features, fix
    50  bugs, and improve our products. Specifically, Docker, Inc. collects the
    51  following information:
    52  
    53  * Error logs
    54  * Crash logs
    55  
    56  ## Emergency access to the DHE admin web interface
    57  
    58  If your authenticated or public access to the DHE web interface has stopped
    59  working, but your DHE admin container is still running, you can add an
    60  [ambassador container](https://docs.docker.com/articles/ambassador_pattern_linking/)
    61  to get temporary unsecure access to it by running:
    62  
    63      $ docker run --rm -it --link docker_hub_enterprise_admin_server:admin -p 9999:80 svendowideit/ambassador
    64  
    65  > **Note:** This guide assumes you can run Docker commands from a machine where
    66  > you are a member of the `docker` group, or have root privileges. Otherwise,
    67  > you may need to add `sudo` to the example command above.
    68  
    69  This will give you access on port `9999` on your DHE server - `http://<dhe-host-ip>:9999/admin/`.
    70  
    71  ## Services
    72  
    73  DHE runs several Docker services which are essential to its reliability and
    74  usability. The following services are included; you can see their details by
    75  running queries on the [System Health](#system-health) and [Logs](#logs) pages:
    76  
    77  * `admin_server`: Used for displaying system health, performing upgrades,
    78  configuring settings, and viewing logs.
    79  * `load_balancer`: Used for maintaining high availability by distributing load
    80  to each image storage service (`image_storage_X`).
    81  * `log_aggregator`: A microservice used for aggregating logs from each of the
    82  other services. Handles log persistence and rotation on disk.
    83  * `image_storage_X`: Stores Docker images using the [Docker Registry HTTP API V2](https://github.com/docker/distribution/blob/master/doc/SPEC.md). Typically,
    84  multiple image storage services are used in order to provide greater uptime and
    85  faster, more efficient resource utilization.
    86  
    87  ## DHE system management
    88  
    89  The `dockerhubenterprise/manager` image is used to control the DHE system. This
    90  image uses the Docker socket to orchestrate the multiple services that comprise
    91  DHE.
    92  
    93       $ sudo bash -c "$(sudo docker run dockerhubenterprise/manager [COMMAND])"
    94  
    95  Supported commands are: `install`, `start`, `stop`, `restart`, `status`, and
    96  `upgrade`.
    97  
    98  > **Note**: `sudo` is needed for `dockerhubenterprise/manager` commands to
    99  > ensure that the Bash script is run with full access to the Docker host.
   100  
   101  ## Next Steps
   102  
   103  For information on installing DHE, take a look at the [Installation instructions](./install.md).