PV管理 原创

1、功能

2、类型转换

2.1、实现类型转换

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

package pv

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

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

type PersistentVolumeCell corev1.PersistentVolume

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

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

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

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

2.2、实现增删改查

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

package pv

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

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

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

package pv

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 ListPersistentVolume(name, namespace string, page, limit int) ([]corev1.PersistentVolume, error) {
	global.Log.Info("获取ingress的列表")
	list, err := global.K8S.CoreV1().PersistentVolumes().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
}

（3）在 internal/pkg/k8s/pv/update.go 中创建以下内容，用于更新 pv

package pv

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 UpdatePersistentVolume(namespace, content string) error {
	var sts corev1.PersistentVolume
	if err := json.Unmarshal([]byte(content), &sts); err != nil {
		return err
	}

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

	return nil
}

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

package pv

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

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

3、实现 services 方法

3.1、请求参数校验

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

package requests

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

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

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

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

package services

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

// PersistentVolume

func (s *Services) K8sPersistentVolumeList(param *requests.K8sPersistentVolumeListRequest) ([]corev1.PersistentVolume, error) {
	return pv.ListPersistentVolume(param.Name, param.Namespace, param.Page, param.Limit)
}

func (s *Services) K8sPersistentVolumeDelete(param *requests.K8sCommonRequest) error {
	return pv.DeletePersistentVolume(param.Name, param.Namespace)
}

func (s *Services) K8sPersistentVolumeUpdate(param *requests.K8sPersistentVolumeUpdateRequest) error {
	return pv.UpdatePersistentVolume(param.Namespace, param.Content)
}

func (s *Services) K8sPersistentVolumeDetail(param *requests.K8sCommonRequest) (*corev1.PersistentVolume, error) {
	return pv.GetPersistentVolumeDetail(param.Name, param.Namespace)
}

4、新增 controllers 方法

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

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

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

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

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

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

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

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

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

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

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

// Detail godoc
// @Summary 获取PersistentVolume的详情
// @Description 获取PersistentVolume的详情
// @Tags K8s PersistentVolume管理
// @Produce json
// @Param name query string false "PersistentVolume名" maxlength(100)
// @Success 200 {object} string "成功"
// @Failure 400 {object} errorcode.Error "请求错误"
// @Failure 500 {object} errorcode.Error "内部错误"
// @Router /api/v1/k8s/pv/detail [get]
func (k *PersistentVolumeController) 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)
	pv, err := svc.K8sPersistentVolumeDetail(&param)
	if err != nil {
		global.Log.Error("获取获取PersistentVolume的详情失败", zap.String("error", err.Error()))
		response.ToErrorResponse(errorcode.ErrorK8sPersistentVolumeDetailFail)
		return
	}

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

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

package errorcode

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

	ErrorK8sPersistentVolumeUpdateFail = NewError(500121, "更新K8s PersistentVolume 失败")
	ErrorK8sPersistentVolumeDeleteFail = NewError(500122, "删除K8s PersistentVolume 失败")
	ErrorK8sPersistentVolumeListFail   = NewError(500123, "获取K8s PersistentVolume 列表失败")
	ErrorK8sPersistentVolumeDetailFail = NewError(500124, "获取K8s PersistentVolume 详情失败")
	ErrorK8sPersistentVolumeCreateFail = NewError(500125, "创建K8s PersistentVolume 失败")
)

5、新增路由

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

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

		// PersistentVolume 管理
		pv := new(k8s.PersistentVolumeController)
		ks.GET("/pv/list", pv.List)
		ks.POST("/pv/update", pv.Update)
		ks.POST("/pv/delete", pv.Delete)
		ks.GET("/pv/detail", pv.Detail)
	}
}

6、测试一下

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

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

其他接口自行下去测试。

7、代码版本

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

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