1PCP_KUBE_PODS(1)            General Commands Manual           PCP_KUBE_PODS(1)
2
3
4

NAME

6       pcp-kube-pods - list Kubernetes pods to scan for running PCP services
7

SYNOPSIS

9       $PCP_BINADM_DIR/discover/pcp-kube-pods
10

DESCRIPTION

12       pcp-kube-pods  uses  kubectl(1)  to  provide a list of IP addresses for
13       PODs running in a local Kubenetes cluster, that may be running PCP ser‐
14       vices like pmcd(1) and pmproxy(1).
15
16       It  is  used by the pmfind(1) command and the pmDiscoverServices(3) API
17       as a ``shell'' command.
18
19       The script invokes the kubectl  get  pod  command  line  (see  kubectl-
20       get(1))  to  discover  IP addresses for pods.  The .status.podIP output
21       field is extracted  from  the  Kubernetes  pod  object(s).   Additional
22       options  can  be  specified  via  configuration  file,  such as -l ser‐
23       vice=database to restrict the results using Kubernetes pod labels.  The
24       default   configuration   file  is  $PCP_SYSCONF_DIR/discover/pcp-kube-
25       pods.conf
26
27       If no local kubectl command is found, nothing is reported and  an  exit
28       code indicating success is returned.
29

FILES

31       $PCP_BINADM_DIR/discover
32                 default  path  to  address  discovery commands like pcp-kube-
33                 pods.
34       $PCP_SYSCONF_DIR/discover/pcp-kube-pods.conf
35                 configuration file containing command line options passed  to
36                 kubectl-get.
37       $PCP_SYSCONF_DIR/discover/pcp-kube-pods.disabled
38                 existence of this file causes the script to report nothing
39

PCP ENVIRONMENT

41       Environment variables with the prefix PCP_ are used to parameterize the
42       file and directory names used by PCP.  On each installation,  the  file
43       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
44       $PCP_CONF variable may be used to specify an alternative  configuration
45       file, as described in pcp.conf(5).
46

SEE ALSO

48       kubectl-get(1),  kubectl(1),  pmcd(1), pmfind(1), pmDiscoverServices(3)
49       and pcp.env(5).
50

DIAGNOSTICS

52       All diagnostics produced are provided by the kubectl command.
53
54       The kubectl exit status is propogated unchanged.
55
56
57
58Performance Co-Pilot                  PCP                     PCP_KUBE_PODS(1)
Impressum