---
title: Charmhub | Deploy OpenSearch using Charmhub - The Open Operator Collection
description: Deploy the latest version of OpenSearch on any cloud.
url: https://charmhub.io/opensearch/actions
---

# OpenSearch

[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:

24.04

22.04

2/stable 344

```
juju deploy opensearch --channel 2/stable
```

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

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

[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

  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 OpenSearch and/or charm is not compatible with previous version
* force-upgrade

  Potential of *data loss* and *downtime*

  Force upgrade of this unit.

  Use to

  + force incompatible upgrade and/or
  + continue upgrade if 1+ upgraded units have non-active status
* get-password

  Fetch the system user's password and CA chain, which is used by charm. It is for internal charm users and SHOULD NOT be used by applications.

  Params

  + username
    string

    The username, the default value 'admin'. Possible values - admin.
* list-backups

  List available backup\_ids in the S3 bucket and path provided by the S3 integrator charm.

  Params

  + output
    string

    Format which the data should be returned. Possible values: table, json.
    The json format will bring more details, such as shard status, indices name, etc.
* pre-upgrade-check

  Check if charm is ready to upgrade
* 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: backup-id=<string>.

  Required

  backup-id
* resume-upgrade

  Upgrade remaining units (after you manually verified that upgraded 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 set.
  + username
    string

    The username, the default value 'admin'. Possible values - admin.
* set-tls-private-key

  Set the private keys, which will be used for certificate signing requests (CSR). Run for each unit separately or on-leader only depending on the type.

  Params

  + category
    string

    (Required) Type of private key to be set. "app-admin" must only be set on the leader.
  + key
    string

    (Optional) The content of the private key. The content will be auto-generated if not set.
  + password
    string

    (Optional) The passphrase of the private key. Will NOT be set if omitted.

  Required

  category