命名空间管理原创

1、功能

ee132beb34b04c4a255779525c60fcbf MD5

2、类型转换

2.1、实现类型转换

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

package namespace

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

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

type NamespaceCell corev1.Namespace

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

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

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

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

2.2、实现增删改查

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

package namespace

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"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

const (
	DescriptionAnnotationKey = "description"
)

func CreateNamespace(ing *requests.K8sNamespaceCreateRequest) error {
	annotations := map[string]string{}
	if ing.Description != nil {
		annotations[DescriptionAnnotationKey] = *ing.Description
	}

	labels := common.GetLabelsMap(ing.Labels)

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

	serv := &corev1.Namespace{
		ObjectMeta: metadata,
	}

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

	return nil
}

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

package namespace

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

func DeleteNamespace(name string) error {
	return global.K8S.CoreV1().Namespaces().Delete(context.TODO(), name, metav1.DeleteOptions{})
}

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

package namespace

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

func ListNamespace(name string, page, limit int) ([]corev1.Namespace, error) {
	global.Log.Info("获取ingress的列表")
	list, err := global.K8S.CoreV1().Namespaces().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/namespace/update.go 中创建以下内容，用于更新 namespace

package namespace

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

func UpdateNamespace(content string) error {
	var sts corev1.Namespace
	if err := json.Unmarshal([]byte(content), &sts); err != nil {
		return err
	}

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

	return nil
}

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

package namespace

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

func GetNamespaceDetail(name string) (*corev1.Namespace, error) {
	sts, err := global.K8S.CoreV1().Namespaces().Get(context.TODO(), name, metav1.GetOptions{})
	if err != nil {
		return nil, err
	}
	return sts, nil
}

3、实现 services 方法

3.1、请求参数校验

在 internal/app/requests 目录中新建 k8s_namespace.go 文件，写入以下内容以完成请求参数校验：

package requests

import (
	"github.com/gin-gonic/gin"
	"github.com/joker-bai/hawkeye/pkg/app"
	"github.com/thedevsaddam/govalidator"
)

type K8sNamespaceCreateRequest struct {
	Name        string  `json:"name" form:"name" valid:"name"`                      // Namespace的名字
	Description *string `json:"description" form:"description" valid:"description"` // 描述
	Labels      []Label `json:"labels" form:"labels" valid:"labels"`                // 关联标签
}

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

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

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

type K8sNamespaceUpdateRequest struct {
	Content string `json:"content" form:"content" valid:"content"`
}

func ValidK8sNamespaceUpdateRequest(data interface{}, ctx *gin.Context) map[string][]string {
	rules := govalidator.MapData{
		"content": []string{"required"},
	}
	messages := govalidator.MapData{
		"content": []string{
			"required: content 不能为空",
		},
	}

	// 校验入参

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

type K8sNamespaceListRequest struct {
	K8sCommonRequest
	Page  int `json:"page" form:"page" valid:"page"`    // 页数
	Limit int `json:"limit" form:"limit" valid:"limit"` // 每页条数
}

func ValidK8sNamespaceListRequest(data interface{}, ctx *gin.Context) map[string][]string {
	rules := govalidator.MapData{
		"page":  []string{"required"},
		"limit": []string{"required"},
	}
	messages := govalidator.MapData{
		"page": []string{
			"required: page不能为空",
		},
		"limit": []string{
			"required: limit不能为空",
		},
	}

	// 校验入参

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

3.2、实现 services 方法

在 internal/app/services/k8s_namespace.go 文件中新增 Namespace 操作的 services 方法，如下：

package services

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

// Namespace

func (s *Services) K8sNamespaceList(param *requests.K8sNamespaceListRequest) ([]corev1.Namespace, error) {
	return namespace.ListNamespace(param.Name, param.Page, param.Limit)
}

func (s *Services) K8sNamespaceDelete(param *requests.K8sCommonRequest) error {
	return namespace.DeleteNamespace(param.Name)
}

func (s *Services) K8sNamespaceUpdate(param *requests.K8sNamespaceUpdateRequest) error {
	return namespace.UpdateNamespace(param.Content)
}

func (s *Services) K8sNamespaceCreate(param *requests.K8sNamespaceCreateRequest) error {
	return namespace.CreateNamespace(param)
}

func (s *Services) K8sNamespaceDetail(param *requests.K8sCommonRequest) (*corev1.Namespace, error) {
	return namespace.GetNamespaceDetail(param.Name)
}

4、新增 controllers 方法

在 internal/app/controllers/api/v1/k8s 目录中新增 namespace.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 NamespaceController struct{}

// List godoc
// @Summary 列出K8s Namespace
// @Description 列出K8s Namespace
// @Tags K8s Namespace管理
// @Produce json
// @Param name query string false "Namespace名" 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/namespace/list [get]
func (k *NamespaceController) List(ctx *gin.Context) {
	param := requests.K8sNamespaceListRequest{}
	response := app.NewResponse(ctx)

	if ok := app.Validate(ctx, &param, requests.ValidK8sNamespaceListRequest); !ok {
		return
	}

	svc := services.New(ctx)
	namespaces, err := svc.K8sNamespaceList(&param)
	if err != nil {
		global.Log.Error("获取Namespace列表失败", zap.String("error", err.Error()))
		response.ToErrorResponse(errorcode.ErrorK8sNamespaceListFail)
		return
	}

	response.ToResponseList(namespaces, len(namespaces))
}

// Update godoc
// @Summary 更新Namespace
// @Description 更新Namespace
// @Tags K8s Namespace管理
// @Produce json
// @Param body body requests.K8sNamespaceUpdateRequest true "body"
// @Success 200 {object} string "成功"
// @Failure 400 {object} errorcode.Error "请求错误"
// @Failure 500 {object} errorcode.Error "内部错误"
// @Router /api/v1/k8s/namespace/update [post]
func (k *NamespaceController) Update(ctx *gin.Context) {
	param := requests.K8sNamespaceUpdateRequest{}
	response := app.NewResponse(ctx)

	if ok := app.Validate(ctx, &param, requests.ValidK8sNamespaceUpdateRequest); !ok {
		return
	}

	svc := services.New(ctx)
	err := svc.K8sNamespaceUpdate(&param)
	if err != nil {
		global.Log.Error("更新Namespace失败", zap.String("error", err.Error()))
		response.ToErrorResponse(errorcode.ErrorK8sNamespaceUpdateFail)
		return
	}

	response.ToResponse(gin.H{
		"msg": "Namespace更新成功",
	})
}

// Delete godoc
// @Summary 删除Namespace
// @Description 删除Namespace
// @Tags K8s Namespace管理
// @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/namespace/delete [post]
func (k *NamespaceController) 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.K8sNamespaceDelete(&param)
	if err != nil {
		global.Log.Error("删除Namespaces失败", zap.String("error", err.Error()))
		response.ToErrorResponse(errorcode.ErrorK8sNamespaceDeleteFail)
		return
	}

	response.ToResponse(gin.H{
		"msg": "Namespace删除成功",
	})
}

// Create godoc
// @Summary 创建Namespace
// @Description 创建Namespace
// @Tags K8s Namespace管理
// @Produce json
// @Param body body requests.K8sNamespaceCreateRequest true "body"
// @Success 200 {object} string "成功"
// @Failure 400 {object} errorcode.Error "请求错误"
// @Failure 500 {object} errorcode.Error "内部错误"
// @Router /api/v1/k8s/namespace/create [post]
func (k *NamespaceController) Create(ctx *gin.Context) {
	param := requests.K8sNamespaceCreateRequest{}
	response := app.NewResponse(ctx)

	if ok := app.Validate(ctx, &param, requests.ValidK8sNamespaceCreateRequest); !ok {
		return
	}

	svc := services.New(ctx)
	err := svc.K8sNamespaceCreate(&param)
	if err != nil {
		global.Log.Error("创建Namespace失败", zap.String("error", err.Error()))
		response.ToErrorResponse(errorcode.ErrorK8sNamespaceCreateFail)
		return
	}

	response.ToResponse(gin.H{
		"msg": "Namespace创建成功",
	})
}

// Detail godoc
// @Summary 获取Namespace的详情
// @Description 获取Namespace的详情
// @Tags K8s Namespace管理
// @Produce json
// @Param name query string false "Namespace名" 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/namespace/detail [get]
func (k *NamespaceController) 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)
	namespace, err := svc.K8sNamespaceDetail(&param)
	if err != nil {
		global.Log.Error("获取获取Namespace的详情失败", zap.String("error", err.Error()))
		response.ToErrorResponse(errorcode.ErrorK8sNamespaceDetailFail)
		return
	}

	response.ToResponse(gin.H{
		"data": namespace,
		"msg":  "获取Namespace的详情成功",
	})
}

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 Namespace 错误码

	ErrorK8sNamespaceUpdateFail = NewError(500151, "更新K8s Namespace 失败")
	ErrorK8sNamespaceDeleteFail = NewError(500152, "删除K8s Namespace 失败")
	ErrorK8sNamespaceListFail   = NewError(500153, "获取K8s Namespace 列表失败")
	ErrorK8sNamespaceDetailFail = NewError(500154, "获取K8s Namespace 详情失败")
	ErrorK8sNamespaceCreateFail = NewError(500155, "创建K8s Namespace 失败")
)

