Kubegres 源码解析(三) 从 main.go 到 Spec 默认值填充

// ----------------------- SPEC -------------------------------------------

// 用于描述 Postgres 实例
type KubegresDatabase struct {
    // 集群中每个 Postgres Pod 数据库所占据的存储空间大小, "Mi" 和 "Gi" 属于 Kubernetes 惯用法, 注意 "Mi" 是 1024*1024
    Size string `json:"size,omitempty"`
    // Postgres 容器中 pgdata 的挂载点. 也就是 PVC postgres-db-xx 的挂载位置
    VolumeMount string `json:"volumeMount,omitempty"`
    // 在 Dynamic Provisioning 中, StorageClass 用作创建 PV 的模板, 提供 provisioner 和 parameters.
    // 在 Static Provisioning 中, StorageClass 用作 PV 和 PVC 的绑定决策.
    // 如果未设置, 则使用默认的 StorageClass, 如果没有开启 DefaultStorageClass 的 Admission Plugin, 则就是 ""
    StorageClassName *string `json:"storageClassName,omitempty"`
}

// 用于描述 Postgres 备份
type KubegresBackUp struct {
    // 通过标准的 cron 格式来指定多久进行一次备份
    Schedule string `json:"schedule,omitempty"`
    // 在 docker 镜像中备份的存储位置, 一个用于备份的 Volume 会挂载到这个文件夹.
    VolumeMount string `json:"volumeMount,omitempty"`
    // PVC 定义备份的数据存储到哪个 Volume.
    PvcName string `json:"pvcName,omitempty"`
}

// 用于描述 Postgres 故障转移
type KubegresFailover struct {
    // 关闭 PostgresSql 集群的自动故障转移功能.
    // 如果为 true 则当一个 Primary 或 Replica PostgresSql 实例不在线 Kubegres 不会尝试故障转移和修复集群.
    // 在手动管理一个 node (重启, patching等) 的维护期间使用.
    IsDisabled bool `json:"isDisabled,omitempty"`
    // 允许手动将一个 Replica PostgresSql 推举为一个 Primary Pod.
    // 需要一个被期望推举为 Primary 的 Replica Pod 的 name 字段
    // 无论 failover.isDisabled true or false, 总是可以手动推举一个 Pod
    PromotePod string `json:"promotePod,omitempty"`
}

// 用于描述 Postgres 调度
type KubegresScheduler struct {
    // 自定义 Pod/Node affinity 策略
    Affinity *v1.Affinity `json:"affinity,omitempty"`
    // 自定义 tolerations 策略 (污点是否要 tolerated)
    Tolerations []v1.Toleration `json:"tolerations,omitempty"`
}

// PVC 模板
type VolumeClaimTemplate struct {
    Name string                       `json:"name,omitempty"`
    Spec v1.PersistentVolumeClaimSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}

// 用于描述 Volume
type Volume struct {
    // 允许 Postgres container(s) 挂载一个或多个 Volumes 的不同挂载点.
    VolumeMounts []v1.VolumeMount `json:"volumeMounts,omitempty"`
    // 允许声明可以被挂载到 Postgres container(s) 的一个或多个 Volumes.
    Volumes []v1.Volume `json:"volumes,omitempty"`
    // 允许使用 StorageClass 的 provisioner 自动为 Postgres container(s) 提供一个或多个 Volumes.
    VolumeClaimTemplates []VolumeClaimTemplate `json:"volumeClaimTemplates,omitempty"`
}

// 探针
type Probe struct {
    // 存活探针, 否则重启容器
    LivenessProbe *v1.Probe `json:"livenessProbe,omitempty"`
    // 是否准备好接入流量
    ReadinessProbe *v1.Probe `json:"readinessProbe,omitempty"`
}

// KubegresSpec 定义 Kubegres 的期望状态
type KubegresSpec struct {
    // 集群中的节点数量
    Replicas *int32 `json:"replicas,omitempty"`
    // 指定 Postgres Docker image, 建议使用 Docker 官方维护的版本, 12.4 及以上.
    Image string `json:"image,omitempty"`
    // Postgres docker container 公开的端口.
    Port int32 `json:"port,omitempty"`
    // 允许从私有 repo 中提取自定义 Postgres images.
    ImagePullSecrets []v1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
    // 允许设置 ConfigMap, 其中包含 Kubegres 所需的配置文件及内容.
    CustomConfig string           `json:"customConfig,omitempty"`
    Database     KubegresDatabase `json:"database,omitempty"`
    Failover     KubegresFailover `json:"failover,omitempty"`
    Backup       KubegresBackUp   `json:"backup,omitempty"`
    // 环境变量
    Env       []v1.EnvVar       `json:"env,omitempty"`
    Scheduler KubegresScheduler `json:"scheduler,omitempty"`
    // 定义 requests 和 limits
    Resources       v1.ResourceRequirements `json:"resources,omitempty"`
    Volume          Volume                  `json:"volume,omitempty"`
    SecurityContext *v1.PodSecurityContext  `json:"securityContext,omitempty"`
    Probe           Probe                   `json:"probe,omitempty"`
}