これは、このセクションの複数ページの印刷可能なビューです。 印刷するには、ここをクリックしてください.

このページの通常のビューに戻る.

セットアップツールのリファレンス

1 - Kubeadm

kubeadmは、kubeadm initkubeadm joinなどのコマンドを提供するツールで、Kubernetesクラスターを構築する上でのベストプラクティスを反映した「近道」を提供するものとして開発されました。

kubeadmは実用最小限のクラスターをセットアップするための処理を実行します。設計上、kubeadmはブートストラップのみを行い、マシンのプロビジョニングは行いません。同様に、Kubernetesダッシュボード、モニタリングソリューション、クラウド向けのアドオンなど、あれば便利でもなくても支障のない各種アドオンのインストールも範囲外です。

その代わりに、高度な特定用途向けのツールはkubeadmをベースに構築されることが期待されています。理想的には、すべてのデプロイのベースとしてkubeadmを使用することで、適合テストに通るクラスターを簡単に作れるようになります。

インストール方法

kubeadmをインストールするには、インストールガイドを参照してください。

次の項目

  • kubeadm initを使用して、Kubernetesのコントロールプレーンノードをブートストラップする
  • kubeadm joinを使用して、Kubernetesのワーカーノードをブートストラップし、クラスターに参加させる
  • kubeadm upgradeで、Kubernetesクラスターを新しいバージョンにアップグレードする
  • kubeadm configを使用して、kubeadm v1.7.x以前で初期化されたクラスターを、kubeadm upgradeを利用できるように設定する
  • kubeadm tokenで、kubeadm joinのためのトークンを管理する
  • kubeadm resetを使用して、kubeadm initまたはkubeadm joinでホストに行われた変更を元に戻す
  • kubeadm versionで、kubeadmのバージョンを表示する
  • kubeadm alphaで、コミュニティからのフィードバックを集めるために有効にされた各種機能を試用する

1.1 - Kubeadm Generated

1.1.1 -

kubeadmが使用するイメージの一覧を出力します。 設定ファイルはイメージやイメージリポジトリをカスタマイズする際に使用されます。

概要

kubeadmが使用するイメージの一覧を出力します。 設定ファイルはイメージやイメージリポジトリをカスタマイズする際に使用されます。

kubeadm config images list [flags]

オプション

--allow-missing-template-keys     デフォルト値: true

trueならば、テンプレートの中にフィールドやマップキーが見つからない場合に、テンプレート内のエラーを無視します。golangまたはjsonpathを出力フォーマットとした場合にのみ適用されます。

--config string

kubeadmの設定ファイルのパス。

-o, --experimental-output string     デフォルト値: "text"

出力フォーマット。次のいずれか: text|json|yaml|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file.

--feature-gates string

様々な機能に対するフィーチャーゲートを記述するkey=valueペアのセット。オプション:
EtcdLearnerMode=true|false (BETA - デフォルト値=true)
PublicKeysECDSA=true|false (DEPRECATED - デフォルト値=false)
RootlessControlPlane=true|false (ALPHA - デフォルト値=false)
UpgradeAddonsBeforeControlPlane=true|false (DEPRECATED - デフォルト値=false)
WaitForAllControlPlaneComponents=true|false (ALPHA - デフォルト値=false)

-h, --help

listのヘルプ

--image-repository string     デフォルト値: "registry.k8s.io"

コントロールプレーンのイメージをプルするコンテナレジストリを選択します。

--kubernetes-version string     デフォルト値: "stable-1"

コントロールプレーンの特定のKubernetesバージョンを選択します。

--show-managed-fields

trueならば、JSONまたはYAMLフォーマットでmanagedFieldsを省略せずにオブジェクトを出力します。

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

1.1.2 -

kubeadmによって使用されるイメージをプルします。

概要

kubeadmによって使用されるイメージをプルします。

kubeadm config images pull [flags]

オプション

--config string

kubeadmの設定ファイルのパス。

--cri-socket string

接続するCRIソケットへのパス。空の場合、kubeadmはこの値を自動検出しようとします。このオプションは、複数のCRIがインストールされているか、標準ではないCRIソケットがある場合のみ使用してください。

--feature-gates string

様々な機能に対するフィーチャーゲートを記述するkey=valueペアのセット。オプション:
EtcdLearnerMode=true|false (BETA - デフォルト値=true)
PublicKeysECDSA=true|false (DEPRECATED - デフォルト値=false)
RootlessControlPlane=true|false (ALPHA - デフォルト値=false)
UpgradeAddonsBeforeControlPlane=true|false (DEPRECATED - デフォルト値=false)
WaitForAllControlPlaneComponents=true|false (ALPHA - デフォルト値=false)

