-
Notifications
You must be signed in to change notification settings - Fork 248
feat(OPS): add OpenSearch doc MTA-6320 #5313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 16 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
2806cd3
feat(OPS): add OpenSearch doc MTA-6320
SamyOubouaziz 21ff3c4
feat(OPS): update
SamyOubouaziz c146798
feat(OPS): update
SamyOubouaziz c2bb1d4
feat(OPS): update
SamyOubouaziz 8825a28
feat(OPS): update
SamyOubouaziz 46723af
feat(OPS): update
SamyOubouaziz d0bafe3
docs(ops): update
SamyOubouaziz 5c7aae2
docs(ops): update
SamyOubouaziz 2b2b974
docs(ops): update
SamyOubouaziz 46dfa15
docs(ops): update
SamyOubouaziz e9b0183
docs(ops): update
SamyOubouaziz ffb80ed
docs(ops): update
SamyOubouaziz 71914e1
docs(ops): update
SamyOubouaziz 0046f8e
Update pages/opensearch/how-to/connect-to-opensearch-deployment.mdx
SamyOubouaziz 29a125a
docs(ops): update
SamyOubouaziz 199d6c0
docs(ops): update
SamyOubouaziz f2f8359
Apply suggestions from code review
SamyOubouaziz b2de0f8
Apply suggestions from code review
SamyOubouaziz a243c6a
Update pages/opensearch/how-to/create-opensearch-deployment.mdx
SamyOubouaziz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: Cloud Essentials for OpenSearch - Concepts | ||
description: Understand key concepts behind Scaleway Cloud Essentials for OpenSearch. | ||
tags: cloud essentials opensearch concepts glossary terms definitions | ||
dates: | ||
published: 2025-08-05 | ||
validation: 2025-08-05 | ||
categories: | ||
- opensearch | ||
--- | ||
|
||
## Cloud Essentials | ||
|
||
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. | ||
|
||
## OpenSearch | ||
|
||
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. | ||
|
||
## Document | ||
|
||
A document is a unit that stores information (text or structured data). In OpenSearch, documents are stored in JSON format. | ||
|
||
You can think of a document in several ways: | ||
|
||
- In a database of students, a document might represent one student. | ||
- When you search for information, OpenSearch returns documents related to your search. | ||
- A document represents a row in a traditional database. | ||
|
||
For example, in a school database, a document can represent one student and contain the following data: | ||
|
||
| ID | Name | GPA | Graduation Year | | ||
|--------|----------|--------|-----------------| | ||
| 1 | John Doe | 3.89 | 2022 | | ||
|
||
Here is what this document looks like in JSON format: | ||
|
||
```json | ||
{ | ||
"name": "John Doe", | ||
"gpa": 3.89, | ||
"grad_year": 2022 | ||
} | ||
``` | ||
Document IDs are assigned in indexing documents. | ||
|
||
## Index | ||
|
||
An index is a collection of documents. | ||
|
||
You can think of an index in several ways: | ||
|
||
- In a database of students, an index represents all students in the database. | ||
- When you search for information, you query data contained in an index. | ||
- An index represents a database table in a traditional database. | ||
|
||
For example, in a school database, an index might contain all students in the school. | ||
|
||
| ID | Name | GPA | Graduation Year | | ||
|--------|--------------|--------|-----------------| | ||
| 1 | John Doe | 3.89 | 2022 | | ||
| 2 | Steve Powers | 3.85 | 2025 | | ||
| 3 | Jane Doe | 3.52 | 2024 | | ||
| ... | | | | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Cloud Essentials for OpenSearch FAQ | ||
description: Discover Scaleway Cloud Essentials for OpenSearch and find answers to general questions. | ||
dates: | ||
validation: | ||
productIcon: openSearch | ||
--- | ||
|
||
## What is Cloud Essentials for OpenSearch | ||
|
||
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. | ||
|
||
Refer to the [quickstart documentation](/opensearch/quickstart/) to get started. |
65 changes: 65 additions & 0 deletions
65
pages/opensearch/how-to/connect-to-opensearch-deployment.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
title: How to connect to a Cloud Essentials for OpenSearch deployment | ||
description: This page provides a guide on how to connect to a Cloud Essentials for OpenSearch deployment using the Scaleway console. | ||
tags: | ||
dates: | ||
validation: 2025-08-05 | ||
posted: 2025-08-05 | ||
--- | ||
|
||
import Requirements from '@macros/iam/requirements.mdx' | ||
|
||
This page explains how to connect an OpenSearch deployment using the Scaleway console. | ||
SamyOubouaziz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
<Requirements /> | ||
|
||
- A Scaleway account logged into the [console](https://console.scaleway.com) | ||
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization | ||
- [Created an OpenSearch deployment](/opensearch/how-to/create-opensearch-deployment/) | ||
|
||
## How to connect to a Cloud Essentials for OpenSearch deployment | ||
|
||
### How to connect to OpenSearch Dashboards | ||
SamyOubouaziz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 connect to. Its **Overview** page displays. | ||
|
||
3. Click the **OpenSearch dashboard** button. | ||
|
||
4. Enter the credentials set up during deployment creation, then click **Log in**. | ||
|
||
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. | ||
SamyOubouaziz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### How to communicate with a deployment using the OpenSearch REST API | ||
|
||
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 connect to. Its **Overview** page displays. | ||
|
||
3. From the **Network** section of the **Overview** page, copy the **API** endpoint. | ||
|
||
4. In a terminal, run the following command to interact with your deployment. Remember to replace the placeholders with the appropriate values: | ||
|
||
```sh | ||
curl -X GET "<deployment_api_endpoint>/_cluster/health" -ku <username>:<password> | ||
``` | ||
|
||
An output similar to the following displays: | ||
|
||
```json | ||
{ | ||
"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 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: How to create a Cloud Essentials for OpenSearch deployment | ||
description: This page provides a guide on how to set up a Cloud Essentials for OpenSearch deployment using the Scaleway console. | ||
tags: opensearch search db engine data manage create deploy dashboard api | ||
dates: | ||
validation: 2025-08-05 | ||
posted: 2025-08-05 | ||
--- | ||
|
||
import Requirements from '@macros/iam/requirements.mdx' | ||
|
||
This page explains how to create an OpenSearch deployment using the Scaleway console. | ||
|
||
<Requirements /> | ||
|
||
- A Scaleway account logged into the [console](https://console.scaleway.com) | ||
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) 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 an OpenSearch version for your deployment. | ||
|
||
4. Select a region where your resource will be deployed. | ||
|
||
5. Select a deployment configuration. You can choose between: | ||
|
||
- **High Availability**: ensures fault tolerance in case of node failure, workload distribution across all nodes for improved performance, service continuity during rolling updates. | ||
- **Standalone**: cost-optimized single-node deployment for testing environments and non-critical, small-scale applications, without redundancy. | ||
|
||
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. | ||
|
||
7. Define a storage capacity for each node. The total storage size for your deployment depends on the number of nodes provisioned. | ||
|
||
8. Configure network connectivity for your deployment. | ||
|
||
9. Create credentials to log in to your OpenSearch deployment. These credentials will grant `admin` access to the user. | ||
|
||
10. Enter a name for your deployment, or keep the automatically generated one. | ||
|
||
11. Review the estimated cost for your cluster, then click **Create deployment** to finish. | ||
SamyOubouaziz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
You are directed to the **Overview** tab of your deployment. | ||
|
||
<Message type="note"> | ||
The creation of a Cloud Essentials for OpenSearch deployment can take up to several minutes to complete. | ||
SamyOubouaziz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
</Message> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: How to delete a Cloud Essentials for OpenSearch deployment | ||
description: This page provides a guide on how to delete a Cloud Essentials for OpenSearch deployment using the Scaleway console. | ||
tags: opensearch search db engine data manage remove drop destroy delete | ||
dates: | ||
validation: 2025-08-05 | ||
posted: 2025-08-05 | ||
--- | ||
import Requirements from '@macros/iam/requirements.mdx' | ||
SamyOubouaziz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
This page explains how to delete an OpenSearch deployment using the Scaleway console. | ||
|
||
<Message type="important"> | ||
Deleting an OpenSearch deployment is irreversible, and all its associated data will be lost. | ||
</Message> | ||
|
||
<Requirements /> | ||
|
||
- A Scaleway account logged into the [console](https://console.scaleway.com) | ||
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization | ||
- [Created an OpenSearch deployment](/opensearch/how-to/create-opensearch-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 <Icon name="more" /> 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. | ||
|
||
<Message type="tip"> | ||
You can also delete an OpenSearch deployment from its **Settings** tab. | ||
</Message> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
title: Cloud Essentials for OpenSearch - How Tos | ||
description: Practical guides for using Scaleway Cloud Essentials for OpenSearch. | ||
--- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: How to manage a Cloud Essentials for OpenSearch deployment | ||
description: This page provides a guide on how to manage a Cloud Essentials for OpenSearch deployment using the Scaleway console. | ||
tags: | ||
dates: | ||
validation: 2025-08-05 | ||
posted: 2025-08-05 | ||
--- | ||
|
||
import Requirements from '@macros/iam/requirements.mdx' | ||
|
||
This page explains how to manage an OpenSearch deployment using the Scaleway console. | ||
|
||
<Requirements /> | ||
|
||
- A Scaleway account logged into the [console](https://console.scaleway.com) | ||
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization | ||
- [Created an OpenSearch deployment](/opensearch/how-to/create-opensearch-deployment/) | ||
|
||
## 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: | ||
SamyOubouaziz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Access the dashboard of your deployment | ||
- View and manage the users of your deployment | ||
- Delete your deployment |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.