bitnamicharts/consul

Bitnami HashiCorp Consul Helm Chart

HashiCorp Consul是用于在基础设施中发现和配置服务的工具。

HashiCorp Consul概述

商标声明：本软件列表由Bitnami打包。所提及的相关商标归各自公司所有，使用这些商标并不意味着任何关联或背书。

快速开始

console
helm install my-release oci://registry-1.docker.io/bitnamicharts/consul

希望在生产环境中使用HashiCorp Consul？请尝试VMware Tanzu Application Catalog，即Bitnami目录的商业版。

⚠️ 重要通知：Bitnami目录即将变更

自2025年8月28日起，Bitnami将升级其公共目录，通过新的Bitnami Secure Images计划提供精选的强化、安全聚焦镜像集。作为此次转型的一部分：

• 首次向社区用户提供热门容器镜像的安全优化版本访问权限。
• Bitnami将开始在免费层中弃用对非强化、基于Debian的软件镜像的支持，并将逐步从公共目录中移除非最新标签。因此，社区用户将只能访问数量减少的强化镜像，这些镜像仅以“latest”标签发布，仅供开发使用。
• 从8月28日开始，在两周内，所有现有容器镜像（包括旧版本或带版本的标签，如2.50.0、10.6）将从公共目录（docker.io/bitnami）迁移到“Bitnami Legacy”仓库（docker.io/bitnamilegacy），且不再接收更新。
• 对于生产工作负载和长期支持，建议用户采用Bitnami Secure Images，包括强化容器、更小的***面、CVE透明度（通过VEX/KEV）、SBOM以及企业支持。

这些变更旨在通过推广软件供应链完整性和最新部署的最佳实践，提高所有Bitnami用户的安全态势。更多详情，请访问https://github.com/bitnami/containers/issues/83267%E3%80%82

介绍

此chart使用Helm包管理器在Kubernetes集群上引导https://github.com/bitnami/containers/tree/main/bitnami/consul%E9%83%A8%E7%BD%B2%E3%80%82

前提条件

• Kubernetes 1.23+
• Helm 3.8.0+
• 底层基础设施支持PV供应

安装Chart

要使用发布名称my-release安装chart：

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/consul

注意：您需要将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm chart仓库和存储库的引用。例如，对于Bitnami，需使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。

这些命令使用默认配置在Kubernetes集群上部署HashiCorp Consul。参数部分列出了可在安装期间配置的参数。

提示：使用helm list列出所有发布

配置和安装详情

资源请求和限制

Bitnami charts允许为chart部署中的所有容器设置资源请求和限制，这些配置位于resources值中（参见参数表）。为生产工作负载设置请求至关重要，且应根据您的具体用例进行调整。

为简化此过程，chart包含resourcesPreset值，可根据不同预设自动设置resources部分。有关这些预设，请查看https://github.com/bitnami/charts/blob/main/bitnami/common/templates/_resources.tpl#L15%E3%80%82%E7%84%B6%E8%80%8C%EF%BC%8C%E5%9C%A8%E7%94%9F%E4%BA%A7%E5%B7%A5%E4%BD%9C%E8%B4%9F%E8%BD%BD%E4%B8%AD%E4%B8%8D%E5%BB%BA%E8%AE%AE%E4%BD%BF%E7%94%A8%60resourcesPreset%60%EF%BC%8C%E5%9B%A0%E4%B8%BA%E5%AE%83%E5%8F%AF%E8%83%BD%E6%97%A0%E6%B3%95%E5%AE%8C%E5%85%A8%E9%80%82%E5%BA%94%E6%82%A8%E7%9A%84%E7%89%B9%E5%AE%9A%E9%9C%80%E6%B1%82%E3%80%82%E6%9C%89%E5%85%B3%E5%AE%B9%E5%99%A8%E8%B5%84%E6%BA%90%E7%AE%A1%E7%90%86%E7%9A%84%E6%9B%B4%E5%A4%9A%E4%BF%A1%E6%81%AF%EF%BC%8C%E8%AF%B7%E5%8F%82%E9%98%85Kubernetes%E5%AE%98%E6%96%B9%E6%96%87%E6%A1%A3%E3%80%82

滚动标签与不可变标签

强烈建议在生产环境中使用不可变标签。这可确保如果相同标签使用不同镜像更新，您的部署不会自动更改。

如果主容器有新版本、重大变更或严重漏洞，Bitnami将发布新的chart来更新其容器。

Prometheus指标

