CRD 参考

资源类型

• MogdbCluster
• MogdbBackup

MogdbCluster

MogdbCluster是MogdbCluster API的简单概要

名称	类型	描述	必选项
apiVersion	string	mogdb.enmotech.io/v1	true
kind	string	MogdbCluster	true
metadata	object	相关字段参考 Kubernetes API文档	true
spec	object	定义MogdbCluster期望的状态	false
status	object	定义MogdbCluster观测到的状态	false

MogdbCluster.spec

MogdbClusterSpec 定义MogdbCluster期望的状态

名称	类型	描述	必选项
replicas	integer	MogdbCluster期望的副本数	true
readPort	integer	只读service端口	true
writePort	integer	读写service端口	true
postgresConf	object	MogDB配置文件配置项	false
podSpec	object	集群pod期望的状态	false
backup	object	自动备份配置	false
Restore	object	备份恢复配置	false
DataSource	object	备份恢复数据源	false
Paused	bool	是否暂停	false
EnableHa	bool	是否开启ha	false

MogdbCluster.spec.podSpec

名称	类型	描述	必选项
mogdbVersion	string	MogDB数据库的版本	false
image	string	MogDB镜像	false
sidecarImage	string	sidecar镜像	false
SidecarHaImage	string	sidecarha镜像	false
initImage	string	init镜像	false
volumeSpec	object	volume类型配置	false
logVolumeSpec	object	日志volume类型配置	false
backupVolumeSpec	object	备份volume类型配置	false
imagePullPolicy	string	镜像拉取策略	false
imagePullSecrets	[]string	镜像拉取秘钥	false
labels	map[string]string	自定义label	false
annotations	map[string]string	自定义注释	false
resources	object	资源限额	false
affinity	object	亲和性设置	false
nodeSelector	map[string]string	节点选择器	false
priorityClassName	string	优先级类名设置	false
tolerations	[]object	容忍性设置	false
serviceAccountName	string	服务账户名称	false
volumes	[]object	额外的volume设置	false
volumeMounts	[]object	volume挂载设置	false
initContainers	[]object	额外的初始化容器设置	false
containers	[]object	额外的容器设置	false
sidecarResources	object	sidecar容器资源限额	false

MogdbCluster.spec.podSpec.volumeSpec

名称	类型	描述	必选项
emptyDir	object	emptyDir类型的卷	false
hostPath	object	hostPath类型的卷	false
persistentVolumeClaim	object	pvc卷声明	false

MogdbCluster.spec.Backup

名称	类型	描述	必选项
Image	string	备份镜像	false
GSBaseBackup	object	物理备份	false
GSDumpAll	object	逻辑备份	false

MogdbCluster.spec.Backup.GSBaseBackup

名称	类型	描述	必选项
Name	string	备份容器名称	false
BackupSchedules	object	备份策略	false
BackupScheduleHistoryLimit	integer	保留历史自大数量	false
S3	object	s3存储配置	false

MogdbCluster.spec.Backup.GSBaseBackup.S3

名称	类型	描述	必选项
region	string	regin	false
secretName	string	访问密钥	true
provider	string	s3存储提供者	true
endPoint	string	节点	true
bucket	string	存储桶	true

MogdbCluster.spec.Backup.GSDumpAll

名称	类型	描述	必选项
Name	string	备份容器名称	false
BackupSchedules	object	备份策略	false
BackupScheduleHistoryLimit	integer	保留历史自大数量	false
S3	object	s3存储配置	false

MogdbCluster.spec.Backup.GSDumpAll.S3

名称	类型	描述	必选项
region	string	regin	false
secretName	string	访问密钥	true
provider	string	s3存储提供者	true
endPoint	string	节点	true
bucket	string	存储桶	true

MogdbCluster.spec.Restore

名称	类型	描述	必选项
RestoreId	string	恢复标识ID	false
Image	string	镜像	false
ClusterName	string	目标集群名称	false
GSBaseBackupSource	object	恢复物理备份配置	false
GSDumpAllSource	object	恢复逻辑备份配置	false

MogdbCluster.spec.Restore.GSBaseBackupSource

名称	类型	描述	必选项
Type	string	恢复类型	false
Target	string	恢复对象	false

MogdbCluster.spec.Restore.GSDumpAllSource

名称	类型	描述	必选项
Type	string	恢复类型	false
Target	string	恢复对象	false

MogdbCluster.status

