API Reference

PostgreSQLInstance

Tiers

This feature is available for the following tiers: Standard, Premium.

Packages:

• database.entigo.com/v1alpha1

database.entigo.com/v1alpha1

Resource Types:

• PostgreSQLInstance

PostgreSQLInstance

^{↩ Parent}

Name	Type	Description	Required
apiVersion	string	database.entigo.com/v1alpha1	true
kind	string	PostgreSQLInstance	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object	Validations: !self.deletionProtection || (has(self.snapshotIdentifier) ? self.snapshotIdentifier : '') == (has(oldSelf.snapshotIdentifier) ? oldSelf.snapshotIdentifier : ''): snapshotIdentifier cannot be changed when deletionProtection is enabled	true
status	object		false

PostgreSQLInstance.spec

^{↩ Parent}

Name	Type	Description	Required
allocatedStorage	number	Database disk size in GB. Default is 20GB. Default: 20 Minimum: 20 Maximum: 5000	true
engineVersion	string	Database engine version. Use AWS documentation to find a list of supported versions: https://docs.aws.amazon.com/AmazonRDS/latest/PostgreSQLReleaseNotes/postgresql-versions.html	true
instanceType	string	AWS database instance type. For a list of available instance types: https://aws.amazon.com/rds/instance-types/	true
allowMajorVersionUpgrade	boolean	Indicates that major version upgrades are allowed. Default is false. Default: false	false
autoMinorVersionUpgrade	boolean	Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true. Default: true	false
backupRetentionPeriod	number	The days to retain backups for. Must be between 0 and 35. Minimum: 0 Maximum: 35	false
backupWindow	string	The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window. Default value is determined by the region.	false
deletionProtection	boolean	If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is true. Default: true	false
iops	number	Use reserved IOPS for the database. For most use-cases it is more cost effective to increase the disk size than to by IOPS. Default unset.	false
maintenanceWindow	string	The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.	false
multiAZ	boolean	Specifies if the Database instance is multi-AZ. Default false. Default: false	false
parameterGroupName	string	Reference to a custom parameter group.	false
snapshotIdentifier	string	Specifies whether or not to create this database from a snapshot. This corresponds to the snapshot ID in the RDS console.	false

PostgreSQLInstance.status

^{↩ Parent}

Name	Type	Description	Required
allowMajorVersionUpgrade	boolean		false
autoMinorVersionUpgrade	boolean		false
backupWindow	string		false
dbInstanceIdentifier	string		false
endpoint	object		false
finalSnapshotIdentifier	string		false
iops	number		false
kmsKeyId	string		false
latestRestorableTime	string	Format: date-time	false
maintenanceWindow	string		false
parameterGroupName	string		false
resourceId	string		false
snapshotIdentifier	string		false
status	string		false
storageEncrypted	boolean		false
storageThroughput	number		false
storageType	string		false
vpcSecurityGroupIds	[]string		false

PostgreSQLInstance.status.endpoint

^{↩ Parent}

Name	Type	Description	Required
address	string		true
hostedZoneId	string		true
port	number		true

Examples

Basic Instance

A minimal PostgreSQL instance definition showing the required fields only.

apiVersion: database.entigo.com/v1alpha1
kind: PostgreSQLInstance
metadata:
  name: basic-instance
spec:
  storageGB: 10
  version: "14"

High Availability Instance

An example of a PostgreSQL instance configured with replication for high availability.

apiVersion: database.entigo.com/v1alpha1
kind: PostgreSQLInstance
metadata:
  name: ha-instance
spec:
  storageGB: 100
  version: "15"
  replicas: 3
  backup:
    enabled: true
    schedule: "0 2 * * *"