uofa/shepherd-operator

Shepherd Operator

镜像概述和主要用途

Shepherd Operator是一个提供Kubernetes operators的项目，用于控制环境的备份与恢复功能。该项目使用Go语言开发，并基于https://github.com/kubernetes-sigs/kubebuilder%E6%A1%86%E6%9E%B6%E6%9E%84%E5%BB%BA%E3%80%82

注意：Kubebuilder v2版本与Shepherd运行的OpenShift版本不兼容。

核心功能和特性

• 提供Kubernetes operators实现环境备份与恢复控制
• 支持通过Shepherd的Drupal UI创建Backup和Restore对象
• 支持通过Kubernetes清单文件定义备份和恢复配置
• 可备份PVC卷数据和MySQL数据库数据
• 提供备份/恢复状态跟踪（包括开始时间、完成时间、状态阶段等）

使用场景和适用范围

• 需要对Kubernetes环境中的应用数据（包括卷和数据库）进行定期备份的场景
• 需要通过UI或Kubernetes原生方式触发环境恢复的场景
• Shepherd平台管理员进行环境数据管理和灾难恢复的需求

使用方法和配置说明

通过Shepherd UI使用

Shepherd已与该operator集成，管理员可通过Drupal UI创建新的Backup和Restore对象，实现可视化的备份与恢复操作。

通过Kubernetes清单使用

可通过创建类似以下示例的清单文件来定义备份/恢复对象。示例说明：

• site和environment标签用于Shepherd在UI中查询和显示这些对象
• volumes包含要备份的每个PVC的唯一名称和claimName
• mysql包含要备份的每个数据库的唯一名称和secret，secret.keys属性用于operator将环境变量挂载到运行SQL转储/恢复的容器中，以连接数据库

yaml
apiVersion: extension.shepherd/v1
kind: Backup
metadata:
  name: node-123-backup-xyz
  labels:
    site: 456
    environment: 123
spec:
  volumes:
    shared:
      claimName: node-123-shared
  mysql:
    default:
      secret:
        name: node-123
        keys:
          username: DATABASE_USER
          password: DATABASE_PASSWORD
          database: DATABASE_NAME
          hostname: DATABASE_HOST
          port: DATABASE_PORT
status:
  startTime: '2018-11-21T00:16:23Z'
  completionTime: '2018-11-21T00:16:43Z'
  resticId: abcd969xcz
  phase: New|InProgress|Failed|Completed

Containers

TODO

集群设置

1. 按要求配置命名空间（用于RBAC规则，本地开发默认为'myproject'）：

   bash
   export NAMESPACE=shepherd-dev
   make kustomize
   

2. 安装CRD和RBAC：

   bash
   make install
   

3. 为需要创建Backup/Restore对象的账户配置RBAC规则（如shepherd服务账户）：

   bash
   oc create clusterrole shepherd-backups --verb=get,list,create,update,delete --resource=backups,restores
   oc adm policy add-cluster-role-to-user shepherd-backups --serviceaccount=shepherd
   

开发

代码库使用Go语言开发，并基于Kubebuilder框架。

• https://github.com/alco/gostart
• https://github.com/kubernetes-sigs/kubebuilder

operator的核心逻辑位于：

• pkg/controller/backup/backup_controller.go中的Reconcile()函数
• pkg/controller/restore/restore_controller.go中的Reconcile()函数

开发入门

开始开发此operator前，请确保满足以下先决条件：

• 本地运行的minishift VM
• 安装Go >=1.10
• 推荐使用VSCode或Goland等IDE 👍

1. 将仓库克隆到$GOPATH/src/github.com/universityofadelaide/shepherd-operator
2. 以集群管理员身份登录：oc login -u system:admin
3. 运行make install在本地OpenShift中设置CRD
4. 运行make run编译本地工作区并运行operator（保持运行状态以进行后续步骤）
5. 通过Shepherd UI备份环境
6. 运行oc get jobs检查创建的作业