-h, --help

pullのヘルプ

--image-repository string     デフォルト値: "registry.k8s.io"

コントロールプレーンのイメージをプルするコンテナレジストリを選択します。

--kubernetes-version string     デフォルト値: "stable-1"

コントロールプレーンの特定のKubernetesバージョンを選択します。

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

1.1.3 -

ファイルから古いバージョンのAPIタイプのkubeadmの設定を読み込み、新しいバージョンの同等の設定オブジェクトを出力します。

概要

このコマンドは、古いバージョンの設定オブジェクトを、サポートされている最新のバージョンに変換します。 これはクラスターを何も触ることなく、CLIツール内に閉じています。 kubeadmのこのバージョンでは、次のAPIバージョンがサポートされています:

  • kubeadm.k8s.io/v1beta3

さらに、kubeadmはバージョン"kubeadm.k8s.io/v1beta3"の設定しか出力できませんが、両方の種類を読むことができます。 このため、どのバージョンを--old-configパラメーターに渡したとしても、APIオブジェクトは読み込まれ、デシリアライズ、デフォルト化、変換、検証、再シリアライズされて、標準出力または--new-configで指定されたファイルに出力されます。

言い換えると、このコマンドの出力は、そのファイルを"kubeadm init"に渡した時にkubeadmが実際に内部で読むものとなります。

kubeadm config migrate [flags]

オプション

--allow-experimental-api

実験的な未リリースのAPIへの移行を許可します。

-h, --help

migrateのヘルプ

--new-config string

新しいAPIバージョンを使用して得られた同等の内容のkubeadm設定ファイルのパス。この設定はオプションで、指定しない場合は標準出力に出力されます。

--old-config string

古いAPIバージョンを使用している、変換対象のkubeadm設定ファイルのパス。このフラグは必須です。

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

1.1.4 -

設定を出力します。

概要

このコマンドは、指定されたサブコマンドに対する設定を出力します。 詳細については次を参照してください: https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#section-directories

kubeadm config print [flags]

オプション

-h, --help

printのヘルプ

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

1.1.5 -

kubeadm initで使用できるデフォルトのInitConfigurationを出力します。

概要

このコマンドは、'kubeadm init'で使用されるデフォルトのInitConfigurationオブジェクトを出力します。

Bootstrap Tokenフィールドのような機密性が高い値は、実際にトークンを生成する計算は実行しませんが、検証をパスするために"abcdef.0123456789abcdef"のようなプレースホルダーの値に置き換えられることに注意してください。

kubeadm config print init-defaults [flags]

オプション

--component-configs strings

デフォルト値を出力するコンポーネントの設定APIオブジェクトのカンマ区切りのリスト。利用可能な値: [KubeProxyConfiguration KubeletConfiguration]。このフラグが設定されていない場合は、どのコンポーネントの設定も出力されません。

-h, --help

init-defaultsのヘルプ

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

1.1.6 -

kubeadm joinで使用できるデフォルトのJoinConfigurationを出力します。

概要

このコマンドはkubeadm joinで使用されるデフォルトのJoinConfigurationオブジェクトを出力します

Bootstrap Tokenフィールドのような機密性が高い値は、実際にトークンを生成する計算は実行しませんが、検証をパスするために"abcdef.0123456789abcdef"のようなプレースホルダーの値に置き換えられることに注意してください。

kubeadm config print join-defaults [flags]

オプション

-h, --help

join-defaultsのヘルプ

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

1.1.7 -

kubeadm設定APIを含むファイルを読み込み、検証に問題があれば報告します。

概要

このコマンドはkubeadm設定APIファイルを検証して、警告やエラーがあれば報告します。 エラーが無い場合は終了ステータスはゼロ、それ以外の場合はゼロ以外の値となります。 不明なAPIフィールドのようなデータ変換できない問題については、エラーが発生します。 不明なAPIバージョンや不正な値を持つフィールドについてもエラーとなります。 入力ファイルの内容によっては、その他のエラーや警告が報告されることもあります。

このバージョンのkubeadmでは、次のAPIバージョンがサポートされています:

  • kubeadm.k8s.io/v1beta3
kubeadm config validate [flags]

オプション

--allow-experimental-api