通过将metrics.enabled设置为true，此chart可与Prometheus集成。这将在所有pod中部署带有https://github.com/prometheus/consul_exporter%E7%9A%84%E8%BE%B9%E8%BD%A6%E5%AE%B9%E5%99%A8%EF%BC%8C%E4%BB%A5%E5%8F%8A%E5%8F%AF%E5%9C%A8%60metrics.service%60%E9%83%A8%E5%88%86%E9%85%8D%E7%BD%AE%E7%9A%84%60metrics%60%E6%9C%8D%E5%8A%A1%E3%80%82%E6%AD%A4%60metrics%60%E6%9C%8D%E5%8A%A1%E5%B0%86%E5%85%B7%E6%9C%89%E5%BF%85%E8%A6%81%E7%9A%84%E6%B3%A8%E8%A7%A3%EF%BC%8C%E4%BB%A5%E4%BE%BF%E8%A2%ABPrometheus%E8%87%AA%E5%8A%A8%E6%8A%93%E5%8F%96%E3%80%82

Prometheus要求

要使集成正常工作，需要安装Prometheus或Prometheus Operator。安装https://github.com/bitnami/charts/tree/main/bitnami/prometheus%E6%88%96https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus%EF%BC%8C%E5%8F%AF%E8%BD%BB%E6%9D%BE%E5%9C%A8%E9%9B%86%E7%BE%A4%E4%B8%AD%E9%83%A8%E7%BD%B2%E5%8F%AF%E7%94%A8%E7%9A%84Prometheus%E3%80%82

与Prometheus Operator集成

通过设置metrics.serviceMonitor.enabled=true，chart可部署ServiceMonitor对象以与Prometheus Operator集成。确保集群中已安装Prometheus Operator CustomResourceDefinitions，否则将失败并显示以下错误：

text
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

安装https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus%E4%BB%A5%E8%8E%B7%E5%8F%96%E5%BF%85%E8%A6%81%E7%9A%84CRD%E5%92%8CPrometheus Operator。

使用自定义配置

此helm chart支持自定义整个配置文件。

您可以使用configuration参数指定Hashicorp Consul配置。

此外，您还可以设置包含所有配置文件的外部ConfigMap，通过设置existingConfigmap参数实现。注意，这将覆盖上述选项。

Ingress

此chart提供对Ingress资源的支持。如果集群上安装了Ingress控制器（如https://github.com/bitnami/charts/tree/main/bitnami/nginx-ingress-controller%E6%88%96https://github.com/bitnami/charts/tree/main/bitnami/contour%EF%BC%89%EF%BC%8C%E6%82%A8%E5%8F%AF%E4%BB%A5%E5%88%A9%E7%94%A8Ingress%E6%8E%A7%E5%88%B6%E5%99%A8%E6%9D%A5%E6%8F%90%E4%BE%9B%E5%BA%94%E7%94%A8%E6%9C%8D%E5%8A%A1%E3%80%82

要启用Ingress集成，请将ingress.enabled设置为true。

主机

通常，您可能只需要一个主机名映射到此Consul安装。如果是这种情况，ingress.hostname属性将设置它。不过，也可以有多个主机。为方便实现，ingress.extraHosts对象可指定为数组。您还可以使用ingress.extraTLS为额外主机添加TLS配置。

对于ingress.extraHosts中指定的每个主机，请指明name、path以及您希望Ingress控制器了解的任何annotations。

关于注解，请参阅https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md%E3%80%82%E5%B9%B6%E9%9D%9E%E6%89%80%E6%9C%89%E6%B3%A8%E8%A7%A3%E9%83%BD%E5%8F%97%E6%89%80%E6%9C%89Ingress%E6%8E%A7%E5%88%B6%E5%99%A8%E6%94%AF%E6%8C%81%EF%BC%8C%E4%BD%86%E6%9C%AC%E6%96%87%E6%A1%A3%E5%BE%88%E5%A5%BD%E5%9C%B0%E8%AF%B4%E6%98%8E%E4%BA%86%E5%93%AA%E4%BA%9B%E6%B3%A8%E8%A7%A3%E5%8F%97%E8%AE%B8%E5%A4%9A%E6%B5%81%E8%A1%8CIngress%E6%8E%A7%E5%88%B6%E5%99%A8%E6%94%AF%E6%8C%81%E3%80%82

使用TLS保护流量

此chart将帮助创建用于Ingress控制器的TLS密钥，但这不是必需的。常见用例有三种：

• Helm生成/管理证书密钥
• 用户单独生成/管理证书
• 其他工具（如cert-manager）为应用管理密钥

