🐕

Kubernetesクラスタを安全に操作する

2022/12/23に公開

AWS

Kubernetes

tmux

tech

本記事では、tmuxのセッションごとにKubernetesクラスタを固定することでAWS EKSを安全に操作する方法について説明します。
カスタマイズしていただければ、GKE、AKSなどでもご利用いただけるかと思いますし、ほかにも方法はあるのでその中の1つとして参考にしていただければと思います。

なぜそうしたのか？

私は、普段の業務で複数のクラスタを1つのターミナルから操作しています。
Kubernetesクラスタを管理している多くの方が、同じような状況ではないでしょうか。

そこで問題となるのが、Kubernetesクラスタの切り替えです。
kubectlはデフォルトで$HOME/.kube/configに設定されたcurrent-contextを参照します。
つまり、クラスタごとにターミナルやタブを分けてもすべてのターミナルが同じコンフィグを参照するため、ターミナルを分ける意味がなくなってしまいます。
また、操作するクラスタが変わるたびにコマンドを実行し切り替える必要があり大変ですし、切り替え忘れてkubectl deleteをしてしまった場合はもっと大変なことになりそうな予感がします。

それらを防ぐために今回は、私がどのような方法をとっているか紹介したいと思います。

以下の方向けの記事です

普段tmuxを使っていて、セッション、ウィンドウごとにKubernetesクラスタを固定したい
プロンプトをカスタマイズしていて、いい感じにkubieが使えない

ちなみにプロンプトやコンフィグをデフォルトで利用している方は、kubieがおすすめです。

簡単にどのような実装となっているか説明し、その後具体的な設定内容を紹介します。

実装の簡単な説明

AWS CLIのコンフィグからプロファイルをfzfで選択し、選択したプロファイルに存在するEKS一覧が表示されるため、その中から操作したいクラスタを選択します。

次にtmuxのセッションごとに選択したクラスタのkubeconfigを作成し、ログインシェルの環境変数KUBECOFIGを設定することで操作するクラスタを固定します。
また、tmuxのセッション環境変数を設定することによって、新しいウィンドウやペインを作成した際、引き継がれるようになっています。

接続先を切り替えるごとにkubeconfigを生成するため、/tmpに作成することで、PCリスタート時に削除します。

では、どのようになっているか見ていきたいと思います。

実装内容

以下functionを.zshrcや.bashrcなどに登録し、リロードしてください。

# ローカルに登録されているAWSプロファイルを表示
aws_profiles () {
    [[ -r "${AWS_CONFIG_FILE:-$HOME/.aws/config}" ]] || return 1
    grep --color=auto --exclude-dir={.bzr,CVS,.git,.hg,.svn,.idea,.tox} --color=never -Eo '\[.*\]' "${AWS_CONFIG_FILE:-$HOME/.aws/config}" | sed -E 's/^[[:space:]]*\[(profile)?[[:space:]]*([-_[:alnum:]\.@]+)\][[:space:]]*$/\2/g'
}

function up() {
  # /tmpに作成するコンフィグ用のディレクトリを作成
  # PCをリスタートした際、削除されるように/tmpに配置
  ! test  -d "/tmp/kubeconfigs" && mkdir /tmp/kubeconfigs

  # デフォルトのコンフィグ($HOME/.kube/config)に戻れるオプションも用意
  if [[ $1 == "reset" ]]; then
    export KUBECONFIG="$HOME/.kube/config"
    return 0
  fi

  # AWSプロファイルを環境変数に設定
  AWS_PROFILE=$(aws_profiles | fzf) \
    && export AWS_PROFILE \
    && export AWS_DEFAULT_PROFILE="${AWS_PROFILE}"

  # AWSプロファイル内に存在するEKSクラスタを取得
  cluster_name=$(aws eks list-clusters | jq -r '.clusters[]' | fzf)

  # 取得したEKSクラスタのkubeconfigを作成
  export KUBECONFIG="$(mktemp -q /tmp/kubeconfigs/"$cluster_name"-XXXXXXX)"
  aws eks update-kubeconfig --name "$cluster_name" --kubeconfig "$KUBECONFIG"

  # tmuxのセッション環境変数に追加
  # 新しいウィンドウ、ペインを作成しても引き継がれます
  tmux setenv KUBECONFIG "$KUBECONFIG"
  tmux setenv AWS_PROFILE "$AWS_PROFILE"
  tmux setenv AWS_DEFAULT_PROFILE "$AWS_DEFAULT_PROFILE"
}

最後に

いかがだったでしょうか？
ニッチな情報となりましたが、少しでもローカル環境構築の役に立てれればと思います。

ほかにもこんなツールがあるよなど教えていただけると大変嬉しいです。

GitHubで編集を提案

なぜそうしたのか？

実装の簡単な説明

実装内容

最後に

Discussion