Pod アノテーションリファレンス - Container Compute Service

アノテーションを使用して、ACS Pod の拡張機能を有効化し、設定できます。このトピックでは、ACS がサポートする Pod アノテーションについて説明します。

ACS Pod の作成時に追加できるアノテーション

Pod にアノテーションを追加することで、特定の機能を有効化し、設定を適用できます。以下にコード例を示します。

Pod 設定例

apiVersion: v1
kind: Pod
metadata:
  name: annotation-pod
  annotations:
    network.alibabacloud.com/vswitch-ids: "vsw-foo"
spec:
  ...

デプロイメント構成例

apiVersion: apps/v1
kind: Deployment
metadata:
  name: foo
  ...
spec:
  ...
  template:
    metadata:
      annotations:
        network.alibabacloud.com/vswitch-ids: "vsw-foo"
    ...

ネットワーク

機能	パラメーター	値の例	説明
Pod の vSwitch とセキュリティグループの指定	network.alibabacloud.com/vswitch-ids	"vsw-slw1*,vsw-lkjwo*"	vSwitch ID を指定します。複数の vSwitch ID を指定して、複数のゾーンに Pod を作成できます。重要 Pod が vSwitch とアフィニティの両方を指定した場合、ACS はリソース作成時に指定された vSwitch を優先します。アフィニティ設定は無視されます。重要 Pod が WaitForFirstConsumer タイプの PersistentVolumeClaim (PVC) も使用する場合、Pod のアフィニティ設定で対応するゾーンを指定する必要があります。スケジューラは、PVC に割り当てられたゾーンが vSwitch と一致することを確認し、Pod が pending 状態になるのを防ぎます。詳細については、「ノードアフィニティスケジューリング」をご参照ください。
Pod の vSwitch とセキュリティグループの指定	network.alibabacloud.com/security-group-ids	"sg-sljwo*,sg-lwirp*"	セキュリティグループ ID を指定します。複数のセキュリティグループ ID を指定できます。
アノテーションを使用したカスタム DNS の設定	network.alibabacloud.com/custom-dnsconfig	{"servers":["20.1.xx.xx","30.1.xx.xx"],"searches":["xx.com","yy.com"],"options":["ndots:2","edns0"]}	カスタム DNS 設定を指定します。
ACK クラスタでネットワークポリシーを使用する	alibabacloud.com/enable-network-policy-agent	"true"	ACS Pod の NetworkPolicy を有効にします。デフォルト値は `false` です。
アノテーションを使用した Pod への EIP のアタッチ	network.alibabacloud.com/pod-with-eip	"true"	EIP を自動的に作成してアタッチするかどうかを指定します。有効な値は次のとおりです： `true`：EIP を自動的に作成してアタッチします。 `false`：EIP を自動的に作成してアタッチしません。
	network.alibabacloud.com/pod-eip-instanceid	"eip-bp14q***"	指定された EIP を使用します。`eip-bp14q***` のような EIP インスタンス ID を入力します。詳細については、「EIP の申請」をご参照ください。
	k8s.aliyun.com/eci-eip-instanceid (ECI アノテーションと互換)	"eip-bp14q***"
	network.alibabacloud.com/eip-bandwidth	"5"	EIP のピーク帯域幅。単位：Mbit/s。
	network.alibabacloud.com/eip-internet-charge-type	"PayByTraffic"	EIP の課金方法。有効な値は次のとおりです： `PayByTraffic`：デフォルト値。トラフィック課金。 `PayByBandwidth`：帯域幅課金。詳細については、「EIP の課金方法」をご参照ください。
	k8s.aliyun.com/eip-charge-type (旧バージョンのアノテーションと互換)	"PayByTraffic"
	network.alibabacloud.com/eip-instance-charge-type	"PrePaid"	EIP インスタンスの課金方法。有効な値は次のとおりです： `PrePaid`：サブスクリプション。 `PostPaid`：従量課金。詳細については、「サブスクリプション」および「従量課金」をご参照ください。
	network.alibabacloud.com/eip-common-bandwidth-package-id	"cbwp-slex***"	既存のインターネット共有帯域幅インスタンスをアタッチします。
	network.alibabacloud.com/eip-isp	"BGP"	EIP の回線タイプ。有効な値は次のとおりです： `BGP`：BGP (マルチ ISP)。 `BGP_PRO`：BGP (マルチ ISP) Pro。詳細については、「EIP の申請」をご参照ください。
	network.alibabacloud.com/eip-public-ip-address-pool-id	"pippool-dlsw***"	EIP アドレスプール。EIP アドレスプールの使用に関する制限事項と手順については、「IP アドレスプール」をご参照ください。
	network.alibabacloud.com/eip-resource-group-id		EIP のリソースグループ。詳細については、「EIP の申請」をご参照ください。
	network.alibabacloud.com/eip-name		EIP の名前。詳細については、「EIP の申請」をご参照ください。
	network.alibabacloud.com/eip-description		EIP の説明。詳細については、「EIP の申請」をご参照ください。
	network.alibabacloud.com/eip-security-protection-types		EIP を保護するために使用されるセキュリティサービス。複数のセキュリティサービスはカンマ `,` で区切ります。詳細については、「EIP の申請」をご参照ください。
	network.alibabacloud.com/pod-eip-release-strategy	"Never"	Pod の EIP のリリース方針。有効な値は次のとおりです： `Follow`：デフォルト値。EIP は Pod のライフサイクルに従います。 `Never`：Pod の EIP は削除されません。不要になった EIP は手動で削除する必要があります。有効期限を設定します。たとえば、`5m30s` は、Pod が削除されてから 5 分 30 秒後に EIP が削除されることを意味します。Go 形式の時間期間表現がサポートされています。

