signadot/operator

Signadot Kubernetes Operator 镜像文档

概述

Signadot Kubernetes Operator 是专为在 Kubernetes 集群中管理 Signadot 相关资源设计的操作器（Operator）。它基于 Kubernetes Operator 模式，通过自定义资源定义（CRD）扩展 Kubernetes API，实现对 Signadot 资源的声明式管理，自动化完成 Signadot 功能的部署、配置、升级及生命周期维护，降低用户在 Kubernetes 环境中使用 Signadot 的复杂度。

核心功能和特性

• 自定义资源管理：提供 Signadot 相关的自定义资源定义（CRD），支持通过 Kubernetes API 声明式创建、更新和删除 Signadot 资源（如环境、路由规则等）。
• 自动化运维：自动处理 Signadot 资源的部署、版本升级、故障回滚及生命周期管理，减少手动操作成本。
• 配置集成：与 Kubernetes 原生配置机制（ConfigMap、Secret）深度集成，安全管理 Signadot 所需的配置参数和敏感信息。
• 状态监控：实时监控 Signadot 资源的运行状态，通过 Kubernetes 事件和资源状态字段反馈健康状况，便于问题排查。
• 版本兼容性：兼容主流 Kubernetes 版本（1.19+），确保在不同集群环境中的稳定运行。

使用场景和适用范围

• 微服务开发与测试：在 Kubernetes 环境中开发或测试微服务时，快速配置和管理 Signadot 提供的环境隔离、流量路由等功能，提升开发测试效率。
• 规模化部署 Signadot：适用于需要在多 Kubernetes 集群或多命名空间中统一部署、管理 Signadot 功能的团队，提供标准化资源管理入口。
• DevOps 流程集成：无缝融入 CI/CD 流水线，实现 Signadot 资源的自动化部署与更新，支持微服务迭代的快速验证。

使用方法和配置说明

前提条件

• Kubernetes 集群版本 1.19 及以上
• kubectl 命令行工具（已配置集群访问权限）
• （可选）Helm 3.0+（如需通过 Helm 安装）

安装步骤

方法 1：通过 YAML 清单安装

1. 部署 Signadot Operator CRD 和控制器：

   bash
   # 安装 CRD
   kubectl apply -f https://github.com/signadot/operator/releases/latest/download/signadot-crds.yaml
   # 安装 Operator 控制器
   kubectl apply -f https://github.com/signadot/operator/releases/latest/download/signadot-operator.yaml
   

2. 验证安装状态：

   bash
   # 检查 CRD 是否创建成功
   kubectl get crd | grep signadot.com
   # 检查 Operator 控制器 Pod 状态
   kubectl get pods -n signadot-operator -l app=signadot-operator
   

方法 2：通过 Helm Chart 安装

1. 添加 Signadot Helm 仓库：

   bash
   helm repo add signadot https://signadot.github.io/helm-charts
   helm repo update
   

2. 安装 Operator：

   bash
   helm install signadot-operator signadot/signadot-operator \
     --namespace signadot-operator \
     --create-namespace \
     --version latest
   

配置说明

环境变量配置

Operator 控制器支持通过环境变量调整运行参数，常见配置如下：

自定义资源（CR）配置示例

以 SignadotEnvironment 资源为例，创建 Signadot 环境的配置示例：

yaml
apiVersion: signadot.com/v1alpha1
kind: SignadotEnvironment
metadata:
  name: dev-environment
  namespace: default
spec:
  # 环境名称（Signadot 系统中唯一）
  envName: "dev-team-env"
  # 关联的 Kubernetes 命名空间（资源部署目标）
  targetNamespace: "dev-team"
  # 资源限制配置
  resources:
    cpu: "200m"       # CPU 限制
    memory: "512Mi"   # 内存限制
  # 流量路由配置
  routing:
    enabled: true     # 启用流量路由
    priority: 100     # 路由优先级（值越高优先级越高）

部署示例

创建 Signadot 环境资源

通过 kubectl apply 创建自定义资源：

bash
kubectl apply -f - <<EOF
apiVersion: signadot.com/v1alpha1
kind: SignadotEnvironment
metadata:
  name: staging-env
  namespace: default
spec:
  envName: "staging"
  targetNamespace: "staging"
  resources:
    cpu: "500m"
    memory: "1Gi"
  routing:
    enabled: true
    priority: 50
EOF

查看资源状态

bash
# 列出所有 SignadotEnvironment 资源
kubectl get signadotenvironments.signadot.com -o wide
# 查看资源详情（包含状态和事件）
kubectl describe signadotenvironment staging-env

卸载步骤

bash
# 通过 YAML 安装的卸载
kubectl delete -f https://github.com/signadot/operator/releases/latest/download/signadot-operator.yaml
kubectl delete -f https://github.com/signadot/operator/releases/latest/download/signadot-crds.yaml

# 通过 Helm 安装的卸载
helm uninstall signadot-operator -n signadot-operator
kubectl delete namespace signadot-operator