5、新增路由

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

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

		// Namespace 管理
		ns := new(k8s.NamespaceController)
		ks.GET("/namespace/list", ns.List)
		ks.POST("/namespace/create", ns.Create)
		ks.POST("/namespace/update", ns.Update)
		ks.POST("/namespace/delete", ns.Delete)
		ks.GET("/namespace/detail", ns.Detail)
	}
}

6、测试一下

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

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

5f53c9190da7adf7fb2fe32bcbfc8fc3 MD5

其他接口自行下去测试。

7、代码版本

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

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

环境准备

项目初始化

用户管理

认证模块

容器服务

应用管理

命名空间管理原创

1、功能

2、类型转换

2.1、实现类型转换

2.2、实现增删改查

3、实现 services 方法

3.1、请求参数校验

3.2、实现 services 方法

4、新增 controllers 方法

5、新增路由

6、测试一下

7、代码版本

命名空间管理 原创 ​

1、功能 ​

2、类型转换 ​

2.1、实现类型转换 ​

2.2、实现增删改查 ​

3、实现 services 方法 ​

3.1、请求参数校验 ​

3.2、实现 services 方法 ​

4、新增 controllers 方法 ​

5、新增路由 ​

6、测试一下 ​

7、代码版本 ​

命名空间管理原创

1、功能

2、类型转换

2.1、实现类型转换

2.2、实现增删改查

3、实现 services 方法

3.1、请求参数校验

3.2、实现 services 方法

4、新增 controllers 方法

5、新增路由

6、测试一下

7、代码版本