Skip to content

Latest commit

 

History

History
297 lines (279 loc) · 9.61 KB

README-zh.md

File metadata and controls

297 lines (279 loc) · 9.61 KB
Raw

简易型 Job 编排 Operator

项目思路与设计

设计背景：本项目实现简易型 Job 编排 Operator

JobFlow

功能：k8s 当中原生的 Job 资源对象执行时，并没有相互依赖的编排特性(ex: Job a 完成后 -> 再执行Job b ...)。 在此需求上，基于 k8s 的扩展功能，实现 JobFlow 的自定义资源控制器，实现一个能执行多 Job 树状引擎的 operator 应用。

功能特性

  • 支持 Job 之间的依赖关系
  • 支持 Job 之间的全局参数传递(label,annotation,env)
  • 支持 Job 之间的调度到同一节点 example
  • 支持 Job 之间的共享数据卷 example
  • 支持 Job 引用 JobTemplate 对象 example

  • crd 资源对象如下，更多信息可以参考 参考
    • globalParams: 全局参数，会自动渲染到每个 job 中
    • name: flow 名称，多个 flow 名称不能重复
    • dependencies: 定义依赖项，如果有多个依赖可以填写多个
    • jobTemplate: job 模版，支持 k8s 原生 job spec 全部字段
    • jobTemplateRef: job 模版实例，支持 k8s 原生 job spec 全部字段, 需要填入 JobTemplate 名
    • shareVolumes: job 共享数据卷
    • shareVolumeMounts: job 共享数据卷挂载点
apiVersion: api.practice.com/v1alpha1
kind: JobFlow
metadata:
  name: jobflow-example
spec:
  # 可配置任务流中的全局参数，当设置后会在每个 job 与 pod 中都生效
  globalParams:
    # 可决定所有 job 都运行在同一节点上
    nodeName: minikube
    # 可加入 container 所需的参数
    env:
      - name: "FOO"
        value: "bar"
      - name: "QUE"
        value: "pasa"
    # job pod 的 annotations    
    annotations:
      key1: value1
      key2: value2
    # job pod 的 labels  
    labels:
      key1: value1
      key2: value2
      
  # 可填写多个 flow 流程
  # 每个 flow 中重要字段 分别为：
  # name: flow 名称，多个 flow 名称不能重复
  # dependencies: 定义依赖项，如果有多个依赖可以填写多个
  # jobTemplate: job 模版，支持 k8s 原生 job spec 全部字段
  flows:
    - name: job1
      dependencies: []
      jobTemplate:
        template:
          spec:
            containers:
              - image: busybox:1.28
                command:
                  - sh
                  - -c
                  - sleep 10s
                imagePullPolicy: IfNotPresent
                name: nginx
    - name: job2
      jobTemplate:
        template:
          spec:
            containers:
              - image: busybox:1.28
                command:
                  - sh
                  - -c
                  - sleep 100s
                imagePullPolicy: IfNotPresent
                name: nginx
      dependencies:
        - job1  # 代表 job2 依赖 job1 完成后才开始启动
    - name: job3
      jobTemplate:
        template:
          spec:
            containers:
              - image: busybox:1.28
                command:
                  - sh
                  - -c
                  - sleep 100s
                imagePullPolicy: IfNotPresent
                name: nginx
      dependencies:
        # 代表 job3 依赖 job1 job2 完成后才开始启动
        - job1
        - job2
    - name: job4
      jobTemplate:
        template:
          spec:
            containers:
              - image: busybox:1.28
                command:
                  - sh
                  - -c
                  - sleep 10s
                imagePullPolicy: IfNotPresent
                name: nginx
    - name: job5
      dependencies:
        # 代表依赖 job2 job4 后才执行
        - job4
        - job2
      jobTemplate:
        template:
          spec:
            containers:
              - image: busybox:1.28
                command:
                  - sh
                  - -c
                  - sleep 10s
                imagePullPolicy: IfNotPresent
                name: nginx
apiVersion: api.practice.com/v1alpha1
kind: JobTemplate
metadata:
  name: job1-template
spec:
  jobTemplate:
    template:
      spec:
        containers:
          - image: busybox:1.28
            command:
              - sh
              - -c
              - sleep 10s
            imagePullPolicy: IfNotPresent
            name: nginx
---
apiVersion: api.practice.com/v1alpha1
kind: JobTemplate
metadata:
  name: job2-template
spec:
  jobTemplate:
    template:
      spec:
        containers:
          - image: busybox:1.28
            command:
              - sh
              - -c
              - sleep 10s
            imagePullPolicy: IfNotPresent
            name: nginx
---
apiVersion: api.practice.com/v1alpha1
kind: JobFlow
metadata:
  name: jobflow-example-template
