Kyma の検出

Setting and Configuring Kubectl for Kyma

Objective

After completing this lesson, you will be able to kyma の kubectl の設定および設定

Kyma の Kubectl の設定

使用シナリオ

Kyma ランタイムインスタンスが正常に作成されました。次に、これを操作し、kubectl コマンド行インタフェース (CLI) を使用してリソースを管理する方法を学びます。ただし、特に Kyma ランタイムでは認証プロセスに kubectl の特別なプラグインが必要であるため、最初に kubectl CLI を設定して Kyma ランタイムに接続する方法を理解する必要があります。

タスクフロー

この演習問題では、以下のステップを実行します。

  1. kubectl CLI をインストールします。
  2. kubelogin プラグインをインストールします。
  3. Kyma ランタイムインスタンスに接続するように kubectl CLI を設定します。
  4. kubectl を使用して、Kyma ランタイムインスタンスを操作します。

タスク 1: Kubectl CLI のインストール

前提条件

SAP BTP サブアカウントで Kyma ランタイムインスタンスが正常に作成されました。

ステップ

  1. Kubectl CLI をインストールします。

    1. 公式文書に従って、kubectl CLI をインストールします。

    2. kubectl CLI が正しくインストールされていることを確認するには、ターミナルまたはコマンド行で以下のコマンドを実行します。

      Code Snippet
      1
      kubectl version --client

      インストールが正常に行われると、クライアントバージョンとカスタマイジングバージョンが出力として表示されます。

  2. Kubelogin プラグインをインストールします。

    Kyma ランタイムには、Kyma ランタイムインスタンスに接続するために kubectl CLI に対して kubelogin と呼ばれる特別なプラグインが必要です。

    1. 公式文書に従って、kubelogin プラグインをインストールします。

    2. kubelogin プラグインが正しくインストールされていることを確認するには、ターミナルまたはコマンド行で以下のコマンドを実行します。

      Code Snippet
      1
      kubectl version --client

      インストールが正常に行われると、クライアントおよび kubelogin プラグインバージョンが出力として表示されます。

タスク 2: Kyma ランタイムインスタンスへの接続を参照してください。

前述のとおり、kubectl は kubeconfig ファイルに依存します。通常、このファイルは ~/.kube ディレクトリ (macOS/Linux) または %USERPROFILE%\.kube (Windows) にあります。

ステップ

  1. SAP BTP サブアカウント概要ページに移動します。

  2. KubeconfigURL のリンクを選択して、Kyma ランタイムインスタンスの kubeconfig.yaml ファイルをダウンロードします。

    KubeconfigURL
  3. ターミナルで、kubeconfig ファイルの場所を環境変数としてエクスポートします。

    MacOS/Linux の場合:

    Code Snippet
    1
    export KUBECONFIG={KUBECONFIG_FILE_PATH}

    Windows の場合:

    Code Snippet
    1
    $ENV:KUBECONFIG="{KUBECONFIG_FILE_PATH}"

    注記

    kubeconfig ファイルには、Kyma ランタイムインスタンスにアクセスするための認証情報が含まれています。そのため、セキュリティを確保することが重要です。

  4. kubeconfig ファイルが正しく設定されていることを確認するには、ターミナルまたはコマンド行で以下のコマンドを実行します。

    Code Snippet
    1
    kubectl cluster-info

    成功すると、以下の出力が表示されます。

    コマンド kubectl cluster-info の結果を示すターミナル出力。これには、特定の URL で実行されている Kubernetes コントロールプレーンおよび CoreDNS が表示され、デバッグに kubectl cluster-info ダンプを使用することをお奨めします。

タスク 3: Kyma ランタイムでのリソースへのアクセス

ここで、いくつかの kubectl コマンドを使用して Kyma ランタイムインスタンスと対話します。Kubernetes で定義されたすべてには、RESTful Kubernetes API を使用してアクセスできることに注意してください。

すべての kubectl コマンドで、名前空間およびオブジェクトタイプを指定する必要があります。名前空間が指定されていない場合、kubectl ではデフォルトの名前空間が想定されます。オブジェクトタイプは、Pods や Deployments などのリソースタイプの名称です。オブジェクトの名前は、my-pod や my-deployment などのリソースの名前です。

kubectl 構文は以下のとおりです。

kubectl [command] [TYPE] [NAME] [flags]

