REST Resource: projects.locations.awsClusters.awsNodePools

資源：AwsNodePool

在 AWS 上執行的 Anthos 節點集區。

JSON 表示法 
{
  "name": string,
  "version": string,
  "config": {
    object (AwsNodeConfig)
  },
  "autoscaling": {
    object (AwsNodePoolAutoscaling)
  },
  "subnetId": string,
  "state": enum (State),
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "maxPodsConstraint": {
    object (MaxPodsConstraint)
  },
  "errors": [
    {
      object (AwsNodePoolError)
    }
  ],
  "management": {
    object (AwsNodeManagement)
  },
  "kubeletConfig": {
    object (NodeKubeletConfig)
  },
  "updateSettings": {
    object (UpdateSettings)
  }
}
欄位
name

string

這個資源的名稱。

節點集區名稱的格式為 projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>。

如要進一步瞭解 Google Cloud 資源名稱，請參閱「資源名稱」
version

string

這是必要旗標，要在這個節點集區上執行的 Kubernetes 版本 (例如 1.19.10-gke.1000)。

您可以呼叫 locations.getAwsServerConfig，列出指定 Google Cloud 區域的所有支援版本。
config

object (AwsNodeConfig)

這是必要旗標，節點集區的設定。
autoscaling

object (AwsNodePoolAutoscaling)

這是必要旗標，這個節點集區的自動調度資源設定。
subnetId

string

這是必要旗標，節點集區節點執行的子網路。
state

enum (State)

僅供輸出。節點集區的生命週期狀態。
uid

string

僅供輸出。節點集區的全域專屬 ID。
reconciling

boolean

僅供輸出。如果已設定，目前節點集區的航班有異動。
createTime

string (Timestamp format)

僅供輸出。這個節點集區的建立時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

僅供輸出。上次更新這個節點集區的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
etag

string

允許用戶端透過開放式並行控制執行一致的讀取-修改-寫入作業。

可在更新和刪除要求中傳送，確保用戶端在繼續操作前擁有最新值。
annotations

map (key: string, value: string)

(選用步驟) 節點集區的註解。

這個欄位與 Kubernetes 註解具有相同的限制。所有鍵值組合的總大小不得超過 256k。索引鍵可包含 2 個部分：前置字串 (選填) 和名稱 (必填)，兩者須以正斜線 (/) 分隔。前置字串必須是 DNS 子網域。名稱長度不得超過 63 個字元，開頭和結尾須為英數字元，中間須包含連字號 (-)、底線 (_)、點號 (.) 和英數字元。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
maxPodsConstraint

object (MaxPodsConstraint)

這是必要旗標，節點集區中節點可同時執行的 Pod 數量上限限制。
errors[]

object (AwsNodePoolError)

僅供輸出。節點集區中發現的一組錯誤。
management

object (AwsNodeManagement)

(選用步驟) 這個節點集區的管理設定。
kubeletConfig

object (NodeKubeletConfig)

(選用步驟) 節點 kubelet 設定。
updateSettings

object (UpdateSettings)

(選用步驟) 更新設定可控制更新速度和中斷情形。

AwsNodeConfig

描述叢集中節點的參數。

