使用 ConfigMap PropertySource (Using a ConfigMap PropertySource) _ Spring Cloud Kubernetes 3.1.2 中文文档(官方文档中文翻译) —

Kubernetes 提供了一个名为 ConfigMap 的资源来外部化以键值对或嵌入或文件的形式传递给应用程序的参数。 Spring Cloud Kubernetes Config 项目使 Kubernetes 实例可用在应用程序启动期间，并在检测到观察到的实例。application.propertiesapplication.yamlConfigMapConfigMapSpring中文文档

下面的所有内容主要参考使用 ConfigMap 的示例进行解释，但同样代表机密，即：两者都支持每个功能。Spring中文文档

默认行为是基于 Kubernetes 创建（或）具有以下任一功能之一：Fabric8ConfigMapPropertySourceKubernetesClientConfigMapPropertySourceConfigMapmetadata.nameSpring中文文档

的值spring.cloud.kubernetes.config.nameSpring中文文档
Spring 应用程序的值（由属性定义）spring.application.nameSpring中文文档
字符串文字"application"Spring中文文档

但是，在可以使用多个实例的情况下，可以进行更高级的配置。该列表使这成为可能。例如，您可以定义以下实例：ConfigMapspring.cloud.kubernetes.config.sourcesConfigMapSpring中文文档

spring:
  application:
    name: cloud-k8s-app
  cloud:
    kubernetes:
      config:
        name: default-name
        namespace: default-namespace
        sources:
         # Spring Cloud Kubernetes looks up a ConfigMap named c1 in namespace default-namespace
         - name: c1
         # Spring Cloud Kubernetes looks up a ConfigMap named default-name in whatever namespace n2
         - namespace: n2
         # Spring Cloud Kubernetes looks up a ConfigMap named c3 in namespace n3
         - namespace: n3
           name: c3

在前面的示例中，如果尚未设置，将在应用程序运行的命名空间中查找命名。请参阅命名空间解析，以更好地了解命名空间如何的申请已解决。spring.cloud.kubernetes.config.namespaceConfigMapc1Spring中文文档

找到的任何匹配项都将按如下方式处理：ConfigMapSpring中文文档

应用单个配置属性。Spring中文文档
应用为（或）以（如果不存在，则由yamlpropertiesspring.application.nameapplication.yaml/properties)Spring中文文档
将上述名称的内容 + 每个活动配置文件作为属性文件应用。Spring中文文档

一个例子应该更有意义。让我们假设这样那样我们有一个名为的活动配置文件。对于如下配置：spring.application.name=my-appk8sSpring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: my-app
data:
  my-app.yaml: |-
    ...
  my-app-k8s.yaml: |-
    ..
  my-app-dev.yaml: |-
    ..
  not-my-app.yaml: |-
   ..
  someProp: someValue

这是我们最终将要加载的内容：Spring中文文档

my-app.yaml被视为文件Spring中文文档
my-app-k8s.yaml被视为文件Spring中文文档
my-app-dev.yaml 忽略，因为不是活动配置文件devSpring中文文档
not-my-app.yaml 忽略，因为它不匹配spring.application.nameSpring中文文档
someProp: someValuePlain 属性Spring中文文档

加载属性的顺序如下：Spring中文文档

首先从中加载所有属性my-app.yamlSpring中文文档
然后全部来自基于配置文件的来源：my-app-k8s.yamlSpring中文文档
然后是所有普通属性someProp: someValueSpring中文文档

这意味着基于配置文件的来源优先于非基于配置文件的来源（就像在香草 Spring 应用程序中一样）;普通属性优先于基于配置文件和非配置文件的源。下面是一个示例：Spring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: my-app
data:
  my-app-k8s.yaml: |-
    key1=valueA
	key2=valueB
  my-app.yaml: |-
    key1=valueC
    key2=valueA
  key1: valueD

处理完这样的 ConfigMap 后，您将在以下属性中获得以下内容：， .key1=valueDkey2=valueBSpring中文文档

上述流的唯一例外是当包含指示的单个键时该文件是 YAML 或属性文件。在这种情况下，键的名称不必是或（它可以是任何内容），并且属性的值会正确处理。此功能有助于使用如下内容创建的用例：ConfigMapapplication.yamlapplication.propertiesConfigMapSpring中文文档

kubectl create configmap game-config --from-file=/path/to/app-config.yaml

假设我们有一个名为 Spring Boot 的应用程序，该应用程序使用以下属性来读取其线程池配置。demoSpring中文文档