実験的な未リリースのAPIの検証を許可する。

--config string

kubeadm設定ファイルへのパス。

-h, --help

validateのヘルプ

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

1.2 - kubeadm config

kubeadm initの実行中、kubeadmはクラスターに対して、kube-system名前空間内のkubeadm-configという名前のConfigMapにClusterConfigurationオブジェクトをアップロードします。 この設定はkubeadm joinkubeadm resetおよびkubeadm upgradeの実行中に読み込まれます。

kubeadm config printによって、kubeadmがkubeadm initkubeadm joinで使用する、デフォルトの静的な設定を表示することができます。

initjoinのより詳細な情報については、設定ファイルを使ったkubeadm initの利用、または設定ファイルを使ったkubeadm joinの利用を参照してください。

kubeadmの設定APIの使用法に関するより詳細な情報については、kubeadm APIを使ったコンポーネントのカスタマイズを参照してください。

非推奨のAPIバージョンを含んだ古い設定ファイルを、サポートされた新しいAPIバージョンに変換する際には、kubeadm config migrateコマンドを使用することができます。

設定ファイルを検証するためには、kubeadm config validateを使用することができます。

kubeadmが必要とするイメージを表示、取得するために、kbueadm config images listkubeadm config images pullを使用することができます。

kubeadm config print

設定を出力します。

概要

このコマンドは、指定されたサブコマンドに対する設定を出力します。 詳細については次を参照してください: https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#section-directories

kubeadm config print [flags]

オプション

-h, --help

printのヘルプ

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

kubeadm config print init-defaults

kubeadm initで使用できるデフォルトのInitConfigurationを出力します。

概要

このコマンドは、'kubeadm init'で使用されるデフォルトのInitConfigurationオブジェクトを出力します。

Bootstrap Tokenフィールドのような機密性が高い値は、実際にトークンを生成する計算は実行しませんが、検証をパスするために"abcdef.0123456789abcdef"のようなプレースホルダーの値に置き換えられることに注意してください。

kubeadm config print init-defaults [flags]

オプション

--component-configs strings

デフォルト値を出力するコンポーネントの設定APIオブジェクトのカンマ区切りのリスト。利用可能な値: [KubeProxyConfiguration KubeletConfiguration]。このフラグが設定されていない場合は、どのコンポーネントの設定も出力されません。

-h, --help

init-defaultsのヘルプ

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

kubeadm config print join-defaults

kubeadm joinで使用できるデフォルトのJoinConfigurationを出力します。

概要

このコマンドはkubeadm joinで使用されるデフォルトのJoinConfigurationオブジェクトを出力します

Bootstrap Tokenフィールドのような機密性が高い値は、実際にトークンを生成する計算は実行しませんが、検証をパスするために"abcdef.0123456789abcdef"のようなプレースホルダーの値に置き換えられることに注意してください。

kubeadm config print join-defaults [flags]

オプション

-h, --help

join-defaultsのヘルプ

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

kubeadm config migrate

ファイルから古いバージョンのAPIタイプのkubeadmの設定を読み込み、新しいバージョンの同等の設定オブジェクトを出力します。

概要

このコマンドは、古いバージョンの設定オブジェクトを、サポートされている最新のバージョンに変換します。 これはクラスターを何も触ることなく、CLIツール内に閉じています。 kubeadmのこのバージョンでは、次のAPIバージョンがサポートされています:

  • kubeadm.k8s.io/v1beta3

さらに、kubeadmはバージョン"kubeadm.k8s.io/v1beta3"の設定しか出力できませんが、両方の種類を読むことができます。 このため、どのバージョンを--old-configパラメーターに渡したとしても、APIオブジェクトは読み込まれ、デシリアライズ、デフォルト化、変換、検証、再シリアライズされて、標準出力または--new-configで指定されたファイルに出力されます。

言い換えると、このコマンドの出力は、そのファイルを"kubeadm init"に渡した時にkubeadmが実際に内部で読むものとなります。

kubeadm config migrate [flags]

オプション

--allow-experimental-api

実験的な未リリースのAPIへの移行を許可します。

-h, --help

migrateのヘルプ

--new-config string

新しいAPIバージョンを使用して得られた同等の内容のkubeadm設定ファイルのパス。この設定はオプションで、指定しない場合は標準出力に出力されます。

--old-config string

古いAPIバージョンを使用している、変換対象のkubeadm設定ファイルのパス。このフラグは必須です。

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

kubeadm config validate

