此版本仍在开发中，尚未被视为稳定版本。如需最新的稳定版本，请使用 Spring Cloud Kubernetes 3.1.4！spring-doc.cn

使用ConfigMap PropertySource

Kubernetes 提供了一个名为 ConfigMap 的资源来外部化 参数以键值对或嵌入 OR 文件的形式传递给应用程序。 Spring Cloud Kubernetes Config 项目使 Kubernetes 实例可用 在应用程序启动期间，并在检测到更改时触发 bean 或 Spring 上下文的热重载 观察到的实例。application.propertiesapplication.yamlConfigMapConfigMapspring-doc.cn

接下来的所有内容主要是指使用 ConfigMaps 的示例，但同样代表 Secrets，即：两者都支持每个功能。spring-doc.cn

默认行为是基于 Kubernetes 创建一个（或 一个 ），该 Kubernetes 具有：Fabric8ConfigMapPropertySourceKubernetesClientConfigMapPropertySourceConfigMapmetadata.namespring-doc.cn

但是，在您可以使用多个实例的情况下，可以使用更高级的配置。 该列表使这成为可能。 例如，您可以定义以下实例：ConfigMapspring.cloud.kubernetes.config.sourcesConfigMapspring-doc.cn

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

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

找到的任何匹配项都将按如下方式处理：ConfigMapspring-doc.cn

  • 应用单个配置属性。spring-doc.cn

  • 将 （或 ） 由 的值 （如果不存在，则由yamlpropertiesspring.application.nameapplication.yaml/properties)spring-doc.cn

  • 将上述名称的内容 + 每个活动配置文件作为属性文件应用。spring-doc.cn

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

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-doc.cn

加载属性的顺序如下：spring-doc.cn

这意味着基于配置文件的源优先于非基于配置文件的源（就像在原版 Spring 应用程序中一样）;和 plain 属性优先于基于配置文件和非配置文件的源。下面是一个示例：spring-doc.cn

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-doc.cn

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

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

假设我们有一个名为 Spring Boot 的应用程序，它使用以下属性来读取其线程池 配置。demospring-doc.cn

这可以按以下格式外部化到 config map 中：yamlspring-doc.cn

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

在大多数情况下，单个属性都可以正常工作。但是，有时 embedded 更方便。在这种情况下，我们 使用一个名为 to embed our 的属性，如下所示：yamlapplication.yamlyamlspring-doc.cn

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

以下示例也有效：spring-doc.cn

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

您还可以根据标签定义要进行的搜索，例如：spring-doc.cn

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

这将搜索命名空间中具有 labels 的每个 configmap 。重要的 这里需要注意的是，与按名称读取 configMap 不同，这可能会导致读取多个 config map。 像往常一样，密钥也支持相同的功能。spring-k8s{letter : a}spring-doc.cn

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

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-doc.cn

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

但是，如果配置文件处于活动状态，则配置将变为：productionspring-doc.cn

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

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

另一种选择是为每个配置文件创建不同的 config map，Spring boot 将根据 在活动配置文件上spring-doc.cn

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 中定义该变量。 Deployment 资源文件，如下所示：profilespring-doc.cn

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"

你可能会遇到多个具有相同属性名称的 configs 映射的情况。例如：spring-doc.cn

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

和spring-doc.cn

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

根据 你把这些东西放进去的顺序，你最终可能会得到一个意想不到的结果（最后一个配置映射获胜）。例如：bootstrap.yaml|propertiesspring-doc.cn

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-doc.cn

有一种方法可以通过指定来更改此默认配置。例如：useNameAsPrefixspring-doc.cn

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-doc.cn

  • greetings.message等于 。Say Hello from onespring-doc.cn

  • config-map-two.greetings.message等于Say Hello from twospring-doc.cn

请注意，它的优先级低于 。 这允许您为所有源设置 “default” 策略，同时只允许覆盖少数源。spring.cloud.kubernetes.config.useNameAsPrefixspring.cloud.kubernetes.config.sources.useNameAsPrefixspring-doc.cn

如果无法使用配置映射名称，则可以指定其他策略，称为 ： 。由于这是一个显式的前缀， ，则只能将其提供给 Level。同时，它具有比 更高的优先级。假设我们有第三个配置映射，其中包含这些条目：explicitPrefixsourcesuseNameAsPrefixspring-doc.cn

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

如下所示的配置：spring-doc.cn

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-doc.cn

  • greetings.message等于 。Say Hello from onespring-doc.cn

  • two.greetings.message等于 。Say Hello from twospring-doc.cn

  • config-map-three.greetings.message等于 。Say Hello from threespring-doc.cn

与 为 configmap 配置前缀的方式相同，您也可以为 secret 配置前缀;两者都适用于基于 name 的 secret 以及基于标签的 API。例如：spring-doc.cn

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

生成 property source 时，处理规则与生成 config maps 的处理规则相同。唯一的区别是 按标签查找密钥可能意味着我们会找到多个来源。在这种情况下，前缀（如果通过 ） 将为这些特定标签找到的所有密钥的名称。useNameAsPrefixspring-doc.cn

