Helm

Helm 是 Kubernetes 的首选包管理工具。Helm 图表为 Kubernetes YAML 清单文件提供了模板化语法。通过 Helm,我们可以创建可配置的部署,而不仅仅是使用静态文件。有关创建自己的部署目录的更多信息,请查看Helm 快速入门

K3s 不需要任何特殊的配置就可以使用 Helm 命令行工具。只要确保你已经按照集群访问一节正确设置了你的 kubeconfig。K3s 包含了一些额外的功能,使传统的 Kubernetes 资源清单和 Helm Charts 的部署更加容易。

本节涵盖以下主题:

部署 manifests 和 Helm charts

/var/lib/rancher/k3s/server/manifests中找到的任何 Kubernetes 清单将以类似kubectl apply的方式自动部署到 K3s。以这种方式部署的 manifests 是作为 AddOn 自定义资源来管理的,可以通过运行kubectl get addon -A来查看。你会发现打包组件的 AddOns,如 CoreDNS、Local-Storage、Traefik 等。AddOns 是由部署控制器自动创建的,并根据它们在 manifests 目录下的文件名命名。

也可以将 Helm 图表作为 AddOns 部署。K3s 包括一个Helm Controller,它使用 HelmChart Custom Resource Definition(CRD)管理 Helm 图表。

注意: K3s 版本至 v0.5.0 使用k3s.cattle.io/v1作为 HelmCharts 的 apiVersion。后来的版本已改为helm.cattle.io/v1

HelmChart 资源定义捕获了大多数你通常会传递给helm命令行工具的选项。下面是一个例子,说明如何从默认的图表资源库中部署 Grafana,覆盖一些默认的图表值。请注意,HelmChart 资源本身在 "kube-system"命名空间,但图表资源将被部署到 "monitoring"命名空间。

apiVersion: helm.cattle.io/v1
kind: HelmChart
metadata:
name: grafana
namespace: kube-system
spec:
chart: stable/grafana
targetNamespace: monitoring
set:
adminPassword: "NotVerySafePassword"
valuesContent: |-
image:
tag: master
env:
GF_EXPLORE_ENABLED: true
adminUser: admin
sidecar:
datasources:
enabled: true

使用 Helm CRD

注意:K3s 版本至 v0.5.0 使用k3s.cattle.io/v1作为 HelmCharts 的 apiVersion。后来的版本已改为helm.cattle.io/v1

Helm Chart 资源定义捕获了大多数你通常会传递给helm命令行工具的选项。下面是一个例子,说明如何从默认的图表资源库中部署 Grafana,覆盖一些默认的图表值。请注意,HelmChart 资源本身在 "kube-system "命名空间,但图表资源将被部署到 "monitoring "命名空间。

你可以使用这样的例子部署第三方 Helm chart:

apiVersion: helm.cattle.io/v1
kind: HelmChart
metadata:
name: grafana
namespace: kube-system
spec:
chart: stable/grafana
targetNamespace: monitoring
set:
adminPassword: "NotVerySafePassword"
valuesContent: |-
image:
tag: master
env:
GF_EXPLORE_ENABLED: true
adminUser: admin
sidecar:
datasources:
enabled: true

HelmChart 字段定义

字段默认值描述Helm Argument / Flag Equivalent
nameN/AHelm Chart 名称NAME
spec.chartN/A仓库中的 Helm 图表名称,或完整的 HTTPS URL(.tgz)。CHART
spec.targetNamespacedefaultHelm Chart 目标命名空间--namespace
spec.versionN/AHelm Chart 版本(从版本库安装时使用的版本号)--version
spec.repoN/AHelm Chart 版本库 URL 地址--repo
spec.helmVersionv3Helm 的版本号,可选值为 v2v3,默认值为 v3N/A
spec.bootstrapFalse如果需要该图表来引导集群(Cloud Controller Manager 等),则设置为 True。N/A
spec.setN/A覆盖简单的默认图表值。这些值优先于通过 valuesContent 设置的选项。--set / --set-string
spec.valuesContentN/A通过 YAML 文件内容覆盖复杂的默认图表值。--values
spec.chartContentN/ABase64 编码的图表存档.tgz - 覆盖 spec.chart。CHART

放在/var/lib/rancher/k3s/server/static/中的内容可以通过 Kubernetes APIServer 从集群内匿名访问。这个 URL 可以使用spec.chart字段中的特殊变量%{KUBERNETES_API}%进行模板化。例如,打包后的 Traefik 组件从https://%{KUBERNETES_API}%/static/charts/traefik-1.81.0.tgz加载其图表。

使用 HelmChartConfig 自定义打包的组件

为了允许覆盖作为 HelmCharts(如 Traefik)部署的打包组件的值,从 v1.19.0+k3s1 开始的 K3s 版本支持通过 HelmChartConfig 资源自定义部署。HelmChartConfig 资源必须与其对应的 HelmChart 的名称和命名空间相匹配,并支持提供额外的 "valuesContent",它作为一个额外的值文件传递给helm命令。

注意: HelmChart 的spec.set值覆盖了 HelmChart 和 HelmChartConfig 的spec.valuesContent设置。 例如,要自定义打包后的 Traefik 入口配置,你可以创建一个名为/var/lib/rancher/k3s/server/manifests/traefik-config.yaml的文件,并将其填充为以下内容。

apiVersion: helm.cattle.io/v1
kind: HelmChartConfig
metadata:
name: traefik
namespace: kube-system
spec:
valuesContent: |-
image: traefik
imageTag: v1.7.26-alpine
proxyProtocol:
enabled: true
trustedIPs:
- 10.0.0.0/8
forwardedHeaders:
enabled: true
trustedIPs:
- 10.0.0.0/8
ssl:
enabled: true
permanentRedirect: false

从 Helm v2 升级

如果你在以前的 K3s 版本中使用的是 Helm v2,你可以升级到 v1.17.0+k3s.1 或更新版本,Helm 2 仍然可以使用。如果你想迁移到 Helm 3,thisHelm 的博文介绍了如何使用插件成功迁移。更多信息请参考 Helm 3 的官方文档这里。从 v1.17.0+k3s.1 开始,K3s 可以处理 Helm v2 或 Helm v3。只要确保你已经按照集群访问一节中的例子正确设置了你的 kubeconfig。

注意,Helm 3 不再需要 Tiller 和helm init命令。详情请参考官方文档。

最后由 yzeng25更新 于