Skip to content

Commit e3e5d6d

Browse files
author
remi
committed
Update premium services pages (mongodb and elasticsearch) to reflect to current state
1 parent c39a264 commit e3e5d6d

File tree

2 files changed

+11
-210
lines changed

2 files changed

+11
-210
lines changed

sites/upsun/src/add-services/elasticsearch.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ You can select the major and minor version.
1717

1818
Patch versions are applied periodically for bug fixes and the like. When you deploy your app, you always get the latest available patches.
1919

20-
{{< image-versions image="elasticsearch" status="supported" environment="grid" >}}
20+
{{% note title="No supported versions" theme="info" %}}
21+
Elasticsearch premium versions (>=7.17) aren't available on {{< vendor/name >}} yet. Deprecated versions are free to use or use [OpenSearch](/add-services/opensearch.md).
22+
{{% /note %}}
2123

2224
## Deprecated versions
2325

@@ -26,9 +28,6 @@ but they're at their end of life and are no longer receiving security updates fr
2628

2729
{{< image-versions image="elasticsearch" status="deprecated" environment="grid" >}}
2830

29-
To ensure your project remains stable in the future,
30-
switch to [a premium version](#supported-versions).
31-
3231
Alternatively, you can switch to one of the latest, free versions of [OpenSearch](/add-services/opensearch.md).
3332
To do so, follow the same procedure as for [upgrading](#upgrading).
3433

@@ -111,9 +110,6 @@ export APP_ELASTICSEARCH_HOST=="$(echo $RELATIONSHIPS_JSON | jq -r '.elasticsear
111110

112111
{{< /codetabs >}}
113112

114-
For [premium versions](#supported-versions),
115-
the service type is `elasticsearch-enterprise`.
116-
117113
## Usage example
118114

119115
### 1. Configure the service
@@ -127,8 +123,6 @@ services:
127123
type: elasticsearch:<VERSION>
128124
```
129125
130-
If you’re using a [premium version](/add-services/elasticsearch.md#supported-versions), use the ``elasticsearch-enterprise`` type instead.
131-
132126
Note that changing the name of the service replaces it with a brand new service and all existing data is lost. Back up your data before changing the service.
133127
134128
### 2. Define the relationship
@@ -220,8 +214,6 @@ services:
220214
type: elasticsearch:{{% latest "elasticsearch" %}}
221215
```
222216

223-
If you’re using a [premium version](/add-services/elasticsearch.md#supported-versions), use the ``elasticsearch-enterprise`` type instead.
224-
225217
<--->
226218

227219
+++
@@ -245,16 +237,12 @@ services:
245237
type: elasticsearch:{{% latest "elasticsearch" %}}
246238
```
247239

248-
If you’re using a [premium version](/add-services/elasticsearch.md#supported-versions), use the ``elasticsearch-enterprise`` type instead.
249-
250240
{{< /codetabs >}}
251241

252242
### Use in app
253243

254244
To use the configured service in your app, add a configuration file similar to the following to your project.
255245

256-
Note that configuration for [premium versions](#supported-versions) may differ slightly.
257-
258246
{{< codetabs >}}
259247

260248
+++
@@ -359,8 +347,6 @@ To do so, include the following in your `{{< vendor/configfile "services" >}}` c
359347
{{% /snippet %}}
360348
```
361349

362-
If you're using a [premium version](#supported-versions),
363-
use the `elasticsearch-enterprise` type.
364350

365351
That enables mandatory HTTP Basic auth on all requests.
366352
The credentials are available in any relationships that point at that service,
@@ -401,9 +387,6 @@ To enable them, list them under the `configuration.plugins` key in your `{{< ven
401387
{{% /snippet %}}
402388
```
403389

404-
If you're using a [premium version](#supported-versions),
405-
use the `elasticsearch-enterprise` type.
406-
407390
In this example you'd have the ICU analysis plugin and Python script support plugin.
408391

409392
If there is a publicly available plugin you need that isn't listed here, [contact support](/learn/overview/get-support.md).

sites/upsun/src/add-services/mongodb.md

Lines changed: 8 additions & 190 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ You can select the major and minor version.
1515
Patch versions are applied periodically for bug fixes and the like.
1616
When you deploy your app, you always get the latest available patches.
1717

18-
{{< image-versions image="mongodb-enterprise" status="supported" environment="grid" >}}
18+
{{% note title="No supported versions" theme="info" %}}
19+
MongoDB Enterprise isn't available on {{< vendor/name >}} yet. Deprecated versions are free to use.
20+
{{% /note %}}
21+
1922

2023
{{% deprecated-versions %}}
2124

@@ -69,7 +72,7 @@ MONGODB_REL=mongodb
6972
MONGODB_QUERY={'is_master': True}
7073
MONGODB_PATH=main
7174
MONGODB_PASSWORD=
72-
MONGODB_TYPE=mongodb-enterprise:{{% latest "mongodb-enterprise" %}}
75+
MONGODB_TYPE=mongodb:{{% latest "mongodb" %}}
7376
MONGODB_PORT=27017
7477
```
7578

@@ -97,7 +100,7 @@ The structure of the `PLATFORM_RELATIONSHIPS` environment variable can be obtain
97100
},
98101
"path": "main",
99102
"password": null,
100-
"type": "mongodb-enterprise:{{% latest "mongodb-enterprise" %}}",
103+
"type": "mongodb:{{% latest "mongodb" %}}",
101104
"port": 27017
102105
}
103106
```
@@ -116,191 +119,6 @@ export APP_MONGODBDATABASE_HOST="$(echo $RELATIONSHIPS_JSON | jq -r '.mongodb[0]
116119

117120
## Usage example
118121

119-
### Enterprise edition example
120-
121-
#### 1. Configure the service
122-
123-
To define the service, use the ``mongodb-enterprise`` type:
124-
125-
```yaml {configFile="app"}
126-
services:
127-
# The name of the service container. Must be unique within a project.
128-
<SERVICE_NAME>:
129-
type: mongodb-enterprise:<VERSION>
130-
```
131-
132-
Note that changing the name of the service replaces it with a brand new service and all existing data is lost. Back up your data before changing the service.
133-
134-
#### 2. Define the relationship
135-
136-
To define the relationship, use the following configuration:
137-
{{< codetabs >}}
138-
139-
+++
140-
title=Using default endpoints
141-
+++
142-
143-
```yaml {configFile="app"}
144-
applications:
145-
# The name of the app container. Must be unique within a project.
146-
<APP_NAME>:
147-
# Relationships enable access from this app to a given service.
148-
# The example below shows simplified configuration leveraging a default service
149-
# (identified from the relationship name) and a default endpoint.
150-
# See the Application reference for all options for defining relationships and endpoints.
151-
relationships:
152-
<SERVICE_NAME>:
153-
```
154-
155-
You can define `<SERVICE_NAME>` as you like, so long as it's unique between all defined services
156-
and matches in both the application and services configuration.
157-
158-
The example above leverages [default endpoint](/create-apps/app-reference/single-runtime-image#relationships) configuration for relationships.
159-
That is, it uses default endpoints behind-the-scenes, providing a [relationship](/create-apps/app-reference/single-runtime-image#relationships)
160-
(the network address a service is accessible from) that is identical to the _name_ of that service.
161-
162-
Depending on your needs, instead of default endpoint configuration,
163-
you can use [explicit endpoint configuration](/create-apps/app-reference/single-runtime-image#relationships).
164-
165-
With the above definition, the application container (``<APP_NAME>``) now has [access to the service](#use-in-app) via the relationship ``<SERVICE_NAME>`` and its corresponding [service environment variables](/development/variables/_index.md#service-environment-variables).
166-
167-
<--->
168-
169-
+++
170-
title=Using explicit endpoints
171-
+++
172-
173-
```yaml {configFile="apps"}
174-
applications:
175-
# The name of the app container. Must be unique within a project.
176-
<APP_NAME>:
177-
# Relationships enable access from this app to a given service.
178-
# The example below shows configuration with an explicitly set service name and endpoint.
179-
# See the Application reference for all options for defining relationships and endpoints.
180-
relationships:
181-
<RELATIONSHIP_NAME>:
182-
service: <SERVICE_NAME>
183-
endpoint: mongodb
184-
```
185-
186-
You can define ``<SERVICE_NAME>`` and ``<RELATIONSHIP_NAME>`` as you like, so long as it's unique between all defined services and relationships
187-
and matches in both the application and services configuration.
188-
189-
The example above leverages [explicit endpoint](/create-apps/app-reference/single-runtime-image#relationships) configuration for relationships.
190-
191-
Depending on your needs, instead of explicit endpoint configuration,
192-
you can use [default endpoint configuration](/create-apps/app-reference/single-runtime-image#relationships).
193-
194-
With the above definition, the application container now has [access to the service](#use-in-app) via the relationship `<RELATIONSHIP_NAME>` and its corresponding [service environment variables](/development/variables/_index.md#service-environment-variables).
195-
196-
{{< /codetabs >}}
197-
198-
For PHP, enable the [extension](/languages/php/extensions.md) for the service:
199-
200-
{{< codetabs >}}
201-
202-
+++
203-
title=Using default endpoints
204-
+++
205-
206-
```yaml {configFile="apps"}
207-
applications:
208-
# The name of the app container. Must be unique within a project.
209-
<APP_NAME>:
210-
# PHP extensions.
211-
runtime:
212-
extensions:
213-
- mongodb
214-
# Relationships enable access from this app to a given service.
215-
# The example below shows simplified configuration leveraging a default service
216-
# (identified from the relationship name) and a default endpoint.
217-
# See the Application reference for all options for defining relationships and endpoints.
218-
relationships:
219-
<SERVICE_NAME>:
220-
```
221-
222-
<--->
223-
224-
+++
225-
title=Using explicit endpoints
226-
+++
227-
228-
```yaml {configFile="apps"}
229-
applications:
230-
# The name of the app container. Must be unique within a project.
231-
<APP_NAME>:
232-
# PHP extensions.
233-
runtime:
234-
extensions:
235-
- mongodb
236-
# Relationships enable access from this app to a given service.
237-
# The example below shows configuration with an explicitly set service name and endpoint.
238-
# See the Application reference for all options for defining relationships and endpoints.
239-
relationships:
240-
<RELATIONSHIP_NAME>:
241-
service: <SERVICE_NAME>
242-
endpoint: mongodb
243-
```
244-
245-
{{< /codetabs >}}
246-
247-
#### Example configuration
248-
249-
{{< codetabs >}}
250-
251-
+++
252-
title=Using default endpoints
253-
+++
254-
255-
```yaml {configFile="apps"}
256-
applications:
257-
# The name of the app container. Must be unique within a project.
258-
myapp:
259-
# PHP extensions.
260-
runtime:
261-
extensions:
262-
- mongodb
263-
# Relationships enable access from this app to a given service.
264-
# The example below shows simplified configuration leveraging a default service
265-
# (identified from the relationship name) and a default endpoint.
266-
# See the Application reference for all options for defining relationships and endpoints.
267-
relationships:
268-
mongodb-enterprise:
269-
services:
270-
# The name of the service container. Must be unique within a project.
271-
mongodb-enterprise:
272-
type: mongodb-enterprise:{{% latest "mongodb-enterprise" %}}
273-
```
274-
275-
<--->
276-
277-
+++
278-
title=Using explicit endpoints
279-
+++
280-
281-
```yaml {configFile="apps"}
282-
applications:
283-
# The name of the app container. Must be unique within a project.
284-
myapp:
285-
# PHP extensions.
286-
runtime:
287-
extensions:
288-
- mongodb
289-
# Relationships enable access from this app to a given service.
290-
# The example below shows configuration with an explicitly set service name and endpoint.
291-
# See the Application reference for all options for defining relationships and endpoints.
292-
relationships:
293-
mongodb-enterprise:
294-
service: mongodb-enterprise
295-
endpoint: mongodb
296-
services:
297-
# The name of the service container. Must be unique within a project.
298-
mongodb-enterprise:
299-
type: mongodb-enterprise:{{% latest "mongodb-enterprise" %}}
300-
```
301-
302-
{{< /codetabs >}}
303-
304122
### Legacy edition example
305123

306124
#### 1. Configure the service
@@ -520,7 +338,7 @@ applications:
520338
mongodb:
521339
service:
522340
mongodb:
523-
type: mongodb-enterprise:{{% latest "mongodb-enterprise" %}}
341+
type: mongodb:{{% latest "mongodb" %}}
524342
```
525343

526344
<--->
@@ -553,7 +371,7 @@ applications:
553371
endpoint: mongodb
554372
service:
555373
mongodb:
556-
type: mongodb-enterprise:{{% latest "mongodb-enterprise" %}}
374+
type: mongodb:{{% latest "mongodb" %}}
557375
```
558376

559377
{{< /codetabs >}}

0 commit comments

Comments
 (0)