The COM.TIBCO.hawk.microagent.DockerHostMA Microagent
The DockerHostMA microagent is available on each Docker host as a part of the Hawk agent. It monitors and manages all containers running on that particular Docker host. The microagent communicates with DockerHost using Docker client API.
For details, see Docker Client API Documentation.
Environment Variables
| Environment Variable | Description |
|---|---|
| DOCKER_HOST | The
DOCKER_HOST environment variable specifies URL for the Docker host.
The DOCKER_HOST URL can either be a UNIX socket or an TCP socket. For using the Unix socket, mount the Docker Unix socket into the hkce_agent container as a volume: /var/run/docker.sock:/var/run/docker.sock. Then set DOCKER_HOST to the Unix socket URL: unix:///var/run/docker.sock For using the TCP socket, enable the TCP socket for Docker. For details, see the dockerd command details at Docker Documentation. Then the DOCKER_HOST should be set to the HTTP endpoint of your TCP socket. |
| DOCKER_CERT_PATH | The DOCKER_CERT_PATH environment variable specifies the location of client certificates for secure communication with the Docker host. |
- The DockerHostMA:getContainerInfo Method
The DockerHostMA:getContainerInfo method returns information about the container that matches the given ContainerName. - The DockerHostMA:getContainerStats Method
The DockerHostMA:getContainerStats method returns the resource usage details for the container that matches the given ContainerName. - The DockerHostMA:onContainerLogs Method
The DockerHostMA:onContainerLogs method listens for container logs and returns them. - The DockerHostMA:getContainerProcessInfo Method
The DockerHostMA:getContainerProcessInfo method returns the details of processes running inside the container. - The DockerHostMA:startContainer Method
The DockerHostMA:startContainer method starts the container that matches the given ContainerName. - The DockerHostMA:stopContainer Method
The DockerHostMA:stopContainer method stops the container that matches the given ContainerName. - The DockerHostMA:restartContainer Method
The DockerHostMA:restartContainer method restarts the container that matches the given ContainerName. - The DockerHostMA:killContainer Method
The DockerHostMA:killContainer method kills the container that matches the given ContainerName. - The DockerHostMA:pauseContainer Method
The DockerHostMA:pauseContainer method pauses the container that matches the given ContainerName. - The DockerHostMA:unpauseContainer Method
The DockerHostMA:unpauseContainer method resumes the paused container that matches the given ContainerName. - The DockerHostMA:removeContainer Method
The DockerHostMA:removeContainer method removes the container that matches the given ContainerName. - The DockerHostMA:getDockerImages Method
The DockerHostMA:getDockerImages method returns information of the Docker image. - The DockerHostMA:getDockerVolumes Method
The DockerHostMA:getDockerVolumes method returns information about the Docker volume.