kube-green

项目介绍

有多少开发/预览环境的Pod在周末或夜间仍在运行？这无疑是对资源和资金的浪费！别担心，kube-green正是为此而生。

kube-green是一个简单的Kubernetes插件，能够在您不需要资源时自动关闭（部分）资源，从而节省资源和成本。

如果您正在使用kube-green，欢迎将您的组织添加为采用者！

部署

Docker镜像部署

kube-green控制器可通过Docker镜像部署在Kubernetes集群中。以下是使用Docker镜像在K8s集群中部署kube-green控制器的示例：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kube-green-controller
  namespace: kube-green
spec:
  replicas: 1
  selector:
    matchLabels:
      app: kube-green
  template:
    metadata:
      labels:
        app: kube-green
    spec:
      serviceAccountName: kube-green-controller
      containers:
      - name: kube-green
        image: kube-green/kube-green:latest  # 替换为具体版本标签
        args:
        - --metrics-addr=:8080
        - --enable-leader-election
        resources:
          limits:
            cpu: 100m
            memory: 128Mi
          requests:
            cpu: 10m
            memory: 64Mi

注：完整部署需包含RBAC权限配置（ServiceAccount、ClusterRole、ClusterRoleBinding），详情请参考***安装文档。

开发环境部署

如需本地开发，可使用ko部署到KinD集群：

1. 创建KinD集群：kind create cluster --name kube-green-development
2. 部署kube-green：make local-run clusterName=kube-green-development

使用方法

安装后，通过配置CRD（CustomResourceDefinition）SleepInfo来定义资源休眠规则。

CRD配置说明

SleepInfo CRD用于定义资源的休眠策略，主要字段说明：

• weekdays：指定星期几应用规则（如"1-5"表示周一至周五，"*"表示每天）
• sleepAt：休眠时间（如"20:00"）
• wakeUpAt：唤醒时间（如"08:00"，不指定则仅休眠不唤醒）
• timeZone：时区（如"Europe/Rome"）
• suspendCronJobs：是否暂停CronJob（true/false）
• excludeRef：排除的资源（如特定Deployment）

CRD示例

工作时间运行（欧洲/罗马时区）

仅在工作日运行Pod，暂停CronJob，排除名为api-gateway的Deployment：

yaml
apiVersion: kube-green.com/v1alpha1
kind: SleepInfo
metadata:
  name: working-hours
spec:
  weekdays: "1-5"  # 周一至周五（1=周一，5=周五）
  sleepAt: "20:00"  # 20:00休眠
  wakeUpAt: "08:00"  # 08:00唤醒
  timeZone: "Europe/Rome"  # 时区
  suspendCronJobs: true  # 暂停CronJob
  excludeRef:
    - apiVersion: "apps/v1"
      kind:       Deployment
      name:       api-gateway  # 排除此Deployment

夜间休眠不唤醒

每天夜间休眠，不设置唤醒时间（需手动唤醒）：

yaml
apiVersion: kube-green.com/v1alpha1
kind: SleepInfo
metadata:
  name: working-hours-no-wakeup
spec:
  sleepAt: "20:00"  # 20:00休眠
  timeZone: "Europe/Rome"  # 时区
  weekdays: "*"  # 每天应用

更多示例请参考***文档。

贡献

请阅读CONTRIBUTING.md了解代码规范和PR提交流程。

版本控制

采用SemVer语义化版本控制，版本列表见GitHub Releases。

许可证

本项目基于MIT许可证，详情见LICENSE文件。

致谢

特别感谢JGiola的技术评审。

采用者

查看采用者列表，如使用kube-green，欢迎添加您的组织！