---
title: "Charmhub | Deploy Charmed Operator for MongoDB\n using Charmhub - The Open\
  \ Operator Collection"
description: "Deploy the latest version of Charmed Operator for MongoDB\n as a Kubernetes\
  \ Operator on any cloud."
url: https://charmhub.io/mongodb-k8s/actions
---

# Charmed Operator for MongoDB

[Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")

* [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")
* [Databases](https://charmhub.io/?filter=databases)

Platform:

6/stable 117

```
juju deploy mongodb-k8s --channel 6/stable --trust
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

* [create-backup](https://charmhub.io/mongodb-k8s/actions#create-backup)
* [force-refresh-start](https://charmhub.io/mongodb-k8s/actions#force-refresh-start)
* [get-password](https://charmhub.io/mongodb-k8s/actions#get-password)
* [get-primary](https://charmhub.io/mongodb-k8s/actions#get-primary)
* [list-backups](https://charmhub.io/mongodb-k8s/actions#list-backups)
* [pre-refresh-check](https://charmhub.io/mongodb-k8s/actions#pre-refresh-check)
* [restore](https://charmhub.io/mongodb-k8s/actions#restore)
* [resume-refresh](https://charmhub.io/mongodb-k8s/actions#resume-refresh)
* [set-password](https://charmhub.io/mongodb-k8s/actions#set-password)
* [set-tls-private-key](https://charmhub.io/mongodb-k8s/actions#set-tls-private-key)
* [status-detail](https://charmhub.io/mongodb-k8s/actions#status-detail)

[Learn about actions >](https://juju.is/docs/juju/action)

* 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

  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.
* 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>
* 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.
* status-detail

  Gets statuses of the charm

  Params

  + recompute
    boolean

    a boolean indicating whether a unit should recompute all statuses.