Help Center> Migration Center> Tool Guide> Tool Discovery> Configuring Collector Parameters> Kubernetes Conntrack Collector (app-discovery-k8s-conntrack)
Updated on 2024-01-17 GMT+08:00
View PDF

Kubernetes Conntrack Collector (app-discovery-k8s-conntrack)

The conntrack utility is used to collect the application association topology of a Kubernetes cluster. For details about the configuration parameters, see Table 1.

Table 1 Parameters for configuring the Kubernetes conntrack collector

Parameter

Mandatory

Configuration

output_path

No

Enter the storage path of the collection result file (app-discovery-k8s-conntrack-xxx.csv). If this parameter is left blank, the storage path defaults to <Collector installation path>\output\file.

Example: C:\Edge\tools\plugins\collectors\app-discovery-collectors\python\mgc-app-discovery-collectors\app-discovery-k8s-conntrack\output\file\app-discovery-k8s-conntrack-xxx.csv

rules_path

No

Enter the storage path of the collection rule file (a .properties file). If this parameter is left blank, the path defaults to <Collector installation path>\config\rules.properties.

Example: C:\Edge\tools\plugins\collectors\app-discovery-collectors\python\mgc-app-discovery-collectors\app-discovery-k8s-conntrack\config\rules.properties

NOTICE:

You are advised to use the default rule file. If you need to customize collection rules, modify the default rule file.

timeout

No

Specify the duration of a single collection, in seconds. The value is an integer ranging from 1 to the value of period. If this parameter is not set, half of the value of period is used by default.

max_count

No

Specify the maximum number of traffic records that can be collected for a node each time. The value must be an integer greater than or equal to 1. If this parameter is not set, the default value 1,000 is used.

period

No

Specify the collection interval, in minutes. The value is an integer ranging from 1 to 30. If this parameter is not set, the default value 1 m is used.

time

Yes

Specify the collection duration. If the collection duration exceeds the specified value, the collection stops. The unit can be m (minute), h (hour), or d (day). The value is an integer greater than or equal to 1.

nodes_path

No

Enter the storage path of the access configuration file of the nodes to be collected. If this parameter is left blank, the path defaults to <Collector installation path>\config\nodes.csv.

Example: C:\Edge\tools\plugins\collectors\app-discovery-collectors\python\mgc-app-discovery-collectors\app-discovery-k8s-conntrack\config\nodes.csv

NOTICE:

You are advised to use the default access configuration file. If you need to customize access information, modify the default file.

config_path

No

Enter the storage path of the cluster configuration file (.yaml). Alternatively, create a folder called kube-config in the config directory in the collector installation path and place the cluster configuration file in the folder. In this case, you do not need to set config_path, and the storage path defaults to <Collector installation path>\config\kube-config\xxx.yaml.

Example: C:\Edge\tools\plugins\collectors\app-discovery-collectors\python\mgc-app-discovery-collectors\app-discovery-k8s-conntrack\config\kube-config\xxx.yaml

To obtain the content of a cluster's configuration file, perform the following steps:

On a cluster node, run the following command, and copy the returned information to a YAML file.

cat ~/.kube/config
NOTICE:

Only one configuration file can be stored for a Kubernetes cluster.