Skip to content

Commit d0bafe3

Browse files
committed
docs(ops): update
1 parent 46723af commit d0bafe3

File tree

3 files changed

+103
-0
lines changed

3 files changed

+103
-0
lines changed

json

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

0 commit comments

Comments
 (0)