From 2806cd3bd11a57893693e84428ec1360f21cc00a Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 22 Jul 2025 12:06:36 +0200 Subject: [PATCH 01/19] feat(OPS): add OpenSearch doc MTA-6320 --- pages/opensearch/concepts.mdx | 14 +++++ pages/opensearch/faq.mdx | 7 +++ .../how-to/create-opensearch-deployment.mdx | 10 ++++ .../how-to/delete-opensearch-deployment.mdx | 10 ++++ pages/opensearch/how-to/index.mdx | 4 ++ .../how-to/manage-opensearch-deployment.mdx | 10 ++++ pages/opensearch/index.mdx | 52 +++++++++++++++++++ pages/opensearch/quickstart.mdx | 10 ++++ pages/opensearch/reference-content/index.mdx | 4 ++ 9 files changed, 121 insertions(+) create mode 100644 pages/opensearch/concepts.mdx create mode 100644 pages/opensearch/faq.mdx create mode 100644 pages/opensearch/how-to/create-opensearch-deployment.mdx create mode 100644 pages/opensearch/how-to/delete-opensearch-deployment.mdx create mode 100644 pages/opensearch/how-to/index.mdx create mode 100644 pages/opensearch/how-to/manage-opensearch-deployment.mdx create mode 100644 pages/opensearch/index.mdx create mode 100644 pages/opensearch/quickstart.mdx create mode 100644 pages/opensearch/reference-content/index.mdx diff --git a/pages/opensearch/concepts.mdx b/pages/opensearch/concepts.mdx new file mode 100644 index 0000000000..20ca2fd862 --- /dev/null +++ b/pages/opensearch/concepts.mdx @@ -0,0 +1,14 @@ +--- +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-07-22 + validation: 2025-07-22 +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. \ No newline at end of file diff --git a/pages/opensearch/faq.mdx b/pages/opensearch/faq.mdx new file mode 100644 index 0000000000..a7a4c9b170 --- /dev/null +++ b/pages/opensearch/faq.mdx @@ -0,0 +1,7 @@ +--- +title: Cloud Essentials for OpenSearch FAQ +description: Discover Scaleway Cloud Essentials for OpenSearch and find answers to general questions. +dates: + validation: +productIcon: productIcon +--- \ No newline at end of file diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx new file mode 100644 index 0000000000..fa45fc4e3e --- /dev/null +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -0,0 +1,10 @@ +--- +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: +dates: + validation: + posted: +categories: + - +--- \ No newline at end of file diff --git a/pages/opensearch/how-to/delete-opensearch-deployment.mdx b/pages/opensearch/how-to/delete-opensearch-deployment.mdx new file mode 100644 index 0000000000..3cf228a404 --- /dev/null +++ b/pages/opensearch/how-to/delete-opensearch-deployment.mdx @@ -0,0 +1,10 @@ +--- +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: +dates: + validation: + posted: +categories: + - +--- \ No newline at end of file diff --git a/pages/opensearch/how-to/index.mdx b/pages/opensearch/how-to/index.mdx new file mode 100644 index 0000000000..bd9e5d5c4e --- /dev/null +++ b/pages/opensearch/how-to/index.mdx @@ -0,0 +1,4 @@ +--- +title: Cloud Essentials for OpenSearch - How Tos +description: Practical guides for using Scaleway Cloud Essentials for OpenSearch. +--- \ No newline at end of file diff --git a/pages/opensearch/how-to/manage-opensearch-deployment.mdx b/pages/opensearch/how-to/manage-opensearch-deployment.mdx new file mode 100644 index 0000000000..39b96b2321 --- /dev/null +++ b/pages/opensearch/how-to/manage-opensearch-deployment.mdx @@ -0,0 +1,10 @@ +--- +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: + posted: +categories: + - +--- \ No newline at end of file diff --git a/pages/opensearch/index.mdx b/pages/opensearch/index.mdx new file mode 100644 index 0000000000..eb51831291 --- /dev/null +++ b/pages/opensearch/index.mdx @@ -0,0 +1,52 @@ +--- +title: Cloud Essentials for OpenSearch Documentation +description: Dive into Scaleway Cloud Essentials for OpenSearch with our quickstart guides, how-tos, tutorials and more. +--- + + + +## Getting Started + + + + + + + + +## Changelog + + diff --git a/pages/opensearch/quickstart.mdx b/pages/opensearch/quickstart.mdx new file mode 100644 index 0000000000..8477c01b8c --- /dev/null +++ b/pages/opensearch/quickstart.mdx @@ -0,0 +1,10 @@ +--- +title: Cloud Essentials for OpenSearch - Quickstart +description: This page shows you how to get started with Scaleway Cloud Essentials for OpenSearch. +tags: product name quickstart example guide step guide +dates: + validation: + posted: +categories: + - opensearch +--- \ No newline at end of file diff --git a/pages/opensearch/reference-content/index.mdx b/pages/opensearch/reference-content/index.mdx new file mode 100644 index 0000000000..7fbba47619 --- /dev/null +++ b/pages/opensearch/reference-content/index.mdx @@ -0,0 +1,4 @@ +--- +title: Cloud Essentials for OpenSearch - Additional Content +description: [PRODUCT NAME] additional content. +--- \ No newline at end of file From 21ff3c46f2dbe79efc426666f05715dcc06bc048 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 22 Jul 2025 12:08:59 +0200 Subject: [PATCH 02/19] feat(OPS): update --- pages/opensearch/reference-content/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/opensearch/reference-content/index.mdx b/pages/opensearch/reference-content/index.mdx index 7fbba47619..72b03ea4b5 100644 --- a/pages/opensearch/reference-content/index.mdx +++ b/pages/opensearch/reference-content/index.mdx @@ -1,4 +1,4 @@ --- title: Cloud Essentials for OpenSearch - Additional Content -description: [PRODUCT NAME] additional content. +description: Cloud Essentials for OpenSearch additional content. --- \ No newline at end of file From c1467981582766e9934fc68ec623db3442e95d20 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 29 Jul 2025 12:03:39 +0200 Subject: [PATCH 03/19] feat(OPS): update --- .../how-to/create-opensearch-deployment.mdx | 36 +++++++++++++++---- pages/opensearch/index.mdx | 2 +- .../shared-vs-dedicated-resources.mdx | 13 +++++++ 3 files changed, 44 insertions(+), 7 deletions(-) create mode 100644 pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx index fa45fc4e3e..51fd3b5386 100644 --- a/pages/opensearch/how-to/create-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -1,10 +1,34 @@ --- 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: +tags: opensearch search db engine data manage create deploy dashboard api dates: - validation: - posted: -categories: - - ---- \ No newline at end of file + validation: 2025-07-29 + posted: 2025-07-29 +--- + +import Requirements from '@macros/iam/requirements.mdx' + +This page explains how to create an OpenSearch deployment using the Scaleway console. + + + +- 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. \ No newline at end of file diff --git a/pages/opensearch/index.mdx b/pages/opensearch/index.mdx index eb51831291..6df05632fd 100644 --- a/pages/opensearch/index.mdx +++ b/pages/opensearch/index.mdx @@ -5,7 +5,7 @@ description: Dive into Scaleway Cloud Essentials for OpenSearch with our quickst Date: Tue, 29 Jul 2025 14:16:18 +0200 Subject: [PATCH 04/19] feat(OPS): update --- pages/opensearch/how-to/create-opensearch-deployment.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx index 51fd3b5386..9a8117714e 100644 --- a/pages/opensearch/how-to/create-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -31,4 +31,11 @@ This page explains how to create an OpenSearch deployment using the Scaleway con - **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. \ No newline at end of file +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. + From 8825a28bb988118425f56aabc7d7545f284be69d Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Thu, 31 Jul 2025 11:32:00 +0200 Subject: [PATCH 05/19] feat(OPS): update --- pages/opensearch/concepts.mdx | 52 ++++++++++++++++++- .../how-to/create-opensearch-deployment.mdx | 4 ++ .../how-to/delete-opensearch-deployment.mdx | 37 ++++++++++--- .../how-to/manage-opensearch-deployment.mdx | 30 +++++++++-- 4 files changed, 111 insertions(+), 12 deletions(-) diff --git a/pages/opensearch/concepts.mdx b/pages/opensearch/concepts.mdx index 20ca2fd862..de5697d3d7 100644 --- a/pages/opensearch/concepts.mdx +++ b/pages/opensearch/concepts.mdx @@ -11,4 +11,54 @@ categories: ## 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. \ No newline at end of file +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 | + | ... | | | | diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx index 9a8117714e..70b3e30571 100644 --- a/pages/opensearch/how-to/create-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -39,3 +39,7 @@ This page explains how to create an OpenSearch deployment using the Scaleway con 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. + diff --git a/pages/opensearch/how-to/delete-opensearch-deployment.mdx b/pages/opensearch/how-to/delete-opensearch-deployment.mdx index 3cf228a404..0e4f3d0a97 100644 --- a/pages/opensearch/how-to/delete-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/delete-opensearch-deployment.mdx @@ -1,10 +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: +tags: opensearch search db engine data manage remove drop destroy delete dates: - validation: - posted: -categories: - - ---- \ No newline at end of file + validation: 2025-07-31 + posted: 2025-07-31 +--- +import Requirements from '@macros/iam/requirements.mdx' + +This page explains how to delete an OpenSearch deployment using the Scaleway console. + + +Deleting an OpenSearch deployment is irreversible, and all its associated data will be lost. + + + + +- 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 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. + + +You can also delete an OpenSearch deployment from its **Settings** tab. + \ No newline at end of file diff --git a/pages/opensearch/how-to/manage-opensearch-deployment.mdx b/pages/opensearch/how-to/manage-opensearch-deployment.mdx index 39b96b2321..8183f34faf 100644 --- a/pages/opensearch/how-to/manage-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/manage-opensearch-deployment.mdx @@ -3,8 +3,28 @@ 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: - posted: -categories: - - ---- \ No newline at end of file + validation: 2025-07-31 + posted: 2025-07-31 +--- + +import Requirements from '@macros/iam/requirements.mdx' + +This page explains how to manage an OpenSearch deployment using the Scaleway console. + + + +- 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: + + - Access the dashboard of your deployment + - View and manage the users of your deployment + - Delete your deployment From 46723af87967973764ef3ae5e1aa89a9d0ee5ade Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Thu, 31 Jul 2025 11:45:19 +0200 Subject: [PATCH 06/19] feat(OPS): update --- .../shared-vs-dedicated-resources.mdx | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx b/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx index dcaf6353e4..fabd8c4a67 100644 --- a/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx +++ b/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx @@ -11,3 +11,68 @@ When creating a Cloud Essentials for OpenSearch deployment, selecting the approp Understanding the difference between these two techniques is key to create a deployment adapted to your needs. +## Comparison of shared and dedicated offers + +| Feature | Shared vCPU | Dedicated vCPU | +|---------------------------------|------------------------------------------------------------|----------------------------------------------------------------| +| CPU access | Physical cores shared across multiple deployments | Exclusive access to physical CPU cores | +| Isolation | Strong virtual isolation, no data sharing between deployments | Full physical resource isolation | +| Performance consistency | Variable – depends on other workloads on the host | High – consistent and predictable performance | +| Resource contention risk | Possible during peak usage | None | +| Latency sensitivity | Not suitable for latency-sensitive apps | Ideal for latency-critical applications | +| Cost | Lower | Higher | +| Use case | Dev/staging, personal projects, blogs, low-traffic sites | Production apps, eCommerce, CI/CD, ML, real-time processing | +| Best for | Non-critical or experimental workloads | Business-critical, latency-sensitive or high-performance workloads | + + +## Shared offers + +Nodes with shared vCPU are cost-effective computational units in which CPU resources are shared among multiple deployments. This means that while each deployment gets its own vCPUs, these vCPUs are scheduled on physical cores that are shared across multiple deployments. + +As a result, deployments share physical CPU time, and during peak demand from other resources on the same host machine, your workloads might temporarily slow down due to CPU contention (also known as "CPU steal"). + +While physical CPU threads are shared between deployments, vCPUs are dedicated to each deployments, and no data can be shared or accessed between resources through this setup. + +### Typical use cases + +- Development and staging environments +- Small and non-critical production environments +- Applications tolerant to occasional performance variability +- Experimental or proof-of-concept projects +- Small-scale applications with limited traffic + +### Summary + +- Shared offers provide an affordable solution for non-critical workloads. +- CPU performance is less predictable and may fluctuate depending on neighboring workloads ("noisy neighbors"). +- During peak usage, your workloads might experience temporary slowdowns due to CPU steal. + +## Dedicated offers + +Nodes with dedicated vCPU, provide exclusive access to physical CPU cores. +This ensures consistent and predictable performance at all times. Dedicated offers are perfect for applications that require high CPU utilization and low latency. + +### Typical use cases + +- Production applications with high CPU demands +- Machine learning and scientific computing +- Real-time data processing and analytics +- High-traffic/utilization environments + +### Summary + +- Dedicated vCPU allocation ensures consistent and predictable performance. +- No risk of performance degradation due to neighboring workloads. +- Dedicated offers are more expensive than shared vCPU deployments, but offer guaranteed CPU performance. + +## Choosing the right configuration + +Choose a **shared vCPU** offer if: +- You are running non-critical or experimental workloads +- Budget is a priority over performance consistency + +Choose a **dedicated vCPU** offer if: +- Your application requires stable, predictable CPU performance +- You are in a production environment with strict performance requirements + +Consider your needs and workload requirements to choose the best vCPU provisioning option for your Cloud Essentials for OpenSearch deployment. From d0bafe342a7ad109479d5a232fa25d7bdacc1e6a Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 15:33:29 +0200 Subject: [PATCH 07/19] docs(ops): update --- json | 1 + .../connect-to-opensearch-deployment.mdx | 65 +++++++++++++++++++ .../manage-opensearch-deployment-users.mdx | 37 +++++++++++ 3 files changed, 103 insertions(+) create mode 100644 json create mode 100644 pages/opensearch/how-to/connect-to-opensearch-deployment.mdx create mode 100644 pages/opensearch/how-to/manage-opensearch-deployment-users.mdx diff --git a/json b/json new file mode 100644 index 0000000000..04e1ec6c59 --- /dev/null +++ b/json @@ -0,0 +1 @@ +{"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,"relocating_shards":0,"initializing_shards":0,"unassigned_shards":0,"delayed_unassigned_shards":0,"number_of_pending_tasks":0,"number_of_in_flight_fetch":0,"task_max_waiting_in_queue_millis":0,"active_shards_percent_as_number":100.0} \ No newline at end of file diff --git a/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx b/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx new file mode 100644 index 0000000000..b9ddfb642a --- /dev/null +++ b/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx @@ -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. + + + +- 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 + +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. + +### 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 "/_cluster/health" -ku : + ``` + + 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. diff --git a/pages/opensearch/how-to/manage-opensearch-deployment-users.mdx b/pages/opensearch/how-to/manage-opensearch-deployment-users.mdx new file mode 100644 index 0000000000..949ee6da94 --- /dev/null +++ b/pages/opensearch/how-to/manage-opensearch-deployment-users.mdx @@ -0,0 +1,37 @@ +--- +title: How to manages the users of a Cloud Essentials for OpenSearch deployment +description: This page provides a guide on how to manage the users of 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 the users of an OpenSearch deployment using the Scaleway console. + + + +- 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/) + + +During private beta, only one user is allowed per deployment. Its credentials are defined during deployment creation. + + +## How to change a user's password + +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 in which you want to update a user's password. Its **Overview** page displays. + +3. Click the **Users** tab. The list of users within your deployment displays. + +4. Click **Change password** next to the appropriate user. A pop-up displays. + +5. Enter a new password, or automatically generate one, then click **Update password**. + +You can now [connect to your deployment](/opensearch/how-to/connect-to-opensearch-deployment/) using the new credentials. + From 5c7aae2da34f093602a78d2e0b0dca01b0cd605c Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 15:36:46 +0200 Subject: [PATCH 08/19] docs(ops): update --- pages/opensearch/how-to/manage-opensearch-deployment-users.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/opensearch/how-to/manage-opensearch-deployment-users.mdx b/pages/opensearch/how-to/manage-opensearch-deployment-users.mdx index 949ee6da94..a7af21c383 100644 --- a/pages/opensearch/how-to/manage-opensearch-deployment-users.mdx +++ b/pages/opensearch/how-to/manage-opensearch-deployment-users.mdx @@ -1,6 +1,6 @@ --- title: How to manages the users of a Cloud Essentials for OpenSearch deployment -description: This page provides a guide on how to manage the users of a Cloud Essentials for OpenSearch deployment using the Scaleway console. +description: This page provides detailed information on how to manage the users of a Cloud Essentials for OpenSearch deployment using the Scaleway console. tags: dates: validation: 2025-08-05 From 2b2b9740773852dff8b7120d9af057fb2d43ac2d Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 15:43:52 +0200 Subject: [PATCH 09/19] docs(ops): update --- ...eployment-users.mdx => manage-users-opensearch-deployment.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename pages/opensearch/how-to/{manage-opensearch-deployment-users.mdx => manage-users-opensearch-deployment.mdx} (100%) diff --git a/pages/opensearch/how-to/manage-opensearch-deployment-users.mdx b/pages/opensearch/how-to/manage-users-opensearch-deployment.mdx similarity index 100% rename from pages/opensearch/how-to/manage-opensearch-deployment-users.mdx rename to pages/opensearch/how-to/manage-users-opensearch-deployment.mdx From 46dfa15e6f00f4aa16b17b2d7d96af7d0c9e8e9f Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 16:12:54 +0200 Subject: [PATCH 10/19] docs(ops): update --- .../how-to/create-opensearch-deployment.mdx | 7 ++ pages/opensearch/quickstart.mdx | 110 +++++++++++++++++- 2 files changed, 112 insertions(+), 5 deletions(-) diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx index 70b3e30571..058a4756a9 100644 --- a/pages/opensearch/how-to/create-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -43,3 +43,10 @@ This page explains how to create an OpenSearch deployment using the Scaleway con 11. Review the estimated cost for your cluster, then click **Create deployment** to finish. +You are directed to the **Overview** tab of your deployment. + + +The creation of a Cloud Essentials for OpenSearch deployment can take up to several minutes to complete. + + +## How to connect to \ No newline at end of file diff --git a/pages/opensearch/quickstart.mdx b/pages/opensearch/quickstart.mdx index 8477c01b8c..f87b25d011 100644 --- a/pages/opensearch/quickstart.mdx +++ b/pages/opensearch/quickstart.mdx @@ -3,8 +3,108 @@ title: Cloud Essentials for OpenSearch - Quickstart description: This page shows you how to get started with Scaleway Cloud Essentials for OpenSearch. tags: product name quickstart example guide step guide dates: - validation: - posted: -categories: - - opensearch ---- \ No newline at end of file + validation: 2025-08-05 + posted: 2025-08-05 +--- + +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. + +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. + + + +- 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 the **Standalone** deployment configuration. Standalone deployments are cost-optimized single-node deployment 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. + + +The creation of a Cloud Essentials for OpenSearch deployment can take up to several minutes to complete. + + +## 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: + + ```sh + curl -X GET "/_cluster/health" -ku : + ``` + + 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 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 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. + + +You can also delete an OpenSearch deployment from its **Settings** tab. + \ No newline at end of file From e9b0183e308bd25ddc24cffa28451a54c2dfd58b Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 16:31:37 +0200 Subject: [PATCH 11/19] docs(ops): update --- json | 1 - 1 file changed, 1 deletion(-) delete mode 100644 json diff --git a/json b/json deleted file mode 100644 index 04e1ec6c59..0000000000 --- a/json +++ /dev/null @@ -1 +0,0 @@ -{"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,"relocating_shards":0,"initializing_shards":0,"unassigned_shards":0,"delayed_unassigned_shards":0,"number_of_pending_tasks":0,"number_of_in_flight_fetch":0,"task_max_waiting_in_queue_millis":0,"active_shards_percent_as_number":100.0} \ No newline at end of file From ffb80ed7f613a007fc09250aa744f7ca4c9a50e1 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 16:56:28 +0200 Subject: [PATCH 12/19] docs(ops): update --- menu/navigation.json | 58 +++++++++++++++++++++++++++++++++ pages/opensearch/faq.mdx | 10 ++++-- pages/opensearch/quickstart.mdx | 2 ++ 3 files changed, 68 insertions(+), 2 deletions(-) diff --git a/menu/navigation.json b/menu/navigation.json index 590e194679..5f20b34597 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -2458,6 +2458,64 @@ "label": "Managed MongoDB®", "slug": "managed-mongodb-databases" }, + { + "items": [ + { + "label": "Overview", + "slug": "../opensearch" + }, + { + "label": "Concepts", + "slug": "concepts" + }, + { + "label": "Quickstart", + "slug": "quickstart" + }, + { + "label": "FAQ", + "slug": "faq" + }, + { + "items": [ + { + "label": "Create a deployment", + "slug": "create-opensearch-deployment" + }, + { + "label": "Connect to a deployment", + "slug": "connect-to-opensearch-deployment" + }, + { + "label": "Manage a deployment", + "slug": "manage-opensearch-deployment" + }, + { + "label": "Manage the users of a deployment", + "slug": "manage-users-opensearch-deployment" + }, + { + "label": "Delete a deployment", + "slug": "delete-opensearch-deployment" + } + ], + "label": "How to", + "slug": "how-to" + }, + { + "items": [ + { + "label": "Choosing between shared and dedicated resources", + "slug": "shared-vs-dedicated-resources" + } + ], + "label": "Additional Content", + "slug": "reference-content" + } + ], + "label": "Cloud Essentials for OpenSearch", + "slug": "opensearch" + }, { "items": [ { diff --git a/pages/opensearch/faq.mdx b/pages/opensearch/faq.mdx index a7a4c9b170..3c28183b2f 100644 --- a/pages/opensearch/faq.mdx +++ b/pages/opensearch/faq.mdx @@ -3,5 +3,11 @@ title: Cloud Essentials for OpenSearch FAQ description: Discover Scaleway Cloud Essentials for OpenSearch and find answers to general questions. dates: validation: -productIcon: productIcon ---- \ No newline at end of file +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. \ No newline at end of file diff --git a/pages/opensearch/quickstart.mdx b/pages/opensearch/quickstart.mdx index f87b25d011..5099e2971d 100644 --- a/pages/opensearch/quickstart.mdx +++ b/pages/opensearch/quickstart.mdx @@ -7,6 +7,8 @@ dates: posted: 2025-08-05 --- +import Requirements from '@macros/iam/requirements.mdx' + 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. 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. From 71914e12887922c5a084566a727ea96b97ea8eb5 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 16:58:56 +0200 Subject: [PATCH 13/19] docs(ops): update --- pages/opensearch/concepts.mdx | 4 ++-- pages/opensearch/how-to/create-opensearch-deployment.mdx | 4 ++-- pages/opensearch/how-to/delete-opensearch-deployment.mdx | 4 ++-- pages/opensearch/how-to/manage-opensearch-deployment.mdx | 4 ++-- .../reference-content/shared-vs-dedicated-resources.mdx | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/pages/opensearch/concepts.mdx b/pages/opensearch/concepts.mdx index de5697d3d7..1c254bddb0 100644 --- a/pages/opensearch/concepts.mdx +++ b/pages/opensearch/concepts.mdx @@ -3,8 +3,8 @@ 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-07-22 - validation: 2025-07-22 + published: 2025-08-05 + validation: 2025-08-05 categories: - opensearch --- diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx index 058a4756a9..5170c2eef0 100644 --- a/pages/opensearch/how-to/create-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -3,8 +3,8 @@ 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-07-29 - posted: 2025-07-29 + validation: 2025-08-05 + posted: 2025-08-05 --- import Requirements from '@macros/iam/requirements.mdx' diff --git a/pages/opensearch/how-to/delete-opensearch-deployment.mdx b/pages/opensearch/how-to/delete-opensearch-deployment.mdx index 0e4f3d0a97..2f144258ae 100644 --- a/pages/opensearch/how-to/delete-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/delete-opensearch-deployment.mdx @@ -3,8 +3,8 @@ 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-07-31 - posted: 2025-07-31 + validation: 2025-08-05 + posted: 2025-08-05 --- import Requirements from '@macros/iam/requirements.mdx' diff --git a/pages/opensearch/how-to/manage-opensearch-deployment.mdx b/pages/opensearch/how-to/manage-opensearch-deployment.mdx index 8183f34faf..56953e3c1e 100644 --- a/pages/opensearch/how-to/manage-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/manage-opensearch-deployment.mdx @@ -3,8 +3,8 @@ 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-07-31 - posted: 2025-07-31 + validation: 2025-08-05 + posted: 2025-08-05 --- import Requirements from '@macros/iam/requirements.mdx' diff --git a/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx b/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx index fabd8c4a67..88a5ed3a5a 100644 --- a/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx +++ b/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx @@ -3,8 +3,8 @@ title: Choosing between shared and dedicated resources description: This page provides information on the shared and dedicated node options available for Cloud Essentials for OpenSearch deployments. tags: opensearch search db engine node type shared dedicated compute resource dates: - validation: 2025-07-29 - posted: 2025-07-29 + validation: 2025-08-05 + posted: 2025-08-05 --- When creating a Cloud Essentials for OpenSearch deployment, selecting the appropriate node type is crucial for optimizing performance and cost. Two types of CPU provisioning are available: **shared** and **dedicated** vCPUs. From 0046f8e17c281770a2fc42028448307cadac1d43 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 17:02:17 +0200 Subject: [PATCH 14/19] Update pages/opensearch/how-to/connect-to-opensearch-deployment.mdx --- pages/opensearch/how-to/connect-to-opensearch-deployment.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx b/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx index b9ddfb642a..101a0f378d 100644 --- a/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx @@ -42,7 +42,7 @@ You are now connected to your Cloud Essentials for OpenSearch deployment. Refer 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 "/_cluster/health" -ku : + curl -X GET "/_cluster/health" -ku : ``` An output similar to the following displays: From 29a125aeefe65c9517439ea4b827ef5c44834898 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 17:02:23 +0200 Subject: [PATCH 15/19] docs(ops): update --- pages/opensearch/how-to/create-opensearch-deployment.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx index 5170c2eef0..8a708e9328 100644 --- a/pages/opensearch/how-to/create-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -48,5 +48,3 @@ You are directed to the **Overview** tab of your deployment. The creation of a Cloud Essentials for OpenSearch deployment can take up to several minutes to complete. - -## How to connect to \ No newline at end of file From 199d6c05de1b4202d9e806c3f783a8abf43a9824 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 17:26:34 +0200 Subject: [PATCH 16/19] docs(ops): update --- menu/changelogs.json | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/menu/changelogs.json b/menu/changelogs.json index a96088a89c..31685e3a46 100644 --- a/menu/changelogs.json +++ b/menu/changelogs.json @@ -145,6 +145,10 @@ }, { "items": [ + { + "category": "data-warehouse", + "label": "Data Warehouse for ClickHouse®" + }, { "category": "data-lab", "label": "Data Lab for Apache Spark™" @@ -172,6 +176,10 @@ "category": "mongodb", "label": "Managed MongoDB®" }, + { + "category": "opensearch", + "label": "Cloud Essentials for OpenSearch" + }, { "category": "sql-databases", "label": "SQL Databases" @@ -325,6 +333,10 @@ { "category": "object-storage", "label": "Object Storage" + }, + { + "category": "file-storage", + "label": "File Storage" } ], "category": "storage", From f2f835939a70ba96d5d4b00b3a192a0fa8ca4cf6 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Tue, 5 Aug 2025 17:28:12 +0200 Subject: [PATCH 17/19] Apply suggestions from code review Co-authored-by: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> --- pages/opensearch/how-to/create-opensearch-deployment.mdx | 2 +- pages/opensearch/how-to/manage-opensearch-deployment.mdx | 2 +- .../opensearch/how-to/manage-users-opensearch-deployment.mdx | 4 ++-- pages/opensearch/index.mdx | 2 +- pages/opensearch/quickstart.mdx | 2 +- .../reference-content/shared-vs-dedicated-resources.mdx | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx index 8a708e9328..12b84190b6 100644 --- a/pages/opensearch/how-to/create-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -41,7 +41,7 @@ This page explains how to create an OpenSearch deployment using the Scaleway con 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. +11. Review the estimated cost for your cluster, then click **Create deployment** to finish. You are directed to the **Overview** tab of your deployment. diff --git a/pages/opensearch/how-to/manage-opensearch-deployment.mdx b/pages/opensearch/how-to/manage-opensearch-deployment.mdx index 56953e3c1e..3230fb4d37 100644 --- a/pages/opensearch/how-to/manage-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/manage-opensearch-deployment.mdx @@ -23,7 +23,7 @@ This page explains how to manage an OpenSearch deployment using the Scaleway con 2. Click the name of the OpenSearch deployment you want to manage. Its **Overview** page displays. -3. From here, you can: +3. From the Overview, you can: - Access the dashboard of your deployment - View and manage the users of your deployment diff --git a/pages/opensearch/how-to/manage-users-opensearch-deployment.mdx b/pages/opensearch/how-to/manage-users-opensearch-deployment.mdx index a7af21c383..d648719b05 100644 --- a/pages/opensearch/how-to/manage-users-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/manage-users-opensearch-deployment.mdx @@ -1,5 +1,5 @@ --- -title: How to manages the users of a Cloud Essentials for OpenSearch deployment +title: How to manage the users of a Cloud Essentials for OpenSearch deployment description: This page provides detailed information on how to manage the users of a Cloud Essentials for OpenSearch deployment using the Scaleway console. tags: dates: @@ -18,7 +18,7 @@ This page explains how to manage the users of an OpenSearch deployment using the - [Created an OpenSearch deployment](/opensearch/how-to/create-opensearch-deployment/) -During private beta, only one user is allowed per deployment. Its credentials are defined during deployment creation. +During private beta, only one user is allowed per deployment. Their credentials are defined during deployment creation. ## How to change a user's password diff --git a/pages/opensearch/index.mdx b/pages/opensearch/index.mdx index 6df05632fd..aa7f59e710 100644 --- a/pages/opensearch/index.mdx +++ b/pages/opensearch/index.mdx @@ -8,7 +8,7 @@ description: Dive into Scaleway Cloud Essentials for OpenSearch with our quickst productLogo="openSearch" description="Cloud Essentials for OpenSearch is designed to help users in their reporting and data analysis tasks for business intelligence." url="/opensearch/quickstart" - label=" Cloud Essentials for OpenSearch Quickstart" + label="Cloud Essentials for OpenSearch Quickstart" /> ## Getting Started diff --git a/pages/opensearch/quickstart.mdx b/pages/opensearch/quickstart.mdx index 5099e2971d..70f19481f0 100644 --- a/pages/opensearch/quickstart.mdx +++ b/pages/opensearch/quickstart.mdx @@ -9,7 +9,7 @@ dates: import Requirements from '@macros/iam/requirements.mdx' -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. +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. diff --git a/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx b/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx index 88a5ed3a5a..622aec1312 100644 --- a/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx +++ b/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx @@ -9,7 +9,7 @@ dates: When creating a Cloud Essentials for OpenSearch deployment, selecting the appropriate node type is crucial for optimizing performance and cost. Two types of CPU provisioning are available: **shared** and **dedicated** vCPUs. -Understanding the difference between these two techniques is key to create a deployment adapted to your needs. +Understanding the difference between these two techniques is the key to creating a deployment adapted to your needs. ## Comparison of shared and dedicated offers @@ -31,7 +31,7 @@ Nodes with shared vCPU are cost-effective computational units in which CPU resou As a result, deployments share physical CPU time, and during peak demand from other resources on the same host machine, your workloads might temporarily slow down due to CPU contention (also known as "CPU steal"). -While physical CPU threads are shared between deployments, vCPUs are dedicated to each deployments, and no data can be shared or accessed between resources through this setup. +While physical CPU threads are shared between deployments, vCPUs are dedicated to each deployment, and no data can be shared or accessed between resources through this setup. ### Typical use cases From b2de0f82dd694388c638487e12e7c49034b6b2f7 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Wed, 6 Aug 2025 09:58:42 +0200 Subject: [PATCH 18/19] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Néda <87707325+nerda-codes@users.noreply.github.com> Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> --- pages/opensearch/concepts.mdx | 1 - .../how-to/connect-to-opensearch-deployment.mdx | 2 +- pages/opensearch/how-to/delete-opensearch-deployment.mdx | 1 + pages/opensearch/quickstart.mdx | 8 ++++---- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/pages/opensearch/concepts.mdx b/pages/opensearch/concepts.mdx index 1c254bddb0..e949843070 100644 --- a/pages/opensearch/concepts.mdx +++ b/pages/opensearch/concepts.mdx @@ -61,4 +61,3 @@ For example, in a school database, an index might contain all students in the sc | 1 | John Doe | 3.89 | 2022 | | 2 | Steve Powers | 3.85 | 2025 | | 3 | Jane Doe | 3.52 | 2024 | - | ... | | | | diff --git a/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx b/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx index 101a0f378d..59e8bfcce7 100644 --- a/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/connect-to-opensearch-deployment.mdx @@ -9,7 +9,7 @@ dates: import Requirements from '@macros/iam/requirements.mdx' -This page explains how to connect an OpenSearch deployment using the Scaleway console. +This page explains how to connect to an OpenSearch deployment using the Scaleway console. diff --git a/pages/opensearch/how-to/delete-opensearch-deployment.mdx b/pages/opensearch/how-to/delete-opensearch-deployment.mdx index 2f144258ae..a5fa62f1d1 100644 --- a/pages/opensearch/how-to/delete-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/delete-opensearch-deployment.mdx @@ -6,6 +6,7 @@ dates: validation: 2025-08-05 posted: 2025-08-05 --- + import Requirements from '@macros/iam/requirements.mdx' This page explains how to delete an OpenSearch deployment using the Scaleway console. diff --git a/pages/opensearch/quickstart.mdx b/pages/opensearch/quickstart.mdx index 70f19481f0..7a4b9b327c 100644 --- a/pages/opensearch/quickstart.mdx +++ b/pages/opensearch/quickstart.mdx @@ -13,7 +13,7 @@ Apache OpenSearch allows you to research, analyze, and visualize all your unstru 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. +This guide covers the basic steps to set up, log in to, and delete a Cloud Essentials for OpenSearch deployment. @@ -26,7 +26,7 @@ This guide covers the basic steps to set up, log in to, and delete a Cloud Essen 2. Click **+ Create deployment**. A creation form displays. -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. +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. @@ -38,12 +38,12 @@ This guide covers the basic steps to set up, log in to, and delete a Cloud Essen 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. +9. Review the estimated cost for your deployment, then click **Create deployment** to finish. You are directed to the **Overview** tab of your deployment. -The creation of a Cloud Essentials for OpenSearch deployment can take up to several minutes to complete. +The creation of a Cloud Essentials for OpenSearch deployment can take several minutes to complete. ## How to connect to a Cloud Essentials for OpenSearch deployment From a243c6a5192e36ff18dcd4a82455db5ebd5c61f3 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Wed, 6 Aug 2025 10:07:32 +0200 Subject: [PATCH 19/19] Update pages/opensearch/how-to/create-opensearch-deployment.mdx Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> --- pages/opensearch/how-to/create-opensearch-deployment.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/opensearch/how-to/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx index 12b84190b6..c2f984ff93 100644 --- a/pages/opensearch/how-to/create-opensearch-deployment.mdx +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -46,5 +46,5 @@ This page explains how to create an OpenSearch deployment using the Scaleway con You are directed to the **Overview** tab of your deployment. -The creation of a Cloud Essentials for OpenSearch deployment can take up to several minutes to complete. +The creation of a Cloud Essentials for OpenSearch deployment can take several minutes to complete.