Help Center> Cloud Container Engine> User Guide> New Console> Workloads> Pod Labels and Annotations
View PDF

Pod Labels and Annotations

Pod Annotations

CCE allows you to add annotations to a YAML file to realize some advanced pod functions. The following table describes the annotations you can add.

Table 1 Pod annotations

Annotation

Description

Default Value

kubernetes.AOM.log.stdout

Parameter for container standard output collection. By default, the standard output of all containers is reported to AOM. You can specify ['container name'] to configure whether to report the standard output of certain containers or not.

-

metrics.alpha.kubernetes.io/custom-endpoints

Parameter for reporting AOM monitoring metrics that you specify.

For details, see Custom Monitoring.

-

prometheus.io/scrape

Parameter for reporting Prometheus metrics. If the value is true, the current workload reports the monitoring metrics.

For details, see Monitoring by Using the prometheus Add-on.

-

prometheus.io/path

URL for Prometheus to collect data.

For details, see Monitoring by Using the prometheus Add-on.

/metrics

prometheus.io/port

Endpoint port number for Prometheus to collect data.

For details, see Monitoring by Using the prometheus Add-on.

-

prometheus.io/scheme

Protocol used by Prometheus to collect data. The value can be http or https.

For details, see Monitoring by Using the prometheus Add-on.

-

kubernetes.io/ingress-bandwidth

Ingress bandwidth of a pod.

For details, see Configuring QoS Rate Limiting for Inter-Pod Access.

-

kubernetes.io/egress-bandwidth

Egress bandwidth of a pod.

For details, see Configuring QoS Rate Limiting for Inter-Pod Access.

-

Pod Labels

When you create a workload on the console, the following labels are added to the pod by default. The value of app is the workload name. You can add labels as required.

The pod labels added here will be added to the selector.matchLabels parameter in the workload definition. The following is an example YAML file:

...
spec:
  selector:
    matchLabels:
      app: nginx
      version: v1
  template:
    metadata:
      labels:
        app: nginx
        version: v1
    spec:
      ...
Parent topic: Workloads