Skip to content

Commit c72b02b

Browse files
SamyOubouazizldecarvalho-docnerda-codesjcirinosclwy
authored
feat(OPS): add OpenSearch doc MTA-6320 (#5313)
* feat(OPS): add OpenSearch doc MTA-6320 * feat(OPS): update * feat(OPS): update * feat(OPS): update * feat(OPS): update * feat(OPS): update * docs(ops): update * docs(ops): update * docs(ops): update * docs(ops): update * docs(ops): update * docs(ops): update * docs(ops): update * Update pages/opensearch/how-to/connect-to-opensearch-deployment.mdx * docs(ops): update * docs(ops): update * Apply suggestions from code review Co-authored-by: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Néda <87707325+nerda-codes@users.noreply.github.com> Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> * Update pages/opensearch/how-to/create-opensearch-deployment.mdx Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> --------- Co-authored-by: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> Co-authored-by: Néda <87707325+nerda-codes@users.noreply.github.com> Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com>
1 parent 2898c0d commit c72b02b

14 files changed

+614
-0
lines changed

‎menu/changelogs.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@
145145
},
146146
{
147147
"items": [
148+
{
149+
"category": "data-warehouse",
150+
"label": "Data Warehouse for ClickHouse®"
151+
},
148152
{
149153
"category": "data-lab",
150154
"label": "Data Lab for Apache Spark™"
@@ -172,6 +176,10 @@
172176
"category": "mongodb",
173177
"label": "Managed MongoDB®"
174178
},
179+
{
180+
"category": "opensearch",
181+
"label": "Cloud Essentials for OpenSearch"
182+
},
175183
{
176184
"category": "sql-databases",
177185
"label": "SQL Databases"
@@ -325,6 +333,10 @@
325333
{
326334
"category": "object-storage",
327335
"label": "Object Storage"
336+
},
337+
{
338+
"category": "file-storage",
339+
"label": "File Storage"
328340
}
329341
],
330342
"category": "storage",

‎menu/navigation.json

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2458,6 +2458,64 @@
24582458
"label": "Managed MongoDB®",
24592459
"slug": "managed-mongodb-databases"
24602460
},
2461+
{
2462+
"items": [
2463+
{
2464+
"label": "Overview",
2465+
"slug": "../opensearch"
2466+
},
2467+
{
2468+
"label": "Concepts",
2469+
"slug": "concepts"
2470+
},
2471+
{
2472+
"label": "Quickstart",
2473+
"slug": "quickstart"
2474+
},
2475+
{
2476+
"label": "FAQ",
2477+
"slug": "faq"
2478+
},
2479+
{
2480+
"items": [
2481+
{
2482+
"label": "Create a deployment",
2483+
"slug": "create-opensearch-deployment"
2484+
},
2485+
{
2486+
"label": "Connect to a deployment",
2487+
"slug": "connect-to-opensearch-deployment"
2488+
},
2489+
{
2490+
"label": "Manage a deployment",
2491+
"slug": "manage-opensearch-deployment"
2492+
},
2493+
{
2494+
"label": "Manage the users of a deployment",
2495+
"slug": "manage-users-opensearch-deployment"
2496+
},
2497+
{
2498+
"label": "Delete a deployment",
2499+
"slug": "delete-opensearch-deployment"
2500+
}
2501+
],
2502+
"label": "How to",
2503+
"slug": "how-to"
2504+
},
2505+
{
2506+
"items": [
2507+
{
2508+
"label": "Choosing between shared and dedicated resources",
2509+
"slug": "shared-vs-dedicated-resources"
2510+
}
2511+
],
2512+
"label": "Additional Content",
2513+
"slug": "reference-content"
2514+
}
2515+
],
2516+
"label": "Cloud Essentials for OpenSearch",
2517+
"slug": "opensearch"
2518+
},
24612519
{
24622520
"items": [
24632521
{

‎pages/opensearch/concepts.mdx

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Cloud Essentials for OpenSearch - Concepts
3+
description: Understand key concepts behind Scaleway Cloud Essentials for OpenSearch.
4+
tags: cloud essentials opensearch concepts glossary terms definitions
5+
dates:
6+
published: 2025-08-05
7+
validation: 2025-08-05
8+
categories:
9+
- opensearch
10+
---
11+
12+
## Cloud Essentials
13+
14+
Cloud Essentials aims to provide a vast range of technologies, with a focus on easy deployment and minimal feature set while offering production-ready stability and scalability.
15+
16+
## OpenSearch
17+
18+
OpenSearch is a distributed search and analytics engine that supports various use cases, from implementing a search box on a website to analyzing security data for threat detection. The term distributed means that you can run OpenSearch on multiple computers. Search and analytics means that you can search and analyze your data once you ingest it into OpenSearch. No matter your type of data, you can store and analyze it using OpenSearch.
19+
20+
## Document
21+
22+
A document is a unit that stores information (text or structured data). In OpenSearch, documents are stored in JSON format.
23+
24+
You can think of a document in several ways:
25+
26+
- In a database of students, a document might represent one student.
27+
- When you search for information, OpenSearch returns documents related to your search.
28+
- A document represents a row in a traditional database.
29+
30+
For example, in a school database, a document can represent one student and contain the following data:
31+
32+
| ID | Name | GPA | Graduation Year |
33+
|--------|----------|--------|-----------------|
34+
| 1 | John Doe | 3.89 | 2022 |
35+
36+
Here is what this document looks like in JSON format:
37+
38+
```json
39+
{
40+
"name": "John Doe",
41+
"gpa": 3.89,
42+
"grad_year": 2022
43+
}
44+
```
45+
Document IDs are assigned in indexing documents.
46+
47+
## Index
48+
49+
An index is a collection of documents.
50+
51+
You can think of an index in several ways:
52+
53+
- In a database of students, an index represents all students in the database.
54+
- When you search for information, you query data contained in an index.
55+
- An index represents a database table in a traditional database.
56+
57+
For example, in a school database, an index might contain all students in the school.
58+
59+
| ID | Name | GPA | Graduation Year |
60+
|--------|--------------|--------|-----------------|
61+
| 1 | John Doe | 3.89 | 2022 |
62+
| 2 | Steve Powers | 3.85 | 2025 |
63+
| 3 | Jane Doe | 3.52 | 2024 |

‎pages/opensearch/faq.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Cloud Essentials for OpenSearch FAQ
3+
description: Discover Scaleway Cloud Essentials for OpenSearch and find answers to general questions.
4+
dates:
5+
validation:
6+
productIcon: openSearch
7+
---
8+
9+
## What is Cloud Essentials for OpenSearch
10+
11+
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.
12+
13+
Refer to the [quickstart documentation](/opensearch/quickstart/) to get started.

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: How to connect to a Cloud Essentials for OpenSearch deployment
3+
description: This page provides a guide on how to connect to a Cloud Essentials for OpenSearch deployment using the Scaleway console.
4+
tags:
5+
dates:
6+
validation: 2025-08-05
7+
posted: 2025-08-05
8+
---
9+
10+
import Requirements from '@macros/iam/requirements.mdx'
11+
12+
This page explains how to connect to an OpenSearch deployment using the Scaleway console.
13+
14+
<Requirements />
15+
16+
- A Scaleway account logged into the [console](https://console.scaleway.com)
17+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
18+
- [Created an OpenSearch deployment](/opensearch/how-to/create-opensearch-deployment/)
19+
20+
## How to connect to a Cloud Essentials for OpenSearch deployment
21+
22+
### How to connect to OpenSearch Dashboards
23+
24+
1. Click **OpenSearch** in the **Databases** section of the console. The Cloud Essentials for OpenSearch dashboard displays.
25+
26+
2. Click the name of the OpenSearch deployment you want to connect to. Its **Overview** page displays.
27+
28+
3. Click the **OpenSearch dashboard** button.
29+
30+
4. Enter the credentials set up during deployment creation, then click **Log in**.
31+
32+
You are now connected to your Cloud Essentials for OpenSearch deployment. Refer to the [official documentation](https://docs.opensearch.org/2.19/dashboards/) for comprehensive information on how to use OpenSearch Dashboards.
33+
34+
### How to communicate with a deployment using the OpenSearch REST API
35+
36+
1. Click **OpenSearch** in the **Databases** section of the console. The Cloud Essentials for OpenSearch dashboard displays.
37+
38+
2. Click the name of the OpenSearch deployment you want to connect to. Its **Overview** page displays.
39+
40+
3. From the **Network** section of the **Overview** page, copy the **API** endpoint.
41+
42+
4. In a terminal, run the following command to interact with your deployment. Remember to replace the placeholders with the appropriate values:
43+
44+
```sh
45+
curl -X GET "<deployment_api_endpoint>/_cluster/health" -ku <username>:<password>
46+
```
47+
48+
An output similar to the following displays:
49+
50+
```json
51+
{
52+
"cluster_name": "os-43995940-b3b2-4dd9-ae0f-799417ed3ec6",
53+
"status": "green",
54+
"timed_out": false,
55+
"number_of_nodes": 1,
56+
"number_of_data_nodes": 1,
57+
"discovered_master": true,
58+
"discovered_cluster_manager": true,
59+
"active_primary_shards": 7,
60+
"active_shards": 7,
61+
"active_shards_percent_as_number": 100
62+
}
63+
```
64+
65+
You can now interact with your Cloud Essentials for OpenSearch deployment via its API endpoint. Refer to the [official documentation](https://docs.opensearch.org/latest/getting-started/communicate/) for comprehensive information on how to communicate with OpenSearch using the REST API.

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: How to create a Cloud Essentials for OpenSearch deployment
3+
description: This page provides a guide on how to set up a Cloud Essentials for OpenSearch deployment using the Scaleway console.
4+
tags: opensearch search db engine data manage create deploy dashboard api
5+
dates:
6+
validation: 2025-08-05
7+
posted: 2025-08-05
8+
---
9+
10+
import Requirements from '@macros/iam/requirements.mdx'
11+
12+
This page explains how to create an OpenSearch deployment using the Scaleway console.
13+
14+
<Requirements />
15+
16+
- A Scaleway account logged into the [console](https://console.scaleway.com)
17+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
18+
19+
## How to create a Cloud Essentials for OpenSearch deployment
20+
21+
1. Click **OpenSearch** in the **Databases** section of the console. The Cloud Essentials for OpenSearch dashboard displays.
22+
23+
2. Click **+ Create deployment**. A creation form displays.
24+
25+
3. Select an OpenSearch version for your deployment.
26+
27+
4. Select a region where your resource will be deployed.
28+
29+
5. Select a deployment configuration. You can choose between:
30+
31+
- **High Availability**: ensures fault tolerance in case of node failure, workload distribution across all nodes for improved performance, service continuity during rolling updates.
32+
- **Standalone**: cost-optimized single-node deployment for testing environments and non-critical, small-scale applications, without redundancy.
33+
34+
6. Choose a node type for your deployment. Refer to the [dedicated documentation](/opensearch/reference-content/shared-vs-dedicated-resources/) for more information on shared and dedicated compute resources.
35+
36+
7. Define a storage capacity for each node. The total storage size for your deployment depends on the number of nodes provisioned.
37+
38+
8. Configure network connectivity for your deployment.
39+
40+
9. Create credentials to log in to your OpenSearch deployment. These credentials will grant `admin` access to the user.
41+
42+
10. Enter a name for your deployment, or keep the automatically generated one.
43+
44+
11. Review the estimated cost for your cluster, then click **Create deployment** to finish.
45+
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 several minutes to complete.
50+
</Message>

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: How to delete a Cloud Essentials for OpenSearch deployment
3+
description: This page provides a guide on how to delete a Cloud Essentials for OpenSearch deployment using the Scaleway console.
4+
tags: opensearch search db engine data manage remove drop destroy delete
5+
dates:
6+
validation: 2025-08-05
7+
posted: 2025-08-05
8+
---
9+
10+
import Requirements from '@macros/iam/requirements.mdx'
11+
12+
This page explains how to delete an OpenSearch deployment using the Scaleway console.
13+
14+
<Message type="important">
15+
Deleting an OpenSearch deployment is irreversible, and all its associated data will be lost.
16+
</Message>
17+
18+
<Requirements />
19+
20+
- A Scaleway account logged into the [console](https://console.scaleway.com)
21+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
22+
- [Created an OpenSearch deployment](/opensearch/how-to/create-opensearch-deployment/)
23+
24+
## How to delete a Cloud Essentials for OpenSearch deployment
25+
26+
1. Click **OpenSearch** in the **Databases** section of the console. The Cloud Essentials for OpenSearch dashboard displays.
27+
28+
2. Click <Icon name="more" /> next to the name of the deployment you want to delete. A confirmation pop-up displays.
29+
30+
3. Type **DELETE** in the field, then click **Delete deployment** to confirm your action.
31+
32+
Your deployment is now deleted.
33+
34+
<Message type="tip">
35+
You can also delete an OpenSearch deployment from its **Settings** tab.
36+
</Message>

‎pages/opensearch/how-to/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Cloud Essentials for OpenSearch - How Tos
3+
description: Practical guides for using Scaleway Cloud Essentials for OpenSearch.
4+
---

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: How to manage a Cloud Essentials for OpenSearch deployment
3+
description: This page provides a guide on how to manage a Cloud Essentials for OpenSearch deployment using the Scaleway console.
4+
tags:
5+
dates:
6+
validation: 2025-08-05
7+
posted: 2025-08-05
8+
---
9+
10+
import Requirements from '@macros/iam/requirements.mdx'
11+
12+
This page explains how to manage an OpenSearch deployment using the Scaleway console.
13+
14+
<Requirements />
15+
16+
- A Scaleway account logged into the [console](https://console.scaleway.com)
17+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
18+
- [Created an OpenSearch deployment](/opensearch/how-to/create-opensearch-deployment/)
19+
20+
## How to manage a Cloud Essentials for OpenSearch deployment
21+
22+
1. Click **OpenSearch** in the **Databases** section of the console. The Cloud Essentials for OpenSearch dashboard displays.
23+
24+
2. Click the name of the OpenSearch deployment you want to manage. Its **Overview** page displays.
25+
26+
3. From the Overview, you can:
27+
28+
- Access the dashboard of your deployment
29+
- View and manage the users of your deployment
30+
- Delete your deployment

0 commit comments

Comments
 (0)