JSON 表示法 
{
  "instanceType": string,
  "rootVolume": {
    object (AwsVolumeTemplate)
  },
  "taints": [
    {
      object (NodeTaint)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "tags": {
    string: string,
    ...
  },
  "iamInstanceProfile": string,
  "imageType": string,
  "sshConfig": {
    object (AwsSshConfig)
  },
  "securityGroupIds": [
    string
  ],
  "proxyConfig": {
    object (AwsProxyConfig)
  },
  "configEncryption": {
    object (AwsConfigEncryption)
  },
  "instancePlacement": {
    object (AwsInstancePlacement)
  },
  "autoscalingMetricsCollection": {
    object (AwsAutoscalingGroupMetricsCollection)
  },
  "spotConfig": {
    object (SpotConfig)
  }
}
欄位
instanceType

string

(選用步驟) 建立隨選執行個體時的 EC2 執行個體類型。

如果在建立節點集區時未指定，系統會根據節點集區版本選擇預設值，並指派給這個欄位。
rootVolume

object (AwsVolumeTemplate)

(選用步驟) 為節點集區節點佈建的根磁碟區範本。系統會在指派給節點集區子網路的可用區中，佈建磁碟區。

如未指定，則預設為 32 GiB，磁碟區類型為 GP2。
taints[]

object (NodeTaint)

(選用步驟) 指派給這個節點集區節點的初始汙點。
labels

map (key: string, value: string)

(選用步驟) 指派給這個節點集區節點的初始標籤。含有「鍵」/「值」組合清單的物件。例如：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
tags

map (key: string, value: string)

(選用步驟) 要指派給每個基礎 AWS 資源的鍵/值中繼資料。最多可指定 50 組英數字元、空格和符號 (.+-=_:@/)，金鑰最多可包含 127 個 Unicode 字元。值最多可包含 255 個 Unicode 字元。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
iamInstanceProfile

string

這是必要旗標，要指派給集區中節點的 AWS IAM 執行個體設定檔名稱或 ARN。
imageType

string

(選用步驟) 要在節點集區執行個體上使用的 OS 映像檔類型。可以未指定，或值為 ubuntu。

如未指定，則預設為 ubuntu。
sshConfig

object (AwsSshConfig)

(選用步驟) SSH 設定。
securityGroupIds[]

string

(選用步驟) 要新增至這個集區節點的其他安全性群組 ID。管理員會自動建立安全性群組，並加入叢集運作所需的最低規則。
proxyConfig

object (AwsProxyConfig)

(選用步驟) 用於輸出 HTTP(S) 流量的 Proxy 設定。
configEncryption

object (AwsConfigEncryption)

這是必要旗標，設定使用者資料的加密方式。
instancePlacement

object (AwsInstancePlacement)

(選用步驟) 這個節點的刊登位置相關資訊。如未指定，則會使用 VPC 的預設租戶。
autoscalingMetricsCollection

object (AwsAutoscalingGroupMetricsCollection)

(選用步驟) 與節點集區的 Auto Scaling 群組相關的 CloudWatch 指標收集設定。

如果未指定，系統會停用指標收集功能。
spotConfig

object (SpotConfig)

(選用步驟) 佈建 EC2 Spot 執行個體的設定

如有指定，節點集區會從 spotConfig.instance_types 集合佈建 Spot 執行個體。這個欄位與 instanceType 互斥。

AwsAutoscalingGroupMetricsCollection

與 AWS Auto Scaling 群組中的 CloudWatch 指標收集作業相關的設定。

JSON 表示法 
{
  "granularity": string,
  "metrics": [
    string
  ]
}
欄位
granularity

string

這是必要旗標，EC2 Auto Scaling 將匯總資料傳送至 AWS CloudWatch 的頻率。唯一有效的值是「1Minute」。
metrics[]

string

(選用步驟) 要啟用的指標。如需有效指標的清單，請參閱 https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html。如果您指定「細微程度」，但未指定任何指標，系統會啟用所有指標。

SpotConfig

SpotConfig 包含 Spot 節點的設定資訊。

JSON 表示法 
{
  "instanceTypes": [
    string
  ]
}
欄位
instanceTypes[]

string

這是必要旗標，用於建立 Spot 節點集區的執行個體類型清單。

AwsNodePoolAutoscaling

AwsNodePoolAutoscaling 包含叢集自動調度器調整節點集區大小，以符合目前叢集用量所需的資訊。

JSON 表示法 
{
  "minNodeCount": integer,
  "maxNodeCount": integer
}
欄位
minNodeCount

integer

這是必要旗標，節點集區中的節點數量下限。必須大於或等於 1，且小於或等於 maxNodeCount。
maxNodeCount

integer

這是必要旗標，節點集區中的節點數量上限。必須大於或等於 minNodeCount，且小於或等於 50。

狀態

節點集區的生命週期狀態。

列舉
STATE_UNSPECIFIED 未設定。
PROVISIONING 「PROVISIONING」狀態表示節點集區正在建立中。
RUNNING RUNNING 狀態表示節點集區已建立完成，可完全使用。
RECONCILING 「RECONCILING」狀態表示節點集區正在協調。
STOPPING 「STOPPING」狀態表示節點集區正在刪除。
ERROR ERROR 狀態表示節點集區已損毀，無法復原。
DEGRADED 「DEGRADED」狀態表示節點集區需要使用者採取行動，才能恢復完整功能。

AwsNodePoolError

AwsNodePoolError 會說明 AWS 節點集區中發現的錯誤。

JSON 表示法 
{
  "message": string
}
欄位
message

string

使用者可理解的錯誤說明。

AwsNodeManagement

AwsNodeManagement 定義為 AWS 節點集區啟用的一組節點管理功能。

JSON 表示法 
{
  "autoRepair": boolean
}
欄位
autoRepair

boolean

(選用步驟) 是否自動修復節點。如果設為 true，系統會監控這個節點集區中的節點，如果節點在一段時間內持續未通過健康狀態檢查，系統就會觸發自動修復動作，以新節點取代這些節點。

NodeKubeletConfig

節點集區 kubelet 選項的設定。

JSON 表示法 
{
  "insecureKubeletReadonlyPortEnabled": boolean,
  "cpuManagerPolicy": string,
  "cpuCfsQuota": boolean,
  "cpuCfsQuotaPeriod": string,
  "podPidsLimit": string
}
欄位
insecureKubeletReadonlyPortEnabled

boolean

(選用步驟) 啟用不安全的 kubelet 唯讀通訊埠。
cpuManagerPolicy

string

(選用步驟) 控管節點的 CPU 管理政策。請參閱 https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

可使用的值如下：*「none」：預設值，代表現有的排程行為。*「static」：允許具有特定資源特徵的 Pod 在節點上獲得更高的 CPU 親和性和專屬性。如未指定，預設值為「none」。
cpuCfsQuota

boolean

(選用步驟) 針對指定 CPU 限制的容器，啟用 CPU CFS 配額強制執行功能。

這個選項預設為啟用，kubelet 會使用 CFS 配額 (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) 強制執行容器 CPU 限制。否則系統不會強制執行 CPU 限制。

停用這個選項，即可指定 CPU 限制，讓 Pod 仍處於 Guaranteed QoS 類別，同時減輕 CPU 節流問題。

如未指定，預設值為「true」。
cpuCfsQuotaPeriod

string

(選用步驟) 設定 CPU CFS 配額週期值「cpu.cfs_period_us」。

字串必須是一連串十進位數字，每個數字可選擇是否加上分數和單位後置字串，例如「300ms」。有效時間單位為「ns」、「us」(或「µs」)、「ms」、「s」、「m」、「h」。值必須是正數。

如未指定，預設值為「100 毫秒」。
podPidsLimit

string (int64 format)

(選用步驟) 設定 Pod PID 限制。請參閱 https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits

控制 Pod 中可執行的程序數量上限。這個值必須大於或等於 1024，且小於 4194304。

UpdateSettings

UpdateSettings 可控制平行處理級別，以及節點集區更新期間造成的干擾程度。

如果節點集區更新需要以更新後的節點取代現有節點集區節點，則適用這些設定。

UpdateSettings 為選用欄位。如果在建立節點集區時未指定 UpdateSettings，系統會根據上層叢集版本選擇預設值。如果是子版本為 1.27 以上的叢集，系統會使用預設的 surgeSettings 設定，其中 maxSurge = 1 且 maxUnavailable = 0。如果是舊版叢集，節點集區更新會使用傳統的逐一更新節點的「先終止再建立」機制，且不適用 updateSettings。

設定 surgeSettings 參數，即可使用節點數擴充更新機制，對節點集區節點進行滾動式更新。1. maxSurge 會控制在更新期間，可暫時超出目前節點集區大小的額外節點數量，以增加可用節點數量。2. maxUnavailable 可控管更新期間同時無法使用的節點數量。3. (maxSurge + maxUnavailable) 會決定平行處理的程度 (即同時更新的節點數)。

JSON 表示法 
{
  "surgeSettings": {
    object (SurgeSettings)
  }
}
欄位
surgeSettings

object (SurgeSettings)

(選用步驟) 節點數擴充升級設定。

SurgeSettings

SurgeSettings 包含 Surge 更新的參數。

JSON 表示法 
{
  "maxSurge": integer,
  "maxUnavailable": integer
}
欄位
maxSurge

integer

(選用步驟) 更新程序期間可建立的最大節點數量，這麼做可以擴大目前的節點集區規模。
maxUnavailable

integer

(選用步驟) 在更新程序期間，可同時無法使用的節點數量上限。如果節點的狀態不是「已就緒」，系統就會將其視為無法使用。

方法

create
(deprecated)

 建立新的 AwsNodePool，並附加至指定的 AwsCluster。

delete
(deprecated)

 刪除特定 AwsNodePool 資源。

get
(deprecated)

 說明特定 AwsNodePool 資源。

list
(deprecated)

 列出指定 AwsCluster 上的所有 AwsNodePool 資源。

patch
(deprecated)

 更新 AwsNodePool。

rollback
(deprecated)

 復原先前已中止或失敗的 AwsNodePool 更新要求。