Hooks

Hooks

Helm提供了一个hook机制,允许chart开发人员在release的生命周期中的某些点进行干预。例如,可以使用hooks来:

  • 在加载任何其他chart之前,在安装过程中加载ConfigMapSecret
  • 在安装新chart之前执行作业以备份数据库,然后在升级后执行第二个作业以恢复数据。
  • 在删除release之前运行作业,以便在删除release之前优雅地停止服务。

Hooks像常规模板一样工作,但它们具有特殊的注释,可以使Helm以不同的方式使用它们。

可用的Hooks

定义了以下hooks

  • 预安装pre-install::在模板渲染后执行,但在Kubernetes中创建任何资源之前执行。
  • 安装后post-install:在所有资源加载到Kubernetes后执行
  • 预删除pre-delete:在从Kubernetes删除任何资源之前执行删除请求。
  • 删除后post-delete:删除所有release的资源后执行删除请求。
  • 升级前pre-upgrade:在模板渲染后,但在任何资源加载到Kubernetes之前执行升级请求(例如,在Kubernetes应用操作之前
  • 升级后post-upgrade:在所有资源升级后执行升级。
  • 预回滚pre-rollback:在渲染模板之后,但在任何资源已回滚之前,在回滚请求上执行。
  • 回滚后post-rollback:在修改所有资源后执行回滚请求。

Hook声明

Hook只是Kubernetes manifest文件,在metadata部分有特殊的注释 。因为他们是模板文件,可以使用所有的Normal模板的功能,包括读取.Values.Release.Template。例如,在此模板中,存储在templates/post-install-job.yaml的声明要在post-install阶段运行作业:

apiVersion: batch/v1
kind: Job
metadata:
  name: "{{.Release.Name}}"
  labels:
    app.kubernetes.io/managed-by: {{.Release.Service | quote}}
    app.kubernetes.io/instance: {{.Release.Name | quote}}
    helm.sh/chart: "{{.Chart.Name}}-{{.Chart.Version}}"
  annotations:
    # This is what defines this resource as a hook. Without this line, the
    # job is considered part of the release.
    "helm.sh/hook": post-install
    "helm.sh/hook-weight": "-5"
    "helm.sh/hook-delete-policy": hook-succeeded
spec:
  template:
    metadata:
      name: "{{.Release.Name}}"
      labels:
      app.kubernetes.io/managed-by: {{.Release.Service | quote}}
      app.kubernetes.io/instance: {{.Release.Name | quote}}
      helm.sh/chart: "{{.Chart.Name}}-{{.Chart.Version}}"
    spec:
      restartPolicy: Never
      containers:
      - name: post-install-job
        image: "alpine:3.3"
        command: ["/bin/sleep","{{default"10".Values.sleepyTime}}"]

注释使这个模板成为hook

  annotations:
    "helm.sh/hook": post-install

一个资源可以部署多个hook

  annotations:
    "helm.sh/hook": post-install,post-upgrade

同样,实现一个给定的hook的不同种类资源数量没有限制。例如,我们可以将secretconfig map声明为预安装hook

chart声明hook时,也会评估这些hook。顶级chart无法禁用子chart所声明的hook

可以为一个hook定义一个权重,这将有助于建立一个确定性的执行顺序。权重使用以下注释来定义:

  annotations:
    "helm.sh/hook-weight": "5"

hook权重可以是正数或负数,但必须表示为字符串。当Tiller开始执行一个特定类型的hook (例:pre-install hookspost-installhooks,等等)执行周期时,它会按升序对这些hook进行排序。

还可以定义确定何时删除相应的hook资源的策略。hook删除策略使用以下注释来定义:

  annotations:
    "helm.sh/hook-delete-policy": hook-succeeded

可以选择一个或多个定义的注释值:

  • “hook-succeeded” 指定Tiller应该在hook成功执行后删除hook
  • “hook-failed” 指定如果hook在执行期间失败,Tiller应该删除hook
  • “before-hook-creation” 指定Tiller应在删除新hook之前删除以前的hook
上一页
下一页