要记住的另一件事是，我们支持按源，而不是按机密。解释这一点的最简单方法是通过一个例子：prefixspring-doc.cn

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

假设与此类标签匹配的查询将提供两个密钥作为结果：和 。 这两个密钥具有相同的属性名称： 和 .它是 undefined，它最终将成为 property sources 的一部分，但它的前缀将是 （自然连接排序，秘密的名称）。secret-asecret-bcolor=sea-bluecolor=ocean-bluecolorsecret-a.secret-bspring-doc.cn

如果您需要更精细的结果，则可以选择添加更多标签来唯一标识密钥。spring-doc.cn

默认情况下，除了读取配置中指定的 config map 之外，Spring 还会尝试读取 来自 “Profile Aware” 源的所有属性。解释这一点的最简单方法是通过一个例子。假设您的应用程序 启用名为 “dev” 的配置文件，并且您拥有如下所示的配置：sourcesspring-doc.cn

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

除了读取 ， Spring 还会尝试读取 ;按此特定顺序。每个活动配置文件 生成这样的配置文件感知配置 Map。config-map-oneconfig-map-one-devspring-doc.cn

虽然你的应用程序不应该受到这种配置映射的影响，但如果需要，可以禁用它：spring-doc.cn

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

请注意，和之前一样，有两个级别可以指定此属性：for all config maps 或 对于单个 ID;后者具有更高的优先级。spring-doc.cn

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

使用实例的另一种选择是通过运行 Spring Cloud Kubernetes 应用程序将它们挂载到 Pod 中 以及让 Spring Cloud Kubernetes 从文件系统中读取它们。ConfigMapspring-doc.cn

此功能已弃用，并将在未来发行版中删除（改用）。 此行为由属性控制。您可以在 添加或代替前面描述的机制。 需要每个属性文件的完整路径的 List，因为目录不会被递归解析。例如：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 加载你的一些内容。 如果希望应用程序在这种情况下启动过程失败，则可以设置为使应用程序启动失败并出现 Exception。ConfigMapsspring.cloud.kubernetes.config.fail-fast=truespring-doc.cn

您还可以让应用程序在失败时重试加载属性源。首先，您需要 设置。然后你需要将 and 添加到你的 classpath 中。您可以配置重试属性，例如 最大尝试次数、回退选项（如初始间隔、乘数、最大间隔）通过设置属性。ConfigMapspring.cloud.kubernetes.config.fail-fast=truespring-retryspring-boot-starter-aopspring.cloud.kubernetes.config.retry.*spring-doc.cn

如果出于某种原因您已经有 和 在 Classpath 上 并希望启用快速失败，但不希望启用重试;您可以通过设置 来禁用重试。spring-retryspring-boot-starter-aopConfigMapPropertySourcesspring.cloud.kubernetes.config.retry.enabled=false
表 1.性能：
名字 类型 违约 描述

spring.cloud.kubernetes.config.enabledspring-doc.cn

Booleanspring-doc.cn

truespring-doc.cn

启用 ConfigMapPropertySourcespring-doc.cn

spring.cloud.kubernetes.config.namespring-doc.cn

Stringspring-doc.cn

${spring.application.name}spring-doc.cn

设置要查找的名称ConfigMapspring-doc.cn

spring.cloud.kubernetes.config.namespacespring-doc.cn

Stringspring-doc.cn

客户端命名空间spring-doc.cn

设置要查找的 Kubernetes 命名空间spring-doc.cn

spring.cloud.kubernetes.config.pathsspring-doc.cn

Listspring-doc.cn

nullspring-doc.cn

设置实例的挂载路径ConfigMapspring-doc.cn

spring.cloud.kubernetes.config.enableApispring-doc.cn

Booleanspring-doc.cn

truespring-doc.cn

通过 API 启用或禁用消费实例ConfigMapspring-doc.cn

spring.cloud.kubernetes.config.fail-fastspring-doc.cn

Booleanspring-doc.cn

falsespring-doc.cn

启用或禁用在加载ConfigMapspring-doc.cn

spring.cloud.kubernetes.config.retry.enabledspring-doc.cn

Booleanspring-doc.cn

truespring-doc.cn

启用或禁用配置重试。spring-doc.cn

spring.cloud.kubernetes.config.retry.initial-intervalspring-doc.cn

Longspring-doc.cn

1000spring-doc.cn

初始重试间隔（以毫秒为单位）。spring-doc.cn

spring.cloud.kubernetes.config.retry.max-attemptsspring-doc.cn

Integerspring-doc.cn

6spring-doc.cn

最大尝试次数。spring-doc.cn

spring.cloud.kubernetes.config.retry.max-intervalspring-doc.cn

Longspring-doc.cn

2000spring-doc.cn

回退的最大间隔。spring-doc.cn

spring.cloud.kubernetes.config.retry.multiplierspring-doc.cn

Doublespring-doc.cn

1.1spring-doc.cn

下一个间隔的乘数。spring-doc.cn