MongoDB

Learn about actions >

• create-backup

  Create a database backup. S3 credentials are retrieved from a relation with the S3 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 MongoDB 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 MongoDB 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-primary

  Report primary replica

• 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

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

  • remap-pattern string

    Optional, a pattern used to remap cluster component names when performing a restore. Format of old_config_server_name=new_config_server_name,old_shard_name=new_shard_name

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