Skip to content

Commit cab1563

Browse files
committed
Update Opensearch capabilities guide
1 parent bd7920c commit cab1563

File tree

15 files changed

+765
-422
lines changed

15 files changed

+765
-422
lines changed

pages/platform/databases/opensearch_01_capabilities/guide.de-de.md

Lines changed: 51 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ section: OpenSearch - Guides
66
order: 010
77
routes:
88
canonical: 'https://docs.ovh.com/gb/en/publiccloud/databases/opensearch/capabilities/'
9-
updated: 2023-01-19
9+
updated: 2023-04-22
1010
---
1111

12-
**Last updated January 19th, 2023**
12+
**Last updated April 22nd, 2023**
1313

1414
## Objective
1515

@@ -36,9 +36,10 @@ Database nodes have to be in the same region. Multi-AZ is currently not supporte
3636

3737
The Public Cloud Databases offer supports the following OpenSearch versions:
3838

39-
- OpenSearch 1.1
39+
- OpenSearch 1
40+
- OpenSearch 2
4041

41-
You can follow version history for OpenSearch version on their official page: <https://opensearch.org/docs/latest/version-history/>
42+
Please refer to the [DBMS lifecycle policy guide](https://docs.ovh.com/gb/en/publiccloud/databases/lifecycle-policy/) for recommendations on version upgrades and end of life announcements of major versions. You can, additionally, follow version history for OpenSearch version on their official page: <https://opensearch.org/docs/latest/version-history/>
4243

4344
### OpenSearch clients and plugins compatibility
4445

@@ -60,13 +61,16 @@ Here is an overview of the various plans' capabilities:
6061
| *Business* | 3 | Planned |
6162
| *Enterprise* | 6 | Planned |
6263

63-
Your choice of plan affects the number of nodes your cluster can run, the SLA, and a few other features such as backup retention.
64+
Your choice of plan affects the number of nodes your cluster can run, the SLA, and a few other features such as read replicas or backup retention.
65+
66+
> [!primary]
67+
> Be aware that you will be able to upgrade your plan but will not be able to downgrade it afterwards.
6468
6569
#### Nodes and replicas
6670

6771
- **Essential**: the cluster can support at most one node.
68-
- **Business**: The cluster is delivered with 3 nodes by default.
69-
- **Enterprise**: The cluster is delivered with 6 nodes by default.
72+
- **Business**: the cluster is delivered with 3 nodes by default.
73+
- **Enterprise**: the cluster is delivered with 6 nodes by default.
7074

7175
#### License type
7276

@@ -79,35 +83,44 @@ Here are the node types you can choose from:
7983

8084
**Essentials plans**
8185

82-
| Name | Disk (GB) | Cores | Memory (GB) |
83-
| ------- | --------- | ----- | ----------- |
84-
| db1-7 | 80 | 2 | 7 |
85-
| db1-15 | 160 | 4 | 15 |
86+
| Name | Storage | vCore | Memory (GB) |
87+
| ------- | ----------------------| ----- | ----------- |
88+
| db1-4 | From 40 GB to 120 GB | 2 | 4 |
89+
| db1-7 | From 80 GB to 240 GB | 2 | 7 |
90+
| db1-15 | From 160 GB to 480 GB | 4 | 15 |
8691

8792

8893
**Business plans**
8994

90-
| Name | Disk (GB) | Cores | Memory (GB) |
91-
| ------- | --------- | ----- | ----------- |
92-
| db1-7 | 240 | 2 | 7 |
93-
| db1-15 | 480 | 4 | 15 |
94-
| db1-30 | 960 | 8 | 30 |
95-
| db1-60 | 1920 | 16 | 60 |
96-
| db1-120 | 3840 | 32 | 120 |
95+
| Name | Storage | vCore | Memory (GB) |
96+
| ------- | ------------------------ | ----- | ----------- |
97+
| db1-7 | From 240 GB to 720 GB | 2 | 7 |
98+
| db1-15 | From 480 GB to 1.44 TB | 4 | 15 |
99+
| db1-30 | From 960 GB to 2.88 TB | 8 | 30 |
100+
| db1-60 | From 1.92 TB to 5.76 TB | 16 | 60 |
101+
| db1-120 | From 3.84 TB to 11.52 TB | 32 | 120 |
97102

98103

99104
**Enterprise plans**
100105

101-
| Name | Disk (GB) | Cores | Memory (GB) |
102-
| ------- | --------- | ----- | ----------- |
103-
| db1-7 | 480 | 2 | 7 |
104-
| db1-15 | 960 | 4 | 15 |
105-
| db1-30 | 1920 | 8 | 30 |
106-
| db1-60 | 3840 | 16 | 60 |
107-
| db1-120 | 7680 | 32 | 120 |
106+
| Name | Storage | vCore | Memory (GB) |
107+
| ------- | ------------------------ | ----- | ----------- |
108+
| db1-7 | From 480 GB to 1.44 TB | 2 | 7 |
109+
| db1-15 | From 960 GB to 2.88 TB | 4 | 15 |
110+
| db1-30 | From 1.92 TB to 5.76 TB | 8 | 30 |
111+
| db1-60 | From 3.84 TB to 11.52 TB | 16 | 60 |
112+
| db1-120 | From 7.68 TB to 23.04 TB | 32 | 120 |
108113

109114
Right now, all nodes of a given cluster should be of the same type and distributed in the same region.
110115

116+
#### Flexible storage
117+
118+
You can increased the storage of your cluster up to the maximum allowed for a given reference. Please refer to the [Resize your cluster storage guide](https://docs.ovh.com/gb/en/publiccloud/databases/resize-cluster-storage/) for more information.
119+
120+
#### Node template upgrade
121+
122+
You can upgrade the node template of your cluster to scale your hardware resources up. This operation causes no interruption of service but be aware that you will not be able to downgrade the node template afterwards.
123+
111124
#### Disk type
112125

113126
The type of storage available may vary according to the region your cluster lives in: see [Availability of Public Cloud products](https://www.ovhcloud.com/de/public-cloud/regions-availability/) for more information about block storage type availability depending on region. Thus, your cluster may be backed by e.g. *High Speed* or *High Speed Gen2* block storage.
@@ -120,6 +133,14 @@ Public Cloud Databases will select the most efficient disk type for your cluster
120133

121134
The disk size listed above is the total disk size of the underlying machine. However, a small part of it goes towards the OS install.
122135

136+
We try hard to avoid "disk full" situations that could be harmful to cluster health. Therefore:
137+
138+
1. When reaching a concerning level of disk usage, a warning email is sent.
139+
2. When reaching a concerning level of disk usage, the service is moved in the "DISK_FULL" state, and "read-only" mode, meaning no more writes can be done.
140+
3. You then have the ability to upgrade to a higher service plan with more storage.
141+
142+
See the [Handling «Disk Full» situations documentation](https://docs.ovh.com/gb/en/publiccloud/databases/handling-disk-full/) for more information.
143+
123144
### Features
124145

125146
#### Plugin enabled by default
@@ -157,10 +178,13 @@ Here are some considerations to take into account when using private network:
157178
- When connecting from outside subnet, Openstack IP gateway must be enabled in the subnet use for the Database service. The customer is responsible for any other custom network setup.
158179

159180

181+
##### Authorised IPs
182+
183+
Once your service is up and running, you will be able to specify IP addresses (or CIDR blocks) to authorise incoming traffic, until then your service will be unreachable.
160184

161185
#### Advanced parameters
162186

163-
We do not currently support OpenSearch advanced parameters.
187+
You can customize your Opensearch further through the use of advanced parameters. See the [Advanced parameters references documentation](https://help.ovhcloud.com/csm/en-gb-public-cloud-databases-opensearch-advanced-parameters-references?id=kb_article_view&sysparm_article=KB0054697) for more information about which ones are supported.
164188

165189
#### Backups
166190

@@ -172,8 +196,7 @@ We do not currently support OpenSearch advanced parameters.
172196

173197
#### Logs and metrics
174198

175-
Logs and metrics are available via the OVHcloud Public Cloud Control Panel.
176-
As of today, you can't export logs and metrics, nor plug them into a remote tool.
199+
Logs and metrics are available through the Control Panel and the API. Additionally, cross service integration could be configured to leverage your logs and metrics in other Public Cloud Database services. You could then view your Opensearch metrics in Grafana. See the [Cross Service Integration documentation](https://docs.ovh.com/gb/en/publiccloud/databases/cross-service-integration/) for more information.
177200

178201
- **Logs retention**: 1000 lines of logs
179202
- **Metrics retention**: 1 calendar month

pages/platform/databases/opensearch_01_capabilities/guide.en-asia.md

Lines changed: 51 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ slug: opensearch/capabilities
44
excerpt: Discover the capabilities and limitations of Public Cloud Databases for OpenSearch
55
section: OpenSearch - Guides
66
order: 010
7-
updated: 2023-01-19
7+
updated: 2023-04-22
88
---
99

10-
**Last updated January 19th, 2023**
10+
**Last updated April 22nd, 2023**
1111

1212
## Objective
1313

@@ -34,9 +34,10 @@ Database nodes have to be in the same region. Multi-AZ is currently not supporte
3434

3535
The Public Cloud Databases offer supports the following OpenSearch versions:
3636

37-
- OpenSearch 1.1
37+
- OpenSearch 1
38+
- OpenSearch 2
3839

39-
You can follow version history for OpenSearch version on their official page: <https://opensearch.org/docs/latest/version-history/>
40+
Please refer to the [DBMS lifecycle policy guide](https://docs.ovh.com/gb/en/publiccloud/databases/lifecycle-policy/) for recommendations on version upgrades and end of life announcements of major versions. You can, additionally, follow version history for OpenSearch version on their official page: <https://opensearch.org/docs/latest/version-history/>
4041

4142
### OpenSearch clients and plugins compatibility
4243

@@ -58,13 +59,16 @@ Here is an overview of the various plans' capabilities:
5859
| *Business* | 3 | Planned |
5960
| *Enterprise* | 6 | Planned |
6061

61-
Your choice of plan affects the number of nodes your cluster can run, the SLA, and a few other features such as backup retention.
62+
Your choice of plan affects the number of nodes your cluster can run, the SLA, and a few other features such as read replicas or backup retention.
63+
64+
> [!primary]
65+
> Be aware that you will be able to upgrade your plan but will not be able to downgrade it afterwards.
6266
6367
#### Nodes and replicas
6468

6569
- **Essential**: the cluster can support at most one node.
66-
- **Business**: The cluster is delivered with 3 nodes by default.
67-
- **Enterprise**: The cluster is delivered with 6 nodes by default.
70+
- **Business**: the cluster is delivered with 3 nodes by default.
71+
- **Enterprise**: the cluster is delivered with 6 nodes by default.
6872

6973
#### License type
7074

@@ -77,35 +81,44 @@ Here are the node types you can choose from:
7781

7882
**Essentials plans**
7983

80-
| Name | Disk (GB) | Cores | Memory (GB) |
81-
| ------- | --------- | ----- | ----------- |
82-
| db1-7 | 80 | 2 | 7 |
83-
| db1-15 | 160 | 4 | 15 |
84+
| Name | Storage | vCore | Memory (GB) |
85+
| ------- | ----------------------| ----- | ----------- |
86+
| db1-4 | From 40 GB to 120 GB | 2 | 4 |
87+
| db1-7 | From 80 GB to 240 GB | 2 | 7 |
88+
| db1-15 | From 160 GB to 480 GB | 4 | 15 |
8489

8590

8691
**Business plans**
8792

88-
| Name | Disk (GB) | Cores | Memory (GB) |
89-
| ------- | --------- | ----- | ----------- |
90-
| db1-7 | 240 | 2 | 7 |
91-
| db1-15 | 480 | 4 | 15 |
92-
| db1-30 | 960 | 8 | 30 |
93-
| db1-60 | 1920 | 16 | 60 |
94-
| db1-120 | 3840 | 32 | 120 |
93+
| Name | Storage | vCore | Memory (GB) |
94+
| ------- | ------------------------ | ----- | ----------- |
95+
| db1-7 | From 240 GB to 720 GB | 2 | 7 |
96+
| db1-15 | From 480 GB to 1.44 TB | 4 | 15 |
97+
| db1-30 | From 960 GB to 2.88 TB | 8 | 30 |
98+
| db1-60 | From 1.92 TB to 5.76 TB | 16 | 60 |
99+
| db1-120 | From 3.84 TB to 11.52 TB | 32 | 120 |
95100

96101

97102
**Enterprise plans**
98103

99-
| Name | Disk (GB) | Cores | Memory (GB) |
100-
| ------- | --------- | ----- | ----------- |
101-
| db1-7 | 480 | 2 | 7 |
102-
| db1-15 | 960 | 4 | 15 |
103-
| db1-30 | 1920 | 8 | 30 |
104-
| db1-60 | 3840 | 16 | 60 |
105-
| db1-120 | 7680 | 32 | 120 |
104+
| Name | Storage | vCore | Memory (GB) |
105+
| ------- | ------------------------ | ----- | ----------- |
106+
| db1-7 | From 480 GB to 1.44 TB | 2 | 7 |
107+
| db1-15 | From 960 GB to 2.88 TB | 4 | 15 |
108+
| db1-30 | From 1.92 TB to 5.76 TB | 8 | 30 |
109+
| db1-60 | From 3.84 TB to 11.52 TB | 16 | 60 |
110+
| db1-120 | From 7.68 TB to 23.04 TB | 32 | 120 |
106111

107112
Right now, all nodes of a given cluster should be of the same type and distributed in the same region.
108113

114+
#### Flexible storage
115+
116+
You can increased the storage of your cluster up to the maximum allowed for a given reference. Please refer to the [Resize your cluster storage guide](https://docs.ovh.com/gb/en/publiccloud/databases/resize-cluster-storage/) for more information.
117+
118+
#### Node template upgrade
119+
120+
You can upgrade the node template of your cluster to scale your hardware resources up. This operation causes no interruption of service but be aware that you will not be able to downgrade the node template afterwards.
121+
109122
#### Disk type
110123

111124
The type of storage available may vary according to the region your cluster lives in: see [Availability of Public Cloud products](https://www.ovhcloud.com/asia/public-cloud/regions-availability/) for more information about block storage type availability depending on region. Thus, your cluster may be backed by e.g. *High Speed* or *High Speed Gen2* block storage.
@@ -118,6 +131,14 @@ Public Cloud Databases will select the most efficient disk type for your cluster
118131

119132
The disk size listed above is the total disk size of the underlying machine. However, a small part of it goes towards the OS install.
120133

134+
We try hard to avoid "disk full" situations that could be harmful to cluster health. Therefore:
135+
136+
1. When reaching a concerning level of disk usage, a warning email is sent.
137+
2. When reaching a concerning level of disk usage, the service is moved in the "DISK_FULL" state, and "read-only" mode, meaning no more writes can be done.
138+
3. You then have the ability to upgrade to a higher service plan with more storage.
139+
140+
See the [Handling «Disk Full» situations documentation](https://docs.ovh.com/gb/en/publiccloud/databases/handling-disk-full/) for more information.
141+
121142
### Features
122143

123144
#### Plugin enabled by default
@@ -154,10 +175,13 @@ Here are some considerations to take into account when using private network:
154175
- Network ports are created in the private network of your choice. Thus, further operations on that network might be restricted - e.g. you won’t be able to delete the network if you didn’t stop the Public Cloud Databases services first.
155176
- When connecting from outside subnet, Openstack IP gateway must be enabled in the subnet use for the Database service. The customer is responsible for any other custom network setup.
156177

178+
##### Authorised IPs
179+
180+
Once your service is up and running, you will be able to specify IP addresses (or CIDR blocks) to authorise incoming traffic, until then your service will be unreachable.
157181

158182
#### Advanced parameters
159183

160-
We do not currently support OpenSearch advanced parameters.
184+
You can customize your Opensearch further through the use of advanced parameters. See the [Advanced parameters references documentation](https://help.ovhcloud.com/csm/en-gb-public-cloud-databases-opensearch-advanced-parameters-references?id=kb_article_view&sysparm_article=KB0054697) for more information about which ones are supported.
161185

162186
#### Backups
163187

@@ -169,8 +193,7 @@ We do not currently support OpenSearch advanced parameters.
169193

170194
#### Logs and metrics
171195

172-
Logs and metrics are available via the OVHcloud Public Cloud Control Panel.
173-
As of today, you can't export logs and metrics, nor plug them into a remote tool.
196+
Logs and metrics are available through the Control Panel and the API. Additionally, cross service integration could be configured to leverage your logs and metrics in other Public Cloud Database services. You could then view your Opensearch metrics in Grafana. See the [Cross Service Integration documentation](https://docs.ovh.com/gb/en/publiccloud/databases/cross-service-integration/) for more information.
174197

175198
- **Logs retention**: 1000 lines of logs
176199
- **Metrics retention**: 1 calendar month

0 commit comments

Comments
 (0)