yametech/nuwa-controller

Nuwa

概述

Nuwa作为云平台的数据平面工具，旨在解决Kubernetes原生Deployment和Statefulset在部署策略上的局限性。原生资源仅提供基础发布策略，无法满足跨机房发布、分组批量发布、Deployment缺乏步骤控制等场景需求。Nuwa支持有状态资源（Stone）和无状态资源（Water）部署，并具备动态资源注入（Injector）能力。

核心功能与特性

• 多区域部署：可精确到区域内机架中的特定机器
• 精细部署策略：支持多种发布阶段控制，降低发布风险
• 分组批量部署：按分组进行分阶段发布
• 蓝绿部署与金丝雀部署：支持流量切换和风险控制的高级发布模式
• 双类型资源支持：同时支持有状态（Stone）和无状态（Water）资源部署
• 动态注入：支持日志收集、配置文件、跟踪代理等组件的动态注入

安装要求

• Kubernetes集群版本需≥1.15.x

使用方法

1. 节点标签配置

需为Kubernetes节点添加区域、机架和主机标签，用于Nuwa的地理位置部署控制：

shell
kubectl label nodes node2 nuwa.io/zone=A nuwa.io/rack=W-01 nuwa.io/host=node1 --overwrite
kubectl label nodes node3 nuwa.io/zone=A nuwa.io/rack=S-02 nuwa.io/host=node2 --overwrite
kubectl label nodes node4 nuwa.io/zone=B nuwa.io/rack=W-01 nuwa.io/host=node3 --overwrite
kubectl label nodes node5 nuwa.io/zone=B nuwa.io/rack=S-02 nuwa.io/host=node4 --overwrite

2. 安装Nuwa CRD资源

通过以下命令安装Nuwa自定义资源定义：

shell
kubectl apply -f https://github.com/yametech/nuwa/releases/download/v1.0.0/release.yaml

Water资源（无状态部署）

功能概述

基于Kubernetes原生Deployment的高级实现，主要特性包括：

1. 支持地理位置部署，可精确到区域内机架中的特定机器
2. 支持精细部署策略：Alpha、Beta、Release

部署策略说明

部署策略设计用于降低因Pod错误导致的服务抖动风险，通过分阶段发布并确认的方式控制发布节奏：

• Alpha：随机选择一个节点部署单个Pod，等待用户确认是否存在错误
• Beta：在每个Node上部署Pod
• Release：全量部署

Water资源使用示例

yaml
apiVersion: nuwa.nip.io/v1
kind: Water
metadata:
  name: water-sample
spec:
  strategy: Release  # 部署策略：Alpha/Beta/Release
  template:
    metadata:
      name: water-sample
      labels:
        app: water-sample
    spec:
      containers:
        - name: cn-0
          image: nginx:latest
          imagePullPolicy: IfNotPresent
  service:  # 可选：创建关联Service
    ports:
      - name: default-web-port
        protocol: TCP
        port: 80
        targetPort: 80
    type: NodePort
  coordinates:  # 地理位置部署配置
    - zone: A
      rack: W-01
      host: node1
      replicas: 1  # 该位置部署副本数
    - zone: A
      rack: S-02
      host: node2
      replicas: 1
    - zone: B
      rack: W-01
      host: node3
      replicas: 1
    - zone: B
      rack: S-02
      host: node4
      replicas: 1

Stone资源（有状态部署）

功能概述

基于Kubernetes原生Statefulset的高级实现，主要特性包括：

1. 支持地理位置发布，可精确到区域内机架中的特定机器
2. 支持分组部署策略（因需挂载磁盘）：Alpha、Beta、Omega、Release

部署策略说明

• Alpha：从分组中选择一个并发布1个Pod
• Beta：选择一个（多组/单组）发布1个Pod
• Omega：选择多个组并在每台机器上发布1个Pod
• Release：全量发布

Stone资源使用示例

yaml
apiVersion: nuwa.nip.io/v1
kind: Stone
metadata:
  name: stone-example
spec:
  strategy: Release  # 部署策略：Alpha/Beta/Omega/Release
  template:
    metadata:
      name: sample
      labels:
        app: stone-example
    spec:
      containers:
        - name: cn-0
          image: nginx:alpine
          imagePullPolicy: IfNotPresent
  service:  # 可选：创建关联Service
    ports:
      - name: default-web-port
        protocol: TCP
        port: 80
        targetPort: 80
    type: NodePort
  coordinates:  # 分组部署配置
    - group: A  # 分组名称
      replicas: 3  # 该组总副本数
      zoneset:  # 该组包含的地理位置
      - zone: A
        rack: W-01
        host: node1
      - zone: A
        rack: S-02
        host: node2
    - group: B
      replicas: 2
      zoneset:
      - zone: B
        rack: W-01
        host: node3
      - zone: B
        rack: S-02
        host: node4

Injector资源（动态注入）

功能概述

基于CRD+Sidecar实现的动态注入机制，允许用户动态注入日志收集、配置文件、跟踪代理等组件。支持在业务容器之前或之后注入，可与Water和Stone资源结合使用。当Water资源被删除时，对应的Injector资源会自动垃圾回收。

与Water资源结合使用示例

yaml
# Water资源定义
apiVersion: nuwa.nip.io/v1
kind: Water
metadata:
  name: water-sample
spec:
  strategy: Release
  template:
    metadata:
      name: sample
      labels:
        app: water-sample  # 需与Injector的selector匹配
    spec:
      containers:
        - name: cn-0
          image: nginx:latest
          imagePullPolicy: IfNotPresent
  service:
    ports:
      - name: default-web-port
        protocol: TCP
        port: 80
        targetPort: 80
    type: NodePort
  coordinates:
    - zone: A
      rack: W-01
      host: node1
      replicas: 2
    - zone: A
      rack: S-02
      host: node2
      replicas: 0
    - zone: B
      rack: W-01
      host: node3
      replicas: 0
    - zone: B
      rack: S-02
      host: node4
      replicas: 0
---
# Injector资源定义（在业务容器前注入busybox容器）
apiVersion: nuwa.nip.io/v1
kind: Injector
metadata:
  name: water-sample
spec:
  namespace: ${CURRENT_NAMESPACE}  # 当前命名空间
  name: water-sample  # 关联的Water资源名称
  resourceType: Water  # 关联资源类型
  selector:  # 匹配目标Pod的标签
    matchLabels:
      app: water-sample
  preContainers:  # 在业务容器前注入的容器
    - name: count
      image: busybox
      args:
        - /bin/sh
        - -c
        - >
          i=0;
          while true;
          do
            echo "$i: $(date)" >> /var/log/1.log;
            echo "$(date) INFO $i" >> /var/log/2.log;
            i=$((i+1));
            sleep 1;
          done
      volumeMounts:
        - name: varlog
          mountPath: /var/log
  volumes:  # 注入容器使用的存储卷
    - name: varlog
      emptyDir: {}

适用场景

• 需要跨机房/多区域部署的应用
• 对发布风险敏感，需分阶段验证的生产环境
• 需要按业务分组进行差异化部署的场景
• 有状态服务（如数据库）的精细化部署需求
• 需要动态注入辅助组件（日志、监控、跟踪）的应用