kinitiras 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00097/article/details/139573616

kinitiras 项目教程

kinitiras A programmable rule engine for k8s admission webhook 项目地址: https://gitcode.com/gh_mirrors/ki/kinitiras

1. 项目目录结构及介绍

kinitiras 项目的目录结构如下：

kinitiras/
├── cmd/
│   └── app/
├── deploy/
├── docs/
│   └── images/
├── examples/
├── hack/
├── images/
│   └── webhook/
├── pkg/
├── script/
├── .gitignore
├── Dockerfile
├── LICENSE
├── Makefile
├── README-zh.md
├── README.md
├── ROADMAP.md
├── check_label.py
├── go.mod
├── go.sum
└── main.go

目录介绍

cmd/app/: 包含项目的启动文件。
deploy/: 包含项目的部署文件。
docs/images/: 包含项目文档中的图片资源。
examples/: 包含项目的示例配置文件。
hack/: 包含项目的辅助脚本。
images/webhook/: 包含与 webhook 相关的图片资源。
pkg/: 包含项目的核心代码包。
script/: 包含项目的脚本文件。
.gitignore: Git 忽略文件配置。
Dockerfile: 项目的 Dockerfile 文件。
LICENSE: 项目的开源许可证文件。
Makefile: 项目的 Makefile 文件，用于自动化构建和测试。
README-zh.md: 项目的中文 README 文件。
README.md: 项目的英文 README 文件。
ROADMAP.md: 项目的路线图文件。
check_label.py: 项目的 Python 脚本文件。
go.mod: Go 模块依赖文件。
go.sum: Go 模块依赖的校验文件。
main.go: 项目的启动文件。

2. 项目启动文件介绍

项目的启动文件位于 cmd/app/ 目录下，主要文件为 main.go。该文件是项目的入口文件，负责初始化项目并启动服务。

main.go 文件结构

package main

import (
    // 导入必要的包
)

func main() {
    // 初始化配置
    // 启动服务
}

启动流程

初始化配置: 读取配置文件并初始化项目配置。
启动服务: 根据配置启动 Kubernetes admission webhook 服务。

3. 项目配置文件介绍

项目的配置文件主要位于 deploy/ 目录下，包括以下几个关键文件：

deploy/webhook-configuration.yaml: 定义了 webhook 的配置，包括 mutate 和 validate 的规则。
deploy/kinitiras-webhook.yaml: 定义了 webhook 的部署配置，包括命名空间、镜像等。

deploy/webhook-configuration.yaml

该文件定义了 webhook 的配置，包括以下几个关键部分：

apiVersion: admissionregistration.k8s.io/v1
kind: MutatingWebhookConfiguration
metadata:
  name: kinitiras-webhook
webhooks:
  - name: kinitiras.kcloudlabs.io
    clientConfig:
      service:
        name: kinitiras-webhook
        namespace: kinitiras-system
        path: "/mutate"
    rules:
      - operations: ["CREATE", "UPDATE"]
        apiGroups: ["*"]
        apiVersions: ["*"]
        resources: ["*"]
    failurePolicy: Fail
    sideEffects: None

deploy/kinitiras-webhook.yaml

该文件定义了 webhook 的部署配置，包括以下几个关键部分：

apiVersion: apps/v1
kind: Deployment
metadata:
  name: kinitiras-webhook
  namespace: kinitiras-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: kinitiras-webhook
  template:
    metadata:
      labels:
        app: kinitiras-webhook
    spec:
      containers:
        - name: kinitiras-webhook
          image: k-cloud-labs/kinitiras:latest
          ports:
            - containerPort: 443