Klio Catalog API reference v0.0.12
This is documentation for a Tech Preview of EDB's Enterprise Data Protection for CloudNativePG™ (Klio) solution. It is made available AS IS for testing and early evaluation purposes ONLY! Is is not to be used in production environments. For details, please refer to EULA section 9.4.
Packages
kliocatalog.enterprisedb.io/v1alpha1
Package v1alpha1 the Klio Catalog API
Resource Types
KlioBackup
KlioBackup is the Schema for a Klio Backup API.
Appears in:
| Field | Description | Required | Default | Validation |
|---|---|---|---|---|
apiVersion string | kliocatalog.enterprisedb.io/v1alpha1 | True | ||
kind string | KlioBackup | True | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | True | ||
spec KlioBackupSpec | True | |||
status KlioBackupStatus | Optional: {} |
KlioBackupList
KlioBackupList contains a list of KlioBackup.
| Field | Description | Required | Default | Validation |
|---|---|---|---|---|
apiVersion string | kliocatalog.enterprisedb.io/v1alpha1 | True | ||
kind string | KlioBackupList | True | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | True | ||
items KlioBackup array | True |
KlioBackupSpec
KlioBackupSpec defines the desired state of a KlioBackup.
Appears in:
| Field | Description | Required | Default | Validation |
|---|---|---|---|---|
clusterName string | ClusterName is the name of the cluster that has been backed up | True | ||
backupID string | BackupID is the unique identifier of the backup | True |
KlioBackupStatus
KlioBackupStatus defines the observed state of a KlioBackup.
Appears in:
| Field | Description | Required | Default | Validation |
|---|---|---|---|---|
startLSN integer | StartLSN is the LSN of the backup start | True | ||
endLSN integer | EndLSN is the LSN of the backup end | True | ||
startWAL string | StartWAL is the current WAL when the backup started | True | ||
endWAL string | EndWAL is the current WAL when the backup ends | True | ||
tablespaces TablespaceLayoutList | Tablespaces are the metadata of the tablespaces | True | ||
annotations object (keys:string, values:string) | Annotations is a generic data store where each backend can put its metadata. | True | ||
startedAt Time | StartedAt is the current time when the backup started. | True | ||
stoppedAt Time | StoppedAt is the current time when the backup ended. | True |
TablespaceLayout
TablespaceLayout is the on-disk structure of a tablespace.
Appears in:
| Field | Description | Required | Default | Validation |
|---|---|---|---|---|
name string | Name is the tablespace name | True | ||
oid string | Oid is the OID of the tablespace. | True | ||
path string | Path is the path where the tablespace can be found. | True | ||
annotations object (keys:string, values:string) | Annotations is a generic data store where each backend can annotate its metadata. | True |
TablespaceLayoutList
Underlying type: TablespaceLayout
TablespaceLayoutList is a list of TablespaceLayout.
Appears in:
| Field | Description | Required | Default | Validation |
|---|---|---|---|---|
name string | Name is the tablespace name | True | ||
oid string | Oid is the OID of the tablespace. | True | ||
path string | Path is the path where the tablespace can be found. | True | ||
annotations object (keys:string, values:string) | Annotations is a generic data store where each backend can annotate its metadata. | True |