Bridge to Kubernetes を構成する

[アーティクル]
06/04/2024

Note

Microsoft は、Bridge to Kubernetes プロジェクトを積極的に維持することを計画しています。今後数か月で、プロジェクトをアーカイブ状態に移行します。それまでの間、プロジェクトは引き続き使用およびダウンロードできます。この期間中、私たちは、今後のご利用のために Bridge to Kubernetes と同様のメリットを提供するコミュニティプロジェクトを調査し、推奨したいと考えています。ご質問がある場合は、GitHub の問題ボードでお問い合わせください。

ローカルの Bridge to Kubernetes プロセスは、2 つの方法を使用して構成できます。クラスター上のサービスに注釈を付けることができ、ローカル構成を指定できます。

Kubernetes の構成

Kubernetes 構成 (kubeconfig) ファイルは既定で ~/.kube/config に格納されますが、KUBECONFIG 環境変数を使用して設定できます。

Visual Studio を使用している場合は、デバッグプロパティのデバッグ起動プロファイル UI を使用して、IDE で Bridge to Kubernetes 起動プロファイルを編集できます。「起動プロファイルの編集」を参照してください。

そこから、次の画面を開くことができます。この画面では、最も一般的な構成プロパティの一部を編集できます。

Bridge to Kubernetes で特定のポートを転送しないようにする

サービスに bridgetokubernetes/ignore-ports 注釈を追加して、Kubernetes サービスの特定のポートをマシンにマッピングしないように Bridge to Kubernetes を構成します。

apiVersion: v1
kind: Service
metadata:
  annotations:
    bridgetokubernetes/ignore-ports:445,23

(KubernetesLocalProcessConfig.yaml) を使用したローカル構成

KubernetesLocalProcessConfig.yaml ファイルを使用すると、クラスター内のポッドからアクセスできる環境変数とマウントされたファイルをレプリケートすることができます。 KubernetesLocalProcessConfig.yaml ファイルでは、次のアクションを指定できます。

ボリュームをダウンロードし、そのボリュームへのパスを環境変数として設定する。
クラスター上で実行されているサービスを、開発用コンピューター上で実行されているプロセスで使用できるようにします。
定数値を指定した環境変数を作成します。

既定の KubernetesLocalProcessConfig.yaml ファイルは自動的には作成されません。プロジェクトのルートに手動でファイルを作成する必要があります。

ボリュームをダウンロードする

ダウンロードするボリュームごとに、env で name と value を指定します。 name は、開発用コンピューターで使用される環境変数です。 value は、開発用コンピューター上のボリュームの名前とパスです。 value の値は、 $(volumeMounts:VOLUME_NAME)/PATH/TO/FILES の形式を受け取ります。

次に例を示します。

version: 0.1
env:
  - name: ALLOW_LIST_PATH
    value: $(volumeMounts:allow-list)/allow-list

上の例では、コンテナーから allow-list ボリュームをダウンロードし、その場所と環境変数 ALLOW_LIST_PATH へのパスを設定しています。既定の動作では、開発用コンピューター上の一時ディレクトリ以下の指定したパスにファイルがダウンロードされます。上の例では、ALLOW_LIST_PATH は /TEMPORARY_DIR/allow-list に設定されています。

注意

ボリュームをダウンロードすると、設定したパスに関係なく、そのボリュームの内容全体がダウンロードされます。このパスは、開発用コンピューターで使用する環境変数を設定するためにのみ使用されます。トークンの末尾に /allow-list または /path/to/files を追加しても、ボリュームが永続化される場所には実際には影響しません。環境変数は、そのボリューム内の特定のファイルへの参照がアプリに必要な場合に便利です。

一時ディレクトリを使用するのではなく、開発用コンピューターにボリュームマウントをダウンロードする場所を指定することもできます。特定の場所ごとに、volumeMounts で name と localPath を指定します。 name は照合するボリューム名であり、localPath は開発用コンピューターの絶対パスです。次に例を示します。

version: 0.1
volumeMounts:
  - name: default-token-*
    localPath: /var/run/secrets/kubernetes.io/serviceaccount
env:
  - name: KUBERNETES_IN_CLUSTER_CONFIG_OVERRIDE
    value: $(volumeMounts:default-token-*)