名称	类型	描述	必选项
readyNodes	integer	处于ready节点的个数	true
conditions	[]object	集群状况	true
nodes	[]object	节点状况	true
RestoreStatus	object	恢复状况	true
BackupStatus	object	备份状况	true
StartupInstance	string	开始实现	true
FirstInstance	string	第一次实现	true
HaService	string	ha服务	true

MogdbCluster.status.conditions

名称	类型	描述	必选项
type	string	状况类型	true
status	string	状况的状态	true
lastTransitionTime	time	状况发生的时间	true
reason	string	状况的原因	true
message	string	状况信息	true

MogdbCluster.status.RestoreStatus

名称	类型	描述	必选项
id	string	恢复ID	true
finished	bool	是否已经结束	true
startTime	time	开始时间	true
completionTime	time	完成时间	true
active	integer	进行中数量	true
succeeded	integer	成功数量	true
Failed	integer	失败数量	true

MogdbCluster.status.BackupStatus

名称	类型	描述	必选项
ManualBackups	[]object	手动备份	true
ScheduledBackups	[]object	自动备份	true

MogdbCluster.status.BackupStatus.ManualBackups

名称	类型	描述	必选项
name	string	备份名称	true
backupType	string	备份类型	true
backupLevel	string	备份级别	true
backupFile	string	备份文件	true
startTime	time	开始时间	true
completionTime	time	结束时间动	true
active	integer	进行中数量	true
succeeded	integer	成功数量	true
failed	integer	失败数量	true
finished	bool	是否已经结束	true

MogdbCluster.status.BackupStatus.ScheduledBackups

名称	类型	描述	必选项
name	string	备份名称	true
backupType	string	备份类型	true
backupLevel	string	备份级别	true
backupFile	string	备份文件	true
startTime	time	开始时间	true
completionTime	time	结束时间动	true
active	integer	进行中数量	true
succeeded	integer	成功数量	true
failed	integer	失败数量	true
finished	bool	是否已经结束	true

MogdbCluster.status.nodes

名称	类型	描述	必选项
name	string	集群节点状态的名称	true
conditions	[]object	节点状况集合	true

MogdbCluster.status.nodes.conditions

名称	类型	描述	必选项
type	string	状况类型	true
status	string	状况的状态	true
lastTransitionTime	time	状况发生的时间	true

MogdbBackup

MogdbBackup是MogdbBackup API的简单概要

名称	类型	描述	必选项
apiVersion	string	mogdb.enmotech.io/v1	true
kind	string	MogdbBackup	true
metadata	object	相关字段参考 Kubernetes API文档	true
spec	object	定义MogdbBackup期望的状态	false
status	object	定义MogdbBackup观测到的状态	false

MogdbBackup.spec

名称	类型	描述	必选项
clusterName	string	MogDB cluster集群名称	true
image	string	备份历史保留天数	false
baseBackup	object	物理备份配置	false
dumpAll	object	逻辑备份配置	false

MogdbBackup.spec.BaseBackup

名称	类型	描述	必选项
name	string	备份名称	true
backupLevel	string	备份级别	false
fileName	string	备份文件名称	false
dbName	string	指定备份数据库	false
tbNames	[]string	指定备份表格	false
s3	object	s3对象存储配置	false

MogdbBackup.spec.BaseBackup.S3

名称	类型	描述	必选项
region	string	regin	false
secretName	string	访问密钥	true
provider	string	s3存储提供者	true
endPoint	string	节点	true
bucket	string	存储桶	true

MogdbBackup.spec.dumpAll

名称	类型	描述	必选项
name	string	备份名称	true
backupLevel	string	备份级别	false
fileName	string	备份文件名称	false
dbName	string	指定备份数据库	false
tbNames	[]string	指定备份表格	false
s3	object	s3对象存储配置	false

MogdbBackup.spec.dumpAll.S3

名称	类型	描述	必选项
region	string	regin	false
secretName	string	访问密钥	true
provider	string	s3存储提供者	true
endPoint	string	节点	true
bucket	string	存储桶	true

MogdbBackup.status

名称	类型	描述	必选项
completed	bool	备份是否完成	true
completedTimestamp	time	备份完成的时间	true
conditions	[]object	备份状况列表	true

MogdbBackup.status.conditions

名称	类型	描述	必选项
type	string	状况类型	true
status	string	状况的状态	true
lastTransitionTime	time	状况发生的时间	true
reason	string	状况发生的原因	true
message	string	状况详情	true