解锁环境变量在云原生应用中各种姿势

2020 年 11 月 20 日
筆記
.NET

应用程序在某些时刻总是需要一些外挂配置，云原生应用的实践是在容器化之前就将应用程序配置保留在代码之外。

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
    }

介绍几种创建环境变量的方式：

windows：在CMD/Powershell setx命令设置永久环境变量；
linux：使用export命令设置会话级别环境变量，修改bash_profile文件设置系统级别环境变量

windows电脑还可以在-[我的电脑]-[高级设置]-[环境变量]操作

在Visual Studio IDE launchsettings.json 设置进程级别环境变量

{
  "profiles": {
    "Gridsum.EAP.Web": {
      "commandName": "Project",
      "launchBrowser": false,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "production"
        "IsAuthEnabled": "true",
      },
      "applicationUrl": "//localhost:5002;//localhost:5001/"
    }
  }
}

Visual Studio Code 设置环境变量

{
   "version": "0.1.0",
   "configurations": [
        {
            "name": ".NET Core Launch (web)",
            "type": "coreclr",
            "env": {
                "ASPNETCORE_ENVIRONMENT": "Development"
            }
        }
    ]
}

若使用IIS托管 ASP.NET CORE，可在IIS[配置编辑器]新增、重写环境变量

IIS配置会落地到web.config 文件

Docker 环境变量

Docker-Compose有多重方式为容器设置环境变量，按照优先级如下：

在environment配置节写入
通过shell传入环境变量
从env_file配置节加载环境变量文件

① 文件中的环境变量并不会自动应用到容器，需要在Compose yml文件中以${}引用
② docker-compose命令默认从命令执行的同一目录寻找.env文件

在Dockerfile内置环境变量
ASP.NETCore3.1 Runtime镜像作为基础镜像的应用，会发现应用使用Production配置在80端口提供服务。

基础镜像Dockerfile内置：
ENV ASPNETCORE_ENVIRONMENT=Production
ENV ASPNETCORE_URLS=//+: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配置节。

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

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配置节设置的环境变量会覆盖镜像内环境变量。

🐂👃

环境变量的变更，需要重启应用。
环境变量在小范围内使用很方便，当您具有更复杂的配置方案时，应该选择其他数据注入方式，例如外挂文件。

Tags: .NET