OpenSearch

Channel Revision Published Runs on
2/stable 168 24 Sep 2024
Ubuntu 22.04
2/candidate 168 24 Sep 2024
Ubuntu 22.04
2/beta 168 24 Sep 2024
Ubuntu 22.04
2/edge 191 Today
Ubuntu 22.04
juju deploy opensearch --channel 2/stable
Show information

Platform:

Ubuntu
22.04

Charmed OpenSearch Tutorial > 2. Deploy OpenSearch

Deploy OpenSearch

To deploy Charmed OpenSearch, all you need to do is run the following command:

Note: Charmed OpenSearch supports performance profile. It is recommended in a single host deployment with LXD to use the testing profile, which will only consume 1G RAM per container.

juju deploy opensearch -n 3 --channel 2/beta --config profile="testing"

Note: The -n flag is optional and specifies the number of units to deploy. In this case, we are deploying three units of Charmed OpenSearch. We recommend deploying at least three units for high availability.

The command will fetch the charm from Charmhub and deploy 3 units to the LXD cloud. This process can take several minutes depending on your machine.

You can track the progress by running:

juju status --watch 1s

This command is useful for checking the status of your Juju model, including the applications and machines it hosts. Helpful information it displays includes IP addresses, ports, state, etc. The output of this command updates once every other second.

When the application is ready, juju status will show something similar to the sample output below:

Model     Controller       Cloud/Region         Version  SLA          Timestamp
tutorial  opensearch-demo  localhost/localhost  3.5.3    unsupported  12:36:56Z

App         Version  Status   Scale  Charm       Channel  Rev  Exposed  Message
opensearch           blocked      3  opensearch  2/beta   117  no       Missing TLS relation with this cluster.

Unit           Workload  Agent      Machine  Public address  Ports  Message
opensearch/0*  blocked   idle       0        10.95.38.94            Missing TLS relation with this cluster.
opensearch/1   blocked   executing  1        10.95.38.139           Missing TLS relation with this cluster.
opensearch/2   blocked   idle       2        10.95.38.212           Missing TLS relation with this cluster.

Machine  State    Address       Inst id        Base          AZ  Message
0        started  10.95.38.94   juju-be3883-0  ubuntu@22.04      Running
1        started  10.95.38.139  juju-be3883-1  ubuntu@22.04      Running
2        started  10.95.38.212  juju-be3883-2  ubuntu@22.04      Running

To exit the juju status screen, enter Ctrl + C.

The status message Waiting for TLS to be fully configured... is displayed because Charmed OpenSearch requires TLS to be configured before use, to ensure data is encrypted in transit for the HTTP and Transport layers. We will do this in the next step.

If you see the following status message:

vm.swappiness should be 0 - net.ipv4.tcp_retries2 should be 5

you need to set the correct kernel parameters to continue.

Next step: 3. Enable TLS