Charmed MySQL

Learn about actions >

• create-backup

  Create a database backup using xtrabackup. S3 credentials are retrieved from a relation with the S3 integrator charm.

• fence-writes

  Stops write traffic to a primary cluster of a ClusterSet.

  Params

  • cluster-set-name string

    The name of the cluster-set. Mandatory option, used for confirmation.

• get-cluster-status

  Get cluster status information

  Params

  • cluster-set boolean

    Whether to fetch the cluster or cluster-set status. Possible values are False (default) or True.

• get-password

  Fetch 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 string

    The username, the default value 'root'. Possible values - root, serverconfig, clusteradmin.

• list-backups

  List available backup_ids in the S3 bucket and path provided by the S3 integrator charm.

• pre-upgrade-check

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

• promote-standby-cluster

  Promotes this cluster to become the leader in the cluster-set. Used for safe switchover or failover. Must be run against the charm leader unit of a standby cluster.

  Params

  • cluster-set-name string

    The name of the cluster-set. Mandatory option, used for confirmation.

  • force boolean

    Use force when previous primary is unreachable (failover). Will invalidate previous primary.

• recreate-cluster

  Recreates cluster on one or more standalone units that were previously part of a standby cluster.

  When a standby cluster is removed from an async replication relation, the cluster will be dissolved and each unit will be kept in blocked status. Recreating the cluster allows to rejoin the async replication relation, or usage as a standalone cluster.

• rejoin-cluster

  Rejoins an invalidated cluster to the cluster-set, after a previous failover or switchover.

  Params

  • cluster-name string

    The name of the cluster to be rejoined.

• restore

  Restore a database backup using xtrabackup. 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)

• 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 'root'. Possible values - root, serverconfig, clusteradmin.

• 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.

• unfence-writes

  Resumes write traffic to a primary cluster of a ClusterSet.

  Params

  • cluster-set-name string

    The name of the cluster-set. Mandatory option, used for confirmation.