Sync docs from Discourse

docs/how-to/h-deploy-lxd.md

@@ -150,6 +150,10 @@ juju model-config --file=./cloudinit-userdata.yaml
 
 ## Deploy OpenSearch
 
+[note]
+**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.
+[/note]
+
 To deploy OpenSearch, run
 ```shell
 juju deploy opensearch --channel 2/edge

docs/how-to/h-integrate.md

@@ -27,7 +27,7 @@ The Charmed OpenSearch provides the `opensearch_client` interface to allow other
 To integrate your client application you must define the `opensearch_client` interface in your charm's `metadata.yaml` file.
 
 ```yaml
-provides:
+requires:
   opensearch:
     interface: opensearch_client
 ```

docs/how-to/h-large-deployment.md

@@ -45,6 +45,7 @@ When no roles are set on the `roles` config option of the opensearch application
 There are currently two ways for users to set roles in an application: at deploy time, or via a config change. Note that a role change will effectively trigger a rolling restart of the OpenSearch application.
 
 To set roles at deploy time, run
+
  ```none
  juju deploy opensearch -n 3 --config roles="cluster_manager,data,ml"
 ```
@@ -63,12 +64,25 @@ The cluster will consist of multiple integrated juju applications (clusters) wit
 
 ### Deploy the clusters
 
+[note type="caution"]
+**Caution**: Charmed OpenSearch supports performance profiles and will have different RAM consumption according to the profile chosen:
+
+* `production`: consumes 50% of the RAM available, up to 32G
+* `staging`: consumes 25% of the RAM available, up to 32G
+* `testing`: consumes 1G of RAM
+
+The configuration defaults to `production`, but for the examples below, testing will be chosen as it is assumed the deployment happens on a single LXD cluster.
+
+[/note]
+
 1. First, deploy the orchestrator app.
+
     ```shell
     juju deploy -n 3 \
         opensearch main \
         --config cluster_name="app" \
-        --channel 2/edge
+        --channel 2/edge \
+        --config profile="testing"
     ```
 
     As a reminder, since we did not set any role to this application, the operator will assign each node the `cluster_manager,coordinating_only,data,ingest,ml` roles.
@@ -80,8 +94,9 @@ The failover app will take over the orchestration of the fleet in the events whe
         opensearch failover \
         --config cluster_name="app" \
         --config init_hold="true" \
-        --config roles="cluster_manager" 
-        --channel 2/edge
+        --config roles="cluster_manager"  \
+        --channel 2/edge \
+        --config profile="testing"
     ```
 
    The failover nodes are not required for a basic deployment of OpenSearch. They are however highly recommended for production deployments to ensure high availability and fault tolerance.
@@ -98,7 +113,8 @@ The failover app will take over the orchestration of the fleet in the events whe
          --config cluster_name="app" \
          --config roles="data.hot" \
          --config init_hold="true" \
-         --channel 2/edge 
+         --channel 2/edge \
+         --config profile="testing"
    ```
 
 4. We also need to deploy a TLS operator to enable TLS encryption for the cluster. We will deploy the `self-signed-certificates` charm to provide self-signed certificates for the cluster.

docs/how-to/h-minor-upgrade.md

@@ -114,10 +114,25 @@ The action will ensure and check the health of OpenSearch and determine if the c
 
 ## Initiate the upgrade
 
+[note type="caution"]
+**Caution**: Charmed OpenSearch supports performance profiles and will have different RAM consumption according to the profile chosen:
+
+* `production`: consumes 50% of the RAM available, up to 32G
+* `staging`: consumes 25% of the RAM available, up to 32G
+* `testing`: consumes 1G of RAM
+
+In case your charm is running on revision prior to `185`, the `testing` profile will be your default value. Ensure you have it set at upgrade and then feel free to switch to another profile that is more suitable to your use-case.
+
+[/note]
+
 Use the juju refresh command to trigger the charm upgrade process. You have control over what upgrade you want to apply:
 - You can upgrade the charm to the latest revision available in the charm store for a specific channel, in this case, the edge channel:
 
     ```shell
+    # If your charm is running a revision prior to 185, then set the profile explicitly:
+    juju refresh opensearch --channel 2/edge --config profile="testing"
+
+    # Otherwise, just refresh
     juju refresh opensearch --channel 2/edge
     ```
 

docs/tutorial/t-deploy-opensearch.md

@@ -4,8 +4,13 @@
 
 To deploy Charmed OpenSearch, all you need to do is run the following command:
 
+[note]
+**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.
+[/note]
+
+
 ```shell
-juju deploy opensearch -n 3 --channel 2/beta
+juju deploy opensearch -n 3 --channel 2/beta --config profile="testing"
 ```
 
 [note]