Skip to content

Commit f23f781

Browse files
SamyOubouazizSamyOubouaziz
committed
docs(ops): update
1 parent 3390191 commit f23f781

File tree

2 files changed

+112
-5
lines changed

2 files changed

+112
-5
lines changed

‎pages/opensearch/how-to/create-opensearch-deployment.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,10 @@ This page explains how to create an OpenSearch deployment using the Scaleway con
4343

4444
11. Review the estimated cost for your cluster, then click **Create deployment** to finish.
4545

46+
You are directed to the **Overview** tab of your deployment.
47+
48+
<Message type="note">
49+
The creation of a Cloud Essentials for OpenSearch deployment can take up to several minutes to complete.
50+
</Message>
51+
52+
## How to connect to

‎pages/opensearch/quickstart.mdx‎

Lines changed: 105 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,108 @@ title: Cloud Essentials for OpenSearch - Quickstart
33
description: This page shows you how to get started with Scaleway Cloud Essentials for OpenSearch.
44
tags: product name quickstart example guide step guide
55
dates:
6-
validation:
7-
posted:
8-
categories:
9-
- opensearch
10-
---
6+
validation: 2025-08-05
7+
posted: 2025-08-05
8+
---
9+
10+
Apache OpenSearch allows 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.
11+
12+
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.
13+
14+
This guide covers the basic steps to set up, log in to, and delete a Cloud Essentials for OpenSearch.
15+
16+
<Requirements />
17+
18+
- A Scaleway account logged into the [console](https://console.scaleway.com)
19+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
20+
21+
## How to create a Cloud Essentials for OpenSearch deployment
22+
23+
1. Click **OpenSearch** in the **Databases** section of the console. The Cloud Essentials for OpenSearch dashboard displays.
24+
25+
2. Click **+ Create deployment**. A creation form displays.
26+
27+
3. Select the **Standalone** deployment configuration. Standalone deployments are cost-optimized single-node deployment for testing environments and non-critical, small-scale applications, without redundancy.
28+
29+
4. Select the **SEARCHDB-SHARED-2C-8G** node type.
30+
31+
5. Define a storage capacity of **5 GB**.
32+
33+
6. Keep the default **network connectivity**.
34+
35+
7. Create credentials to log in to your OpenSearch deployment. These credentials will grant `admin` access to the user.
36+
37+
8. Enter a name for your deployment, or keep the automatically generated one.
38+
39+
9. Review the estimated cost for your deployment, then click **Create deployment** to finish.
40+
41+
You are directed to the **Overview** tab of your deployment.
42+
43+
<Message type="note">
44+
The creation of a Cloud Essentials for OpenSearch deployment can take up to several minutes to complete.
45+
</Message>
46+
47+
## How to connect to a Cloud Essentials for OpenSearch deployment
48+
49+
### How to connect to OpenSearch Dashboards
50+
51+
1. From the **Overview** tab of the deployment you just created, click the **OpenSearch dashboard** button.
52+
53+
2. Enter the credentials set up during deployment creation, then click **Log in**.
54+
55+
You are now connected to your Cloud Essentials for OpenSearch deployment.
56+
57+
### How to communicate with a deployment using the OpenSearch REST API
58+
59+
1. From the **Network** section of the **Overview** tab of the deployment you just created, copy the **API** endpoint.
60+
61+
2. In a terminal, run the following command to interact with your deployment. Remember to replace the placeholders with the appropriate values:
62+
63+
```sh
64+
curl -X GET "<cluster_api_endpoint>/_cluster/health" -ku <username>:<password>
65+
```
66+
67+
An output similar to the following displays:
68+
69+
```json
70+
{
71+
"cluster_name": "os-43995940-b3b2-4dd9-ae0f-799417ed3ec6",
72+
"status": "green",
73+
"timed_out": false,
74+
"number_of_nodes": 1,
75+
"number_of_data_nodes": 1,
76+
"discovered_master": true,
77+
"discovered_cluster_manager": true,
78+
"active_primary_shards": 7,
79+
"active_shards": 7,
80+
"active_shards_percent_as_number": 100
81+
}
82+
```
83+
84+
You can now interact with your deployment using the OpenSearch REST API.
85+
86+
## How to manage a Cloud Essentials for OpenSearch deployment
87+
88+
1. Click **OpenSearch** in the **Databases** section of the console. The Cloud Essentials for OpenSearch dashboard displays.
89+
90+
2. Click the name of the OpenSearch deployment you want to manage. Its **Overview** page displays.
91+
92+
3. From here, you can:
93+
94+
- Access the dashboard of your deployment
95+
- View and manage the users of your deployment
96+
- Delete your deployment
97+
98+
## How to delete a Cloud Essentials for OpenSearch deployment
99+
100+
1. Click **OpenSearch** in the **Databases** section of the console. The Cloud Essentials for OpenSearch dashboard displays.
101+
102+
2. Click <Icon name="more" /> next to the name of the deployment you want to delete. A confirmation pop-up displays.
103+
104+
3. Type **DELETE** in the field, then click **Delete deployment** to confirm your action.
105+
106+
Your deployment is now deleted.
107+
108+
<Message type="tip">
109+
You can also delete an OpenSearch deployment from its **Settings** tab.
110+
</Message>

0 commit comments

Comments
 (0)