Foglight for Container Management 4.0

Creating and Activating a Kubernetes Agent

To create a Kubernetes agent on a monitored host:

On the navigation panel, from Standard View click Container Environment or from Expert View click Dashboards > Container. Then the Container dashboard will display as below.

In the Container dashboard, click Administration tab, and then click Create Agent. The Create Docker Agent wizard opens.

Agent Manager: specify the following values, and then click Next.

•

Agent Manager: The Kubernetes Agent will be create in the selected Agent Manager.

•

Cluster Name: Customized cluster name which identifies a Kubernetes cluster.

•

Agent Name: Auto-generated agent name. You can change the name according to your requirement. It should be a unique name.

Agent Properties

•

Kubernetes API Service End Point: The format is: http(s)://<url:port>. If you have a Kubeconfig file, retrieve this endpoint from the file (path: clusters -> cluster -> server). If there are multiple clusters, find the current context related cluster server URL.

•

Collected Event Level: Set the collected event level, including ABNORMAL and ALL. ALL will collect both abnormal and normal events while Abnormal only collects abnormal events.

•

Enable Proxy: To enable the proxy, select the checkbox. Enter the Proxy Server Address and Proxy Server Port information.

•

Collector Configuration: Used to configure collection interval for inventory and metrics. You can change the collector intervals of defaultSchedule, however, this will affect all the Kubernetes Agents. Or you can create a new scheduler, configure the collector intervals, and then assign this scheduler to this agent.

Collector intervals to configure:

•

inventory interval (inventory data collection interval).

•

metrics interval (performance metrics data collection interval).

Credential

•

If no credentials were found for the provided resource, configure credentials:

•

Credential Properties: Click Load from file to upload the credential and click Next.

•

Credential Name and Lockbox: give a name for the credential, choose a lockbox, then click Next.

•

If an existing credential is detected, go to Metrics Collector directly.

Metrics Collector

Currently both Prometheus metrics collector and Heapster metric collector are supported. However, users are encouraged to use the Prometheus metrics collector.

Prometheus metrics collector

•

Have existing Prometheus in your cluster.


	NOTE: Ensure that you have Prometheus in your cluster before this step. We will check the service existence and health status after you click Next.

•

Select Prometheus Type.

•

Default type: allows Agent to use KubeConfig credentials to access the Prometheus service. Enter the existing Prometheus service namespace and name to configure the metrics collector.

•

OpenShift Prometheus type: you need to provide OpenShift Route Hostname, Username, and Password for Agent to access the target OpenShift Prometheus.


	NOTE: To find the Route Hostname, go to the OPENSHIFT ORIGIN dashboard, Application > Routes. Your OpenShift Login User should have the privilege to access to the Prometheus.

•

Do not have existing Prometheus in your cluster.

A Prometheus Configuration wizard will appear. To configure the metrics collector, either use the default Prometheus template or upload your own Prometheus deployment .yml files through Load from files.


	NOTE: Whenever you change the content in Configure file (template), ensure that the Namespace and Name fields are consistent with the Prometheus service configurations in your Configure file (template). If you are using the default template, there is no need to change anything. For a full version of the default template, see https://github.com/Foglight/Container/tree/master/prometheus

Reset from template: Helps you to reset the Configure file (template) content to the default template.

Deploy: Creates Prometheus components to your cluster with the Configure file.
After clicking Deploy, a progress message will be displayed.

•

If deployed successfully, a succeeded message will be displayed. Close the Validation Result page and then click Next to finish your agent creation process.

•

If failed to deploy the Prometheus configuration, a Validation Result page will be displayed with possible solutions.

Heapster metric collector

Enter the existing Heapster service namespace and name to configure the metrics collector.


	IMPORTANT: Deploy the Heapster service to your cluster manually before creating an agent with Heapster as metric collector. Otherwise, connection test to your Heapster service will fail, and you cannot proceed to the next step.

Summary: click Finish.

Then, the agent will be created and activated automatically.

Creating and Activating a Docker Swarm Agent

Each Docker Swarm Agent monitored one docker host. If the docker host belongs to a Docker Swarm cluster, it will be considered as a manager/worker node. Otherwise, it will be considered to be a standalone docker host.


	NOTE: For a Docker Swarm cluster, you should create one Docker Swarm Agent for one host in the cluster, and if you want to monitor the whole cluster environment, you need to create all the Docker Swarm Agents for all the hosts in the cluster.

To create a Docker Swarm agent on a monitored host:

On the navigation panel, under Dashboards, click Administration > Agents > Agent Status.

The Agent Status dashboard opens.

In the Agent Status dashboard, click Create Agent.

The Create Agent wizard opens.

Host Selector: Select the monitored host that you want to monitor with the Docker Swarm agent instance that you are about to create, and then click Next.


	NOTE: In order to select the host, the Foglight Agent Manager must be installed and running on the monitored host.

Agent Type and Instance Name: Specify the following values, and then click Next.

•

Agent Type: Select DockerSwarmAgent from the agent type list.

•

Agent Name: Specify the name of the agent instance that you are about to create using either of the following approaches:

•

Generic Name: This option is selected by default. A generic name is a combination of the host name and the agent type and uses the following syntax: agent_type@host_name.

•

Specify Name: Type that name in the Name field. For example, MyAgent.

On the Summary page, review the choices you have made, and then click Finish.

The Agents table refreshes automatically, showing the new Docker Swarm Agent.

On the Agents table, select the Docker Swarm Agent that you create, click Edit Properties, and then click Modify the private properties for this agent.

In the Agents properties view, check if the following values have been configured based upon your environment:

•

Name: give a name to the monitored docker host, it should be unique.

•

Host Name: IP address or host name of the monitored docker host.

•

Docker Remote API End Point: Docker Remote API endpoint of the monitored docker host. For more information, see Enabling Docker Remote API for monitored docker host .

•

Swarm Name: specify the swarm cluster name for display. If the swarm name is kept as “default”, then the cluster name will be displayed as “default (cluster ID)” on the dashboard. If a customized name is input here, then the customized cluster name will be displayed on the dashboard.