Skip to content

Ingress管理 原创

1、功能

ea168c8bc1c3b4420e8bb0308288bc04 MD5

2、类型转换

2.1、实现类型转换

internal/pkg/k8s/ingress/common.go 文件中新增 IngressCell,实现和 extenv1beta1.IngressCell 进行类型转换,如下:

go
package ingress

import (
	extenv1beta1 "k8s.io/api/extensions/v1beta1"
	"time"

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

type IngressCell extenv1beta1.Ingress

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

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

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

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

2.2、实现增删改查

(1)创建 internal/pkg/k8s/ingress/create.go 文件,输入以下内容,用于创建 ingress

go
package ingress

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"
	extenv1beta1 "k8s.io/api/extensions/v1beta1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/util/intstr"
)

const (
	DescriptionAnnotationKey = "description"
)

func CreateIngress(ing *requests.K8sIngressCreateRequest) 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 := &extenv1beta1.Ingress{
		ObjectMeta: metadata,
		Spec:       extenv1beta1.IngressSpec{},
	}

	for _, rule := range ing.Rules {
		var ingressPaths []extenv1beta1.HTTPIngressPath
		for _, svc := range rule.Services {
			ingressPath := extenv1beta1.HTTPIngressPath{
				Path:     rule.Path,
				PathType: nil,
				Backend: extenv1beta1.IngressBackend{
					ServiceName: svc.ServiceName,
					ServicePort: intstr.IntOrString{IntVal: svc.ServicePort},
				},
			}
			ingressPaths = append(ingressPaths, ingressPath)
		}

		ingressRule := extenv1beta1.IngressRule{
			Host: rule.Host,
			IngressRuleValue: extenv1beta1.IngressRuleValue{
				HTTP: &extenv1beta1.HTTPIngressRuleValue{
					Paths: ingressPaths,
				},
			},
		}

		serv.Spec.Rules = append(serv.Spec.Rules, ingressRule)
	}

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

	return nil
}

(2)在 internal/pkg/k8s/ingress/delete.go 中创建以下内容,用户删除 ingress

go
package ingress

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

func DeleteIngress(name, namespace string) error {
	return global.K8S.ExtensionsV1beta1().Ingresses(namespace).Delete(context.TODO(), name, metav1.DeleteOptions{})
}

(3)在 internal/pkg/k8s/ingress/list.go 中创建以下内容,用于列出 ingress 列表

go
package ingress

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

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

go
package ingress

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

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

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

	return nil
}

(5)在 internal/pkg/k8s/ingress/detail.go 中创建以下内容,用于获取 ingress 详情

go
package ingress

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

func GetIngressDetail(name, namespace string) (*extenv1beta1.Ingress, error) {
	sts, err := global.K8S.ExtensionsV1beta1().Ingresses(namespace).Get(context.TODO(), name, metav1.GetOptions{})
	if err != nil {
		return nil, err
	}
	return sts, nil
}

3、实现 services 方法

3.1、请求参数校验

internal/app/requests 目录中新建 k8s_ingress.go 文件,写入以下内容以完成请求参数校验:

go
package requests

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

type K8sIngressCreateRequest struct {
	Name        string        `json:"name" form:"name" valid:"name"`                      // Ingress的名字
	Description *string       `json:"description" form:"description" valid:"description"` // 描述
	Namespace   string        `json:"namespace" form:"namespace" valid:"namespace"`       // 名称空间
	Labels      []Label       `json:"labels" form:"labels" valid:"labels"`                // 关联标签
	Rules       []IngressRule `json:"rules" valid:"rules"`
}

type IngressRule struct {
	Path     string           `json:"path" valid:"path"`
	Host     string           `json:"host" valid:"host"`
	Services []BackendService `json:"services" valid:"services"`
}

type BackendService struct {
	ServiceName string `json:"service_name" valid:"service_name"`
	ServicePort int32  `json:"service_port" valid:"service_port"`
}

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

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

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

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

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

func ValidK8sIngressListRequest(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_ingress.go 文件中新增 Ingress 操作的 services 方法,如下:

go
package services

import (
	"github.com/joker-bai/hawkeye/internal/app/requests"
	"github.com/joker-bai/hawkeye/internal/pkg/k8s/ingress"
	extenv1beta1 "k8s.io/api/extensions/v1beta1"
)

// Ingress

func (s *Services) K8sIngressList(param *requests.K8sIngressListRequest) ([]extenv1beta1.Ingress, error) {
	return ingress.ListIngress(param.Name, param.Namespace, param.Page, param.Limit)
}

func (s *Services) K8sIngressDelete(param *requests.K8sCommonRequest) error {
	return ingress.DeleteIngress(param.Name, param.Namespace)
}

func (s *Services) K8sIngressUpdate(param *requests.K8sIngressUpdateRequest) error {
	return ingress.UpdateIngress(param.Namespace, param.Content)
}

func (s *Services) K8sIngressCreate(param *requests.K8sIngressCreateRequest) error {
	return ingress.CreateIngress(param)
}

func (s *Services) K8sIngressDetail(param *requests.K8sCommonRequest) (*extenv1beta1.Ingress, error) {
	return ingress.GetIngressDetail(param.Name, param.Namespace)
}

4、新增 controllers 方法

在 internal/app/controllers/api/v1/k8s 目录中新增 ingress.go 文件,实现如下方法:

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 IngressController struct{}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

go
package errorcode

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

	ErrorK8sIngressUpdateFail = NewError(500081, "更新K8s Ingress 失败")
	ErrorK8sIngressDeleteFail = NewError(500082, "删除K8s Ingress 失败")
	ErrorK8sIngressListFail   = NewError(500083, "获取K8s Ingress 列表失败")
	ErrorK8sIngressDetailFail = NewError(500084, "获取K8s Ingress 详情失败")
	ErrorK8sIngressCreateFail = NewError(500085, "创建K8s Ingress 失败")
)

5、新增路由

internal/app/routers/k8s.go 文件中新增 CronJob 操作的路由,如下:

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

		// Ingress 管理
		ingc := new(k8s.IngressController)
		ks.GET("/ingress/list", ingc.List)
		ks.POST("/ingress/create", ingc.Create)
		ks.POST("/ingress/update", ingc.Update)
		ks.POST("/ingress/delete", ingc.Delete)
		ks.GET("/ingress/detail", ingc.Detail)
	}
}

6、测试一下

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

这里简单测试列出 CronJob 接口,如下:

bc7c534fb12dcdf7cf7afc935b156757 MD5

其他接口自行下去测试。

7、代码版本

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

go
$ swag init
$ git add .
$ git commit -m "新增k8s集群ingress操作"
最近更新