Valkey

Learn about actions >

• create-backup

  Stream a fresh RDB backup of this unit's Valkey instance to the related backup storage. Runs on the targeted unit (any unit, leader or follower). Credentials are taken from the related storage integrator charm.

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

• list-backups

  List all backup objects in the configured backup storage, newest first. Safe to run while another backup is uploading.

  Params

  • output string

    Output format of the backup list, either "table" or "json".

• pre-refresh-check

  Check if charm is ready to refresh

• restore

  Restore the cluster's dataset from a backup in the related backup storage. Replaces the data on all units. Run on the leader unit. The backup-id must be one returned by list-backups. Credentials are taken from the related storage integrator charm.

  Params

  • backup-id string

    The backup-id to restore, in the format produced by list-backups (YYYY-MM-DDTHH:MM:SSZ).

• resume-refresh

  Refresh next unit(s) (after you have manually verified that refreshed units are healthy) If the pause-after-unit-refresh config 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. Exception: if automatic health checks fail after a unit has refreshed, the refresh will pause. 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.

• status-detail

  Gets statuses of the charm

  Params

  • recompute boolean

    a boolean indicating whether a unit should recompute all statuses.

• sync-ldap-users

  Synchronize users from related LDAP provider to Valkey's ACL file.