Service管理原创

1、功能

6ecb050526e6d3224d7288d2635a56b7 MD5

2、类型转换

2.1、实现类型转换

在 internal/pkg/k8s/service/common.go 文件中新增 ServiceCell，实现和 corev1.ServiceCell 进行类型转换，如下：

package service

import (
	v1 "k8s.io/api/core/v1"
	"time"

	"github.com/joker-bai/hawkeye/internal/pkg/k8s/dataselect"
)

type ServiceCell v1.Service

func (p ServiceCell) GetCreation() time.Time {
	return p.CreationTimestamp.Time
}

func (p ServiceCell) GetName() string {
	return p.Name
}

// toCells batchv1.Service 类型 转换成 DataCell 类型
// @description: Service类型转换成DataCell
func toCells(sts []v1.Service) []dataselect.DataCell {
	cells := make([]dataselect.DataCell, len(sts))
	for i := range sts {
		cells[i] = ServiceCell(sts[i])
	}
	return cells
}

// fromCells DataCell 类型转换成 batchv1.Service 类型
// @description: DataCell类型转换成Service
func fromCells(cells []dataselect.DataCell) []v1.Service {
	ds := make([]v1.Service, len(cells))
	for i := range cells {
		ds[i] = v1.Service(cells[i].(ServiceCell))
	}
	return ds
}

2.2、实现增删改查

（1）创建 internal/pkg/k8s/service/create.go 文件，输入以下内容，用于创建 service

package service

import (
	"context"
	"fmt"
	"github.com/joker-bai/hawkeye/global"
	"github.com/joker-bai/hawkeye/internal/app/requests"
	"github.com/joker-bai/hawkeye/internal/pkg/k8s/common"
	v1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/util/intstr"
	"k8s.io/apimachinery/pkg/util/rand"
	"strings"
)

const (
	DescriptionAnnotationKey = "description"
)

func CreateService(svc *requests.K8sServiceCreateRequest) error {
	annotations := map[string]string{}
	if svc.Description != nil {
		annotations[DescriptionAnnotationKey] = *svc.Description
	}

	labels := common.GetLabelsMap(svc.Labels)

	metadata := metav1.ObjectMeta{
		Annotations: annotations,
		Labels:      labels,
		Name:        svc.Name,
	}

	serv := &v1.Service{
		ObjectMeta: metadata,
		Spec: v1.ServiceSpec{
			Type:     v1.ServiceType(svc.ServiceType),
			Selector: labels,
		},
	}

	for _, portMapping := range svc.PortMappings {
		servicePort := v1.ServicePort{
			Name:     generatePortMappingName(portMapping),
			Protocol: v1.Protocol(portMapping.Protocol),
			Port:     portMapping.Port,
			TargetPort: intstr.IntOrString{
				Type:   intstr.Int,
				IntVal: portMapping.TargetPort,
			},
		}

		if svc.NodePort != 0 {
			servicePort.NodePort = svc.NodePort
		}

		serv.Spec.Ports = append(serv.Spec.Ports, servicePort)
	}

	if _, err := global.K8S.CoreV1().Services(svc.Namespace).Create(context.TODO(), serv, metav1.CreateOptions{}); err != nil {
		return err
	}

	return nil
}

func generatePortMappingName(portMapping requests.PortMapping) string {
	return generateName(fmt.Sprintf("%s-%d-%d-", strings.ToLower(string(portMapping.Protocol)),
		portMapping.Port, portMapping.TargetPort))
}

func generateName(base string) string {
	maxNameLength := 63
	randomLength := 5
	maxGeneratedNameLength := maxNameLength - randomLength
	if len(base) > maxGeneratedNameLength {
		base = base[:maxGeneratedNameLength]
	}
	return fmt.Sprintf("%s%s", base, rand.String(randomLength))
}

（2）在 internal/pkg/k8s/service/delete.go 中创建以下内容，用户删除 service

package service

