Charmed Apache Zookeeper

Learn about actions >

• create-backup

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

• get-super-password

  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

  Returns the Zookeeper sync user password. This user is only for internal quorum handling.

• list-backups

  List database backups. S3 credentials are retrieved from a relation with the S3 integrator charm.

• pre-upgrade-check

  Run necessary pre-upgrade checks before executing a charm upgrade.

• restore

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

• set-password

  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

  • password string

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

  • username string

    The username, the default value 'operator'. Possible values - super, sync.

• set-tls-private-key

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

  Params

  • internal-key string

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