k9s の概要 - Kubernetes の高度なターミナル インターフェイス

K9s Kubernetes クラスターと対話するためのターミナル ユーザー インターフェイスを提供します。 このオープンソース プロジェクトの目標は、K8s でのアプリケーションの移動、監視、管理を容易にすることです。 K9s は、Kubernetes の変更を常に監視し、監視対象のリソースを操作するための迅速なコマンドを提供します。

このプロジェクトは Go で書かれており、1 年半以上前から存在しており、最初のコミットは 2019 年 9000 月 XNUMX 日に行われました。 この記事の執筆時点では、XNUMX 個以上のスターが付いています。 GitHub そして約80人の寄稿者。 k9s で何ができるか見てみましょう?

インストールと起動

これは、Docker イメージとして実行するのが最も簡単なクライアント (Kubernetes クラスターに関連した) アプリケーションです。

docker run --rm -it -v $KUBECONFIG:/root/.kube/config quay.io/derailed/k9s

一部の Linux ディストリビューションやその他のオペレーティング システムについては、すぐにインストールできるものもあります。 パッケージ。 一般に、Linux システムの場合は、バイナリ ファイルをインストールできます。

sudo wget -qO- https://github.com/derailed/k9s/releases/download/v0.22.0/k9s_Linux_x86_64.tar.gz | tar zxvf -  -C /tmp/
sudo mv /tmp/k9s /usr/local/bin

K8s クラスター自体には特定の要件はありません。 レビューから判断すると、このアプリケーションは 1.12 などの古いバージョンの Kubernetes でも​​動作します。

アプリケーションは標準構成を使用して起動されます .kube/config - やり方と似ています kubectl.

ナビゲーション

デフォルトでは、コンテキストに指定されたデフォルトの名前空間でウィンドウが開きます。 つまり、次のように書いた場合 kubectl config set-context --current --namespace=testそうすると、名前空間が開きます test. (コンテキスト/名前空間の変更については以下を参照してください。)

に行く コマンドモード 「:」を押すと実行されます。 その後、コマンドを使用して k9s の動作を制御できます。たとえば、(現在の名前空間内の) StatefulSet のリストを表示するには、次のように入力します。 :sts.

その他の Kubernetes リソースについては、次のとおりです。

• :ns — 名前空間;
• :deploy — 導入;
• :ing — 侵入;
• :svc — サービス。

表示可能なリソース タイプの完全なリストを表示するには、次のコマンドがあります。 :aliases.

また、現在のウィンドウ内でホット キーの組み合わせで使用できるコマンドのリストを表示すると便利です。これを行うには、「?」をクリックするだけです。

k9sにもあります 検索モード, 「/」を入力するだけで移動できます。 これを使用すると、現在の「ウィンドウ」の内容に対して検索が実行されます。 以前に入力したとしましょう :ns、名前空間のリストが開いています。 それらが多すぎる場合は、長時間下にスクロールしないように、名前空間を含むウィンドウに入力するだけで十分です /mynamespace.

ラベルで検索するには、目的の名前空間内のすべてのポッドを選択し、たとえば次のように入力します。 / -l app=whoami。 このラベルが付いたポッドのリストを取得します。

検索は、ログ、YAML マニフェストの表示、 describe リソースについては、これらの機能の詳細については以下を参照してください。

全体的なナビゲーション フローはどのようなものですか?

コマンドで :ctx コンテキストを選択できます。

名前空間を選択するには、すでに述べたコマンドがあります。 :nsをクリックすると、目的のスペースを検索できます。 /test.

ここで、関心のあるリソース (たとえば、同じ StatefulSet) を選択すると、それに対応する情報 (実行中のポッドの数とそれらに関する簡単な情報) が表示されます。

ポッドのみが対象となる可能性があります。その場合は、入力するだけで十分です :pod。 ConfigMap の場合 (:cm - これらのリソースのリストについては)、興味のあるオブジェクトを選択して「u」をクリックすると、K9 が具体的に誰がそれを使用しているかを通知します (この CM)。

