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", 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/concepts.mdx b/pages/opensearch/concepts.mdx new file mode 100644 index 0000000000..e949843070 --- /dev/null +++ b/pages/opensearch/concepts.mdx @@ -0,0 +1,63 @@ +--- +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 | diff --git a/pages/opensearch/faq.mdx b/pages/opensearch/faq.mdx new file mode 100644 index 0000000000..3c28183b2f --- /dev/null +++ b/pages/opensearch/faq.mdx @@ -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. \ 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..59e8bfcce7 --- /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 to 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/create-opensearch-deployment.mdx b/pages/opensearch/how-to/create-opensearch-deployment.mdx new file mode 100644 index 0000000000..c2f984ff93 --- /dev/null +++ b/pages/opensearch/how-to/create-opensearch-deployment.mdx @@ -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. + + + +- 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. + +You are directed to the **Overview** tab of your deployment. + + +The creation of a Cloud Essentials for OpenSearch deployment can take several minutes to complete. + 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..a5fa62f1d1 --- /dev/null +++ b/pages/opensearch/how-to/delete-opensearch-deployment.mdx @@ -0,0 +1,36 @@ +--- +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' + +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/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..3230fb4d37 --- /dev/null +++ b/pages/opensearch/how-to/manage-opensearch-deployment.mdx @@ -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. + + + +- 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 the Overview, you can: + + - Access the dashboard of your deployment + - View and manage the users of your deployment + - Delete your deployment diff --git a/pages/opensearch/how-to/manage-users-opensearch-deployment.mdx b/pages/opensearch/how-to/manage-users-opensearch-deployment.mdx new file mode 100644 index 0000000000..d648719b05 --- /dev/null +++ b/pages/opensearch/how-to/manage-users-opensearch-deployment.mdx @@ -0,0 +1,37 @@ +--- +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: + 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. Their 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. + diff --git a/pages/opensearch/index.mdx b/pages/opensearch/index.mdx new file mode 100644 index 0000000000..aa7f59e710 --- /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..7a4b9b327c --- /dev/null +++ b/pages/opensearch/quickstart.mdx @@ -0,0 +1,112 @@ +--- +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: 2025-08-05 + posted: 2025-08-05 +--- + +import Requirements from '@macros/iam/requirements.mdx' + +Apache OpenSearch allows you to research, analyze, and visualize all your unstructured data with an open-source search and analytics suite. It provides a fully-managed NoSQL database service to perform full-text searches and visualize results. + +Cloud Essentials for OpenSearch is a managed solution to quickly deploy a robust database search engine that can be distributed across several nodes for enhanced performance and high availability. + +This guide covers the basic steps to set up, log in to, and delete a Cloud Essentials for OpenSearch deployment. + + + +- 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 deployments for testing environments and non-critical, small-scale applications, without redundancy. + +4. Select the **SEARCHDB-SHARED-2C-8G** node type. + +5. Define a storage capacity of **5 GB**. + +6. Keep the default **network connectivity**. + +7. Create credentials to log in to your OpenSearch deployment. These credentials will grant `admin` access to the user. + +8. Enter a name for your deployment, or keep the automatically generated one. + +9. Review the estimated cost for your deployment, then click **Create deployment** to finish. + +You are directed to the **Overview** tab of your deployment. + + +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 + +### 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 diff --git a/pages/opensearch/reference-content/index.mdx b/pages/opensearch/reference-content/index.mdx new file mode 100644 index 0000000000..72b03ea4b5 --- /dev/null +++ b/pages/opensearch/reference-content/index.mdx @@ -0,0 +1,4 @@ +--- +title: Cloud Essentials for OpenSearch - Additional Content +description: Cloud Essentials for OpenSearch additional content. +--- \ No newline at end of file diff --git a/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx b/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx new file mode 100644 index 0000000000..622aec1312 --- /dev/null +++ b/pages/opensearch/reference-content/shared-vs-dedicated-resources.mdx @@ -0,0 +1,78 @@ +--- +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-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. + +Understanding the difference between these two techniques is the key to creating 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 deployment, 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.