ステップ

  1. オブジェクト一覧を表示します。

    オブジェクトを一覧表示するには、get コマンドを使用します。get コマンドは、1 つ以上のリソースを一覧表示します。

    1. すべての名前空間のすべての Pod を一覧表示するには、以下のコマンドを使用します。

      Code Snippet
      1
      kubectl get all --all-namespaces
    2. 特定の名前空間内のすべての Pod を一覧表示するには、以下のコマンドを使用します。

      Code Snippet
      1
      kubectl get pods --namespace my-namespace

      ヒント

      --namespace フラグはオプションです。名前空間を指定しない場合は、デフォルトの名前空間が使用されます。ただし、kubeconfig ファイルで名前空間を指定したり、名前空間ごとに異なるコンテキストを作成したりすることもできます。その後、カスタム名前空間をデフォルトとして切り替えたり、設定したりすることができます。コンテキストの詳細については、正式な Kubernetes 文書を参照してください。

    3. デフォルトのネームスペースで指定されたタイプのリソースを一覧表示する get コマンドの他の例をいくつか試します。

      Code Snippet
      1
      kubectl get pods
      Code Snippet
      1
      kubectl get services
      Code Snippet
      1
      kubectl get replicasets
      Code Snippet
      1
      kubectl get deployments
      Code Snippet
      1
      kubectl get nodes
  2. オブジェクトを作成します。

    1. 新規名称領域を登録します。

      Code Snippet
      1
      kubectl create namespace my-namespace
    2. 新しく作成した名前空間にポッドを作成します。

      Code Snippet
      12345678910
      cat <<EOF | kubectl -n my-namespace apply -f - apiVersion: v1 kind: Pod metadata: name: my-pod spec: containers: - name: my-container image: nginx:1.21.3 EOF
    3. create コマンドは、YAML または JSON ファイルから Kubernetes オブジェクトを作成することもできます。たとえば、YAML ファイルで Pod を定義し、以下のコマンドを使用して作成できます。

      Code Snippet
      1
      kubectl create -f my-pod.yaml

      -f--filename の省略形フラグです。これにより、オブジェクト定義を含む YAML または JSON ファイルへのパスが指定されます。

    4. 3 つ目のアプローチは、URL からオブジェクトを登録することです。たとえば、次のコマンドを使用できます。

      Code Snippet
      1
      kubectl create -f https://raw.githubusercontent.com/SAP-samples/kyma-runtime-learning-journey/main/unit_1/my-pod.yaml

      注記

      同じオブジェクト定義で create コマンドを 2 回実行すると、エラーが発生します。これを回避するには、代わりに apply コマンドを使用します。

  3. オブジェクトを更新します。

    オブジェクトを更新するには、apply コマンドを使用します。apply コマンドにより、YAML または JSON ファイルから Kubernetes オブジェクトが更新されます。たとえば、Pod を更新するには、以下のコマンドを使用します。

    Code Snippet
    1
    kubectl apply -f my-pod.yaml

    適用の操作時に、Kubernetes API サーバで YAML または JSON ファイルのオブジェクト定義がクラスタ内のオブジェクトの現在のステータスと比較されます。差異がある場合は、オブジェクトが更新されます。

  4. オブジェクトを記述します。

    オブジェクトを記述するには、Kubernetes オブジェクトに関する詳細情報を表示する describe コマンドを使用します。

    1. たとえば、Pod を記述するには、以下のコマンドを使用できます。

      Code Snippet
      1
      kubectl describe pod my-pod
    1. describe コマンドの出力を YAML または JSON ファイルにエクスポートすることもできます。たとえば、describe コマンドの出力を YAML ファイルにエクスポートするには、以下のコマンドを使用します。

      Code Snippet
      1
      kubectl describe pod my-pod -o yaml > my-pod.yaml
  5. オブジェクトにラベルを付けます。

    オブジェクトにラベルを付けるには、label コマンドを使用します。label コマンドにより、Kubernetes オブジェクトでラベルが追加または更新されます。たとえば、Pod にラベルを追加するには、以下のコマンドを使用できます。

    Code Snippet
    1
    kubectl label pod my-pod my-label=my-value
  6. オブジェクトを削除します。

    1. オブジェクトを削除するには、delete コマンドを使用します。たとえば、Pod を削除するには、以下を実行します。

      Code Snippet
      1
      kubectl delete pod my-pod
    2. 作成した名前空間を削除するには、以下を実行します。

      Code Snippet
      1
      kubectl delete namespace my-namespace
  7. クラスタの詳細を取得します。

    1. クラスタ情報を取得するには、cluster-info コマンドを使用します。クラスタに関する情報が表示されます。

      Code Snippet
      1
      kubectl cluster-info
    2. ノードおよび Pod のリソース使用情報を取得するには、top コマンドを使用します。

      Code Snippet
      1
      kubectl top nodes
      Code Snippet
      1
      kubectl top pods
  8. 使用可能なすべてのコマンドの完全な一覧を取得するには、help コマンドを使用します。

    Code Snippet
    1
    kubectl help

結果

kubectl CLI が正常にインストールされ、Kyma ランタイムインスタンスに接続されるように設定されている必要があります。基本の kubectl コマンドを使用して、それを操作できます。