Charmed MySQL K8s

Learn about actions >

• create-backup

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

  Params

  • force boolean

    Whether to ignore cluster health concerns and create the backup regardless. Use it with caution, as it can potentially create a backup from stale data.

• create-replication

  Create replication between two related clusters. This action is must be run on the offer side of the relation.

  Params

  • name string

    A (optional) name for this replication.

• force-refresh-start

  Potential of data loss and downtime. Force refresh of first unit Must run with at least one of the parameters =false

  Params

  • check-compatibility boolean

    Potential of data loss and downtime If false, force refresh if new version of MySQL and/or charm is not compatible with previous version

  • check-workload-container boolean

    Potential of data loss and downtime during and after refresh If false, allow refresh to MySQL container version that has not been validated to work with the charm revision

  • run-pre-refresh-checks boolean

    Potential of data loss and downtime If false, force refresh if app is unhealthy or not ready to refresh (and unit status shows "Pre-refresh check failed")

• 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 to get password from. Possible values - charmed-operator, charmed-replication, charmed-backup, charmed-stats.

• list-backups

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

• pre-refresh-check

  Check if charm is ready to refresh

• promote-to-primary

  Promotes the unit or cluster to become the primary in the cluster or cluster-set, depending on the scope (unit or cluster). Used for safe switchover or failover. When in cluster scope, can only be run against the charm leader unit of a standby cluster.

  Params

  • force boolean

    For cluster scope, use force when previous primary is unreachable (failover). Will invalidate previous primary. For unit scope, use force to force quorum from the current unit. Note that this operation is DANGEROUS as it can create a split-brain if incorrectly used and should be considered a last resort. Make absolutely sure that there are no partitions of this group that are still operating somewhere in the network, but not accessible from your location

  • scope string

    Whether to promote a unit or a cluster. Must be set to either unit or cluster.

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

  • restore-to-time string

    Point-in-time-recovery target (format = %Y-%m-%d %H:%M:%S).

• resume-refresh

  Refresh next unit(s) (after you have manually verified that refreshed units are healthy) If pause-after-unit-refresh is set to all, this action will refresh the next unit. If pause-after-unit-refresh is set to first, this action will refresh all remaining units. If pause-after-unit-refresh is set to none, this action will have no effect unless it is called with check-health-of-refreshed-units as false.

  Params

  • check-health-of-refreshed-units boolean

    Potential of data loss and downtime. If false, force refresh (of next unit) if 1 or more refreshed units are unhealthy

    Warning: if first unit to refresh is unhealthy, consider running force-refresh-start action on that unit instead of using this parameter. If first unit to refresh is unhealthy because compatibility checks, pre-refresh checks, or workload container checks are failing, this parameter is more destructive than the force-refresh-start action.

• 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 to set password. Possible values - charmed-operator, charmed-replication, charmed-backup, charmed-stats.

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