使用配置文件管理 Secret
开始之前
你需要一个 Kubernetes 集群,并且 kubectl 命令行工具必须配置为与你的集群通信。建议在至少有两个节点(不充当控制平面主机)的集群上运行本教程。如果你还没有集群,可以使用 minikube 创建一个,或者可以使用以下 Kubernetes 游乐场
创建 Secret
你可以首先在清单中定义 Secret 对象,以 JSON 或 YAML 格式,然后创建该对象。Secret 资源包含两个映射:data 和 stringData。data 字段用于存储任意数据,使用 base64 编码。stringData 字段是为了方便起见提供的,它允许你提供与未编码字符串相同的数据。data 和 stringData 的键必须由字母数字字符、-、_ 或 . 组成。
以下示例使用 data 字段将两个字符串存储在 Secret 中。
将字符串转换为 base64
echo -n 'admin' | base64 echo -n '1f2d1e2e67df' | base64说明
Secret 数据的序列化 JSON 和 YAML 值编码为 base64 字符串。换行符在这些字符串中无效,必须省略。在使用 Darwin/macOS 上的base64实用程序时,用户应避免使用-b选项来拆分长行。相反,Linux 用户应该将选项-w 0添加到base64命令或管道base64 | tr -d '\n'(如果不可用-w选项)。输出类似于
YWRtaW4= MWYyZDFlMmU2N2Rm创建清单
apiVersion: v1 kind: Secret metadata: name: mysecret type: Opaque data: username: YWRtaW4= password: MWYyZDFlMmU2N2Rm请注意,Secret 对象的名称必须是有效的 DNS 子域名。
使用
kubectl apply创建 Secretkubectl 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
同时指定 data 和 stringData
如果你在 data 和 stringData 中都指定了一个字段,则使用 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 中的数据,请修改清单中的 data 或 stringData 字段,并将文件应用到你的集群。除非 Secret 是 不可变的,否则你可以编辑现有的 Secret 对象。
例如,如果你想将先前的示例中的密码从 administrator 更改为 birdsarentreal,请执行以下操作
编码新的密码字符串
echo -n 'birdsarentreal' | base64输出类似于
YmlyZHNhcmVudHJlYWw=使用新的密码字符串更新
data字段apiVersion: v1 kind: Secret metadata: name: mysecret type: Opaque data: username: YWRtaW4= password: YmlyZHNhcmVudHJlYWw=将清单应用到你的集群
kubectl apply -f ./secret.yaml输出类似于
secret/mysecret configured
Kubernetes 更新现有的 Secret 对象。详细地说,kubectl 工具会注意到存在具有相同名称的现有 Secret 对象。kubectl 获取现有对象,计划对其进行更改,并将更改后的 Secret 对象提交到你的集群控制平面。
如果你指定了 kubectl apply --server-side,则 kubectl 将使用 服务器端应用。
清理
要删除你创建的 Secret
kubectl delete secret mysecret
接下来
- 了解更多关于 Secret 概念
- 了解如何 使用 kubectl 管理 Secret
- 了解如何使用 kustomize 管理 Secret