开源项目 `secrets-manager` 使用教程

开源项目 secrets-manager 使用教程

secrets-manager A daemon to sync Vault secrets to Kubernetes secrets 项目地址: https://gitcode.com/gh_mirrors/se/secrets-manager

1. 项目介绍

secrets-manager 是一个用于将 Vault 中的密钥同步到 Kubernetes 密钥的守护进程。许多公司使用 Vault 作为其多种类型密钥的后端存储，而 Kubernetes 提供了方便的密钥 API。然而，这意味着您有两个不同的密钥来源。secrets-manager 旨在解决这个问题，通过从 Vault 读取密钥并将其与 Kubernetes 密钥进行比较，创建和更新 Kubernetes 密钥，以确保两者同步。

主要功能

• 密钥同步：从 Vault 同步密钥到 Kubernetes。
• 自定义资源定义 (CRD)：使用 SecretDefinition 对象扩展 Kubernetes API。
• 多种后端支持：目前支持 Vault，未来计划支持更多后端。

2. 项目快速启动

2.1 安装 CRD

首先，需要在 Kubernetes 集群中安装 SecretDefinition CRD：

kubectl apply -f crd.yaml

2.2 部署 secrets-manager

接下来，部署 secrets-manager：

kubectl apply -f deploy/secrets-manager.yaml

2.3 创建 SecretDefinition 对象

创建一个 SecretDefinition 对象示例：

apiVersion: secrets-manager.tuenti.io/v1alpha1
kind: SecretDefinition
metadata:
  name: secretdefinition-sample
spec:
  name: supersecretnew
  keysMap:
    decoded:
      path: secret/data/pathtosecret1
      encoding: base64
      key: value
    raw:
      path: secret/data/pathtosecret1
      key: value

应用该对象：

kubectl apply -f secretdefinition-sample.yaml

3. 应用案例和最佳实践

3.1 密钥管理

在多租户环境中，secrets-manager 可以帮助确保每个租户的密钥在 Vault 和 Kubernetes 之间保持同步。例如，一个租户可能需要访问多个服务，每个服务都有自己的密钥。通过使用 secrets-manager，可以确保这些密钥在 Kubernetes 中始终是最新的。

3.2 自动化密钥轮换

secrets-manager 可以与 Vault 的密钥轮换机制集成，确保 Kubernetes 中的密钥定期更新。这对于需要高安全性的应用场景非常有用，例如金融和医疗行业。

4. 典型生态项目

4.1 Vault

secrets-manager 主要与 HashiCorp 的 Vault 集成，Vault 是一个用于安全访问密钥的工具。通过 secrets-manager，可以将 Vault 中的密钥同步到 Kubernetes，确保密钥的安全性和一致性。

4.2 Kubernetes

Kubernetes 是一个开源的容器编排平台，广泛用于微服务架构中。secrets-manager 通过扩展 Kubernetes API，提供了更强大的密钥管理功能，使得在 Kubernetes 中使用密钥更加方便和安全。

4.3 Helm

Helm 是 Kubernetes 的包管理工具，可以用于部署和管理 Kubernetes 应用。通过 Helm，可以轻松地将 secrets-manager 部署到 Kubernetes 集群中，并管理其配置。

通过以上步骤，您可以快速上手并使用 secrets-manager 项目，确保您的 Kubernetes 密钥与 Vault 保持同步。

secrets-manager A daemon to sync Vault secrets to Kubernetes secrets 项目地址: https://gitcode.com/gh_mirrors/se/secrets-manager