リソースを表示するためのもう XNUMX つの便利な機能は、 「x-ray」（X線ビュー）。 このモードはコマンドによって呼び出されます。 :xray RESOURCE そして...それがどのように機能するかを説明するよりも示す方が簡単です。 StatefulSet の図を次に示します。

(これらのリソースはそれぞれ編集、変更、作成することができます describe.)

Ingress を使用したデプロイメントは次のとおりです。

リソースの操作

YAML またはそのリソースの各リソースに関する情報を取得できます。 describe 対応するキーボード ショートカット (それぞれ「y」と「d」) を押します。 もちろん、さらに基本的な操作もあります。それらのリストとキーボード ショートカットは、インターフェイスの便利な「ヘッダー」のおかげで常に表示されます (Ctrl + e を押すと非表示になります)。

リソース (選択後の「e」) を編集すると、環境変数で定義されたテキスト エディターが開きます (export EDITOR=vim).

リソースの詳細な説明は次のようになります (describe):

この出力 (またはリソースの YAML マニフェストを表示した出力) は、使い慣れた Ctrl + s キーボード ショートカットを使用して保存できます。 保存される場所は、K9s メッセージからわかります。

Log /tmp/k9s-screens-root/kubernetes/Describe-1601244920104133900.yml saved successfully!

システム ラベルと注釈を削除した後、作成されたバックアップ ファイルからリソースを復元することもできます。 これを行うには、それらが含まれるディレクトリに移動する必要があります (:dir /tmp)、目的のファイルを選択して適用します apply.

ちなみに、現在の ReplicaSet に問題がある場合は、いつでも以前の ReplicaSet にロールバックできます。 これを行うには、目的の RS (:rs 彼らのリストについては):

...Ctrl + l でロールバックします。 すべてがうまくいったという通知を受け取るはずです。

k9s/whoami-5cfbdbb469 successfully rolled back

レプリカをスケールするには、「s」（スケール）をクリックして、必要なインスタンスの数を選択するだけです。

シェルを使用して任意のコンテナに入ることができます。これを行うには、目的のポッドに移動し、「s」(シェル) をクリックしてコンテナを選択します。

その他の機能

もちろん、ログの表示もサポートされています (選択したリソースの場合は「l」)。 また、新しいログを監視するために、Enter キーを常に押す必要はありません。(「m」) をマークして、新しいメッセージのみを追跡するだけで十分です。

また、同じウィンドウで、ログ出力の時間範囲を選択できます。

• キー「1」 - 1分間;
• 「2」 - 5分。
• 「3」 - 15分。
• 「4」 - 30分。
• 「5」 - 1時間。
• 「0」 - ポッドの存続期間全体。

特殊動作モード パルス（指令） :pulse) は、Kubernetes クラスターに関する一般情報を示します。

ここでは、リソースの数とそのステータスを確認できます (緑色はステータスのあるリソースを示します) Running).

K9s のもう XNUMX つの優れた機能は次のとおりです。 ポパイ。 すべてのリソースの正確性に関する特定の基準をチェックし、その結果の「評価」を説明とともに表示します。 たとえば、十分なサンプルや制限がなく、一部のコンテナは root として実行できることがわかります。

Helm には基本的なサポートがあります。 たとえば、クラスターにデプロイされているリリースを確認する方法は次のとおりです。

:helm all # все
:helm $namespace # в конкретном пространстве имен

ベンチマーク

K9 にも組み込まれています ねえ これはシンプルな HTTP サーバー ロード ジェネレーターであり、よく知られている ab (ApacheBench) の代替品です。

これを有効にするには、ポッドでポート転送を有効にする必要があります。 これを行うには、ポッドを選択して Shift + f を押し、「pf」エイリアスを使用してポートフォワード サブメニューに移動します。

ポートを選択して Ctrl + b を押すと、ベンチマーク自体が開始されます。 彼の仕事の結果は次の場所に保存されます。 /tmp 後で K9 で表示できるようになります。

ベンチマークの構成を変更するには、ファイルを作成する必要があります $HOME/.k9s/bench-<my_context>.yml (クラスターごとに決定されます)。

