This article reviews how to add and configure a Docker connection using GroundWork Cloud Hub. The connection requires a unique set of parameters. If you are connecting to a remote GroundWork server to send results, you will need your remote GroundWork server RESTACCESSAPI token.

Adding a new connection

To access Cloud Hub configuration, log in to GroundWork Monitor as a member of the Admin role (e.g., user admin), and select Configuration > Cloud Hub. To add a new connection click the +Add button next to the Docker connector icon. You will need to create a new connection in this way for each Docker project to be monitored.

adding a new connection

Connection parameters

The data the GroundWork server receives comes from the remote virtualization server. The information is pulled from the API on a periodic basis based on the check interval that is set. In the configuration page you will need to enter both the GroundWork Server and Docker Connector parameters.

connection parameters

GroundWork server

  1. The GroundWork Server can simply be the same as the one you are running the Cloud Hub connector on, or it can be a remote server.
    • If it's the same as the one you are running on, leave the directive Use Local Connection checked. 
    • Otherwise, uncheck this box and fill in the hostname of the remote GroundWork server in the Hostname field, leave RESTAPIACCESS in the Username field, and paste in the the encrypted Token. The token can be obtained on the remote GroundWork server, for users within the Admin role, by going to Administration > Security under Webservices API Account: RESTAPIACCESSEncrypted Token. Just copy the key from the remote server into the Token field on the Cloud Hub server.

      restapiaccess token
  2. Once you have the GroundWork Server side of the form filled out, click TestIf you have the credentials correct and you have access to the API, you will see a Success message. Otherwise an error will give you a hint as to what is wrong and let you try again. 

    Using a remote server will populate the remote server with the Docker monitoring data, and this will not show in the local GroundWork Server.

    Table: GroundWork server values

    VersionIndicates the minimum GroundWork Monitor version needed. In other words, a version below the indicated value is incompatible.
    HostnameThe host name or IP address where a GroundWork server is running. A port number should not be entered here. If GroundWork is running on the same server, you can enter localhost.
    UsernameThe provisioned Username granted API access on the GroundWork server.
    TokenThe corresponding API Token for the given Username on the GroundWork server, see Administration > Security under Webservices API Account: RESTAPI Encryted Token.
    SSLCheck this box if the GroundWork server is provisioned with a secure HTTPS transport.
    Merge HostsIf checked, this option combines all metrics of same named hosts under one host. For example, if there is a Nagios configured host named demo1 and a Cloud Hub discovered host named demo1, the services for both configured and discovered hosts will be combined under the hostname demo1 (case-sensitive).
    MonitorIf checked, enables connection to be monitored.
    Use Local ConnectionThis directive refers to where the Cloud Hub results are sent.
    If this field is checked, results will be posted to the same server as where Cloud Hub is running.
    Or, with this field unchecked, you can forward results to any accessible GroundWork server you define with the name and API key.
    OwnershipOwnership is the owner of a connectors hosts and the ownership can be switched.
    When a Cloud Hub connector is instantiated the following options are available for ownership:

    Always take ownership: The connector will assume ownership of all hosts it instantiates, even merged hosts. This will remain true even if another app merges the host. 
    Leave ownership if already owned: The connector host will remain with the existing owner until or unless the owner deletes the host.
    Always defer ownership (default): This option leaves ownership unchanged on merged hosts, and allows other apps to take ownership.

    Note that multiple apps can report on a single service, but only one can own the host.
    Connection StatusClick Test to verify a connection using the GroundWork server entries.

Docker server

Next you will need to fill in the Docker Connector parameters and test the connection.

  1. Enter a Display Name.
  2. Enter the Docker Host:Port.
  3. Enter the Host Prefix.
  4. Optionally set the Interval and Retry directives.
  5. Validate the connection by clicking TestA dialog will be displayed with either a Success message or, if the project cannot be contacted, an error message will be displayed with a hint as to why the connection failed. When a successful connection is made, the Connection Status buttons will change to green.
  6. Click Save in the upper right corner to save your correct connection parameters. 
  7. After the credentials have been validated and the resources indicated, select the Metrics link (top navigation) to start customizing metrics for the connection. Please refer to the article How to determine Cloud Hub metrics to be monitored.

    Table: Docker server values

    Display NameThis is the configuration’s name displayed in the list of Cloud Hub connectors on the Cloud Hub home page.
    Docker Host:PortThis is the URL for the Docker virtualization server (e.g.,
    Host PrefixThis is the prefix of the host (e.g., qa- or docker1-).
    Cloud Hub Interval (min)This is the metric gathering interval for collecting monitoring data from Docker and sending it to the GroundWork server. The value is in minutes.
    Infinite RetriesCheck this box if you want Cloud Hub to infinitely retry connection to Docker when the connection fails. When this box is checked, the Retry Limit field is disabled. When this box is unchecked, the Retry Limit field is enabled.
    Retry LimitThis entry is the number of retries for the connection and sets a limit on how many attempts are made after a failure. The number set indicates how many connections are attempted before the connection is left in an inactive state. At this point, the connection is suspended and you will need to manually restart it. When a retry limit is exhausted, all hosts managed by this connection are set to the monitor status Unreachable and all services for the matched hosts are set to the status of Unknown.
    Connection StatusClick Test to verify a connection using the Docker connector entries.

Related articles