CRD References

Resource Types

• MogdbCluster
• MogdbBackup

MogdbCluster

MogdbCluster is a simple summary of the MogdbCluster API.

Name	Type	Description	Required option
apiVersion	string	mogdb.enmotech.io/v1	true
kind	string	MogdbCluster	true
metadata	object	Related fields refer to the Kubernetes API documentation	true
spec	object	The desired state of MogdbCluster	false
status	object	The state observed by MogdbCluster	false

MogdbCluster.spec

MogdbClusterSpec defines the desired state of MogdbCluster

Name	Type	Description	Required option
replicas	integer	The number of replicas expected by MogdbCluster	true
readPort	integer	Read-only service port	true
writePort	integer	Read and write service port	true
postgresConf	object	MogDB configuration file configuration items	false
podSpec	object	Desired state of the cluster pod	false
backup	object	Automatic backup configuration	false
Restore	object	Backup and restoration configuration	false
DataSource	object	Backup and restoration data source	false
Paused	bool	Whether to pause a cluster	false
EnableHa	bool	Whether to enable HA	false

MogdbCluster.spec.podSpec

Name	Type	Description	Required option
mogdbVersion	string	MogDB database version	false
image	string	MogDB image	false
sidecarImage	string	Sidecar image	false
SidecarHaImage	string	sidecarha image	false
initImage	string	Init image	false
volumeSpec	object	Volume type configuration	false
logVolumeSpec	object	Log volume type configuration	false
backupVolumeSpec	object	Backup volume type configuration	false
imagePullPolicy	string	Image pulling strategy	false
imagePullSecrets	[]string	Image pull secrets	false
labels	map[string]string	Custom labels	false
annotations	map[string]string	Custom Comments	false
resources	object	Resource Limits	false
affinity	object	Affinity setting	false
nodeSelector	map[string]string	Node selector	false
priorityClassName	string	Priority class name setting	false
tolerations	[]object	Tolerance setting	false
serviceAccountName	string	Service account name	false
volumes	[]object	Additional volume settings	false
volumeMounts	[]object	volume mount setting	false
initContainers	[]object	Additional initialization container setting	false
containers	[]object	Additional container setting	false
sidecarResources	object	sidecar container resource limits	false

MogdbCluster.spec.podSpec.volumeSpec

Name	Type	Description	Required option
emptyDir	object	Volume of type emptyDir	false
hostPath	object	Volume of type hostPath	false
persistentVolumeClaim	object	pvc volume statement	false

MogdbCluster.spec.Backup

Name	Type	Description	Required Option
Image	string	Backup image	false
GSBaseBackup	object	Physical backup	false
GSDumpAll	object	Logical backup	false

MogdbCluster.spec.Backup.GSBaseBackup

Name	Type	Description	Required Option
Name	string	Backup container name	false
BackupSchedules	object	Backup strategy	false
BackupScheduleHistoryLimit	integer	Maximum historical amount that is kept	false
S3	object	s3 storage configuration	false

MogdbCluster.spec.Backup.GSBaseBackup.S3

NameType		Description	Required Option
region	string	Region	false
secretName	string	Access key	true
provider	string	s3 storage provider	true
endPoint	string	Node	true
bucket	string	Storage bucket	true

MogdbCluster.spec.Backup.GSDumpAll

Name	Type	Description	Required Option
Name	string	Backup container name	false
BackupSchedules	object	Backup strategy	false
BackupScheduleHistoryLimit	integer	Maximum historical amount that is kept	false
S3	object	s3 storage configuration	false

MogdbCluster.spec.Backup.GSDumpAll.S3

Name	Type	Description	Required Option
region	string	Region	false
secretName	string	Access key	true
provider	string	s3 storage provider	true
endPoint	string	Node	true
bucket	string	Storage bucket	true

MogdbCluster.spec.Restore

Name	Type	Description	Required Option
RestoreId	string	Restoration ID	false
Image	string	Image	false
ClusterName	string	Target cluster name	false
GSBaseBackupSource	object	Physical backup configuration	false
GSDumpAllSource	object	Logical backup configuration	false

MogdbCluster.spec.Restore.GSBaseBackupSource

Name	Type	Description	Required Option
Type	string	Restoration type	false
Target	string	Object to be restored	false

MogdbCluster.spec.Restore.GSDumpAllSource

Name	Type	Description	Required Option
Type	string	Restoration type	false
Target	string	Object to be restored	false

MogdbCluster.status