spec:
  # 可配置任务流中的全局参数，当设置后会在每个 job 与 pod 中都生效
  globalParams:
    env:
      - name: "FOO"
        value: "bar"
      - name: "QUE"
        value: "pasa"
    # job pod 的 annotations
    annotations:
      key1: value1
      key2: value2
    # job pod 的 labels
    labels:
      key1: value1
      key2: value2
  flows:
    - name: job1
      dependencies: []
      # JobTemplate 实例名
      jobTemplateRef: job1-template
    - name: job2
      jobTemplateRef: job2-template
      dependencies:
        - job1  # 代表 job2 依赖 job1 完成后才开始启动

项目功能

  1. 支持 JobFlow 任务中的 job 依赖执行
  2. 查看任务流状态
[root@vm-0-12-centos jobflow]# kubectl get jobflows.api.practice.com
NAME                    STATUS    AGE
jobflow-example         Running   117s
jobflow-example-error   Failed    117s
[root@vm-0-12-centos jobflow]# kubectl get jobs | grep jobflow-example
jobflow-example-error-job1                   1/1           13s        3d18h
jobflow-example-error-job2-error-container   0/1           3d18h      3d18h
jobflow-example-error-job4                   1/1           12s        3d18h
jobflow-example-job1                         1/1           12s        2m44s
jobflow-example-job2                         1/1           102s       2m31s
jobflow-example-job3                         0/1           48s        48s
jobflow-example-job4                         1/1           12s        2m44s
jobflow-example-job5                         1/1           12s        48s
[root@vm-0-12-centos jobflow]# kubectl  get pods | grep jobflow-example
jobflow-example-error-job1-x9tn8                   0/1     Completed   0          3d18h
jobflow-example-error-job2-error-container-wxpvb   0/1     Error       0          3d18h
jobflow-example-error-job4-p286g                   0/1     Completed   0          3d18h
jobflow-example-job1-4zq22                         0/1     Completed   0          3m8s
jobflow-example-job2-qsvr9                         0/1     Completed   0          2m55s
jobflow-example-job3-4f6lb                         1/1     Running     0          72s
jobflow-example-job4-7ngpd                         0/1     Completed   0          3m8s
jobflow-example-job5-m8cwg                         0/1     Completed   0          72s
  • 注：pod 字段中的 restartPolicy 不允许被使用，就算定义后也不会生效(都会被强制设为"Never")
  • 注：jobTemplate or jobTemplateRef 选其一，推荐使用 jobTemplateRef，可以减少配置复杂性

DaemonJob

功能：k8s 当中原生的 Job 资源对象执行时，并没有类似 pod 中的 daemonset 的工作负载。 在此需求上，基于 k8s 的扩展功能，实现 DaemonJob 的自定义资源控制器，实现一个能选定节点执行 job 的 operator 应用。

  • crd 资源对象如下，更多信息可以参考 参考
    • globalParams: 全局参数，会自动渲染到每个 job 中
    • excludeNodeList: 不执行 job 的节点名称，使用 "," 隔开
    • template: job 模版，支持 k8s 原生 job spec 字段
apiVersion: api.practice.com/v1alpha1
kind: DaemonJob
metadata:
  name: daemonjob-example
spec:
  # 可配置任务流中的全局参数，当设置后会在每个 job 与 pod 中都生效
  globalParams:
    # 可加入 container 所需的参数
    env:
      - name: "FOO"
        value: "bar"
      - name: "QUE"
        value: "pasa"
    # job pod 的 annotations
    annotations:
      key1: value1
      key2: value2
    # job pod 的 labels
    labels:
      key1: value1
      key2: value2
  # 除这些节点之外，都要创建 job, 使用 "," 隔开
  excludeNodeList: node1, node2
  # 支持原生 job Template 模版
  template:
    spec:
      restartPolicy: OnFailure
      containers:
        - image: busybox:1.28
          command:
            - sh
            - -c
            - sleep 100s
          imagePullPolicy: IfNotPresent
          name: nginx

项目功能

  1. 支持 DaemonJob 任务中的 job 执行
  2. 查看任务流状态
[root@vm-0-12-centos jobflow]# kubectl get daemonjobs.api.practice.com
NAME                STATUS    AGE
daemonjob-example   Running   117s
[root@vm-0-12-centos jobflow]# kubectl get daemonjobs.api.practice.com
NAME                STATUS    AGE
daemonjob-example   Succeed   3m21s
[root@vm-0-12-centos jobflowoperator]# kubectl  get jobs | grep daemonjob-example
daemonjob-example-vm-0-12-centos             1/1           102s       3d17h
daemonjob-example-vm-0-17-centos             1/1           102s       3d17h
  • 注：pod 字段中的 restartPolicy 不允许被使用，就算定义后也不会生效(都会被强制设为"Never")

部署

目前已支持 helm 部署，请参考 这里