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

  Force refresh of this unit. Potential of data loss and downtime.

• get-password

  Fetch the password of the provided internal user of the charm, used for internal charm operations. It is for internal charm users only, and SHOULD NOT be used by applications.

  Params

  • username string

    The username, the default value 'operator'. Possible values - operator, backup, monitor.

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

• set-password

  Change the admin 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 'operator'. Possible values - operator, backup, monitor.

• set-tls-private-key

  Set the privates key, which will be used for certificate signing requests (CSR). Run for each unit separately.

  Params

  • external-key string

    The content of private key for external communications with clients. Content will be auto-generated if this option is not specified.

  • internal-key string

    The content of private key for internal communications with clients. Content will be auto-generated if this option is not specified.