The end of life (EOL) date for this integration is 30 September 2020. This documentation is now archived and is no longer updated. The Collection Agent plugin for Kubernetes now replaces this integration, see Installation in a Kubernetes or OpenShift environment.
Red Hat OpenShift Container Platform is an enterprise application platform, built for containers that use Kubernetes and offering full control over Kubernetes environments.
OpenShift integration enables you to retrieve all metrics and metadata available in your OpenShift environment and display them as dataviews in Geneos. You can query services of your OpenShift running environment, see the number of pods, list the available images you can deploy, check the ability to deploy builds, and tail logs from a pod or from a container.
The integration provides a Gateway configuration file that enables monitoring of (Undefined variable: Integrations/openshift.openshift-name) through a set of pre-configured Toolkit samplers.
This guide walks you through the integration process.
This user guide is intended for experienced Geneos users who want to set up and configure an integration between Geneos and OpenShift. This is also intended for users who are monitoring data from the OpenShift environment.
As a user, you should be familiar with Python and with general administration of OpenShift web console.
The following requirements must be met on the machine where the Netprobe is installed:
- Geneos version 4.11.x or higher.
- Python 3.4 or higher.
occlient binary, version 3.11 or higher. It can be downloaded from the official OpenShiftGitHub repository.
- The package contains an executable file named
oc. Use the
loginoption to generate your OpenShift configuration file that contains a token that allows the connection to your OpenShift environment.
- The package contains an executable file named
- Access to an OpenShift environment version 3.10 or higher or access to the OpenShift online service.
- You need to be authenticated to OpenShift from the host where your Netprobe is running.
Note: The support and compatibility that ITRS provides are only limited to the currently supported versions of OpenShift. In addition, not all resources covered in our samplers might be available in your OpenShift environment.
The OpenShift monitoring integration is largely pre-configured and involves these primary steps:
- Download the integration files from the resources site.
- Load the integration file in the Gateway Setup Editor.
- Associate the samplers with a managed entity.
- Configure the dataviews.
Note: The include files are intended to be read-only and should not be edited (unless the integration specifically requires for them to be modified). This is because include files can be shared between a few instances of a Gateway and best practice is to share them in their default state. It is also to make the upgrades and maintenance process of the integration files easier. All configuration should be carried out in your local Gateway files instead.
- Download the integration package
geneos-integration-openshift-<version>.zipfrom the ITRS Downloads site.
- As a best practice, save the files on the same machine where your Gateway is running.
The integration package includes the
include/openshiftMonitoring.xml file. This is a Gateway configuration file (also called an include file) containing Toolkit samplers configured for OpenShift monitoring integration.
To load the integration files into the Gateway Setup Editor, follow these steps:
- Open Gateway Setup Editor.
- In the Navigation panel, click Includes to create a new file.
- Enter the location of the file to include in the Location field. In this example, it is
- Update the Priority field. This can be any value except
1. If you input a priority of
1, the Gateway Setup Editor returns an error when you save your changes.
- Expand the file location in the Include section.
- Select Click to load.
- Click Yes to load the new include file.
Success: Gateway configuration now appears in the Includes section.
After you have loaded the configuration file, the OpenShift samplers become available. These samplers are associated with a pre-defined Type. To associate the samplers with a managed entity, follow these steps:
- In the Gateway Setup Editor, create a new managed entity by right-clicking the Managed entities folder.
- Under the Basic tab for the new managed entity, add a pre-configured
- Specify the environment associated with the samplers. By default, this is
- Apply the managed entity to the running Netprobe.
- Click Validate current document to check your configuration.
- Click Save current document to apply the changes.
Success: After you save your changes to the managed entity, the OpenShift dataviews appear under the managed entity on the state tree.
For more information about include files, see the 'Include' files in Gateway Setup Editor.
This integration provides a number of samplers, each with default dataview. You can customise some of them to show details of specific pods, nodes or containers. Samplers that can be customised are:
To configure a sampler with a particular pod, node or container, use the environment variables. The value of the variable is a name or uid of what you want to see the details of.
Below you can see an example configuration of a specific PodHealth sampler.
When viewing the metrics you can also communicate with the OpenShift environment by streaming the logs out of that environment. This is achieved by using the preconfigured commands.
The following commands are available:
- For pods:
- Describe pod — displays metadata and build information for this pod.
- Get pods log — used if there is only one container. If there are more, an error is displayed.
- Get pods containers log — used if there is more than one container. You must specify a container name to get the logs for that container.
- For nodes:
- Describe node — displays metadata of the selected event.
- For events:
- Describe event — displays metadata of the selected event.
For more information about using and configuring commands, see Gateway Commands.
The default environment configuration is created by the
openshiftMonitoring.xml script. You can create a new environment based on the default and modify the environment variables according to your system.
Note: Standard variable scoping rules apply when variable reference is used in include files. Please take note of that when creating your own variables. For more information, see Variable Scoping and Resolution in User Variables and Environments.
openshiftMonitoring.xml script provides the variables that are set in the Environments section. They need to be configured to ensure that the integration monitors your target OpenShift environment.
|PYTHON_PATH||String||Path of the Python library located on the machine where the Netprobeis running.|
Path of the oc client used to connect to a cluster.
|OPENSHIFT_URL||String||URL of your OpenShift web console.|
|OPENSHIFT_LABEL||String||Used to assign a name to a group of samplers.|
|OPENSHIFT_MANUAL_SAMPLE||Integer||Frequency of sampling. If checks are executed manually, the value is
You can also use environment variables when configuring the samplers. The available environment variables are:
|OC_GET_ALL_SPACES||String||Get a list of all name spaces. This is used by administrators to get access to everything in the OpenShift environment.|
|OC_GET_AUTH||String||Get a list of authorize tokens and their expiration.|
Get a list of routes and their target ports.
|OC_GET_PROJECTS||String||Get a list of associated projects.|
|OC_GET_QUOTAS||String||Get a list of quotas and limits.|
|OC_GET_PODS_METADATA||String||Get a list of pods and their metadata.|
|OC_GET_PODS_SPECDATA||String||Get a list of pods and their specdata.|
|OC_GET_PODS_HEALTH||String||Get a list of pod's health conditions. You must provide pod's name or uid.|
|OC_GET_POD_CONTAINERS||String||Get a list of a pod's containers and their statuses. You must provide pod's name or uid.|
|OC_GET_SERVICES||String||Get a list of services and their port info.|
|OC_GET_EVENTS||String||Get a list of recent events and their descriptions.|
|OC_GET_NODES_METADATA||String||Get a list of nodes and their associated metadata.|
|OC_GET_NODES_STATUS||String||Get a list of nodes and their hardware status.|
|OC_GET_NODES_INFO||String||Get a list of nodes and their hardware info (for example, OS, Arch, etc).|
|OC_GET_NODE_HEALTH||String||Get a list of node's health conditions. You must provide node's name or uid.|
The OpenShift monitoring integration provides a number of samplers each with a default dataview. The sections below show example dataviews.
Note: Your access to the dataviews in Geneos depends on your permission levels in OpenShift. If you do not have permission to view a certain pod, you cannot see applicable dataviews in Geneos.
This dataview displays a list of events and the number of times the events occurred along with their details.
This dataview displays a high level overview of all nodes, capacity, and where they are located.
This dataview displays a list of access tokens to accounts that logged into your OpenShift project. You can check if users logged through the client or the web console, how many successful logins there were, and how much time the person has in their session.
This dataview displays a list of containers in a specific pod, it also shows the state of the containers.
This dataview displays an overview of all pods running in your environment. OpenShift uses the labelling system as a way to identify and add properties to these pods. This information is stored in the labels.
This dataview displays specification of the pods and how many containers there are. For example, if you forget which node your pod is running on, you can check it here. You can also check how long it takes for the pod to terminate.
This dataview displays a list of quota limits and current consumption on pods, secrets and other resources.
This dataview displays a list of services showing their route and port information (for example, available ports).