Charmed PostgreSQL K8s

Learn about actions >

• create-backup

  Creates a backup to s3 storage in AWS.

  Params

  • type string

    The backup type, the default value is 'full'. Full backup is a full copy of all data. Differential backup is a copy only of changed data since the last full backup. Incremental backup is a copy only of changed data since the last backup (any type). Possible values - full, differential, incremental.

• create-replication

  Set up asynchronous replication between two clusters.

  Params

  • name string

    The name of the replication (defaults to 'default').

• get-password

  Get a charm system user's password. Useful for manual troubleshooting and for backing up cluster credentials. It cannot be used for application integration relations.

  Params

  • username string

    The username, the default value 'operator'. Possible values - backup, operator, replication, rewind, patroni.

• get-primary

  Get the unit with is the primary/leader in the replication.

• list-backups

  Lists backups in s3 storage in AWS.

• pre-upgrade-check

  Run necessary pre-upgrade checks and preparations before executing a charm refresh.

• promote-to-primary

  Promotes the cluster of choice to a primary cluster. Must be ran against the leader unit.

  Params

  • force boolean

    Force the promotion of a cluster when there is already a primary cluster.

• restore

  Restore a database backup using pgBackRest. S3 credentials are retrieved from a relation with the S3 integrator charm.

  Params

  • backup-id string

    A backup-id to identify the backup to restore (format = %Y-%m-%dT%H:%M:%SZ)

  • restore-to-time string

    Point-in-time-recovery target in PSQL format.

• resume-upgrade

  Resume a rolling upgrade after asserting successful upgrade of a new revision.

• set-password

  Change the system user's password, which is used by charm. It is for internal charm users and SHOULD NOT be used by applications.

  Params

  • password string

    The password will be auto-generated if this option is not specified.

  • username string

    The username, the default value 'operator'. Possible values - backup, operator, replication rewind.

• set-tls-private-key

  Set the private key, which will be used for certificate signing requests (CSR). Run for each unit separately.

  Params

  • private-key string

    The content of private key for communications with clients. Content will be auto-generated if this option is not specified.