Backstage运维小贴士：运行时即时更改配置值的魔法（环境变量篇）

大家好！今天，我们将深入探讨在将Backstage部署到生产环境时，不修改已构建的产物，而是实时（Runtime）更改配置的最直接方法。🚀

在开发环境中，我们可以直接修改app-config.yaml文件，但在使用Docker容器部署的生产环境中，每次修改文件并重新构建几乎是不可能的。那么，在这种情况下，我们能使用的“最强大、最直接的武器”是什么呢？💡

---

🏗️ 答案就是“环境变量（Environment Variables）”！🌡️

在Backstage中，在运行时覆盖单个配置值最直接和标准的方法就是利用环境变量。

Backstage的配置引擎config-loader会在执行时查找具有特定规则的环境变量，并替换YAML文件中定义的值。

---

🌟 为什么要使用环境变量？

1. 构建与配置分离： 一次构建的Docker镜像可以在开发、预发布和生产环境之间重复使用。（一次构建，随处运行！🏎️）
2. 安全性： API密钥、数据库密码等敏感信息无需硬编码到YAML文件中，可以在系统层面注入。🔐
3. 灵活性： 只需更改Kubernetes或Docker Compose配置即可立即生效，响应速度非常快。⚡

---

🛠️ 实战应用：环境变量命名规则 (Naming Convention)

Backstage在将YAML文件的层次结构转换为环境变量时遵循非常明确的规则。

📝 规则1：大写和下划线(_)

将YAML的所有键值转换为大写，层次结构分隔符使用两个下划线(__)或一个下划线(_)。（最新版本建议为了可读性使用APP_CONFIG_前缀，但最直接的方法如下所示。）

💡 实际示例

假设app-config.yaml中有以下配置：

YAML

app:
  baseUrl: https://my-backstage.com
backend:
  database:
    connection:
      host: localhost

如果想在运行时覆盖这些值，可以按如下方式设置环境变量：

• 更改URL时： APP_CONFIG_app_baseUrl=
• 更改DB主机时： APP_CONFIG_backend_database_connection_host=db.production.com

重要提示！🚩

>

Backstage默认会自动检测以APP_CONFIG_开头的环境变量，并将其映射到内部配置。

>

示例：APP_CONFIG_backend_auth_keys_0=”my-secret-key”

---

🏗️ 不同环境中的注入方法

1. 在Docker中使用 🐳

Bash

docker run -e APP_CONFIG_app_baseUrl=https://prod.com my-backstage-image

2. 在Kubernetes(K8s)中使用 ☸️

在deployment.yaml的env部分定义。

YAML

spec:
  containers:
  - name: backstage
    env:
    - name: APP_CONFIG_app_baseUrl
      value: "https://k8s-backstage.com"

3. 在Docker Compose中使用 🐙

YAML

services:
  backstage:
    environment:
      - APP_CONFIG_app_baseUrl=http://localhost:3000

---

⚠️ 注意事项 (Best Practices)

1. 遵守数据类型： 数字必须以数字形式传递，布尔值（true/false）必须以相应的格式传递。
2. 数组处理： 如果要更改数组的特定索引，请附加数字后缀，如_0, _1。

• 示例：APP_CONFIG_organization_name_0=”First Org”

1. 优先级： 环境变量始终具有比app-config.yaml文件中指定的值更高的优先级。这意味着如果设置了环境变量，文件内容将被忽略。🔝

---

🏁 结论：运行时配置之王是“环境变量”

如果您想在Backstage部署环境中以最快、最直接的方式更改单个配置值，请毫不犹豫地使用环境变量（APP_CONFIG_…）。这是在云原生环境中智能运营Backstage的最佳方法！🚀

---