Updated on 2026-04-28 GMT+08:00

Annotation Description

By adding annotations in the YAML file, you can use some advanced functions provided by CCI. This section describes the available annotations when a pod is created.

Table 1 Annotations

Function and Reference

Annotation

Type

Description

Specifying the Pod Type

resource.cci.io/instance-type

String

Pod type

Specifying Multiple Pod Types

resource.cci.io/instance-type-preference

String

Pod types. Separate multiple pod types with commas (,). CCI will select one from them. resource.cci.io/instance-type-preference and resource.cci.io/instance-type cannot be specified at the same time. The following is an example:

resource.cci.io/instance-type-preference: A,B,C

When a pod is being created, A, B, or C will be selected as the pod type.

Upgrading Pod Flavors

resource.cci.io/pod-size-specs

String

Pod flavor

resource.cci.io/size

String

The value is set by CCI and is the final pod flavor.

resource.cci.io/resizing-large-size-instance-greater-than-32-cores

String

Whether to automatically upgrade the pod flavor if the pod has over 32 vCPUs.

Increasing the Reserved System Overhead

resource.cci.io/memory-reservation

String

Whether to reserve system overhead. The default value is false. If this parameter is set to true, system overhead will be reserved.

resource.cci.io/memory-burst-size

String

Whether to increase the container memory limits to the memory in the pod flavor. The default value is false. If this parameter is set to true, this option is enabled.

Binding an Existing EIP to a Pod

yangtse.io/eip-id

String

ID of an existing EIP that will be bound

Binding a New EIP to a Pod

yangtse.io/pod-with-eip

String

Whether to bind a new EIP to the pod. The value false indicates that no new EIP will be bound to the pod, and the value true indicates that a new EIP will be bound to the pod.

yangtse.io/eip-bandwidth-size

String

Bandwidth, in Mbit/s. The default value is 5. The bandwidth varies by region. You can view the bandwidth on the purchase page of the EIP console.

yangtse.io/eip-network-type

String

EIP type. The default value is 5_bgp. If your region does not support 5_bgp and this parameter is an empty string, an event will be reported for the pod. The types vary by region. You can view available types on the purchase page of the EIP console.

yangtse.io/eip-charge-mode

String

Whether the bandwidth is billed by traffic or bandwidth. The value can be bandwidth (default) or traffic.

  • bandwidth: billed by bandwidth
  • traffic: billed by traffic

yangtse.io/eip-bandwidth-name

String

Bandwidth name. The default value is the same as the EIP name.

  • The name contains 1 to 64 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.
  • Minimum characters: 1
  • Maximum characters: 64

yangtse.io/eip-bandwidth-id

String

Shared bandwidth ID

Pulling an Image from a Self-Managed Image Repository

cci.io/http-registries

String

Harbor image address that uses the HTTP protocol

cci.io/insecure-registries

String

Harbor image address with certificate authentication skipped

Configuring Headers for Images

cci.io/registry-headers

String

Registry and header information, and custom information to describe the source

Using an Image Snapshot

cci.io/image-snapshot-auto-match

String

Automatically-matched image snapshots

cci.io/image-snapshot-exact-match

String

Fully-matched image snapshot.

Whether all container images in the pod are fully matched with those in the image snapshot.

cci.io/image-snapshot-usage-strategy

String

Strategy for automatic image snapshot matching

cci.io/image-snapshot-specified-name

String

User-specified image snapshot

cci.io/image-snapshot-create-if-not-present

String

Automatic image snapshot creation

cci.io/image-snapshot-reject-if-not-available

String

Whether to reject image snapshot creation if the image snapshot does not exist or is unavailable.

cci.io/image-snapshot-detail

String

Details about the image snapshot used by the pod. The value is set by CCI.

Table 2

logconf.k8s.io/fluent-bit-log-type

String

Log collection method

logconfigs.logging.openvessel.io

String

Log collection details

Enabling Pod Metrics

monitoring.cci.io/enable-pod-metrics

String

Whether to enable pod metrics. The default value is true. If this parameter is set to false, pod metrics will be disabled.

monitoring.cci.io/metrics-port

String

Port for pod monitoring. The default value is 19100.

Configuring a Port for Obtaining the Pod Information

observability.cci.io/read-only-port

String

Port for obtaining the pod information

cni.yangtse.io/network-status

String

Pod network status. The value is set by CCI.

Configuring Core Dumps

system.cci.io/coredump

String

Core dump settings

Configuring Transparent Huge Pages

system.cci.io/transparent_hugepage.enabled

String

THP settings. The default value is always. Other options are madvise and never.