Mysql Innodb Cluster

Learn about actions >

• add-instance

  Configure and add an instance to the cluster. Note This action must be run on an instance that is a functioning member of the cluster.

  Params

  • address string

    Address of the instance to add to the cluster

  Required

  address

• cluster-rescan

  Clean up cluster metadata by rescanning the cluster. See https://dev.mysql.com/doc/refman/8.0/en/mysql-innodb-cluster-working-with-cluster.html#rescan-cluster

• cluster-status

  JSON dump of the cluster schema and status. This action can be used to determine the RW and RO instances.

  Params

  • extended integer

    Level of information to report back, valid values between 0 and 3 inclusive

• list-service-usernames

  List the usernames of the passwords that have been provided on the shared-db and router-db relations. The service username passed to 'rotate-service-user-password' needs to be on this list.

• mysqldump

  MySQL dump of databases. Action will return mysqldump-file location of the requested backup in the results. If the databases parameter is unset all databases will be dumped. If the databases parameter is set only the databases specified will be dumped.

  Params

  • basedir string

    The base directory for backups

  • databases

    Comma delimited database names to dump. If left unset, all databases will be dumped.

• pause

  Pause services. If the deployment is clustered using the hacluster charm, the corresponding hacluster unit on the node must first be paused as well. Not doing so may lead to an interruption of service.

• reboot-cluster-from-complete-outage

  In the case of a complete outage, reboot the cluster from this instance's GTID superset.

• rejoin-instance

  Rejoin an instance to the cluster. Note This action must be run on an instance that is a functioning member of the cluster. For example, after a complete outage the unit which ran reboot-cluster-from-complete-outage.

  Params

  • address string

    Address of the instance to rejoin to the cluster

  Required

  address

• remove-instance

  Remove an instance from the cluster. Note This action must be run on an instance that is a functioning member of the cluster preferrably the the juju leader to guarantee charm related flags are cleared.

  Params

  • address string

    Address of the instance to be removed from the cluster

  • force boolean

    Remove the instance even if it is unreachable.

  Required

  address

• restart-services

  Restart services. Restart the services the charm manages.

• restore-mysqldump

  Restore a MySQL dump of database(s). WARNING This is a desctructive action. It may overwrite existing database(s) data.

  Params

  • dump-file string

    Path to the mysqldump file.

• resume

  Resume services. If the deployment is clustered using the hacluster charm, the corresponding hacluster unit on the node must be resumed as well.

• rotate-service-user-password

  Rotate the specified mysql user's password. The current password is replaced with a randomly generated password. The password is changed on the relation to the user's units. This may result in a control plane outage for the duration of the password changing process.

  Params

  • service-user string

    The username of the mysql service as specified in list-service-usernames. Do NOT use this to change keystone service user passwords; the keystone charm has an action to change services related to keystone.

• set-cluster-option

  Set an option on the cluster.

  Params

  • key string

    Option name

  • value string

    Option value

• update-unit-acls

  This action should only be needed if a unit was added to the cluster on a new subnet. In this case group_replication_ip_allowlist need updating to include the subnet. Run add-instance to add in the new unit once this action succesfully completes. WARNING When this action is run, group replication is stopped, the acls updated and the group replication is started again. Group replication should be running after this action has completed.