k8s cron

1、概述

关于定时任务，有多种不同方案，比如第三方包、服务器 cron、k8s cronjob，这里只讲解 k8s cronjob，其他的可以去看相关第三方包资料自行学习

2、项目地址

项目地址：https://github.com/Mikaelemmmm/zerok8scron

我们在项目中集成了 cobra，k8s cronjob 在每次调度的时候直接执行对应 job name 即可

3、关键代码分析

main.go

  1. package main
  3. import (
  4.     "zerok8scron/internal/cmd"
  5. )
  7. func main() {
  8.     cmd.Execute()
  9. }

internal/cmd/root.go

  1. package cmd
  3. import (
  4.     "github.com/spf13/cobra"
  5.     "github.com/zeromicro/go-zero/core/conf"
  6.     "os"
  7.     "zerok8scron/internal/config"
  8.     "zerok8scron/internal/logic"
  9.     "zerok8scron/internal/svc"
  10. )
  12. const (
  13.     codeFailure = 1
  14. )
  16. var (
  17.     confPath string
  19.     rootCmd = &cobra.Command{
  20.         Use:   "cron",
  21.         Short: "exec cron job",
  22.         Long:  "exec cron job",
  23.     }
  25. // all job ...
  26.     helloJob = &cobra.Command{
  27.         Use:   "hello",
  28.         Short: "print 'hello SvcName' once per minute",
  29.         RunE:  logic.Hello,
  30.     }
  32.     // add more job , wait for you.....
  33. )
  35. // Execute executes the given command
  36. func Execute() {
  37.     if err := rootCmd.Execute(); err != nil {
  38.         os.Exit(codeFailure)
  39.     }
  40. }
  42. func init() {
  44.     // init config
  45.     cobra.OnInitialize(initConfig)
  46.     rootCmd.PersistentFlags().StringVar(&confPath, "config", "etc/cron.yaml", "config file (default is $HOME/.cobra.yaml)")
  48.     // add subcommand
  49.     rootCmd.AddCommand(helloJob)
  50. }
  52. func initConfig() {
  53.     var c config.Config
  54.     conf.MustLoad(confPath, &c)
  55.     svc.InitSvcCtx(c)
  56. }

internal/logic/hello.go

  1. package logic
  3. import (
  4.     "fmt"
  5.     "github.com/spf13/cobra"
  6.     "zerok8scron/internal/svc"
  7. )
  9. // Hello print "hello SvcName" once per minute
  10. func Hello(_ *cobra.Command, _ []string) error {
  12.     fmt.Printf("srvName : %s , hello \n", svc.GetSvcCtx().Config.Name)
  14.     return nil
  15. }

2.1 如何执行调度

可以看到 rootCmd 是主命令 , helloJob 就是我们自己的一个要调度的任务，调度之后要执行的方法就是 logic 下 hello.go 中的方法。

如果需要添加更多的任务，我们直接在下方继续添加，在 logic 中添加对应的实现即可。

2.2 如何初始化配置

我们在执行之前先初始化了配置，看到这里你可能会很眼熟，我们把 go-zero 默认在 main 中的初始化配置放在了此处 initConfig

我们使用默认的配置文件是 etc/cron.yaml

4、运行调度

4.1 本地执行一次

  1. $ go run main.go hello

4.2 docker 中执行一次

  1. $ goctl docker -go main.go #创建dockerfile，如果你用上面的项目，项目中已经创建好可以省略
  2. $ docker build -t zerok8scron:v1 . # 构建镜像，如果你用上面的项目，项目中已经创建好可以省略
  3. $ docker run zerok8scron:v1 hello #运行即可

4.3 k8s 中使用 cronjob 调度一分钟一次

cronjob.yaml

  1. apiVersion: batch/v1
  2. kind: CronJob
  3. metadata:
  4.   name: hello
  5. spec:
  6.   schedule: "*/1 * * * *"
  7.   jobTemplate:
  8.     spec:
  9.       template:
  10.         spec:
  11.           containers:
  12.             - name: hello
  13.               image: zerok8scron:v1
  14.               args:
  15.                 - hello
  16.           restartPolicy: OnFailure

执行

  1. $ kubectl apply -f cronjob.yaml

然后可以查看 cronjob 运行状态以及输出