actions.yaml

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

get-super-password:
  description: Returns the Zookeeper super user password (for the cluster). Used to get
    administrator access to the cluster. Used mainly by the Kafka Charmed Operator.

get-sync-password:
  description: Returns the Zookeeper sync user password. This user is only for internal quorum handling.

pre-upgrade-check:
  description: Run necessary pre-upgrade checks before executing a charm upgrade.

set-password:
  description: Change the system user's password, which is used by the charm.
    It is for internal charm users and SHOULD NOT be used by applications.
    This action must be called on the leader unit.
  params:
    username:
      type: string
      description: The username, the default value 'operator'.
        Possible values - super, sync.
    password:
      type: string
      description: The password will be auto-generated if this option is not specified.

set-tls-private-key:
  description: Set the privates key, which will be used for certificate signing requests (CSR). Run for each unit separately.
  params:
    internal-key:
      type: string
      description: The content of private key for internal communications with clients. Content will be auto-generated if this option is not specified.

create-backup:
  description: Create a database backup and send it to an object storage. S3 credentials are retrieved from a relation with the S3 integrator charm.

list-backups:
  description: List database backups. S3 credentials are retrieved from a relation with the S3 integrator charm.

restore:
  description: Restore a database backup. 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 of <%Y-%m-%dT%H:%M:%SZ>