pool.size.coreSpring中文文档
pool.size.maximumSpring中文文档

这可以外化为配置映射，格式如下：yamlSpring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: demo
data:
  pool.size.core: 1
  pool.size.max: 16

在大多数情况下，单个属性工作正常。但是，有时嵌入式更方便。在这种情况下，我们使用名为 to embing our 的单个属性，如下所示：yamlapplication.yamlyamlSpring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: demo
data:
  application.yaml: |-
    pool:
      size:
        core: 1
        max:16

以下示例也有效：Spring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: demo
data:
  custom-name.yaml: |-
    pool:
      size:
        core: 1
        max:16

您还可以定义要基于标签进行的搜索，例如：Spring中文文档

spring:
  application:
    name: labeled-configmap-with-prefix
  cloud:
    kubernetes:
      config:
        enableApi: true
        useNameAsPrefix: true
        namespace: spring-k8s
        sources:
          - labels:
              letter: a

这将搜索命名空间中具有标签的每个配置映射。重要的这里需要注意的是，与按名称读取 ConfigMap 不同，这可能会导致读取多个 Config Map。像往常一样，机密支持相同的功能。spring-k8s{letter : a}Spring中文文档

您还可以根据合并在一起的活动配置文件以不同的方式配置 Spring Boot 应用程序当读取时。您可以使用 or 属性为不同的配置文件提供不同的属性值，指定特定于配置文件的值，每个值都在其自己的文档中（由序列表示），如下所示：ConfigMapapplication.propertiesapplication.yaml---Spring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: demo
data:
  application.yml: |-
    greeting:
      message: Say Hello to the World
    farewell:
      message: Say Goodbye
    ---
    spring:
      profiles: development
    greeting:
      message: Say Hello to the Developers
    farewell:
      message: Say Goodbye to the Developers
    ---
    spring:
      profiles: production
    greeting:
      message: Say Hello to the Ops

在上述情况下，使用配置文件加载到 Spring Application 中的配置如下所示：developmentSpring中文文档

  greeting:
    message: Say Hello to the Developers
  farewell:
    message: Say Goodbye to the Developers

但是，如果配置文件处于活动状态，则配置将变为：productionSpring中文文档

  greeting:
    message: Say Hello to the Ops
  farewell:
    message: Say Goodbye

如果两个配置文件都处于活动状态，则最后显示的属性将覆盖前面的任何值。ConfigMapSpring中文文档

另一种选择是为每个配置文件创建一个不同的配置映射，Spring Boot 将根据在活动配置文件上Spring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: demo
data:
  application.yml: |-
    greeting:
      message: Say Hello to the World
    farewell:
      message: Say Goodbye

kind: ConfigMap
apiVersion: v1
metadata:
  name: demo-development
data:
  application.yml: |-
    spring:
      profiles: development
    greeting:
      message: Say Hello to the Developers
    farewell:
      message: Say Goodbye to the Developers

kind: ConfigMap
apiVersion: v1
metadata:
  name: demo-production
data:
  application.yml: |-
    spring:
      profiles: production
    greeting:
      message: Say Hello to the Ops
    farewell:
      message: Say Goodbye

要告诉 Spring Boot 应该启用哪个，请参阅 Spring Boot 文档。在部署到 Kubernetes 时激活特定配置文件的一个选项是使用环境变量启动 Spring Boot 应用程序，您可以在容器规范的 PodSpec 中定义该变量。部署资源文件，如下所示：profileSpring中文文档

apiVersion: apps/v1
kind: Deployment
metadata:
  name: deployment-name
  labels:
    app: deployment-name
spec:
  replicas: 1
  selector:
    matchLabels:
      app: deployment-name
  template:
    metadata:
      labels:
        app: deployment-name
	spec:
		containers:
		- name: container-name
		  image: your-image
		  env:
		  - name: SPRING_PROFILES_ACTIVE
			value: "development"

您可能会遇到以下情况：有多个具有相同属性名称的配置映射。例如：Spring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: config-map-one
data:
  application.yml: |-
    greeting:
      message: Say Hello from one

和Spring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: config-map-two
data:
  application.yml: |-
    greeting:
      message: Say Hello from two

根据您放置这些内容的顺序，最终可能会得到意想不到的结果（最后一个配置映射获胜）。例如：bootstrap.yaml|propertiesSpring中文文档

spring:
  application:
    name: cloud-k8s-app
  cloud:
    kubernetes:
      config:
        namespace: default-namespace
        sources:
         - name: config-map-two
         - name: config-map-one