注意: ディレクトリ内のすべての YAML ファイルの拡張子が .k9s まさにそうでした .yml (.yaml 正しく動作しません）。

設定例：

benchmarks:
  defaults:
    # Количество потоков
    concurrency: 2
    # Количество запросов
    requests: 1000
  containers:
    # Настройки для контейнера с бенчмарком
    # Контейнер определяется как namespace/pod-name:container-name
    default/nginx:nginx:
      concurrency: 2
      requests: 10000
      http:
        path: /
        method: POST
        body:
          {"foo":"bar"}
        header:
          Accept:
            - text/html
          Content-Type:
            - application/json
 services:
    # Можно проводить бенчмарк на сервисах типа NodePort и LoadBalancer
    # Синтаксис: namespace/service-name
    default/nginx:
      concurrency: 5
      requests: 500
      http:
        method: GET
        path: /auth
      auth:
        user: flant
        password: s3cr3tp455w0rd

インターフェース

リソースのリストの列の外観は、ファイルを作成することで変更されます。 $HOME/.k9s/views.yml。 その内容の例:

k9s:
 views:
   v1/pods:
     columns:
       - AGE
       - NAMESPACE
       - NAME
       - IP
       - NODE
       - STATUS
       - READY
   v1/services:
     columns:
       - AGE
       - NAMESPACE
       - NAME
       - TYPE
       - CLUSTER-IP

確かに、ラベル用の十分な列がありません。 プロジェクト内の問題.

列による並べ替えはキーボード ショートカットによって実行されます。

• Shift + n - 名前で指定します。
• Shift + o - ノード単位。
• Shift + i - IP による。
• Shift + a - コンテナの存続期間ごとに。
• Shift + t - 再起動の回数分。
• Shift + r - 準備状況による。
• Shift + c - CPU 消費量による。
• Shift + m - メモリ消費量による。

デフォルトの配色が気に入らない場合でも、K9s はサポートします。 スキン。 既製品（7個）をご用意しております ここで。 以下はこれらのスキンの XNUMX つの例です （海軍で）:

Плагины

最後に、 プラグイン K9 の機能を拡張できます。 私自身、仕事でそれらのうちの XNUMX つだけを使用しました。 kubectl get all -n $namespace.

こんな感じです。 ファイルを作成する $HOME/.k9s/plugin.yml 次のような内容で:

plugin:
 get-all:
   shortCut: g    
   confirm: false    
   description: get all
   scopes:
   - all
   command: sh
   background: false
   args:
   - -c
   - "kubectl -n $NAMESPACE get all -o wide | less"

これで、名前空間に移動し、「g」を押して適切なコマンドを実行できます。

プラグインの中には、kubectl-jq との統合やログを表示するためのユーティリティなどがあります。 船尾.

まとめ

私の好みでは、K9 は非常に使いやすいことがわかりました。KXNUMX を使用せずに、必要なものすべてを探すことにすぐに慣れることができます。 kubectl。 ログの表示とその保存、リソースの素早い編集、一般的な作業速度 * に満足しており、ポパイ モードが便利であることがわかりました。 特筆すべき点は、プラグインを作成し、ニーズに合わせてアプリケーションを変更できることです。

※ただし、ログが大量になるとK9sの動作が遅いことも気になりました。 そのような瞬間に、ユーティリティは Intel Xeon E2xx の 312 コアを「消費」し、フリーズする可能性もありました。

現時点で何が足りないのでしょうか？ ディレクトリに移動せずに、以前のバージョンにすばやくロールバックできます (RS については話していません)。 また、回復は次の場合にのみ発生します。 のみ リソース: 注釈またはラベルを削除する場合は、リソース全体を削除して復元する必要があります (ここでディレクトリに移動する必要があります)。 もう XNUMX つの些細なことです。そのような保存された「バックアップ」には十分な日付がありません。

PS

私たちのブログもお読みください:

• «Kubernetes の GUI の概要";
• «Kubernetes Web View の発表 (および Kubernetes の他の Web UI の概要)";
• «kubebox および Kubernetes 用のその他のシェル'。

出所： habr.com