Name	Type	Description	Required option
readyNodes	integer	Number of nodes in ready status	true
conditions	[]object	Cluster condition	true
nodes	[]object	Node condition	true
RestoreStatus	object	Restoration condition	true
BackupStatus	object	Backup condition	true
StartupInstance	string	Startup	true
FirstInstance	string	First instance	true
HaService	string	HA service	true

MogdbCluster.status.conditions

Name	Type	Description	Required option
type	string	Condition type	true
status	string	Status of the condition	true
lastTransitionTime	time	When the condition occurred	true
reason	string	The reason for the condition	true
message	string	Condition message	true

MogdbCluster.status.RestoreStatus

Name	Type	Description	Required Option
id	string	Restoration ID	true
finished	bool	Whether it has been finished	true
startTime	time	Start time	true
completionTime	time	Completion time	true
active	integer	Amount in active status	true
succeeded	integer	Amount in successful status	true
Failed	integer	Amount in failed status	true

MogdbCluster.status.BackupStatus

Name	Type	Description	Required Option
ManualBackups	[]object	Manual backup	true
ScheduledBackups	[]object	Automatic backup	true

MogdbCluster.status.BackupStatus.ManualBackups

Name	Type	Description	Required Option
name	string	Backup name	true
backupType	string	Backup type	true
backupLevel	string	Backup level	true
backupFile	string	Backup file	true
startTime	time	Start time	true
completionTime	time	Completion time	true
active	integer	Amount in active status	true
succeeded	integer	Amount in successful status	true
failed	integer	Amount in failed status	true
finished	bool	Whether it has been finished	true

MogdbCluster.status.BackupStatus.ScheduledBackups

Name	Type	Description	Required Option
name	string	Backup name	true
backupType	string	Backup type	true
backupLevel	string	Backup level	true
backupFile	string	Backup file	true
startTime	time	Start time	true
completionTime	time	Completion time	true
active	integer	Amount in active status	true
succeeded	integer	Amount in successful status	true
failed	integer	Amount in failed status	true
finished	bool	Whether it has been finished	true

MogdbCluster.status.nodes

Name	Type	Description	Required option
name	string	Name of the cluster node state	true
conditions	[]object	Node condition collection	true

MogdbCluster.status.nodes.conditions

Name	Type	Description	Required option
type	string	Condition type	true
status	string	Status of the condition	true
lastTransitionTime	time	When the condition occurred	true

MogdbBackup

MogdbBackup is a simple summary of the MogdbBackup API

Name	Type	Description	Required option
apiVersion	string	mogdb.enmotech.io/v1	true
kind	string	MogdbBackup	true
metadata	object	Related fields refer to the Kubernetes API documentation	true
spec	object	Desired state of MogdbBackup	false
status	object	The state observed by MogdbBackup	false

MogdbBackup.spec

Name	Type	Description	Required Option
clusterName	string	MogDB cluster name	true
image	string	Number of days for backup kept	false
baseBackup	object	Physical backup configuration	false
dumpAll	object	Logical backup configuration	false

MogdbBackup.spec.BaseBackup

Name	Type	Description	Required Option
name	string	Backup name	true
backupLevel	string	Backup level	false
fileName	string	Backup file name	false
dbName	string	Database to be backed up	false
tbNames	[]string	Table to be backed up	false
s3	object	s3 object storage configuration	false

MogdbBackup.spec.BaseBackup.S3

Name	Type	Description	Required Option
region	string	Region	false
secretName	string	Access key	true
provider	string	s3 storage provider	true
endPoint	string	Node	true
bucket	string	Storage bucket	true

MogdbBackup.spec.dumpAll

Name	Type	Description	Required Option
name	string	Backup name	true
backupLevel	string	Backup level	false
fileName	string	Backup file name	false
dbName	string	Database to be backed up	false
tbNames	[]string	Table to be backed up	false
s3	object	s3 object storage configuration	false

MogdbBackup.spec.dumpAll.S3

Name	Type	Description	Required Option
region	string	Region	false
secretName	string	Access key	true
provider	string	s3 storage provider	true
endPoint	string	Node	true
bucket	string	Storage bucket	true

MogdbBackup.status

Name	Type	Description	Required Option
completed	bool	Whether the backup is finished	true
completedTimestamp	time	When the backup is finished	true
conditions	[]object	Backup condition list	true

MogdbBackup.status.conditions

Name	Type	Description	Required Option
type	string	Condition type	true
status	string	Condition status	true
lastTransitionTime	time	When the condition generates.	true
reason	string	Reason why the condition generates	true
message	string	Condition details	true