将导致属性为。greetings.messageSay Hello from oneSpring中文文档

有一种方法可以通过指定来更改此默认配置。例如：useNameAsPrefixSpring中文文档

spring:
  application:
    name: with-prefix
  cloud:
    kubernetes:
      config:
        useNameAsPrefix: true
        namespace: default-namespace
        sources:
          - name: config-map-one
            useNameAsPrefix: false
          - name: config-map-two

这样的配置将导致生成两个属性：Spring中文文档

greetings.message等于。Say Hello from oneSpring中文文档
config-map-two.greetings.message等于Say Hello from twoSpring中文文档

请注意，其优先级低于。这允许您为所有源设置“默认”策略，同时只允许覆盖少数几个源。spring.cloud.kubernetes.config.useNameAsPrefixspring.cloud.kubernetes.config.sources.useNameAsPrefixSpring中文文档

如果不能使用配置映射名称，则可以指定其他策略，称为：。由于这是一个显式前缀您选择，它只能提供给关卡。同时，它的优先级高于。假设我们有第三个包含这些条目的配置映射：explicitPrefixsourcesuseNameAsPrefixSpring中文文档

kind: ConfigMap
apiVersion: v1
metadata:
  name: config-map-three
data:
  application.yml: |-
    greeting:
      message: Say Hello from three

如下所示的配置：Spring中文文档

spring:
  application:
    name: with-prefix
  cloud:
    kubernetes:
      config:
        useNameAsPrefix: true
        namespace: default-namespace
        sources:
          - name: config-map-one
            useNameAsPrefix: false
          - name: config-map-two
            explicitPrefix: two
          - name: config-map-three

将导致生成三个属性：Spring中文文档

greetings.message等于。Say Hello from oneSpring中文文档
two.greetings.message等于。Say Hello from twoSpring中文文档
config-map-three.greetings.message等于。Say Hello from threeSpring中文文档

与为 configmap 配置前缀的方式相同，您也可以为 secrets 配置前缀;两者都适用于基于名称的机密以及基于标签的标签。例如：Spring中文文档

spring:
  application:
    name: prefix-based-secrets
  cloud:
    kubernetes:
      secrets:
        enableApi: true
        useNameAsPrefix: true
        namespace: spring-k8s
        sources:
          - labels:
              letter: a
            useNameAsPrefix: false
          - labels:
              letter: b
            explicitPrefix: two
          - labels:
              letter: c
          - labels:
              letter: d
            useNameAsPrefix: true
          - name: my-secret

在生成属性源时，与配置映射相同的处理规则适用。唯一的区别是潜在地，通过标签查找秘密可能意味着我们找到了多个来源。在这种情况下，前缀（如果通过）将是为这些特定标签找到的所有机密的名称。useNameAsPrefixSpring中文文档

要记住的另一件事是，我们支持每个来源，而不是每个秘密。解释这一点的最简单方法是通过一个例子：prefixSpring中文文档

spring:
  application:
    name: prefix-based-secrets
  cloud:
    kubernetes:
      secrets:
        enableApi: true
        useNameAsPrefix: true
        namespace: spring-k8s
        sources:
          - labels:
              color: blue
            useNameAsPrefix: true

假设匹配此类标签的查询将提供两个密钥，因此：和。这两个密钥具有相同的属性名称：和。它是未定义的，最终将作为属性源的一部分，但它的前缀将是（自然排序的串联，机密的名称）。secret-asecret-bcolor=sea-bluecolor=ocean-bluecolorsecret-a.secret-bSpring中文文档

如果您需要更细粒度的结果，可以选择添加更多标签以唯一标识密钥。Spring中文文档

默认情况下，除了读取配置中指定的配置图外，Spring 还会尝试读取来自“配置文件感知”来源的所有属性。解释这一点的最简单方法是通过一个例子。假设您的应用程序启用名为“dev”的配置文件，并且您具有如下所示的配置：sourcesSpring中文文档

spring:
  application:
    name: spring-k8s
  cloud:
    kubernetes:
      config:
        namespace: default-namespace
        sources:
          - name: config-map-one

除了阅读，Spring也会尝试阅读;按此特定顺序。每个活动配置文件生成这样的配置文件感知配置映射。config-map-oneconfig-map-one-devSpring中文文档

尽管应用程序不应受到此类配置映射的影响，但如果需要，可以禁用它：Spring中文文档

spring:
  application:
    name: spring-k8s
  cloud:
    kubernetes:
      config:
        includeProfileSpecificSources: false
        namespace: default-namespace
        sources:
          - name: config-map-one
            includeProfileSpecificSources: false