イメージ

機能	パラメーター	値の例	説明
自己管理型イメージリポジトリの使用	registry.alibabacloud.com/plain-http-registry	"harbor*.pre.com,192.168.XX.XX:5000,reg*.test.com:80"	HTTP プロトコルを使用する自己管理型イメージリポジトリからイメージをプルする場合、プロトコルの違いによるイメージのプル失敗を防ぐために、このパラメーターを設定します。
自己管理型イメージリポジトリの使用	registry.alibabacloud.com/insecure-registry	"harbor*.pre.com,192.168.XX.XX:5000,reg*.test.com:80"	自己署名証明書を使用する自己管理型イメージリポジトリからイメージをプルする場合、証明書認証をスキップするためにこのパラメーターを設定します。これにより、証明書認証の失敗によるイメージのプル失敗を防ぎます。

スケジューリング

機能	パラメーター	値の例	説明
Pod 計算能力品質のリトライポリシー	alpha.alibabacloud.com/compute-qos-strategy	"best-effort-to-default"	compute-qos リトライポリシーを指定します。有効な値は `best-effort-to-default` です：最初に BestEffort 計算能力品質を使用し、リソースが不足している場合は Default 計算能力品質を使用します。重要このアノテーションを使用する場合、`alibabacloud.com/compute-qos` ラベルを指定する必要はありません。このラベルが既に存在する場合、ラベルの値が優先されます。

オペレーティングシステム

機能

パラメーター

値の例

説明

Pod のオペレーティングシステムの Transparent Huge Pages を変更します

GPU および GPU-HPN 計算クラスのみがサポートされています。

alibabacloud.com/os-kernel-config

{"transparentHugepageEnabled": "madvise","transparentHugepageShmemEnabled": "advise"}

transparentHugepageEnabled：カーネル設定ファイル /sys/kernel/mm/transparent_hugepage/enabled に対応します。有効な値は次のとおりです：
- always
- madvise
- never
transparentHugepageShmemEnabled：カーネル設定ファイル /sys/kernel/mm/transparent_hugepage/shmem_enabled に対応します。有効な値は次のとおりです：
- always
- within_size
- advise
- never
- deny
- force

ACS によって自動的に追加されるアノテーション

説明

以下のアノテーションには、Elastic Network Interface (ENI) や EIP の割り当て結果など、ACS によって生成された情報が含まれます。これらのアノテーションを設定または変更することはできません。

機能	パラメーター	値の例	説明
ENI 割り当て情報	network.alibabacloud.com/allocated-eni-id	"eni-esdxs***"	割り当てられた Elastic Network Interface (ENI) の ID。
	network.alibabacloud.com/vpc-id	"vpc-sljwo***"	ENI が属する VPC の ID。
	network.alibabacloud.com/vswitch-id	"vsw-lskdw***"	ENI が属する vSwitch の ID。ACS Pod の作成時に複数の vSwitch を指定した場合、最終的に使用された vSwitch がここに表示されます。
EIP 割り当て情報	network.alibabacloud.com/allocated-eip-id	"eip-bp1m***"	割り当てられた EIP の ID。
EIP 割り当て情報	network.alibabacloud.com/allocated-eip-address	"116.62.***"	割り当てられた EIP の IP アドレス。
リソース仕様	alibabacloud.com/pod-use-spec	"2.5-5Gi"	正規化後の ACS Pod の CPU とメモリの仕様。「xxvCPU-xxGiB」の形式で表されます。
	alibabacloud.com/pod-gpu-use-spec	"1"	正規化後の ACS Pod 内の GPU カードの数。
	alibabacloud.com/pod-ephemeral-storage	"30Gi"	正規化後の ACS Pod の一時ストレージ領域のサイズ (GiB 単位)。
スケジューリング結果情報	topology.kubernetes.io/region	"cn-hangzhou"	ACS Pod が存在するリージョン。
スケジューリング結果情報	topology.kubernetes.io/zone	"cn-hangzhou-i"	ACS Pod が存在するゾーン。
その他のメタデータ	alibabacloud.com/instance-id	"acs-sdsf***"	ACS Pod のインスタンス ID。
その他のメタデータ	alibabacloud.com/request-id	"6925D4B7-***"	リクエスト ID。