CronJob管理 原创
1、功能
2、类型转换
2.1、实现类型转换
在 internal/pkg/k8s/cronjob/common.go
文件中新增 CronJobCell
,实现和 batchv1.CronJobCell
进行类型转换,如下:
package cronjob
import (
batchv1 "k8s.io/api/batch/v1"
"time"
"github.com/joker-bai/hawkeye/internal/pkg/k8s/dataselect"
)
type CronJobCell batchv1.CronJob
func (p CronJobCell) GetCreation() time.Time {
return p.CreationTimestamp.Time
}
func (p CronJobCell) GetName() string {
return p.Name
}
// toCells corev1.Pod 类型 转换成 DataCell 类型
// @description: Pod类型转换成DataCell
func toCells(sts []batchv1.CronJob) []dataselect.DataCell {
cells := make([]dataselect.DataCell, len(sts))
for i := range sts {
cells[i] = CronJobCell(sts[i])
}
return cells
}
// fromCells DataCell 类型转换成 corev1.Pod 类型
// @description: DataCell类型转换成Pod
func fromCells(cells []dataselect.DataCell) []batchv1.CronJob {
ds := make([]batchv1.CronJob, len(cells))
for i := range cells {
ds[i] = batchv1.CronJob(cells[i].(CronJobCell))
}
return ds
}
2.2、实现增删改查
(1)创建 internal/pkg/k8s/cronjob/create.go 文件,输入以下内容,用于创建 cronjob
package cronjob
import (
"context"
"github.com/joker-bai/hawkeye/global"
"github.com/joker-bai/hawkeye/internal/app/requests"
"github.com/joker-bai/hawkeye/internal/pkg/k8s/common"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"strings"
)
const (
DescriptionAnnotationKey = "description"
)
func CreateCronJob(cronjob *requests.K8sCronJobCreateRequest) error {
annotations := map[string]string{}
if cronjob.Description != nil {
annotations[DescriptionAnnotationKey] = *cronjob.Description
}
labels := common.GetLabelsMap(cronjob.Labels)
metadata := metav1.ObjectMeta{
Annotations: annotations,
Labels: labels,
Name: cronjob.Name,
}
containerSpec := corev1.Container{
Name: cronjob.Name,
Image: cronjob.ContainerImage,
SecurityContext: &corev1.SecurityContext{
Privileged: &cronjob.RunAsPrivileged,
},
Resources: corev1.ResourceRequirements{Requests: make(map[corev1.ResourceName]resource.Quantity)},
Env: common.ConvertEnvVarsSpec(cronjob.Variables),
}
if cronjob.ContainerCommand != nil {
containerSpec.Command = []string{*cronjob.ContainerCommand}
}
if cronjob.ContainerCommandArgs != nil {
containerSpec.Args = strings.Fields(*cronjob.ContainerCommandArgs)
}
if cronjob.MemoryRequirement != nil {
containerSpec.Resources.Requests[corev1.ResourceMemory] = resource.MustParse(*cronjob.MemoryRequirement)
}
if cronjob.CpuRequirement != nil {
containerSpec.Resources.Requests[corev1.ResourceCPU] = resource.MustParse(*cronjob.CpuRequirement)
}
// 是否开启Readiness健康检测
if cronjob.IsReadinessEnable {
probeHandler := common.GetContainerProbe(cronjob.ReadinessProbe)
containerSpec.ReadinessProbe = &corev1.Probe{
ProbeHandler: probeHandler,
InitialDelaySeconds: cronjob.ReadinessProbe.InitialDelaySeconds,
TimeoutSeconds: cronjob.ReadinessProbe.TimeoutSeconds,
PeriodSeconds: cronjob.ReadinessProbe.PeriodSeconds,
SuccessThreshold: cronjob.ReadinessProbe.SuccessThreshold,
FailureThreshold: cronjob.ReadinessProbe.FailureThreshold,
}
}
if cronjob.IsLivenessEnable {
probehandler := common.GetContainerProbe(cronjob.ReadinessProbe)
containerSpec.LivenessProbe = &corev1.Probe{
ProbeHandler: probehandler,
InitialDelaySeconds: cronjob.LivenessProbe.InitialDelaySeconds,
TimeoutSeconds: cronjob.LivenessProbe.TimeoutSeconds,
PeriodSeconds: cronjob.LivenessProbe.PeriodSeconds,
SuccessThreshold: cronjob.LivenessProbe.SuccessThreshold,
FailureThreshold: cronjob.LivenessProbe.FailureThreshold,
}
}
podSpec := corev1.PodSpec{Containers: []corev1.Container{containerSpec}}
if cronjob.ImagePullSecret != nil {
podSpec.ImagePullSecrets = []corev1.LocalObjectReference{{Name: *cronjob.ImagePullSecret}}
}
podTemplate := corev1.PodTemplateSpec{
ObjectMeta: metadata,
Spec: podSpec,
}
jobSpec := batchv1.JobSpec{
Template: podTemplate,
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
}
if cronjob.ActiveDeadlineSeconds != nil {
jobSpec.ActiveDeadlineSeconds = cronjob.ActiveDeadlineSeconds
}
if cronjob.Parallelism != nil {
jobSpec.Parallelism = cronjob.Parallelism
}
if cronjob.BackoffLimit != nil {
jobSpec.BackoffLimit = cronjob.BackoffLimit
}
if cronjob.Completions != nil {
jobSpec.Completions = cronjob.Completions
}
jobTemp := batchv1.JobTemplateSpec{
ObjectMeta: metadata,
Spec: jobSpec,
}
cronjobSpec := batchv1.CronJobSpec{
Schedule: cronjob.Scheduler,
JobTemplate: jobTemp,
}
if cronjob.SuccessJobsHistoryLimit != nil {
cronjobSpec.SuccessfulJobsHistoryLimit = cronjob.SuccessJobsHistoryLimit
}
if cronjob.FailedJobsHistoryLimit != nil {
cronjobSpec.FailedJobsHistoryLimit = cronjob.FailedJobsHistoryLimit
}
if cronjob.ConcurrencyPolicy != "" {
cronjobSpec.ConcurrencyPolicy = getConcurrencyPolicy(cronjob.ConcurrencyPolicy)
}
cronjobTemp := &batchv1.CronJob{
ObjectMeta: metadata,
Spec: cronjobSpec,
}
if _, err := global.K8S.BatchV1().CronJobs(cronjob.Namespace).Create(context.TODO(), cronjobTemp, metav1.CreateOptions{}); err != nil {
return err
}
return nil
}
func getConcurrencyPolicy(policy string) batchv1.ConcurrencyPolicy {
switch policy {
case "Allow":
return batchv1.AllowConcurrent
case "Replace":
return batchv1.ReplaceConcurrent
case "forbid":
return batchv1.ForbidConcurrent
default:
return batchv1.AllowConcurrent
}
}
(2)在 internal/pkg/k8s/cronjob/delete.go 中创建以下内容,用户删除 cronjob
package cronjob
import (
"context"
"github.com/joker-bai/hawkeye/global"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
func DeleteCronJob(name, namespace string) error {
return global.K8S.BatchV1().CronJobs(namespace).Delete(context.TODO(), name, metav1.DeleteOptions{})
}
(3)在 internal/pkg/k8s/cronjob/list.go 中创建以下内容,用于列出 cronjob 列表
package cronjob
import (
"context"
"github.com/joker-bai/hawkeye/global"
"github.com/joker-bai/hawkeye/internal/pkg/k8s/dataselect"
batchv1 "k8s.io/api/batch/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
func ListCronJob(name, namespace string, page, limit int) ([]batchv1.CronJob, error) {
jobs, err := global.K8S.BatchV1().CronJobs(namespace).List(context.TODO(), metav1.ListOptions{})
if err != nil {
return nil, err
}
// 做排序
selector := dataselect.DataSelector{
GenericDataList: toCells(jobs.Items),
DataSelectQuery: &dataselect.DataSelectQuery{
Filter: &dataselect.FilterQuery{
Name: name,
},
Paginate: &dataselect.PaginateQuery{
Limit: limit,
Page: page,
},
},
}
filted := selector.Filter()
data := filted.Sort().Paginate()
return fromCells(data.GenericDataList), nil
}
(4)在 internal/pkg/k8s/cronjob/update.go 中创建以下内容,用于更新 cronjob
package cronjob
import (
"context"
"encoding/json"
"github.com/joker-bai/hawkeye/global"
batchv1 "k8s.io/api/batch/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
func UpdateCronJob(namespace, content string) error {
var sts batchv1.CronJob
if err := json.Unmarshal([]byte(content), &sts); err != nil {
return err
}
if _, err := global.K8S.BatchV1().CronJobs(namespace).Update(context.TODO(), &sts, metav1.UpdateOptions{}); err != nil {
return err
}
return nil
}
(5)在 internal/pkg/k8s/cronjob/detail.go 中创建以下内容,用于获取 cronjob 详情
package cronjob
import (
"context"
"github.com/joker-bai/hawkeye/global"
batchv1 "k8s.io/api/batch/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
func GetCronJobDetail(name, namespace string) (*batchv1.CronJob, error) {
sts, err := global.K8S.BatchV1().CronJobs(namespace).Get(context.TODO(), name, metav1.GetOptions{})
if err != nil {
return nil, err
}
return sts, nil
}
3、实现 services 方法
3.1、请求参数校验
在 internal/app/requests
目录中新建 k8s_cronjob.go
文件,写入以下内容以完成请求参数校验:
package requests
import (
"github.com/gin-gonic/gin"
"github.com/joker-bai/hawkeye/pkg/app"
"github.com/thedevsaddam/govalidator"
)
type K8sCronJobCreateRequest struct {
Name string `json:"name" valid:"name"` // CronJob的名字
ContainerImage string `json:"container_image" valid:"container_image"` // 容器镜像名
ImagePullSecret *string `json:"image_pull_secret" valid:"image_pull_secret"` // 拉取镜像的密钥
ContainerCommand *string `json:"container_command" valid:"container_command"` // 容器启动时执行的命令
ContainerCommandArgs *string `json:"container_command_args" valid:"container_command_args"` // 容器启动时执行命令的参数
PortMappings []PortMapping `json:"port_mappings" valid:"port_mappings"` // 容器端口
Variables []EnvironmentVariable `json:"variables" valid:"variables"` // 环境变量
Description *string `json:"description" valid:"description"` // 描述
Namespace string `json:"namespace" valid:"namespace"` // 名称空间
MemoryRequirement *string `json:"memory_requirement" valid:"memory_requirement"` // 内存
CpuRequirement *string `json:"cpu_requirement" valid:"cpu_requirement"` // CPU
Labels []Label `json:"labels" valid:"labels"` // 标签
RunAsPrivileged bool `json:"run_as_privileged" valid:"run_as_privileged"` // 是否特权用户运行容器
IsReadinessEnable bool `json:"is_readiness_enable" valid:"is_readiness_enable"` // 是否开启ReadinessProbe健康检查
ReadinessProbe HealthCheckDetail `json:"readiness_probe" valid:"readiness_probe"` // ReadinessProbe配置
IsLivenessEnable bool `json:"is_liveness_enable" valid:"is_liveness_enable"` // 是否开启LivenessProbe健康检查
LivenessProbe HealthCheckDetail `json:"liveness_probe" valid:"liveness_probe"` // LivenessProbe 主要配置
Scheduler string `json:"scheduler" valid:"scheduler"` // 定时规则
ConcurrencyPolicy string `json:"concurrency_policy" valid:"concurrency_policy"` // 并发策略,支持Allow,Forbid,Replace,默认Allow
SuccessJobsHistoryLimit *int32 `json:"success_jobs_history_limit" valid:"success_jobs_history_limit"` // 保留成功的任务数
FailedJobsHistoryLimit *int32 `json:"failed_jobs_history_limit" valid:"failed_jobs_history_limit"` // 保留失败的任务数
ActiveDeadlineSeconds *int64 `json:"active_deadline_seconds" valid:"active_deadline_seconds"` // 超时时间,默认600s
BackoffLimit *int32 `json:"backoff_limit" valid:"backoff_limit"` // 重试次数,默认6次
Completions *int32 `json:"completions" valid:"completions"` // 成功运行的Pod数
Parallelism *int32 `json:"parallelism" valid:"parallelism"` // 并行运行的Pod数
}
func ValidK8sCronJobCreateRequest(data interface{}, ctx *gin.Context) map[string][]string {
rules := govalidator.MapData{
"name": []string{"required"},
"namespace": []string{"required"},
"container_image": []string{"required"},
"replicas": []string{"required"},
"scheduler": []string{"required"},
}
messages := govalidator.MapData{
"namespace": []string{
"required: namespace不能为空",
},
"name": []string{
"required: name不能为空",
},
"container_image": []string{
"required: image不能为空",
},
"replicas": []string{
"required: replicas不能为空",
},
"scheduler": []string{
"required: scheduler不能为空",
},
}
return app.ValidateOptions(data, rules, messages)
}
type K8sCronJobUpdateRequest struct {
Namespace string `json:"namespace" valid:"namespace"`
Content string `json:"content" valid:"content"`
}
func ValidK8sCronJobUpdateRequest(data interface{}, ctx *gin.Context) map[string][]string {
rules := govalidator.MapData{
"namespace": []string{"required"},
"content": []string{"required"},
}
messages := govalidator.MapData{
"namespace": []string{
"required: namespace 不能为空",
},
"content": []string{
"required: content 不能为空",
},
}
// 校验入参
return app.ValidateOptions(data, rules, messages)
}
type K8sCronJobListRequest struct {
K8sCommonRequest
Page int `json:"page" form:"page" valid:"page"` // 页数
Limit int `json:"limit" form:"limit" valid:"limit"` // 每页条数
}
func ValidK8sCronJobListRequest(data interface{}, ctx *gin.Context) map[string][]string {
rules := govalidator.MapData{
"namespace": []string{"required"},
"page": []string{"required"},
"limit": []string{"required"},
}
messages := govalidator.MapData{
"namespace": []string{
"required: namespace不能为空",
},
"page": []string{
"required: page不能为空",
},
"limit": []string{
"required: limit不能为空",
},
}
// 校验入参
return app.ValidateOptions(data, rules, messages)
}
3.2、实现 services 方法
在 internal/app/services/k8s_cronjob.go
文件中新增 CronJob
操作的 services 方法,如下:
package services
import (
"github.com/joker-bai/hawkeye/internal/app/requests"
"github.com/joker-bai/hawkeye/internal/pkg/k8s/cronjob"
batchv1 "k8s.io/api/batch/v1"
)
// CronJob Service
func (s *Services) K8sCronJobList(param *requests.K8sCronJobListRequest) ([]batchv1.CronJob, error) {
return cronjob.ListCronJob(param.Name, param.Namespace, param.Page, param.Limit)
}
func (s *Services) K8sCronJobDelete(param *requests.K8sCommonRequest) error {
return cronjob.DeleteCronJob(param.Name, param.Namespace)
}
func (s *Services) K8sCronJobUpdate(param *requests.K8sCronJobUpdateRequest) error {
return cronjob.UpdateCronJob(param.Namespace, param.Content)
}
func (s *Services) K8sCronJobCreate(param *requests.K8sCronJobCreateRequest) error {
return cronjob.CreateCronJob(param)
}
func (s *Services) K8sCronJobDetail(param *requests.K8sCommonRequest) (*batchv1.CronJob, error) {
return cronjob.GetCronJobDetail(param.Name, param.Namespace)
}
4、新增 controllers 方法
在 internal/app/controllers/api/v1/k8s 目录中新增 cronjob.go 文件,实现如下方法:
package k8s
import (
"github.com/gin-gonic/gin"
"github.com/joker-bai/hawkeye/global"
"github.com/joker-bai/hawkeye/internal/app/requests"
"github.com/joker-bai/hawkeye/internal/app/services"
"github.com/joker-bai/hawkeye/pkg/app"
"github.com/joker-bai/hawkeye/pkg/errorcode"
"go.uber.org/zap"
)
type CronJobController struct{}
// List godoc
// @Summary 列出K8s CronJob
// @Description 列出K8s CronJob
// @Tags K8s CronJob管理
// @Produce json
// @Param name query string false "CronJob名" maxlength(100)
// @Param namespace query string false "命名空间" maxlength(100)
// @Param page query int true "页码"
// @Param limit query int true "每页数量"
// @Success 200 {object} string "成功"
// @Failure 400 {object} errorcode.Error "请求错误"
// @Failure 500 {object} errorcode.Error "内部错误"
// @Router /api/v1/k8s/cronjob/list [get]
func (k *CronJobController) List(ctx *gin.Context) {
param := requests.K8sCronJobListRequest{}
response := app.NewResponse(ctx)
if ok := app.Validate(ctx, ¶m, requests.ValidK8sCronJobListRequest); !ok {
return
}
svc := services.New(ctx)
cronjobs, err := svc.K8sCronJobList(¶m)
if err != nil {
global.Log.Error("获取CronJob列表失败", zap.String("error", err.Error()))
response.ToErrorResponse(errorcode.ErrorK8sCronJobListFail)
return
}
response.ToResponseList(cronjobs, len(cronjobs))
}
// Update godoc
// @Summary 更新CronJob
// @Description 更新CronJob
// @Tags K8s CronJob管理
// @Produce json
// @Param body body requests.K8sCronJobUpdateRequest true "body"
// @Success 200 {object} string "成功"
// @Failure 400 {object} errorcode.Error "请求错误"
// @Failure 500 {object} errorcode.Error "内部错误"
// @Router /api/v1/k8s/cronjob/update [post]
func (k *CronJobController) Update(ctx *gin.Context) {
param := requests.K8sCronJobUpdateRequest{}
response := app.NewResponse(ctx)
if ok := app.Validate(ctx, ¶m, requests.ValidK8sCronJobUpdateRequest); !ok {
return
}
svc := services.New(ctx)
err := svc.K8sCronJobUpdate(¶m)
if err != nil {
global.Log.Error("更新CronJob失败", zap.String("error", err.Error()))
response.ToErrorResponse(errorcode.ErrorK8sCronJobUpdateFail)
return
}
response.ToResponse(gin.H{
"msg": "CronJob更新成功",
})
}
// Delete godoc
// @Summary 删除CronJob
// @Description 删除CronJob
// @Tags K8s CronJob管理
// @Produce json
// @Param body body requests.K8sCommonRequest true "body"
// @Success 200 {object} string "成功"
// @Failure 400 {object} errorcode.Error "请求错误"
// @Failure 500 {object} errorcode.Error "内部错误"
// @Router /api/v1/k8s/cronjob/delete [post]
func (k *CronJobController) Delete(ctx *gin.Context) {
param := requests.K8sCommonRequest{}
response := app.NewResponse(ctx)
if ok := app.Validate(ctx, ¶m, requests.ValidK8sCommonRequest); !ok {
return
}
svc := services.New(ctx)
err := svc.K8sCronJobDelete(¶m)
if err != nil {
global.Log.Error("删除CronJobs失败", zap.String("error", err.Error()))
response.ToErrorResponse(errorcode.ErrorK8sCronJobDeleteFail)
return
}
response.ToResponse(gin.H{
"msg": "CronJob删除成功",
})
}
// Create godoc
// @Summary 创建CronJob
// @Description 创建CronJob
// @Tags K8s CronJob管理
// @Produce json
// @Param body body requests.K8sCronJobCreateRequest true "body"
// @Success 200 {object} string "成功"
// @Failure 400 {object} errorcode.Error "请求错误"
// @Failure 500 {object} errorcode.Error "内部错误"
// @Router /api/v1/k8s/cronjob/create [post]
func (k *CronJobController) Create(ctx *gin.Context) {
param := requests.K8sCronJobCreateRequest{}
response := app.NewResponse(ctx)
if ok := app.Validate(ctx, ¶m, requests.ValidK8sCronJobCreateRequest); !ok {
return
}
svc := services.New(ctx)
err := svc.K8sCronJobCreate(¶m)
if err != nil {
global.Log.Error("创建CronJob失败", zap.String("error", err.Error()))
response.ToErrorResponse(errorcode.ErrorK8sCronJobCreateFail)
return
}
response.ToResponse(gin.H{
"msg": "CronJob创建成果",
})
}
// Detail godoc
// @Summary 获取CronJob的详情
// @Description 获取CronJob的详情
// @Tags K8s CronJob管理
// @Produce json
// @Param name query string false "CronJob名" maxlength(100)
// @Param namespace query string false "命名空间" maxlength(100)
// @Success 200 {object} string "成功"
// @Failure 400 {object} errorcode.Error "请求错误"
// @Failure 500 {object} errorcode.Error "内部错误"
// @Router /api/v1/k8s/cronjob/detail [get]
func (k *CronJobController) Detail(ctx *gin.Context) {
param := requests.K8sCommonRequest{}
response := app.NewResponse(ctx)
if ok := app.Validate(ctx, ¶m, requests.ValidK8sCommonRequest); !ok {
return
}
svc := services.New(ctx)
cronjob, err := svc.K8sCronJobDetail(¶m)
if err != nil {
global.Log.Error("获取获取CronJob的详情失败", zap.String("error", err.Error()))
response.ToErrorResponse(errorcode.ErrorK8sCronJobDetailFail)
return
}
response.ToResponse(gin.H{
"data": cronjob,
"msg": "获取CronJob的详情成功",
})
}
再到 pkg/errorcode/k8s.go
文件中新增如下错误代码:
package errorcode
var (
......
// K8s CronJob 错误码
ErrorK8sCronJobUpdateFail = NewError(500061, "更新K8s CronJob 失败")
ErrorK8sCronJobDeleteFail = NewError(500062, "删除K8s CronJob 失败")
ErrorK8sCronJobListFail = NewError(500063, "获取K8s CronJob 列表失败")
ErrorK8sCronJobDetailFail = NewError(500064, "获取K8s CronJob 详情失败")
ErrorK8sCronJobCreateFail = NewError(500065, "创建K8s CronJob 失败")
)
5、新增路由
在 internal/app/routers/k8s.go
文件中新增 CronJob
操作的路由,如下:
package routers
import (
"github.com/gin-gonic/gin"
v1 "github.com/joker-bai/kubemana/internal/app/controllers/api/v1"
)
type K8sRouter struct{}
func (r *K8sRouter) Inject(router *gin.RouterGroup) {
k8s := router.Group("/k8s")
{
......
// CronJob 管理
cc := new(k8s.CronJobController)
ks.GET("/cronjob/list", cc.List)
ks.POST("/cronjob/create", cc.Create)
ks.POST("/cronjob/update", cc.Update)
ks.POST("/cronjob/delete", cc.Delete)
ks.GET("/cronjob/detail", cc.Detail)
}
}
6、测试一下
PS:测试之前都需要先初始化集群,在 4.3.1 Pod 章节有介绍。
这里简单测试列出 CronJob 接口,如下:
由于我当前集群的 CronJob 的版本还是 v1beta1,所以查询不到。
其他接口自行下去测试。
7、代码版本
本节开发完成后,记得生成 swag 和标记代码版本,如下:
$ swag init
$ git add .
$ git commit -m "新增k8s集群job操作"