MongoDB

Channel Revision Published Runs on
6/stable 199 04 Oct 2024
Ubuntu 22.04
6/candidate 199 04 Oct 2024
Ubuntu 22.04
6/beta 199 04 Oct 2024
Ubuntu 22.04
6/edge 204 12 Nov 2024
Ubuntu 22.04
5/stable 117 20 Apr 2023
Ubuntu 22.04
5/candidate 117 20 Apr 2023
Ubuntu 22.04
5/edge 139 21 Nov 2023
Ubuntu 22.04 Ubuntu 20.04
5/edge 109 06 Mar 2023
Ubuntu 22.04 Ubuntu 20.04
3.6/stable 100 28 Apr 2023
Ubuntu 20.04 Ubuntu 18.04
3.6/candidate 100 13 Apr 2023
Ubuntu 20.04 Ubuntu 18.04
3.6/edge 100 03 Feb 2023
Ubuntu 20.04 Ubuntu 18.04
juju deploy mongodb --channel 6/stable
Show information

Platform:

Ubuntu
22.04 20.04 18.04

charms.mongodb.v1.mongodb_backups

In this class, we manage backup configurations and actions.

Specifically backups are handled with Percona Backup MongoDB (pbm). A user for PBM is created when MongoDB is first started during the start phase. This user is named "backup".


class ResyncError

Description

Raised when pbm is resyncing configurations and is not ready to be used. None

class SetPBMConfigError

Description

Raised when pbm cannot configure a given option. None

class PBMBusyError

Description

Raised when PBM is busy and cannot run another operation. None

class RestoreError

Description

Raised when backup operation is failed. None

class BackupError

Description

Raised when backup operation is failed. None

class MongoDBBackups

Description

Manages MongoDB backups. None

Methods

MongoDBBackups. __init__( self , charm )

Description

Manager of MongoDB client relations. None

MongoDBBackups. on_s3_relation_joined( self , event: RelationJoinedEvent )

Description

Checks for valid integration for s3-integrations. None

MongoDBBackups. is_valid_s3_integration( self )

Return true if relation to s3-integrator is valid.

Description

Only replica sets and config servers can integrate to s3-integrator.

MongoDBBackups. get_pbm_status( self )

Description

Retrieve pbm status. None

MongoDBBackups. retrieve_error_message( self , pbm_status: Dict )

Parses pbm status for an error message from the current unit.

Description

If pbm_agent is in the error state, the command pbm status does not raise an error. Instead, it is in the log messages. pbm_agent also shows all the error messages for other replicas in the set.

MongoDBBackups. process_pbm_error( self , pbm_status )

Description

Returns errors found in PBM status. None

MongoDBBackups. get_backup_error_status( self , backup_id: str )

Description

Get the error status for a provided backup. None