AWS-UpdateEKSManagedNodeGroup - AWS Systems Manager オートメーションランブックリファレンス

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS-UpdateEKSManagedNodeGroup

説明

AWS-UpdateEKSManagedNodeGroup ランブックは、Amazon Elastic Kubernetes Service (Amazon EKS) マネージドノードグループを更新するのに役立ちます。Version または Configuration の更新を選択できます。

このオートメーションを実行する (コンソール)

ドキュメントタイプ

Automation

[所有者]

Amazon

[Platforms] (プラットフォーム)

Linux、macOS, Windows

パラメータ

  • AutomationAssumeRole

    型: 文字列

    説明: (オプション) Systems Manager Automation が AWS Identity and Access Management ユーザーに代わってアクションを実行できるようにする () ロールARNの Amazon リソースネーム (IAM)。ロールを指定しない場合、Systems Manager Automation はこのランブックを開始するユーザーのアクセス許可を使用します。

  • ClusterName

    型: 文字列

    説明: (必須) 更新するノードグループを持つクラスターの名前。

  • NodeGroupName

    型: 文字列

    説明: (必須) 更新するノードグループの名前。

  • UpdateType

    型: 文字列

    有効値: [ノードグループバージョンの更新] | [ノードグループ構成の更新]

    デフォルト: ノードグループバージョンの更新

    説明: (必須) ノードグループで実行する更新のタイプ。

以下のパラメーターは Version の更新タイプにのみ適用されます。

  • AMIReleaseVersion

    型: 文字列

    説明: (オプション) Amazon EKS 最適化のバージョン AMI 使用したいもの。デフォルトでは、最新バージョンが使用されます。

  • ForceUpgrade

    型: ブール値

    説明: (オプション) この値が true の場合は、Pod の中断時に予算違反があった場合でも、アップグレードが失敗することはありません。

  • KubernetesVersion

    型: 文字列

    説明: (オプション) ノードグループを更新する Kubernetes バージョン。

  • LaunchTemplateId

    型: 文字列

    説明: (オプション) 起動テンプレートの ID。

  • LaunchTemplateName

    型: 文字列

    説明: (オプション) 起動テンプレートの名前。

  • LaunchTemplateVersion

    型: 文字列

    説明: (オプション) Amazon Elastic Compute Cloud (Amazon EC2) 起動テンプレートバージョン。このパラメーターは、ノードグループが起動テンプレートから作成された場合にのみ有効です。

以下のパラメーターは Configuration の更新タイプにのみ適用されます。

  • AddOrUpdateNodeGroupLabels

    タイプ: StringMap

    説明: (オプション) 追加または更新する Kubernetes ラベル。

  • AddOrUpdateKubernetesTaintsEffect

    タイプ: StringList

    説明: (オプション) 追加または更新する Kubernetes テイント。

  • MaxUnavailableNodeGroups

    型: 整数

    デフォルト: 0

    説明: (オプション) バージョン更新中に一度に使用不可となるノードの最大数。

  • MaxUnavailablePercentageNodeGroup

    型: 整数

    デフォルト: 0

    説明: (オプション) バージョン更新中に使用できないノードの割合。

  • NodeGroupDesiredSize

    型: 整数

    デフォルト: 0

    説明: (オプション) マネージド型ノードグループが保持する必要があるノードの数。

  • NodeGroupMaxSize

    型: 整数

    デフォルト: 0

    マネージド型ノードグループがスケールアウトできるノードの最大数。

  • NodeGroupMinSize

    型: 整数

    デフォルト: 0

    説明: (オプション) マネージド型ノードグループがスケールインできるノードの最小数。

  • RemoveKubernetesTaintsEffect

    タイプ: StringList

    説明: (オプション) 削除する Kubernetes テイント。

  • RemoveNodeGroupLabels

    タイプ: StringList

    説明: (オプション) 削除するラベルのコンマ区切りのリスト。

必要なIAMアクセス許可

AutomationAssumeRole パラメータでは、ランブックを正常に使用するために、次のアクションが必要です。

  • eks:UpdateNodegroupConfig

  • eks:UpdateNodegroupVersion

ドキュメントステップ

  • aws:executeScript - ランブック入力パラメータに指定した値に従って Amazon EKSクラスターノードグループを更新します。

  • aws:waitForAwsResourceProperty - クラスターの更新ステータスが Successful になるのを待ちます。