kubeadm設定APIを含むファイルを読み込み、検証に問題があれば報告します。

概要

このコマンドはkubeadm設定APIファイルを検証して、警告やエラーがあれば報告します。 エラーが無い場合は終了ステータスはゼロ、それ以外の場合はゼロ以外の値となります。 不明なAPIフィールドのようなデータ変換できない問題については、エラーが発生します。 不明なAPIバージョンや不正な値を持つフィールドについてもエラーとなります。 入力ファイルの内容によっては、その他のエラーや警告が報告されることもあります。

このバージョンのkubeadmでは、次のAPIバージョンがサポートされています:

  • kubeadm.k8s.io/v1beta3
kubeadm config validate [flags]

オプション

--allow-experimental-api

実験的な未リリースのAPIの検証を許可する。

--config string

kubeadm設定ファイルへのパス。

-h, --help

validateのヘルプ

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

kubeadm config images list

kubeadmが使用するイメージの一覧を出力します。 設定ファイルはイメージやイメージリポジトリをカスタマイズする際に使用されます。

概要

kubeadmが使用するイメージの一覧を出力します。 設定ファイルはイメージやイメージリポジトリをカスタマイズする際に使用されます。

kubeadm config images list [flags]

オプション

--allow-missing-template-keys     デフォルト値: true

trueならば、テンプレートの中にフィールドやマップキーが見つからない場合に、テンプレート内のエラーを無視します。golangまたはjsonpathを出力フォーマットとした場合にのみ適用されます。

--config string

kubeadmの設定ファイルのパス。

-o, --experimental-output string     デフォルト値: "text"

出力フォーマット。次のいずれか: text|json|yaml|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file.

--feature-gates string

様々な機能に対するフィーチャーゲートを記述するkey=valueペアのセット。オプション:
EtcdLearnerMode=true|false (BETA - デフォルト値=true)
PublicKeysECDSA=true|false (DEPRECATED - デフォルト値=false)
RootlessControlPlane=true|false (ALPHA - デフォルト値=false)
UpgradeAddonsBeforeControlPlane=true|false (DEPRECATED - デフォルト値=false)
WaitForAllControlPlaneComponents=true|false (ALPHA - デフォルト値=false)

-h, --help

listのヘルプ

--image-repository string     デフォルト値: "registry.k8s.io"

コントロールプレーンのイメージをプルするコンテナレジストリを選択します。

--kubernetes-version string     デフォルト値: "stable-1"

コントロールプレーンの特定のKubernetesバージョンを選択します。

--show-managed-fields

trueならば、JSONまたはYAMLフォーマットでmanagedFieldsを省略せずにオブジェクトを出力します。

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

kubeadm config images pull

kubeadmによって使用されるイメージをプルします。

概要

kubeadmによって使用されるイメージをプルします。

kubeadm config images pull [flags]

オプション

--config string

kubeadmの設定ファイルのパス。

--cri-socket string

接続するCRIソケットへのパス。空の場合、kubeadmはこの値を自動検出しようとします。このオプションは、複数のCRIがインストールされているか、標準ではないCRIソケットがある場合のみ使用してください。

--feature-gates string

様々な機能に対するフィーチャーゲートを記述するkey=valueペアのセット。オプション:
EtcdLearnerMode=true|false (BETA - デフォルト値=true)
PublicKeysECDSA=true|false (DEPRECATED - デフォルト値=false)
RootlessControlPlane=true|false (ALPHA - デフォルト値=false)
UpgradeAddonsBeforeControlPlane=true|false (DEPRECATED - デフォルト値=false)
WaitForAllControlPlaneComponents=true|false (ALPHA - デフォルト値=false)

-h, --help

pullのヘルプ

--image-repository string     デフォルト値: "registry.k8s.io"

コントロールプレーンのイメージをプルするコンテナレジストリを選択します。

--kubernetes-version string     デフォルト値: "stable-1"

コントロールプレーンの特定のKubernetesバージョンを選択します。

親コマンドから継承されたオプション

--kubeconfig string     デフォルト値: "/etc/kubernetes/admin.conf"

クラスターと通信する時に使用するkubeconfigファイル。フラグが設定されていない場合は、標準的な場所の中から既存のkubeconfigファイルが検索されます。

--rootfs string

[実験的]'実際の'ホストのルートファイルシステムのパス。

次の項目

  • kubeadm upgradeを使用すると、Kubernetesクラスターを最新のバージョンにアップグレードすることができます