このページでは、kubectl コマンドライン ツールのインストールと構成方法について説明します。
このページは、クラウド インフラストラクチャの設定、モニタリング、管理、クラウド リソースのプロビジョニングと構成を行う IT 管理者、オペレーター、デベロッパーを対象としています。Google Cloud のコンテンツで参照する一般的なロールとタスク例の詳細については、一般的な GKE Enterprise ユーザーロールとタスクをご覧ください。
概要
kubectl は、GKE クラスタを操作するために使用できるコマンドライン ツールです。GKE で kubectl を使用するには、ツールをインストールして、クラスタと通信するように構成する必要があります。Google Cloud で複数のクラスタを実行する場合は、さらに kubectl 構成が必要です。
このページでは次の項目について説明します。
kubectlの仕組みkubectlと必要な依存関係をインストールする方法kubectlのデフォルト クラスタを設定する方法- 特定のクラスタに対して
kubectlコマンドを実行する方法
始める前に
始める前に、次の作業が完了していることを確認してください。
- Google Kubernetes Engine API を有効にする。 Google Kubernetes Engine API の有効化
- このタスクに Google Cloud CLI を使用する場合は、gcloud CLI をインストールして初期化する。すでに gcloud CLI をインストールしている場合は、
gcloud components updateを実行して最新のバージョンを取得する。
kubectl をインストールする
kubectl は、Google Cloud CLI または外部パッケージ マネージャー（apt、yum など）を使用してインストールできます。
gcloud
kubectlコンポーネントをインストールします。gcloud components install kubectlkubectlが最新バージョンであり、インストール済みであることを確認します。kubectl version --client
apt
cloud-sdkリポジトリがあることを確認します。grep -rhE ^deb /etc/apt/sources.list* | grep "cloud-sdk"出力は次のようになります。
deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk maincloud-sdkリポジトリがリストにない場合は、gcloud CLI をインストールします。kubectlコンポーネントをインストールします。apt-get update apt-get install -y kubectlkubectlが最新バージョンであり、インストール済みであることを確認します。kubectl version --client
yum
cloud-sdkリポジトリがあることを確認します。yum repolist | grep "google-cloud-sdk"出力は次のようになります。
google-cloud-sdk Google Cloud SDK 2,205kubectlコンポーネントをインストールします。yum install -y kubectlkubectlが最新バージョンであり、インストール済みであることを確認します。kubectl version --client
必要なプラグインをインストールする
kubectl などの Kubernetes クライアントには認証プラグイン gke-gcloud-auth-plugin が必要です。このプラグインは、Client-go Credential Plugins フレームワークを使用して、GKE クラスタと通信するための認証トークンを提供します。
Kubernetes バージョン 1.26 がリリースされる前に gcloud CLI を起動する場合は、gke-gcloud-auth-plugin バイナリのインストールが必要になります。インストールされていない場合は、kubectl などのカスタム Kubernetes クライアントの既存のインストールは機能しなくなります。
kubectl などのクライアントで GKE を操作するには、このプラグインをインストールする必要があります。プラグインがインストールされていなければ、既存のクライアントにエラー メッセージが表示されます。
始める前に、プラグインがインストール済みであるかどうかを確認します。
gke-gcloud-auth-plugin --version
出力にバージョン情報が表示される場合は、このセクションをスキップします。
認証プラグインは、gcloud CLI または外部パッケージ マネージャー（apt、yum など）を使用してインストールできます。
gcloud
gke-gcloud-auth-plugin バイナリをインストールします。
gcloud components install gke-gcloud-auth-plugin
apt
gke-gcloud-auth-plugin バイナリをインストールします。
apt-get install google-cloud-sdk-gke-gcloud-auth-pluginyum
gke-gcloud-auth-plugin バイナリをインストールします。
yum install google-cloud-sdk-gke-gcloud-auth-plugingke-gcloud-auth-plugin バイナリのインストールを確認します。
gke-gcloud-auth-pluginバイナリのバージョンを確認します。gke-gcloud-auth-plugin --versionプラグインを使用するように
kubectl構成を更新します。gcloud container clusters get-credentials CLUSTER_NAME \ --region=COMPUTE_REGION次のように置き換えます。
CLUSTER_NAME: クラスタの名前。COMPUTE_REGION: クラスタの Compute Engine のリージョン。ゾーンクラスタの場合は、--zone=COMPUTE_ZONEを使用します。
構成を確認します。
kubectl get namespaces出力は次のようになります。
NAME STATUS AGE default Active 51d kube-node-lease Active 51d kube-public Active 51d kube-system Active 51d
このプラグインが必要な理由について詳しくは、Kubernetes KEP をご覧ください。
kubectl を操作する
Kubernetes は、kubeconfig という名前の YAML ファイルを使用して、kubectl のクラスタ認証情報を格納します。デフォルトで、このファイルは $HOME/.kube/config に保存されます。
kubeconfig には、コンテキストと呼ばれるアクセス パラメータのグループが含まれています。各コンテキストには 1 つの Kubernetes クラスタ、1 人のユーザー、任意のデフォルトの Namespace が含まれます。kubectl は、コマンドの実行時にコンテキストを参照します。
kubectl を構成するため、次の作業を完了します。
kubectlが通信するクラスタを選択します。kubeconfigファイルで現在のコンテキストを設定して、kubectlのデフォルト クラスタを設定します。--clusterフラグを使用して、特定のクラスタに対してkubectlコマンドを実行します。
kubeconfig を表示する
環境の kubeconfig を表示するには、次のコマンドを実行します。
kubectl config view
このコマンドは、すでに kubeconfig エントリが生成されているすべてのクラスタのリストを返します。GKE クラスタがリストされた場合、現在の環境でその GKE クラスタに対して kubectl コマンドを実行できます。それ以外の場合は、kubectl のクラスタ情報を保存する必要があります。
kubectl の現在のコンテキストを表示する
現在のコンテキストとは、現在 kubectl のデフォルトとなっているクラスタのことです。すべての kubectl コマンドはこのクラスタに対して実行されます。
gcloud container clusters create-auto を使用してクラスタを作成すると、1 つのエントリが自動的に環境内の kubeconfig ファイルに追加され、現在のコンテキストがそのクラスタに変更されます。次に例を示します。
gcloud container clusters create-auto my-cluster
Creating my-cluster...done
Fetching cluster endpoint and auth data.
kubeconfig entry generated for my-cluster
kubectl の現在のコンテキストを表示するには、次のコマンドを実行します。
kubectl config current-context
kubectl のクラスタ情報を保存する
Google Cloud コンソールを使用してクラスタを作成する場合、または別のパソコンから gcloud CLI を使用してクラスタを作成する場合には、環境の kubeconfig ファイルが更新されません。また、あるプロジェクト チームメンバーが gcloud CLI を使用してメンバー自身のパソコンからクラスタを作成する場合、そのメンバーの kubeconfig だけが更新されます。kubeconfig エントリには次のいずれかが格納されます。
gcloud auth listに示すような認証情報、または- アプリケーションのデフォルト認証情報（構成されている場合）
使用中の環境で kubeconfig コンテキストを生成するには、container.clusters.get 権限が付与されていることを確認します。この権限を付与する最も権限の少ない IAM ロールは container.clusterViewer です。
特定のクラスタの kubeconfig コンテキストを生成するには、次のコマンドを実行します。
gcloud container clusters get-credentials CLUSTER_NAME \
--region=CLUSTER_REGION
次のように置き換えます。
CLUSTER_NAME: クラスタの名前。COMPUTE_REGION: クラスタの Compute Engine のリージョン。ゾーンクラスタの場合は、--zone=COMPUTE_ZONEを使用します。
クラスタの内部 IP アドレスを使用して kubeconfig エントリを生成する
すべてのクラスタには、特性が異なる複数のエンドポイント アドレスがあります。これらのエンドポイントの 1 つは、kubectl や他のサービスがクラスタ コントロール プレーンと通信するために使用する正規エンドポイントとして機能します。GKE は、次の順序に基づいてエンドポイントを自動的に選択します。
- 外部 IP アドレス（外部エンドポイントを有効にしている場合）
- 内部 IP アドレス
- DNS アドレス（IP アクセスが無効な場合）
デフォルトで正規エンドポイントを使用するには、get-credentials コマンドを実行します。kubectl が使用するエンドポイントをさらに制御するには、--internal-ip フラグまたは --dns-endpoint フラグを使用します。
たとえば、内部 IP アドレスを使用するように kubeconfig を更新するには、次のコマンドを実行します。
gcloud container clusters get-credentials CLUSTER_NAME --internal-ip
DNS アドレスを使用するように kubeconfig ファイルを更新するには、次のコマンドを実行します。
gcloud container clusters get-credentials CLUSTER_NAME --dns-endpoint
CLUSTER_NAME は、使用するクラスタの名前に置き換えます。
get-credentials を実行すると、endpoint フィールドに指定された IP がデフォルトで使用されます。
kubectl コマンドのデフォルト クラスタを設定する
以前にクラスタの kubeconfig エントリを生成している場合は、次のコマンドを実行して、kubectl の現在のコンテキストをそのクラスタに切り替えることができます。
gcloud container clusters get-credentials CLUSTER_NAME \
--region=COMPUTE_REGION
次のように置き換えます。
CLUSTER_NAME: クラスタの名前。COMPUTE_REGION: クラスタの Compute Engine のリージョン。ゾーンクラスタの場合は、--zone=COMPUTE_ZONEを使用します。
たとえば、2 つのクラスタ（my-cluster と my-new-cluster）からなるプロジェクトを考えてみましょう。現在のコンテキストは my-new-cluster ですが、すべての kubectl コマンドを my-cluster に対して実行する必要があるとします。現在のコンテキストを my-new-cluster から my-cluster に切り替えるには、次のコマンドを実行します。
gcloud container clusters get-credentials CLUSTER_NAME \
--region=COMPUTE_REGION
特定のクラスタに個別の kubectl コマンドを実行する
特定のクラスタに対して個々の kubectl コマンドを実行するには、--cluster=CLUSTER_NAME を使用します。
たとえば、2 つのクラスタ（my-cluster と my-new-cluster）からなる環境があり、現在のコンテキストが my-cluster であるとします。アプリケーションを my-new-cluster にデプロイする必要が生じましたが、現在のコンテキストを変更したくありません。現在のコンテキストを変更せずにアプリケーションを my-new-cluster にデプロイするには、次のコマンドを実行します。
kubectl run my-app --image us-docker.pkg.dev/my-project/my-repo/my-app:1.0 --cluster my-new-cluster
次のステップ
- GKE クラスタ内のリソースへのアクセスを認可する方法を学習する。
- GKE ワークロードから Google Cloud サービスに対する認証を行う。
kubectlのクイック リファレンスを読む。kubectlコマンドライン ツールのトラブルシューティングを行う。
使ってみる
Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオで GKE のパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
GKE の無料トライアル