使用配置文件管理 Secret

使用资源配置文件创建 Secret 对象。

开始之前

你需要有一个 Kubernetes 集群,并且必须配置 kubectl 命令行工具以与你的集群通信。建议在至少有两个节点的集群上运行本教程,且这些节点不能作为控制平面主机。如果你还没有集群,可以通过 minikube 创建一个,或者使用以下 Kubernetes 演练场之一。

创建 Secret

你可以先用 JSON 或 YAML 格式的清单(Manifest)定义 Secret 对象,然后创建该对象。Secret 资源包含两个映射(map):datastringDatadata 字段用于存储任意数据,必须进行 base64 编码。stringData 字段是为了方便起见而提供的,它允许你以未编码的字符串形式提供相同的数据。datastringData 的键必须由字母数字字符、-_. 组成。

以下示例使用 data 字段在 Secret 中存储了两个字符串。

  1. 将字符串转换为 base64

    echo -n 'admin' | base64
    echo -n '1f2d1e2e67df' | base64
    

    说明

    序列化后的 JSON 和 YAML Secret 数据值需要编码为 base64 字符串。这些字符串中不能包含换行符,必须省略。在 Darwin/macOS 上使用 base64 工具时,用户应避免使用 -b 选项来拆分长行。相反,Linux 用户应该base64 命令中添加 -w 0 选项,如果 -w 选项不可用,则使用管道 base64 | tr -d '\n'

    输出类似于

    YWRtaW4=
    MWYyZDFlMmU2N2Rm
    
  2. 创建清单

    apiVersion: v1
    kind: Secret
    metadata:
      name: mysecret
    type: Opaque
    data:
      username: YWRtaW4=
      password: MWYyZDFlMmU2N2Rm
    

    请注意,Secret 对象的名称必须是有效的 DNS 子域名

  3. 使用 kubectl apply 创建 Secret

    kubectl apply -f ./secret.yaml
    

    输出类似于

    secret/mysecret created
    

要验证 Secret 是否已创建并解码 Secret 数据,请参阅使用 kubectl 管理 Secret

在创建 Secret 时指定未编码的数据

在某些场景下,你可能希望改用 stringData 字段。该字段允许你将非 base64 编码的字符串直接放入 Secret,并且在创建或更新 Secret 时,系统会自动为你进行编码。

一个实际的例子是:你正在部署一个使用 Secret 存储配置文件的应用程序,并且你希望在部署过程中填充该配置文件的部分内容。

例如,如果你的应用程序使用以下配置文件

apiUrl: "https://my.api.com/api/v1"
username: "<user>"
password: "<password>"

你可以使用以下定义将其存储在 Secret 中

apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
stringData:
  config.yaml: |
    apiUrl: "https://my.api.com/api/v1"
    username: <user>
    password: <password>    

说明

Secret 的 stringData 字段与服务器端应用不兼容。

当你检索 Secret 数据时,该命令会返回编码后的值,而不是你在 stringData 中提供的明文值。

例如,如果你运行以下命令

kubectl get secret mysecret -o yaml

输出类似于

apiVersion: v1
data:
  config.yaml: YXBpVXJsOiAiaHR0cHM6Ly9teS5hcGkuY29tL2FwaS92MSIKdXNlcm5hbWU6IHt7dXNlcm5hbWV9fQpwYXNzd29yZDoge3twYXNzd29yZH19
kind: Secret
metadata:
  creationTimestamp: 2018-11-15T20:40:59Z
  name: mysecret
  namespace: default
  resourceVersion: "7225"
  uid: c280ad2e-e916-11e8-98f2-025000000001
type: Opaque

同时指定 datastringData

如果你同时在 datastringData 中指定了同一个字段,则使用 stringData 中的值。

例如,如果你定义了以下 Secret

apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
data:
  username: YWRtaW4=
stringData:
  username: administrator

说明

Secret 的 stringData 字段与服务器端应用不兼容。

Secret 对象创建如下

apiVersion: v1
data:
  username: YWRtaW5pc3RyYXRvcg==
kind: Secret
metadata:
  creationTimestamp: 2018-11-15T20:46:46Z
  name: mysecret
  namespace: default
  resourceVersion: "7579"
  uid: 91460ecb-e917-11e8-98f2-025000000001
type: Opaque

YWRtaW5pc3RyYXRvcg== 解码后为 administrator

编辑 Secret

要编辑使用清单创建的 Secret 中的数据,请修改清单中的 datastringData 字段,并将该文件应用于你的集群。除非 Secret 对象是不可变的,否则你可以编辑现有的对象。

例如,如果你想将上一个示例中的密码更改为 birdsarentreal,请执行以下操作

  1. 对新密码字符串进行编码

    echo -n 'birdsarentreal' | base64
    

    输出类似于

    YmlyZHNhcmVudHJlYWw=
    
  2. 使用你的新密码字符串更新 data 字段

    apiVersion: v1
    kind: Secret
    metadata:
      name: mysecret
    type: Opaque
    data:
      username: YWRtaW4=
      password: YmlyZHNhcmVudHJlYWw=
    
  3. 将清单应用于你的集群

    kubectl apply -f ./secret.yaml
    

    输出类似于

    secret/mysecret configured
    

Kubernetes 会更新现有的 Secret 对象。具体而言,kubectl 工具会检测到存在一个同名的 Secret 对象。kubectl 会获取现有对象,规划变更,并将更改后的 Secret 对象提交给你的集群控制平面。

如果你改用 kubectl apply --server-sidekubectl 将改用服务端应用(Server Side Apply)

清理

要删除你创建的 Secret

kubectl delete secret mysecret

接下来


最后修改于 2023年10月9日 下午9:53 PST:更新 managing-secret-using-config-file.md (cf83760309)