kubectlのインストールおよびセットアップ
Kubernetesのコマンドラインツールであるkubectlを使用して、Kubernetesクラスターに対してコマンドを実行することができます。kubectlによってアプリケーションのデプロイや、クラスターのリソース管理および検査を行うことができます。kubectlの操作に関する完全なリストは、Overview of kubectlを参照してください。
- 始める前に
- Linuxへkubectlをインストールする
- macOSへkubectlをインストールする
- Windowsへkubectlをインストールする
- Google Cloud SDKの一部としてダウンロードする
- kubectlの設定を検証する
- kubectlの任意の設定
- 次の項目
始める前に
kubectlのバージョンは、クラスターのマイナーバージョンとの差分が1つ以内でなければなりません。たとえば、クライアントがv1.2であれば、v1.1、v1.2、v1.3のマスターで動作するはずです。最新バージョンのkubectlを使うことで、不測の事態を避けることができるでしょう。
Linuxへkubectlをインストールする
curlを使用してLinuxへkubectlのバイナリをインストールする
次のコマンドにより、最新リリースをダウンロードしてください:
curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl特定のバージョンをダウンロードする場合、コマンドの
$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)の部分を特定のバージョンに書き換えてください。たとえば、Linuxへv1.18.0のバージョンをダウンロードするには、次のコマンドを入力します:
curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.18.0/bin/linux/amd64/kubectlkubectlバイナリを実行可能にしてください。
chmod +x ./kubectlバイナリをPATHの中に移動させてください。
sudo mv ./kubectl /usr/local/bin/kubectlインストールしたバージョンが最新であることを確認してください:
kubectl version
ネイティブなパッケージマネージャーを使用してインストールする
sudo apt-get update && sudo apt-get install -y apt-transport-https
curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
echo "deb https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee -a /etc/apt/sources.list.d/kubernetes.list
sudo apt-get update
sudo apt-get install -y kubectl
cat <<EOF > /etc/yum.repos.d/kubernetes.repo
[kubernetes]
name=Kubernetes
baseurl=https://packages.cloud.google.com/yum/repos/kubernetes-el7-x86_64
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
EOF
yum install -y kubectl
他のパッケージマネージャーを使用してインストールする
Ubuntuまたはsnapパッケージマネージャーをサポートする別のLinuxディストリビューションを使用している場合、kubectlはsnapアプリケーションとして使用できます。
LinuxでHomebrewパッケージマネージャーを使用している場合は、kubectlをインストールすることが可能です。
sudo snap install kubectl --classic
kubectl version
brew install kubectl
kubectl version
macOSへkubectlをインストールする
curlを使用してmacOSへkubectlのバイナリをインストールする
最新リリースをダウンロードしてください:
curl -LO "https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl"特定のバージョンをダウンロードする場合、コマンドの
$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)の部分を特定のバージョンに書き換えてください。たとえば、macOSへv1.18.0のバージョンをダウンロードするには、次のコマンドを入力します:
curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.18.0/bin/darwin/amd64/kubectlkubectlバイナリを実行可能にしてください。
chmod +x ./kubectlバイナリをPATHの中に移動させてください。
sudo mv ./kubectl /usr/local/bin/kubectlインストールしたバージョンが最新であることを確認してください:
kubectl version
Homebrewを使用してmacOSへインストールする
macOSでHomebrewパッケージマネージャーを使用していれば、Homebrewでkubectlをインストールすることもできます。
インストールコマンドを実行してください:
brew install kubectlまたは
brew install kubernetes-cliインストールしたバージョンが最新であることを確認してください:
kubectl version
MacPortsを使用してmacOSへインストールする
macOSでMacPortsパッケージマネージャーを使用していれば、MacPortsでkubectlをインストールすることもできます。
インストールコマンドを実行してください:
sudo port selfupdate sudo port install kubectlインストールしたバージョンが最新であることを確認してください:
kubectl version
Windowsへkubectlをインストールする
curlを使用してWindowsへkubectlのバイナリをインストールする
こちらのリンクから、最新リリースであるv1.18.0をダウンロードしてください。
または、
curlをインストールされていれば、次のコマンドも使用できます:curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.18.0/bin/windows/amd64/kubectl.exe最新の安定版を入手する際は（たとえばスクリプトで使用する場合）、https://storage.googleapis.com/kubernetes-release/release/stable.txtを参照してください。
バイナリをPATHに追加します
kubectlのバージョンがダウンロードしたものと同じであることを確認してください:kubectl version
備考: Docker Desktop for Windowsは、それ自身のバージョンのkubectlをPATHに追加します。Docker Desktopをすでにインストールしている場合、Docker Desktopインストーラーによって追加されたPATHの前に追加するか、Docker Desktopのkubectlを削除してください。
PSGalleryからPowerShellを使用してインストールする
WindowsでPowershell Galleryパッケージマネージャーを使用していれば、Powershellでkubectlをインストールおよびアップデートすることもできます。
インストールコマンドを実行してください（必ず
DownloadLocationを指定してください）:Install-Script -Name install-kubectl -Scope CurrentUser -Force install-kubectl.ps1 [-DownloadLocation <path>]備考:DownloadLocationを指定しない場合、kubectlはユーザのTempディレクトリにインストールされます。インストーラーは
$HOME/.kubeを作成し、設定ファイルを作成します。インストールしたバージョンが最新であることを確認してください:
kubectl version備考: アップデートする際は、手順1に示した2つのコマンドを再実行してください。
ChocolateyまたはScoopを使用してWindowsへインストールする
Windowsへkubectlをインストールするために、ChocolateyパッケージマネージャーやScoopコマンドラインインストーラーを使用することもできます。
インストールしたバージョンが最新であることを確認してください:
kubectl versionホームディレクトリへ移動してください:
cd %USERPROFILE%.kubeディレクトリを作成してください:mkdir .kube作成した
.kubeディレクトリへ移動してください:cd .kubeリモートのKubernetesクラスターを使うために、kubectlを設定してください:
New-Item config -type file備考: Notepadなどの選択したテキストエディターから設定ファイルを編集してください。
Google Cloud SDKの一部としてダウンロードする
Google Cloud SDKの一部として、kubectlをインストールすることもできます。
- Google Cloud SDKをインストールしてください。
kubectlのインストールコマンドを実行してください:gcloud components install kubectlインストールしたバージョンが最新であることを確認してください:
kubectl version
kubectlの設定を検証する
kubectlがKubernetesクラスターを探索し接続するために、kubeconfigファイルが必要になります。これは、kube-up.shによりクラスターを作成した際や、Minikubeクラスターを正常にデプロイした際に自動生成されます。デフォルトでは、kubectlの設定は~/.kube/configに格納されています。
クラスターの状態を取得し、kubectlが適切に設定されていることを確認してください:
kubectl cluster-infoURLのレスポンスが表示されている場合は、kubectlはクラスターに接続するよう正しく設定されています。
以下のようなメッセージが表示されている場合は、kubectlは正しく設定されていないか、Kubernetesクラスターに接続できていません。
The connection to the server <server-name:port> was refused - did you specify the right host or port?たとえば、ラップトップ上（ローカル環境）でKubernetesクラスターを起動するような場合、Minikubeなどのツールを最初にインストールしてから、上記のコマンドを再実行する必要があります。
kubectl cluster-infoがURLレスポンスを返したにもかかわらずクラスターにアクセスできない場合は、次のコマンドで設定が正しいことを確認してください:
kubectl cluster-info dumpkubectlの任意の設定
シェルの自動補完を有効にする
kubectlはBashおよびZshの自動補完を提供しています。これにより、入力を大幅に削減することができます。
以下にBash（LinuxとmacOSの違いも含む）およびZshの自動補完の設定手順を示します。
はじめに
Bashにおけるkubectlの補完スクリプトはkubectl completion bashコマンドで生成できます。シェル内で補完スクリプトをsourceすることでkubectlの自動補完が有効になります。
ただし、補完スクリプトはbash-completionに依存しているため、このソフトウェアを最初にインストールしておく必要があります（type _init_completionを実行することで、bash-completionがすでにインストールされていることを確認できます）。
bash-completionをインストールする
bash-completionは多くのパッケージマネージャーから提供されています（こちらを参照してください）。apt-get install bash-completionまたはyum install bash-completionなどでインストールできます。
上記のコマンドでbash-completionの主要スクリプトである/usr/share/bash-completion/bash_completionが作成されます。パッケージマネージャーによっては、このファイルを~/.bashrcにて手動でsourceする必要があります。
これを調べるには、シェルをリロードしてからtype _init_completionを実行してください。コマンドが成功していればすでに設定済みです。そうでなければ、~/.bashrcに以下を追記してください:
source /usr/share/bash-completion/bash_completionシェルをリロードし、type _init_completionを実行してbash-completionが正しくインストールされていることを検証してください。
kubectlの自動補完を有効にする
すべてのシェルセッションにてkubectlの補完スクリプトをsourceできるようにしなければなりません。これを行うには2つの方法があります:
補完スクリプトを
~/.bashrc内でsourceしてください:echo 'source <(kubectl completion bash)' >>~/.bashrc補完スクリプトを
/etc/bash_completion.dディレクトリに追加してください:kubectl completion bash >/etc/bash_completion.d/kubectlkubectlにエイリアスを張っている場合は、以下のようにシェルの補完を拡張して使うことができます:
echo 'alias k=kubectl' >>~/.bashrc echo 'complete -F __start_kubectl k' >>~/.bashrc
備考: bash-completionは/etc/bash_completion.d内のすべての補完スクリプトをsourceします。
どちらも同様の手法です。シェルをリロードしたあとに、kubectlの自動補完が機能するはずです。
はじめに
Bashにおけるkubectlの補完スクリプトはkubectl completion bashコマンドで生成できます。シェル内で補完スクリプトをsourceすることでkubectlの自動補完が有効になります。
ただし、補完スクリプトはbash-completionに依存しているため、事前にインストールする必要があります。
警告: bash-completionにはv1とv2のバージョンがあり、v1はBash 3.2（macOSのデフォルト）用で、v2はBash 4.1以降向けです。kubectlの補完スクリプトはbash-completionのv1とBash 3.2では正しく動作しません。bash-completion v2およびBash 4.1が必要になります。したがって、macOSで正常にkubectlの補完を使用するには、Bash 4.1以降をインストールする必要があります(手順)。以下の手順では、Bash4.1以降（Bashのバージョンが4.1またはそれより新しいことを指します）を使用することを前提とします。
bash-completionをインストールする
備考: 前述のとおり、この手順ではBash 4.1以降であることが前提のため、bash-completion v2をインストールすることになります（これとは逆に、Bash 3.2およびbash-completion v1の場合ではkubectlの補完は動作しません）。
type _init_completionを実行することで、bash-completionがすでにインストールされていることを確認できます。ない場合は、Homebrewを使用してインストールすることもできます:
brew install bash-completion@2このコマンドの出力で示されたように、~/.bashrcに以下を追記してください:
export BASH_COMPLETION_COMPAT_DIR="/usr/local/etc/bash_completion.d"
[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh"シェルをリロードし、type _init_completionを実行してbash-completion v2が正しくインストールされていることを検証してください。
kubectlの自動補完を有効にする
すべてのシェルセッションにてkubectlの補完スクリプトをsourceできるようにしなければなりません。これを行うには複数の方法があります:
補完スクリプトを
~/.bashrc内でsourceする:echo 'source <(kubectl completion bash)' >>~/.bashrc補完スクリプトを
/usr/local/etc/bash_completion.dディレクトリに追加する:kubectl completion bash >/usr/local/etc/bash_completion.d/kubectlkubectlにエイリアスを張っている場合は、以下のようにシェルの補完を拡張して使うことができます:
echo 'alias k=kubectl' >>~/.bashrc echo 'complete -F __start_kubectl k' >>~/.bashrckubectlをHomwbrewでインストールした場合（前述のとおり）、kubectlの補完スクリプトはすでに
/usr/local/etc/bash_completion.d/kubectlに格納されているでしょう。この場合、なにも操作する必要はありません。
備考: Homebrewでインストールしたbash-completion v2はBASH_COMPLETION_COMPAT_DIRディレクトリ内のすべてのファイルをsourceするため、後者の2つの方法が機能します。
どの場合でも、シェルをリロードしたあとに、kubectlの自動補完が機能するはずです。
Zshにおけるkubectlの補完スクリプトはkubectl completion zshコマンドで生成できます。シェル内で補完スクリプトをsourceすることでkubectlの自動補完が有効になります。
すべてのシェルセッションで使用するには、~/.bashrcに以下を追記してください:
source <(kubectl completion zsh)kubectlにエイリアスを張っている場合は、以下のようにシェルの補完を拡張して使うことができます:
echo 'alias k=kubectl' >>~/.zshrc
echo 'complete -F __start_kubectl k' >>~/.zshrcシェルをリロードしたあとに、kubectlの自動補完が機能するはずです。
complete:13: command not found: compdefのようなエラーが出力された場合は、以下を~/.zshrcの先頭に追記してください:
autoload -Uz compinit
compinit次の項目
- Minikubeをインストールする
- クラスターの作成に関する詳細をスタートガイドで確認する
- アプリケーションを起動して公開する方法を学ぶ
- あなたが作成していないクラスターにアクセスする必要がある場合は、クラスターアクセスドキュメントの共有を参照してください
- kubectlリファレンスドキュメントを参照する
フィードバック
このページは役に立ちましたか？
Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to 問題を報告する or 改善を提案.