解鎖環境變數在雲原生應用中各種姿勢

有態度的小碼甲發表於2020-11-20
變數

應用程式在某些時刻總是需要一些外掛配置，雲原生應用的實踐是在容器化之前就將應用程式配置保留在程式碼之外。

12-Factors App：Store config in the environment

① 外掛配置檔案：業務配置 appsettings.json

可以在程式碼中要求載入appsetting.serect.json配置檔案，但是不加入程式碼版本管理==》敏感資訊分離。

② 環境變數:

  • 單條業務配置(API_URL_PREFIX)
  • 框架配置(ASPNETCORE_ENVIRONMENT=Production)
  • 部署配置(Tag=v1.2)
  • 敏感資訊(AppId,AppAuthIssuer,AppSerect)

環境變數

現代作業系統均支援儲存key-value環境變數，所有程式都能從OS獲取特定環境變數。

ASP.NET Core預設腳手架：環境變數配置在第4位置插入

IConfiguration會拷貝環境變數鍵值對，後續同名配置會覆蓋之前同名配置值，但是環境變數本身不會變化。
public static string? GetEnvironmentVariable(string variable);

環境變數來自三個級別：程式、使用者、系統

 // Specifies the location where an environment variable is stored or retrieved in  a set or get operation
    public enum EnvironmentVariableTarget
    {
        Process = 0,
        User = 1,
        Machine = 2
    }

介紹幾種建立環境變數的方式：

  1. windows：在CMD/Powershell setx命令設定永久環境變數；
    linux：使用export命令設定會話級別環境變數，修改bash_profile檔案設定系統級別環境變數

windows電腦還可以在-[我的電腦]-[高階設定]-[環境變數]操作

  1. 在Visual Studio IDE launchsettings.json 設定程式級別環境變數
{
  "profiles": {
    "Gridsum.EAP.Web": {
      "commandName": "Project",
      "launchBrowser": false,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "production"
        "IsAuthEnabled": "true",
      },
      "applicationUrl": "https://localhost:5002;http://localhost:5001/"
    }
  }
}

Visual Studio Code 設定環境變數

{
   "version": "0.1.0",
   "configurations": [
        {
            "name": ".NET Core Launch (web)",
            "type": "coreclr",
            "env": {
                "ASPNETCORE_ENVIRONMENT": "Development"
            }
        }
    ]
}
  1. 若使用IIS託管 ASP.NET CORE，可在IIS[配置編輯器]新增、重寫環境變數

IIS配置會落地到web.config 檔案

Docker 環境變數

Docker-Compose有多重方式為容器設定環境變數，按照優先順序如下：

  1. 在environment配置節寫入
  2. 通過shell傳入環境變數
  3. 從env_file配置節載入環境變數檔案

① 檔案中的環境變數並不會自動應用到容器，需要在Compose yml檔案中以${}引用
② docker-compose命令預設從命令執行的同一目錄尋找.env檔案

  1. 在Dockerfile內建環境變數
    ASP.NETCore3.1 Runtime映象作為基礎映象的應用， 會發現應用使用Production配置在80埠提供服務。

基礎映象Dockerfile內建：
ENV ASPNETCORE_ENVIRONMENT=Production
ENV ASPNETCORE_URLS=http://+:80
ENV DOTNET_RUNNING_IN_CONTAINER=true

高優先順序會覆蓋低優先順序環境變數值。

下面的例子：shell傳遞的環境變數值覆蓋了.env檔案同名環境變數。

$ cat .env
TAG=v1.5

$ cat docker-compose.yml
version: '3'
services:
  web:
    image: "webapp:${TAG}"
# 啟動容器，web服務使用 webapp:v1.5的映象
$ docker-compose config

version: '3'
services:
  web:
    image: 'webapp:v1.5'

$ export TAG=v2.0
$ docker-compose config

version: '3'
services:
  web:
    image: 'webapp:v2.0'

Kubernetes 環境變數

你可以為執行在Pod中的容器設定環境變數，利用env和envFrom配置節。

  1. env配置節
apiVersion: v1
kind: Pod
metadata:
  name: envar-demo
  labels:
    purpose: demonstrate-envars
spec:
  containers:
  - name: envar-demo-container
    image: anjia0532/google-samples.node-hello:1.0
    env:
    - name: DEMO_GREETING
      value: "Hello from the environment"
    - name: DEMO_FAREWELL
      value: "Such a sweet sorrow"

進入Pod， 列印環境變數（kubectl exec envar-demo -- printenv）：

NODE_VERSION=4.4.2
EXAMPLE_SERVICE_PORT_8080_TCP_ADDR=10.3.245.237
HOSTNAME=envar-demo
...
DEMO_GREETING=Hello from the environment
DEMO_FAREWELL=Such a sweet sorrow

  1. envFrom配置節
    先建立configmap(作為配置來源)
apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  SPECIAL_LEVEL: very
  SPECIAL_TYPE: charm

kubectl create -f configmap-multikeys.yaml

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: anjia0532/busybox
      command: [ "/bin/sh", "-c", "env" ]
      envFrom:
      - configMapRef:
          name: special-config
  restartPolicy: Never

kubectl create -f pod-configmap-envFrom.yaml

現在Pod的輸出環境變數SPECIAL_LEVEL=very and SPECIAL_TYPE=charm

使用env,envFrom配置節設定的環境變數會覆蓋映象內環境變數。

??

環境變數的變更，需要重啟應用。
環境變數在小範圍內使用很方便，當您具有更復雜的配置方案時，應該選擇其他資料注入方式，例如外掛檔案。

相關文章