actions.yaml

# Copyright 2021 Canonical Ltd.
# See LICENSE file for licensing details.

create-backup:
  description: Creates a backup to s3 storage.
  params:
    type:
      type: string
      description: 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:
  description: Set up asynchronous replication between two clusters.
  params:
    name:
      type: string
      description: The name of the replication (defaults to 'default').
      default: default
get-primary:
  description: Get the unit which is the primary/leader in the replication.
get-password:
  description: Get the system user's password, which is used by charm.
    It is for internal charm users and SHOULD NOT be used by applications.
  params:
    username:
      type: string
      description: The username, the default value 'operator'.
        Possible values - operator, replication, rewind, patroni.
list-backups:
  description: Lists backups in s3 storage.
pre-upgrade-check:
  description: Run necessary pre-upgrade checks and preparations before executing a charm refresh.
promote-to-primary:
  description: Promotes the cluster of choice to a primary cluster. Must be ran against the leader unit.
  params:
    force:
      type: boolean
      description: Force the promotion of a cluster when there is already a primary cluster.
restore:
  description: Restore a database backup using pgBackRest.
    S3 credentials are retrieved from a relation with the S3 integrator charm.
  params:
    backup-id:
      type: string
      description: A backup-id to identify the backup to restore (format = %Y-%m-%dT%H:%M:%SZ)
    restore-to-time:
      type: string
      description: Point-in-time-recovery target in PSQL format.
set-password:
  description: 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:
    username:
      type: string
      description: The username, the default value 'operator'.
        Possible values - operator, replication, rewind.
    password:
      type: string
      description: The password will be auto-generated if this option is not specified.
set-tls-private-key:
  description: Set the private key, which will be used for certificate signing requests (CSR). Run for each unit separately.
  params:
    private-key:
      type: string
      description: The content of private key for communications with clients. Content will be auto-generated if this option is not specified.