import (
	"context"
	"github.com/joker-bai/hawkeye/global"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func DeleteService(name, namespace string) error {
	return global.K8S.CoreV1().Services(namespace).Delete(context.TODO(), name, metav1.DeleteOptions{})
}

（3）在 internal/pkg/k8s/service/list.go 中创建以下内容，用于列出 service 列表

package service

import (
	"context"
	"github.com/joker-bai/hawkeye/global"
	"github.com/joker-bai/hawkeye/internal/pkg/k8s/dataselect"
	v1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func ListService(name, namespace string, page, limit int) ([]v1.Service, error) {
	global.Log.Info("获取cron jobs的列表")
	list, err := global.K8S.CoreV1().Services(namespace).List(context.TODO(), metav1.ListOptions{})
	if err != nil {
		return nil, err
	}

	// 做排序
	selector := dataselect.DataSelector{
		GenericDataList: toCells(list.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/service/update.go 中创建以下内容，用于更新 service

package service

import (
	"context"
	"encoding/json"
	"github.com/joker-bai/hawkeye/global"
	v1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func UpdateService(namespace, content string) error {
	var sts v1.Service
	if err := json.Unmarshal([]byte(content), &sts); err != nil {
		return err
	}

	if _, err := global.K8S.CoreV1().Services(namespace).Update(context.TODO(), &sts, metav1.UpdateOptions{}); err != nil {
		return err
	}

	return nil
}

（5）在 internal/pkg/k8s/service/detail.go 中创建以下内容，用于获取 service 详情

package service

import (
	"context"
	"github.com/joker-bai/hawkeye/global"
	v1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func GetServiceDetail(name, namespace string) (*v1.Service, error) {
	sts, err := global.K8S.CoreV1().Services(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 K8sServiceCreateRequest struct {
	Name         string        `json:"name" form:"name" valid:"name"`                            // Service的名字
	PortMappings []PortMapping `json:"port_mappings" form:"port_mappings" valid:"port_mappings"` // 容器端口
	Description  *string       `json:"description" form:"description" valid:"description"`       // 描述
	Namespace    string        `json:"namespace" form:"namespace" valid:"namespace"`             // 名称空间
	Labels       []Label       `json:"labels" form:"labels" valid:"labels"`                      // 关联标签
	ServiceType  string        `json:"service_type" valid:"service_type"`
	NodePort     int32         `json:"node_port" valid:"node_port"`
}

func ValidK8sServiceCreateRequest(data interface{}, ctx *gin.Context) map[string][]string {
	rules := govalidator.MapData{
		"name":         []string{"required"},
		"namespace":    []string{"required"},
		"labels":       []string{"required"},
		"service_type": []string{"required"},
	}

	messages := govalidator.MapData{
		"namespace": []string{
			"required: namespace不能为空",
		},
		"name": []string{
			"required: name不能为空",
		},
		"labels": []string{
			"required: labels不能为空",
		},
		"service_type": []string{
			"required: service_type不能为空",
		},
	}

	return app.ValidateOptions(data, rules, messages)
}

type K8sServiceUpdateRequest struct {
	Namespace string `json:"namespace" form:"namespace" valid:"namespace"`
	Content   string `json:"content" form:"content" valid:"content"`
}

func ValidK8sServiceUpdateRequest(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 K8sServiceListRequest struct {
	K8sCommonRequest
	Page  int `json:"page" form:"page" valid:"page"`    // 页数
	Limit int `json:"limit" form:"limit" valid:"limit"` // 每页条数
}

func ValidK8sServiceListRequest(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_service.go 文件中新增 Service 操作的 services 方法，如下：

package services

import (
	"github.com/joker-bai/hawkeye/internal/app/requests"
	"github.com/joker-bai/hawkeye/internal/pkg/k8s/service"
	corev1 "k8s.io/api/core/v1"
)

// Service Service

func (s *Services) K8sServiceList(param *requests.K8sServiceListRequest) ([]corev1.Service, error) {
	return service.ListService(param.Name, param.Namespace, param.Page, param.Limit)
}

func (s *Services) K8sServiceDelete(param *requests.K8sCommonRequest) error {
	return service.DeleteService(param.Name, param.Namespace)
}

func (s *Services) K8sServiceUpdate(param *requests.K8sServiceUpdateRequest) error {
	return service.UpdateService(param.Namespace, param.Content)
}

func (s *Services) K8sServiceCreate(param *requests.K8sServiceCreateRequest) error {
	return service.CreateService(param)
}

func (s *Services) K8sServiceDetail(param *requests.K8sCommonRequest) (*corev1.Service, error) {
	return service.GetServiceDetail(param.Name, param.Namespace)
}

4、新增 controllers 方法

在 internal/app/controllers/api/v1/k8s 目录中新增 k8s_service.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, &param, requests.ValidK8sCronJobListRequest); !ok {
		return
	}

	svc := services.New(ctx)
	cronjobs, err := svc.K8sCronJobList(&param)
	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, &param, requests.ValidK8sCronJobUpdateRequest); !ok {
		return
	}

	svc := services.New(ctx)
	err := svc.K8sCronJobUpdate(&param)
	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, &param, requests.ValidK8sCommonRequest); !ok {
		return
	}

	svc := services.New(ctx)
	err := svc.K8sCronJobDelete(&param)
	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, &param, requests.ValidK8sCronJobCreateRequest); !ok {
		return
	}

	svc := services.New(ctx)
	err := svc.K8sCronJobCreate(&param)
	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, &param, requests.ValidK8sCommonRequest); !ok {
		return
	}

	svc := services.New(ctx)
	cronjob, err := svc.K8sCronJobDetail(&param)
	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的详情成功",
	})
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

再到 pkg/errorcode/k8s.go 文件中新增如下错误代码：

package errorcode

var (
	......
	// K8s Service 错误码

	ErrorK8sServiceUpdateFail = NewError(500071, "更新K8s Service 失败")
	ErrorK8sServiceDeleteFail = NewError(500072, "删除K8s Service 失败")
	ErrorK8sServiceListFail   = NewError(500073, "获取K8s Service 列表失败")
	ErrorK8sServiceDetailFail = NewError(500074, "获取K8s Service 详情失败")
	ErrorK8sServiceCreateFail = NewError(500075, "创建K8s Service 失败")
)

5、新增路由

在 internal/app/routers/k8s.go 文件中新增 Service操作的路由，如下：

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")
	{
		......

		// Service 管理
		svc := new(k8s.ServiceController)
		ks.GET("/service/list", svc.List)
		ks.POST("/service/create", svc.Create)
		ks.POST("/service/update", svc.Update)
		ks.POST("/service/delete", svc.Delete)
		ks.GET("/service/detail", svc.Detail)
	}
}

6、测试一下

PS：测试之前都需要先初始化集群，在 4.3.1 Pod 章节有介绍。

这里简单测试列出 Service 接口，如下：

d24621f211c7de6483456cdadfd032da MD5

其他接口自行下去测试。

7、代码版本

本节开发完成后，记得生成 swag 和标记代码版本，如下：

$ swag init
$ git add .
$ git commit -m "新增k8s集群service操作"

环境准备

项目初始化

用户管理

认证模块

容器服务

应用管理

Service管理原创

1、功能

2、类型转换

2.1、实现类型转换

2.2、实现增删改查

3、实现 services 方法

3.1、请求参数校验

3.2、实现 services 方法

4、新增 controllers 方法

5、新增路由

6、测试一下

7、代码版本

Service管理 原创 ​

1、功能 ​

2、类型转换 ​

2.1、实现类型转换 ​

2.2、实现增删改查 ​

3、实现 services 方法 ​

3.1、请求参数校验 ​

3.2、实现 services 方法 ​

4、新增 controllers 方法 ​

5、新增路由 ​

6、测试一下 ​

7、代码版本 ​

Service管理原创

1、功能

2、类型转换

2.1、实现类型转换

2.2、实现增删改查

3、实现 services 方法

3.1、请求参数校验

3.2、实现 services 方法

4、新增 controllers 方法

5、新增路由

6、测试一下

7、代码版本