PATROL Agent configuration variables

Agent configuration variables are the means by which the characteristics of a PATROL Agent are defined. To configure the Kubernetes Cluster for monitoring by using PATROL Configuration Manager, add the following set of agent configuration variables, and apply it on the PATROL Agent that runs PATROL for Kubernetes.

Directory path and variableDescription

/K8S/Clusters/<master node name>/DEBUG

Set this variable to enable or disable debug.

Valid values:

  • Enable - 1
  • Disable - 0

/K8S/Clusters/<master node name>/DeviceMapping

Indicates how the Kubernetes Node, Pod, and Container instances are seen on the TrueSight console.

If this option is not selected the Node, Pod, and Container instances appear below the PATROL Agent device in the TrueSight console. 

By default, Node and Pod instances are displayed as devices.

Note: If you modify this field, restart the PATROL Agent to apply the changes.

"/K8S/Clusters/<master node name>/LogLevel

Indicates the level at which the log files are generated.

  • FINE
  • FINER
  • FINEST 

FINEST level logs each debug log record.

Note: If debug is disabled, the log file contains only warning level log records.

/K8S/Clusters/<master node name>/NamespaceFilter

Set this variable to filter namespace instances. Enter a regular expression matching one or more entities.

The format is <regular-expression>\a<includeflag>

  • <regular-expression> - regular expression matching names
  • <includeflag>
    • 1 = include
    • 2 = exclude

Example:

  • To include all names that begin with Test enter Test.*1
  • To exclude all names that begin with Test enter Test.*2

/K8S/Clusters/<master node name>/authType

Select the authentication type to connect to the Kubernetes cluster.
  • Certificate based
  • Token based

/K8S/Clusters/<master node name>/clientCertPath

Specify the absolute path of the client certificate file on the PATROL Agent server. The certificate file must be in .pfx format.

Use this script to create the .pfx client certificate for kubernetes monitoring.

Note: The client certificate file must reside on the host where the PATROL agent is running.

BMC PATROL default account must have read permission for the client certificate file.

For example:

  • C:\cert\client-cert.pfx

  • /opt/bmc/cert/client-cert.pfx

/SecureStore/K8S_CLUSTER/<master node name>/authToken

Specify the bearer token to connect to the Kubernetes cluster. Use this script to create a service account and get the bearer token.

/SecureStore/K8S_CLUSTER/<KUBERNETES_MASTER>/clientCertPswdSpecify the password to access the client certificate file.

/K8S/Clusters/<master node name>/javaOpts

Indicates the additional Java Virtual Machine arguments for the Java collector.

/K8S/Clusters/<master node name>/name

Stores the host name or the IP address of the Kubernetes master node. Run the kubectl cluster-info command on the cluster to get the master (api server) hostname or IP address.

/K8S/Clusters/<master node name>/nodeDeviceMapping

Set this variable to enable or disable device mapping for nodes.

Valid values:

  • Enable - 1
  • Disable - 0
/K8S/Clusters/<master node name>/containerDeviceMapping

Set this variable to enable or disable device mapping for containers.

Valid values:

  • Enable - 1
  • Disable - 0

/K8S/Clusters/<master node name>/podDeviceMapping

Set this variable to enable or disable device mapping for pods.

Valid values:

  • Enable - 1
  • Disable - 0

/K8S/Clusters/<master node name>/portNumber

Stores the port number.
Was this page helpful? Yes No Submitting... Thank you

Comments