はじめに
kubectlにおける補完機能 kubectl completionについては、過去の偉大なる皆様がナレッジをお残しにいただいているとは思いますが、私個人的な記憶の定着及び、備忘アウトプットとして綴らせていただきます。
kubectlにおける補完機能とは
k8sのコマンド(ネームスペース monitoring配下のあるpod名における、情報を知りたいとき)を実行するときkubectl get pods xxx -n monitoring 等を実行する際に、pod名が忘れたとき
Tab を押すことで、xxxにおける名前の候補が浮かび上がってきます。
これが補完機能です。(厳密には一種ですが)
要するに、kubectlのコマンドや名前を忘れたときに、とりあえずTabを押下することで補完機能を使える有能なものということです。
インストール方法
ここからはインストール方法について記載いたします。(Bash環境)
私は普段UbuntuやRHEL上にコントロールプレーンを立てて、コマンドを実行しておりましたので左記におけるコマンド情報を記載いたします。
まずは、bashの補完機能からインストールいたします。
- RHELや、AmazonLinuxの場合
sudo yum install -y bash-completion
- Ubuntuや、Debianの場合
sudo apt install -y bash-completion
次に、kubectlにおける補完スクリプトの有効化を実施していきます。
※ここからは以下共通
kubectl completion bash > ~/.kubectl_completion.bash
echo "source ~/.kubectl_completion.bash" >> ~/.bashrc
次に、エイリアスに追記します。
echo "alias k=kubectl" >> ~/.bashrc ##こちらは、kubectl を k と入力するだけでkubectlコマンドが実行できるエイリアスです。不要な方でございましたら、無視してください。
echo "complete -F __start_kubectl k" >> ~/.bashrc
最終事項として、.bashrcを即時反映させます。
source ~/.bashrc
手順としては以上となっております。