请注意，就像以前一样，您可以在两个级别指定此属性：对于所有配置映射或对于个人的;后者具有更高的优先级。Spring中文文档

您应该检查安全配置部分。要从 pod 内部访问配置映射，您需要拥有正确的 Kubernetes 服务帐户、角色和角色绑定。

使用实例的另一种选择是通过运行 Spring Cloud Kubernetes 应用程序将它们挂载到 Pod 中并让 Spring Cloud Kubernetes 从文件系统中读取它们。ConfigMapSpring中文文档

此功能已弃用，并将在将来的版本中删除（改用）。此行为由属性控制。您可以在添加或代替前面描述的机制。需要每个属性文件的完整路径列表，因为目录不会被递归解析。例如：spring.config.importspring.cloud.kubernetes.config.pathsspring.cloud.kubernetes.config.paths

spring:
  cloud:
    kubernetes:
      config:
        paths:
          - /tmp/application.properties
          - /var/application.yaml

如果您使用或自动重新加载功能将不起作用。您需要向终端节点发出请求，或者重新启动/重新部署应用程序。spring.cloud.kubernetes.config.pathsspring.cloud.kubernetes.secrets.pathPOST/actuator/refresh

在某些情况下，您的应用程序可能无法使用 Kubernetes API 加载您的某些内容。如果希望应用程序在这种情况下启动过程失败，可以设置为使应用程序启动失败并出现异常。ConfigMapsspring.cloud.kubernetes.config.fail-fast=trueSpring中文文档

还可以使应用程序在失败时重试加载属性源。首先，您需要设置。然后，您需要将和添加到您的类路径中。您可以配置重试属性，例如最大尝试次数，回退选项，如初始间隔，乘数，通过设置属性的最大间隔。ConfigMapspring.cloud.kubernetes.config.fail-fast=truespring-retryspring-boot-starter-aopspring.cloud.kubernetes.config.retry.*Spring中文文档

如果您由于某种原因已经拥有和在类路径上并希望启用快速失败，但不希望启用重试;您可以通过设置来禁用重试。spring-retryspring-boot-starter-aopConfigMapPropertySourcesspring.cloud.kubernetes.config.retry.enabled=false

表 1.性能：
名字	类型	违约	描述
`spring.cloud.kubernetes.config.enabled`Spring中文文档	`Boolean`Spring中文文档	`true`Spring中文文档	启用 ConfigMap`PropertySource`Spring中文文档
`spring.cloud.kubernetes.config.name`Spring中文文档	`String`Spring中文文档	`${spring.application.name}`Spring中文文档	设置要查找的名称`ConfigMap`Spring中文文档
`spring.cloud.kubernetes.config.namespace`Spring中文文档	`String`Spring中文文档	客户端命名空间Spring中文文档	设置要查找的 Kubernetes 命名空间Spring中文文档
`spring.cloud.kubernetes.config.paths`Spring中文文档	`List`Spring中文文档	`null`Spring中文文档	设置挂载实例的路径`ConfigMap`Spring中文文档
`spring.cloud.kubernetes.config.enableApi`Spring中文文档	`Boolean`Spring中文文档	`true`Spring中文文档	通过 API 启用或禁用消费实例`ConfigMap`Spring中文文档
`spring.cloud.kubernetes.config.fail-fast`Spring中文文档	`Boolean`Spring中文文档	`false`Spring中文文档	启用或禁用在加载`ConfigMap`Spring中文文档
`spring.cloud.kubernetes.config.retry.enabled`Spring中文文档	`Boolean`Spring中文文档	`true`Spring中文文档	启用或禁用配置重试。Spring中文文档
`spring.cloud.kubernetes.config.retry.initial-interval`Spring中文文档	`Long`Spring中文文档	`1000`Spring中文文档	初始重试间隔（以毫秒为单位）。Spring中文文档
`spring.cloud.kubernetes.config.retry.max-attempts`Spring中文文档	`Integer`Spring中文文档	`6`Spring中文文档	最大尝试次数。Spring中文文档
`spring.cloud.kubernetes.config.retry.max-interval`Spring中文文档	`Long`Spring中文文档	`2000`Spring中文文档	退避的最大间隔。Spring中文文档
`spring.cloud.kubernetes.config.retry.multiplier`Spring中文文档	`Double`Spring中文文档	`1.1`Spring中文文档	下一个间隔的乘数。Spring中文文档