依存関係のある環境変数の定義

このページでは、KubernetesのPod内のコンテナに対して、依存関係のある環境変数を定義する方法について説明します。

始める前に

Kubernetesクラスターが必要、かつそのクラスターと通信するためにkubectlコマンドラインツールが設定されている必要があります。 このチュートリアルは、コントロールプレーンのホストとして動作していない少なくとも2つのノードを持つクラスターで実行することをおすすめします。 まだクラスターがない場合、minikubeを使って作成するか、 以下のいずれかのKubernetesプレイグラウンドも使用できます:

• Killercoda
• KodeKloud
• Play with Kubernetes

コンテナに依存関係のある環境変数を定義する

Podを作成する際に、そのPod内で実行されるコンテナに対して依存関係のある環境変数を設定できます。 依存関係のある環境変数を設定するには、設定ファイル内のenvのvalueに$(VAR_NAME)を使用します。

このチュートリアルでは、1つのコンテナを実行するPodを作成します。 このPodの設定ファイルでは、一般的な使い方に基づいて依存関係のある環境変数が定義されています。 以下がPodの設定マニフェストです。

pods/inject/dependent-envars.yaml

apiVersion: v1
kind: Pod
metadata:
  name: dependent-envars-demo
spec:
  containers:
    - name: dependent-envars-demo
      args:
        - while true; do echo -en '\n'; printf UNCHANGED_REFERENCE=$UNCHANGED_REFERENCE'\n'; printf SERVICE_ADDRESS=$SERVICE_ADDRESS'\n';printf ESCAPED_REFERENCE=$ESCAPED_REFERENCE'\n'; sleep 30; done;
      command:
        - sh
        - -c
      image: busybox:1.28
      env:
        - name: SERVICE_PORT
          value: "80"
        - name: SERVICE_IP
          value: "172.17.0.1"
        - name: UNCHANGED_REFERENCE
          value: "$(PROTOCOL)://$(SERVICE_IP):$(SERVICE_PORT)"
        - name: PROTOCOL
          value: "https"
        - name: SERVICE_ADDRESS
          value: "$(PROTOCOL)://$(SERVICE_IP):$(SERVICE_PORT)"
        - name: ESCAPED_REFERENCE
          value: "$$(PROTOCOL)://$(SERVICE_IP):$(SERVICE_PORT)"

1. このマニフェストに基づいてPodを作成します:

   kubectl apply -f https://k8s.io/examples/pods/inject/dependent-envars.yaml
   

   pod/dependent-envars-demo created
   

2. 実行中のPodを一覧表示します:

   kubectl get pods dependent-envars-demo
   

   NAME                      READY     STATUS    RESTARTS   AGE
   dependent-envars-demo     1/1       Running   0          9s
   

3. Pod内で実行中のコンテナのログを確認します:

   kubectl logs pod/dependent-envars-demo
   

   
   UNCHANGED_REFERENCE=$(PROTOCOL)://172.17.0.1:80
   SERVICE_ADDRESS=https://172.17.0.1:80
   ESCAPED_REFERENCE=$(PROTOCOL)://172.17.0.1:80
   

上記のとおり、SERVICE_ADDRESSには正しい依存関係の参照を定義しており、UNCHANGED_REFERENCEには誤った依存関係の参照が、ESCAPED_REFERENCEには依存関係の参照をスキップする表現が使われています。

参照される環境変数がすでに定義されている場合、その参照は正しく解決されます。 たとえば、SERVICE_ADDRESSの場合がそれに該当します。

envリスト内の順序が重要であることに注意してください。 環境変数は、リスト内で後に記述されているだけでは「定義済み」と見なされません。 このため、上記の例ではUNCHANGED_REFERENCEが$(PROTOCOL)を解決できません。

環境変数が未定義であるか、いくつかの変数しか含まれていない場合、その未定義の環境変数はUNCHANGED_REFERENCEのように通常の文字列として扱われます。 一般に、誤って解釈された環境変数があっても、コンテナの起動が妨げられることはないことに注意してください。

$(VAR_NAME)構文は、$を2つ重ねて$$(VAR_NAME)のように記述することでエスケープできます。 エスケープされた参照は、参照される変数が定義されているかどうかに関係なく展開されることはありません。 これは、上記のESCAPED_REFERENCEの例からも確認できます。

次の項目

• 環境変数についてさらに詳しく学びましょう。
• EnvVarSourceをご覧ください。