Charmed MongoDB K8s

Learn about actions >

• create-backup

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

• get-password

  Change the system user's password used by charm. It is for internal charm users and SHOULD NOT be used by applications.

  Params

  • username string

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

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

• resume-refresh

  Refresh remaining units (after you manually verified that refreshed units are healthy).

  Params

  • force boolean

    Potential of data loss and downtime

    Force refresh of next unit.

    Use to

    • force incompatible refresh and/or
    • continue refresh if 1+ refreshed units have non-active status

• set-password

  Change the system user's password 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, 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.