Cloud Essentials for OpenSearch - Quickstart

Reviewed on August 05, 2025

Apache OpenSearch allows you to research, analyze, and visualize all your unstructured data with an open-source search and analytics suite. It provides a fully-managed NoSQL database service to perform full-text searches and visualize results.

Cloud Essentials for OpenSearch is a managed solution to quickly deploy a robust database search engine that can be distributed across several nodes for enhanced performance and high availability.

This guide covers the basic steps to set up, log in to, and delete a Cloud Essentials for OpenSearch deployment.

Before you start

To complete the actions presented below, you must have:

• A Scaleway account logged into the console
• Owner status or IAM permissions allowing you to perform actions in the intended Organization

How to create a Cloud Essentials for OpenSearch deployment

1. Click OpenSearch in the Databases section of the console. The Cloud Essentials for OpenSearch dashboard displays.

2. Click + Create deployment. A creation form displays.

3. Select the Standalone deployment configuration. Standalone deployments are cost-optimized single-node deployments for testing environments and non-critical, small-scale applications, without redundancy.

4. Select the SEARCHDB-SHARED-2C-8G node type.

5. Define a storage capacity of 5 GB.

6. Keep the default network connectivity.

7. Create credentials to log in to your OpenSearch deployment. These credentials will grant admin access to the user.

8. Enter a name for your deployment, or keep the automatically generated one.

9. Review the estimated cost for your deployment, then click Create deployment to finish.

You are directed to the Overview tab of your deployment.

How to connect to a Cloud Essentials for OpenSearch deployment

How to connect to OpenSearch Dashboards

1. From the Overview tab of the deployment you just created, click the OpenSearch dashboard button.

2. Enter the credentials set up during deployment creation, then click Log in.

You are now connected to your Cloud Essentials for OpenSearch deployment.

How to communicate with a deployment using the OpenSearch REST API

1. From the Network section of the Overview tab of the deployment you just created, copy the API endpoint.

2. In a terminal, run the following command to interact with your deployment. Remember to replace the placeholders with the appropriate values:

   curl -X GET "<cluster_api_endpoint>/_cluster/health" -ku <username>:<password>

   An output similar to the following displays:

   {
     "cluster_name": "os-43995940-b3b2-4dd9-ae0f-799417ed3ec6",
     "status": "green",
     "timed_out": false,
     "number_of_nodes": 1,
     "number_of_data_nodes": 1,
     "discovered_master": true,
     "discovered_cluster_manager": true,
     "active_primary_shards": 7,
     "active_shards": 7,
     "active_shards_percent_as_number": 100
   }

You can now interact with your deployment using the OpenSearch REST API.

How to manage a Cloud Essentials for OpenSearch deployment

1. Click OpenSearch in the Databases section of the console. The Cloud Essentials for OpenSearch dashboard displays.

2. Click the name of the OpenSearch deployment you want to manage. Its Overview page displays.

3. From here, you can:

   • Access the dashboard of your deployment
   • View and manage the users of your deployment
   • Delete your deployment

How to delete a Cloud Essentials for OpenSearch deployment

1. Click OpenSearch in the Databases section of the console. The Cloud Essentials for OpenSearch dashboard displays.

2. Click more icon next to the name of the deployment you want to delete. A confirmation pop-up displays.

3. Type DELETE in the field, then click Delete deployment to confirm your action.

Your deployment is now deleted.