Kubernetes API 编程

### Kubernetes API 编程

#### Kubernetes API 编程范式

**1. RESTful API**
- **定义**：Kubernetes API 是基于 RESTful 架构风格的，通过 HTTP 方法（如 GET、POST、PUT、DELETE）来管理集群中的资源。
- **常用操作**：
  - **GET**：获取资源信息。
  - **POST**：创建新资源。
  - **PUT**：更新现有资源。
  - **DELETE**：删除资源。
- **示例**：部署一个 Pod
  ```sh
  curl -X POST -H 'Content-Type: application/yaml' -d '
  apiVersion: v1
  kind: Pod
  metadata:
    name: my-pod
  spec:
    containers:
    - name: my-container
      image: my-image
  ' https://<KUBERNETES_MASTER>/api/v1/namespaces/default/pods
  ```

**2. Custom Resources**
- **定义**：Custom Resources 允许用户定义自己的资源类型和 API 端点，扩展 Kubernetes 的功能。
- **步骤**：
  1. **定义 Custom Resource Definition (CRD)**：创建一个 CRD 文件，定义自定义资源的结构和属性。
  2. **创建 Custom Resource (CR)**：使用 CRD 定义的资源类型创建具体的资源实例。
- **示例**：定义一个 CRD
  ```yaml
  apiVersion: apiextensions.k8s.io/v1
  kind: CustomResourceDefinition
  metadata:
    name: myresources.example.com
  spec:
    group: example.com
    versions:
    - name: v1alpha1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                foo:
                  type: string
            status:
              type: object
              properties:
                bar:
                  type: string
    names:
      kind: MyResource
      plural: myresources
    scope: Namespaced
  ```

**3. Custom Controllers**
- **定义**：Custom Controllers 是自定义的控制循环，用于管理自定义资源的生命周期和行为。
- **步骤**：
  1. **定义自定义资源**：创建 CRD 和 CR。
  2. **实现控制器逻辑**：编写代码逻辑，处理自定义资源的创建、更新和删除事件。
  3. **部署控制器**：将控制器部署到 Kubernetes 集群中。
- **示例**：实现一个简单的 Custom Controller
  ```go
  package main

import (
      "context"
      "fmt"
      "time"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
      "k8s.io/client-go/kubernetes"
      "k8s.io/client-go/rest"
  )

func main() {
      // 获取集群的配置
      config, err := rest.InClusterConfig()
      if err != nil {
          panic(err.Error())
      }
      // 创建客户端
      clientset, err := kubernetes.NewForConfig(config)
      if err != nil {
          panic(err.Error())
      }

for {
          // 获取自定义资源
          exampleRes, err := clientset.CustomObjects().Get(context.TODO(), "myresources", "default", "example-res", metav1.GetOptions{})
          if err != nil {
              panic(err.Error())
          }

// 处理自定义资源
          handleCustomResource(exampleRes)

// 等待一段时间
          time.Sleep(1 * time.Second)
      }
  }

func handleCustomResource(obj map[string]interface{}) {
      name := obj["spec"].(map[string]interface{})["name"].(string)
      message := obj["spec"].(map[string]interface{})["message"].(string)
      fmt.Printf("Handling MyResource %s: %s\n", name, message)
  }
  ```

#### 使用 Kubernetes API 进行扩展开发

**1. 定义 API 资源**
- **定义 CRD**：创建一个 CRD 文件，定义自定义资源的结构和属性。
  ```yaml
  apiVersion: apiextensions.k8s.io/v1
  kind: CustomResourceDefinition
  metadata:
    name: myresources.example.com
  spec:
    group: example.com
    versions:
    - name: v1alpha1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                foo:
                  type: string
            status:
              type: object
              properties:
                bar:
                  type: string
    names:
      kind: MyResource
      plural: myresources
    scope: Namespaced
  ```

**2. 实现自定义资源控制器**
- **编写控制器逻辑**：使用 Go 语言编写控制器逻辑，处理自定义资源的生命周期事件。
  ```go
  package main

import (
      "context"
      "fmt"
      "time"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
      "k8s.io/client-go/kubernetes"
      "k8s.io/client-go/rest"
  )

func main() {
      // 获取集群的配置
      config, err := rest.InClusterConfig()
      if err != nil {
          panic(err.Error())
      }
      // 创建客户端
      clientset, err := kubernetes.NewForConfig(config)
      if err != nil {
          panic(err.Error())
      }

for {
          // 获取自定义资源
          exampleRes, err := clientset.CustomObjects().Get(context.TODO(), "myresources", "default", "example-res", metav1.GetOptions{})
          if err != nil {
              panic(err.Error())
          }

// 处理自定义资源
          handleCustomResource(exampleRes)

// 等待一段时间
          time.Sleep(1 * time.Second)
      }
  }

func handleCustomResource(obj map[string]interface{}) {
      name := obj["spec"].(map[string]interface{})["name"].(string)
      message := obj["spec"].(map[string]interface{})["message"].(string)
      fmt.Printf("Handling MyResource %s: %s\n", name, message)
  }
  ```

**3. 测试**
- **单元测试**：编写单元测试，确保控制器逻辑的正确性。
- **集成测试**：在 Kubernetes 集群中部署控制器，测试其与 API Server 的交互。

**4. 部署**
- **构建镜像**：将控制器打包为 Docker 镜像并推送到镜像仓库。
  ```sh
  docker build -t my-custom-controller:latest .
  docker push my-custom-controller:latest
  ```
- **创建 Deployment**：创建一个 Deployment 配置文件，部署控制器到 Kubernetes 集群。
  ```yaml
  apiVersion: apps/v1
  kind: Deployment
  metadata:
    name: my-custom-controller
  spec:
    replicas: 1
    selector:
      matchLabels:
        app: my-custom-controller
    template:
      metadata:
        labels:
          app: my-custom-controller
      spec:
        containers:
        - name: my-custom-controller
          image: my-custom-controller:latest
          ports:
          - containerPort: 8080
  ```

### 总结

通过定义 Custom Resources 和实现 Custom Controllers，可以扩展 Kubernetes 的功能，满足特定的业务需求。掌握 Kubernetes API 的编程范式，可以更高效地进行集群管理和应用部署。