本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
「部署至 Kubernetes 叢集」動作 YAML
以下是「部署至 Kubernetes」叢集動作的YAML定義。若要瞭解如何使用此動作,請參閱EKS使用工作流程部署到 Amazon。
此動作定義存在於更廣泛的工作流程定義檔案中的區段。如需有關此檔案的詳細資訊,請參閱工作流YAML定義。
注意
接下來的大多數YAML屬性在可視化編輯器中都具有相應的 UI 元素。若要查詢使用者介面元素,請使用 Ctrl+F。 元素將與其關聯的YAML屬性一起列示。
# The workflow definition starts here.
# See 頂層屬性 for details.
Name: MyWorkflow
SchemaVersion: 1.0
Actions:
# The action definition starts here.
DeployToKubernetesCluster_nn
:
Identifier: aws/kubernetes-deploy@v1
DependsOn:
- build-action
Compute:
- Type: EC2 | Lambda
- Fleet: fleet-name
Timeout: timeout-minutes
Environment:
Name: environment-name
Connections:
- Name: account-connection-name
Role: DeployToEKS
Inputs:
# Specify a source or an artifact, but not both.
Sources:
- source-name-1
Artifacts:
- manifest-artifact
Configuration:
Namespace: namespace
Region: us-east-1
Cluster: eks-cluster
Manifests: manifest-path
DeployToKubernetesCluster
(必要)
指定動作的名稱。所有動作名稱在工作流程中都必須是唯一的。動作名稱僅限於英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (_)。不允許空格。您無法使用引號來啟用動作名稱中的特殊字元和空格。
預設:DeployToKubernetesCluster_nn
。
對應的 UI:組態索引標籤/動作顯示名稱
Identifier
(DeployToKubernetesCluster
/Identifier)
(必要)
識別動作。除非您要變更版本,否則請勿變更此屬性。如需詳細資訊,請參閱 指定要使用的動作版本。
預設:aws/kubernetes-deploy@v1
。
對應的使用者介面:工作流程圖/DeployToKubernetesCluster_nn/ aws/kubernetes-部署 @v1 標籤
DependsOn
(DeployToKubernetesCluster
/DependsOn)
(選用)
指定必須成功執行的動作、動作群組或閘道,才能執行此動作。
如需有關「依賴」功能的詳細資訊,請參閱。排序動作
對應的用戶界面:輸入選項卡/取決於- 可選
Compute
(DeployToKubernetesCluster
/Compute)
(選用)
用來執行工作流程動作的計算引擎。您可以在工作流程層級或動作層級指定計算,但不能同時指定兩者。在工作流程層級指定時,計算組態會套用至工作流程中定義的所有動作。在工作流程層級,您也可以在相同的執行個體上執行多個動作。如需詳細資訊,請參閱 跨動作共用運算。
對應的用戶界面:無
Type
(DeployToKubernetesCluster
/Compute/Type)
(如果包含Compute,則為必填)
運算引擎的類型。您可以使用下列其中一個值:
-
EC2(可視化編輯器)或
EC2
(YAML編輯器)針對動作執行期間的彈性進行優化
-
Lambda(可視化編輯器)或
Lambda
(YAML編輯器)最佳化動作啟動速度。
如需運算類型的更多相關資訊,請參閱運算類型。
對應的使用者介面:組態索引標籤/進階-選用/運算類型
Fleet
(DeployToKubernetesCluster
/Compute/Fleet)
(選用)
指定將執行工作流程或工作流程動作的機器或叢集。對於隨需叢集,當動作開始時,工作流程會佈建所需的資源,並在動作完成時銷毀機器。隨選艦隊的範例:Linux.x86-64.Large
、Linux.x86-64.XLarge
。如需隨選叢集的詳細資訊,請參閱隨選叢集屬性。
透過佈建的叢集,您可以設定一組專用機器來執行工作流程動作。這些機器保持閒置狀態,可立即處理動作。如需已佈建叢集的詳細資訊,請參閱佈建的叢集屬性。
如Fleet
果省略,預設值為Linux.x86-64.Large
。
對應的使用者介面:組態索引標籤/進階-選用/運算叢集
Timeout
(DeployToKubernetesCluster
/Timeout)
(選用)
指定動作在 CodeCatalyst 結束動作之前可執行的時間長度 (以分鐘為單位) 或小時和分鐘 (視覺化編輯器)。YAML最小值為 5 分鐘,最大值在中說明中工作流程的配額 CodeCatalyst。預設逾時與逾時上限相同。
對應的 UI:配置選項卡/超時- 可選
Environment
(DeployToKubernetesCluster
/Environment)
(必要)
指定要與動作搭配使用的 CodeCatalyst 環境。該動作連接到所選環境中VPC指定的 AWS 帳戶 和可選的 Amazon。該動作使用環境中指定的預設IAM角色連接到 AWS 帳戶,並使用 Amazon VPC 連接中指定的IAM角色連接到 Amazon VPC。
注意
如果預設IAM角色沒有動作所需的權限,您可以將動作配置為使用其他角色。如需詳細資訊,請參閱 變更動IAM作的角色。
若要取得有關環境的更多資訊,請參閱部署到 AWS 帳戶 和 VPCs和建立環境。
對應的 UI:配置選項卡/環境
Name
(DeployToKubernetesCluster
/Environment/Name)
(如果包含Environment,則為必填)
指定您要與動作相關聯的現有環境名稱。
對應的 UI:配置選項卡/環境
Connections
(DeployToKubernetesCluster
/Environment/Connections)
(在較新版本的動作中為選用項目;舊版本為必要)
指定要與動作相關聯的帳號連線。您最多可以在下指定一個帳戶連線Environment
。
如果您未指定帳戶連線:
-
此動作會使用在 CodeCatalyst 主控台環境中指定的 AWS 帳戶 連線和預設IAM角色。如需將帳戶連線和預設IAM角色新增至環境的資訊,請參閱建立環境。
-
預設IAM角色必須包含動作所需的原則和權限。若要判斷這些原則和權限是什麼,請參閱動作的YAML定義文件中角色屬性的說明。
如需有關帳戶連線的詳細資訊,請參閱允許存取已連線的 AWS 資源 AWS 帳戶。如需將帳戶連線新增至環境的資訊,請參閱建立環境。
對應的使用者介面:下列其中一項視動作版本而定:
-
(較新版本)配置選項卡/環境/
my-environment
? /三點菜單/切換角色 -
(舊版本)配置選項卡/「環境/帳戶/角色」/帳AWS 戶連接
Name
(DeployToKubernetesCluster
/Environment/Connections/Name)
(選用)
指定帳戶連線的名稱。
對應的使用者介面:下列其中一項視動作版本而定:
-
(較新版本)配置選項卡/環境/
my-environment
? /三點菜單/切換角色 -
(舊版本)配置選項卡/「環境/帳戶/角色」/帳AWS 戶連接
Role
(DeployToKubernetesCluster
/Environment/Connections/Role)
(如果包含Connections,則為必填)
指定「部署至 Kubernetes」叢集動作用來存取的IAM角色名稱。 AWS請確定您已將角色新增至您的 CodeCatalyst 空間,且該角色包含下列原則。
如果您未指定IAM角色,則動作會使用主 CodeCatalyst 控台環境中列出的預設IAM角色。如果您在環境中使用預設角色,請確定其具有下列原則。
-
下列權限原則:
警告
將權限限制為以下策略中顯示的權限。使用具有更廣泛權限的角色可能會造成安全風險。
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "eks:DescribeCluster", "eks:ListClusters" ], "Resource": "*" } ] }
注意
第一次使用角色時,請在資源策略陳述式中使用下列萬用字元,然後在策略可用之後使用資源名稱來定義策略的範圍。
"Resource": "*"
-
下列自訂信任原則:
{ "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": [ "codecatalyst-runner.amazonaws.com", "codecatalyst.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] }
請確定已將此角色新增至:
-
您的帳戶連接。若要進一步瞭解如何將IAM角色新增至帳戶連線,請參閱將IAM角色新增至帳戶連線。
-
你的庫伯尼特 ConfigMap人 若要進一步了解如何將IAM角色新增至 ConfigMap,請參閱
eksctl
文件中的管理IAM使用者和角色。
提示
另請參閱以教學課程:將應用程式部署到 Amazon EKS取得將 am IAM 角色新增至帳戶連線和的說明 ConfigMap。
注意
如果您願意,您可以將CodeCatalystWorkflowDevelopmentRole-
角色與此動作搭配使用。如需有關此角色的詳細資訊,請參閱 為您的帳戶和空間建立CodeCatalystWorkflowDevelopmentRole-spaceName角色。瞭解spaceName
CodeCatalystWorkflowDevelopmentRole-
角色具有可能造成安全風險的完整存取權限。我們建議您只在不太擔心安全性的教學課程和案例中使用此角色。spaceName
對應的使用者介面:下列其中一項視動作版本而定:
-
(較新版本)配置選項卡/環境/
my-environment
? /三點菜單/切換角色 -
(舊版) 組態索引標籤/「環境/帳戶/角色」/「角色」
Inputs
(DeployToKubernetesCluster
/Inputs)
(如果包含Connections,則為必填)
本Inputs
節定義工作流程執行期間所DeployToKubernetesCluster
需的資料。
注意
每個「部署到 Amazon」EKS 動作只允許一個輸入 (來源或成品)。
對應的 UI:輸入索引標籤
Sources
(DeployToKubernetesCluster
/Inputs/Sources)
(如果您的清單文件存儲在源存儲庫中,則需要)
如果您的 Kubernetes 資訊清單檔案儲存在來源儲存庫中,請指定該來源儲存庫的標籤。目前,唯一支援的標籤是WorkflowSource
。
如果您的資訊清單檔案不包含在來源儲存庫中,則它們必須位於由其他動作產生的成品中。
如需來源的詳細資訊,請參閱 將來源儲存庫連線至工作。
對應的用戶界面:輸入選項卡/源- 可選
Artifacts - input
(DeployToKubernetesCluster
/Inputs/Artifacts)
(如果您的清單文件存儲在上一個操作的輸出成品中,則需要)
如果 Kubernetes 資訊清單檔案包含在先前動作所產生的成品中,請在此指定該成品。如果您的資訊清單檔案不包含在成品中,則它們必須位於來源儲存庫中。
如需人工因素的詳細資訊 (包括範例),請參閱在動作之間共用成品和檔案。
對應的 UI:配置選項卡/成品- 可選
Configuration
(DeployToKubernetesCluster
/Configuration)
(必要)
您可以在其中定義動作的組態屬性的區段。
對應的 UI:組態索引標籤
Namespace
(DeployToKubernetesCluster
/Configuration/Namespace)
(選用)
指定要在其中部署您的 Kubernetes 應用程式的 Kubernetes 命名空間。default
如果您沒有在叢集中使用命名空間,請使用此選項。如需有關命名空間的詳細資訊,請參閱 Kubernetes 說明文件中的使用 Kubernetes 命名空間細分叢集
如果您省略命名空間,則會使default
用的值。
對應的 UI:配置選項卡/命名空間
Region
(DeployToKubernetesCluster
/Configuration/Region)
(必要)
指定 Amazon EKS 叢集和服務所在的 AWS 區域。如需區域代碼的清單,請參閱 AWS 一般參考.
對應的 UI:組態索引標籤/區域
Cluster
(DeployToKubernetesCluster
/Configuration/Cluster)
(必要)
指定現有 Amazon EKS 叢集的名稱。「部署到 Kubernetes」叢集動作會將您的容器化應用程式部署到此叢集中。如需 Amazon EKS 叢集的詳細資訊,請參閱 Amazon EKS 使用者指南中的叢集。
對應的 UI:配置選項卡/集群
Manifests
(DeployToKubernetesCluster
/Configuration/Manifests)
(必要)
在 Kubernetes 文件中指定YAML格式化 Kubernetes 資訊清單檔案的路徑,這些檔案稱為組態檔、組態檔,或簡稱為組態設定。
如果您使用多個清單文件,請將它們放在單個文件夾中並引用該文件夾。資訊清單檔案由 Kubernetes 以字母數字方式處理,因此請務必在檔案名稱前面加上數字或字母增加,以控制處理順序。例如:
00-namespace.yaml
01-deployment.yaml
如果您的資訊清單檔案位於來源儲存庫中,則路徑會相對於來源儲存庫根資料夾。如果檔案位於先前工作流程動作的人工因素中,則路徑會相對於人工因素根資料夾。
範例:
Manifests/
deployment.yaml
my-deployment.yml
請勿使用萬用字元 (*
)。
如需有關資訊清單檔案的詳細資訊,請參閱 Kubernetes 文件中的組織資源組態
對應的用戶界面:配置選項卡/清單