上記の例では、env のエントリを使用して、default-token-1111 や default-token-1234-5678-90abcdef などの default-token-* と一致するボリュームをダウンロードします。複数のボリュームが一致する場合は、最初に一致したボリュームが使用されます。すべてのファイルは、volumeMounts のエントリを使用して、開発用コンピューターの /var/run/secrets/kubernetes.io/serviceaccount にダウンロードされます。 KUBERNETES_IN_CLUSTER_CONFIG_OVERRIDE 環境変数は /var/run/secrets/kubernetes.io/serviceaccount に設定されています。

サービスを使用できるようにする

開発用コンピューターで使用できるようにするサービスごとに、env で name と value を指定します。 name は、開発用コンピューターで使用される環境変数です。 value は、クラスターのサービスの名前とパスです。 value の値は、 $(services:SERVICE_NAME)/PATH の形式を受け取ります。

次に例を示します。

version: 0.1
env:
  - name: MYAPP1_SERVICE_HOST
    value: $(services:myapp1)/api/v1/

上の例では、myapp1 サービスを開発用コンピューターで使用できるようにしています。また、MYAPP1_SERVICE_HOST 環境変数を myapp1 サービスのローカル IP アドレスと /api/v1 パス (つまり、127.1.1.4/api/v1) に設定しています。 myapp1 サービスには、環境変数 myapp1、または myapp1.svc.cluster.local を使用してアクセスできます。

注意

開発用コンピューターでサービスを使用できるようにすると、設定したパスに関係なく、サービス全体を使用できるようになります。このパスは、開発用コンピューターで使用する環境変数を設定するためにのみ使用されます。また、 $(services:SERVICE_NAME.NAMESPACE_NAME) を使用して、特定の Kubernetes 名前空間のサービスを使用できるようにすることもできます。次に例を示します。

version: 0.1
env:
  - name: MYAPP2_SERVICE_HOST
    value: $(services:myapp2.mynamespace)

上の例では、mynamespace 名前空間の myapp2 を開発用コンピューターで使用できるようにしています。また、MYAPP2_SERVICE_HOST 環境変数を mynamespace 名前空間の myapp2 のローカル IP アドレスに設定しています。

定数値を指定した環境変数を作成する

開発用コンピューターに作成する環境変数ごとに、env で name と value を指定します。 name は開発用コンピューターで使用される環境変数であり、value は値です。次に例を示します。

version: 0.1
env:
  - name: DEBUG_MODE
    value: "true"

上の例では、値が true の DEBUG_MODE という名前の環境変数を作成しています。

サービスの依存関係を追加する

サービスの宣言方法と同様に、汎用依存関係フィールドを使用して、データベースやキャッシュなどのサービスの依存関係を指定できます。デバッグ対象のサービスが、クラスター上で実行されていないリソースに接続する必要がある場合は、ここで依存関係を指定します。次の例のように依存関係を宣言します。

version: 0.1
volumeMounts:
env:
  - name: DB_HOST
    value: $(externalendpoints:server-bridgetest123.database.windows.net:1433)

依存関係のホスト DNS 名 (例では server-bridgetest13.database.windows.net) とポート (例では 1433) を指定します。

データベースなどの依存関係を指定する場合、リダイレクト認証モデルは機能しません。たとえば、Azure SQL Database の場合、接続ポリシーを "Proxy" ("Redirect" や "Default" ではなく) に設定する必要があります。

KubernetesLocalProcessConfig.yaml の例

完全な KubernetesLocalProcessConfig.yaml ファイルの例を次に示します。

version: 0.1
volumeMounts:
  - name: default-token-*
    localPath: /var/run/secrets/kubernetes.io/serviceaccount
env:
  - name: KUBERNETES_IN_CLUSTER_CONFIG_OVERRIDE
    value: $(volumeMounts:default-token-*)
  - name: ALLOW_LIST_PATH
    value: $(volumeMounts:allow-list)/allow-list
  - name: MYAPP1_SERVICE_HOST
    value: $(services:myapp1)/api/v1/
  - name: MYAPP2_SERVICE_HOST
    value: $(services:myapp2.mynamespace)
  - name: DEBUG_MODE 
    value: "true"

次の手順

Bridge to Kubernetes を使用してローカル環境の開発用コンピューターをクラスターに接続する方法については、「Visual Studio Code を使用して Bridge to Kubernetes を利用する」と Visual Studio を使用して Bridge to Kubernetes を利用する方法に関するページを参照してください。

次の方法で共有