在前两种情况下，需要证书和密钥。预期格式如下：

• 证书文件应如下所示（如果存在证书链，可包含多个证书）

console
-----BEGIN CERTIFICATE-----
MIID6TCCAtGgAwIBAgIJAIaCwivkeB5EMA0GCSqGSIb3DQEBCwUAMFYxCzAJBgNV
...
jScrvkiBO65F46KioCL9h5tDvomdU1aqpI/CBzhvZn1c0ZTf87tGQR8NK7v7
-----END CERTIFICATE-----

• 密钥应如下所示：

console
-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAvLYcyu8f3skuRyUgeeNpeDvYBCDcgq+LsWap6zbX5f8oLqp4
...
wrj2wDbCDCFmfqnSJ+dKI3vFLlEz44sAV8jX/kd4Y6ZTQhlLbYc=
-----END RSA PRIVATE KEY-----

如果要使用Helm管理证书，请将这些值复制到给定ingress.secrets条目的certificate和key值中。

如果要在Helm外部管理TLS密钥，请了解您可以创建TLS密钥（例如命名为consul-ui.local-tls）。

更多信息请参见https://github.com/kubernetes/contrib/tree/master/ingress/controllers/nginx/examples/tls%E3%80%82

启用服务器间TLS加密

您必须手动创建包含PEM编码的证书颁发机构、PEM编码的证书和PEM编码的私钥的密钥。

请注意，您需要创建具有适当配置的config map。

如果指定了密钥，chart将在/opt/bitnami/consul/certs/位置找到这些文件，因此您需要在config map中使用以下代码段配置HashiCorp Consul TLS加密：

json
  "ca_file": "/opt/bitnami/consul/certs/ca.pem",
  "cert_file": "/opt/bitnami/consul/certs/consul.pem",
  "key_file": "/opt/bitnami/consul/certs/consul-key.pem",
  "verify_incoming": true,
  "verify_outgoing": true,
  "verify_server_hostname": true,

创建密钥后，您可以使用--set tlsEncryptionSecretName=consul-tls-encryption安装helm chart指定密钥名称。

指标

chart可选择在端口9107为prometheus启动指标导出端点。端点公开的数据旨在由集群内部署的prometheus chart使用，因此端点不会暴露到集群外部。

添加额外环境变量

如果需要添加额外环境变量（用于高级操作，如自定义初始化脚本），可使用extraEnvVars属性。

yaml
extraEnvVars:
  - name: LOG_LEVEL
    value: error

或者，您可以使用包含环境变量的ConfigMap或Secret。为此，使用.extraEnvVarsCM或extraEnvVarsSecret属性。

设置Pod亲和性

此chart允许使用affinity参数设置自定义亲和性。有关Pod亲和性的更多信息，请参阅Kubernetes文档。

作为替代方案，您可以使用https://github.com/bitnami/charts/tree/main/bitnami/common#affinities chart中提供的Pod亲和性、Pod反亲和性和节点亲和性预设配置。为此，设置podAffinityPreset、podAntiAffinityPreset或nodeAffinityPreset参数。

Sidecars和Init容器

如果需要在与Consul相同的pod中运行额外容器，可通过sidecars配置参数实现。只需根据Kubernetes容器规范定义您的容器。

yaml
sidecars:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

类似地，您可以使用initContainers参数添加额外的init容器。

yaml
initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

备份和恢复

要在Kubernetes上备份和恢复Helm chart部署，需要使用Velero（Kubernetes备份/恢复工具）备份源部署的持久卷，并将其附加到新部署。有关使用Velero的说明，请参阅本指南。

持久化

https://github.com/bitnami/containers/tree/main/bitnami/consul%E9%95%9C%E5%83%8F%E5%B0%86HashiCorp Consul数据存储在容器的/bitnami路径下。

持久卷声明（PVC）用于在部署之间保留数据。已知在GCE、AWS和minikube中有效。 请参阅参数部分配置PVC或禁用持久化。

调整持久卷挂载点权限

由于镜像默认以非root用户运行，因此需要调整持久卷的所有权，以便容器可以写入数据。

默认情况下，chart配置为使用Kubernetes安全上下文自动更改卷的所有权。但此功能并非在所有Kubernetes发行版中都有效。

作为替代方案，此chart支持使用initContainer在将卷挂载到最终目标之前更改卷的所有权。

您可以通过将volumePermissions.enabled设置为true来启用此initContainer。

参数

全局参数

通用参数

HashiCorp Consul参数