From e3e5d6d9f69a0ac55ff8d3bd55d10d5fd0e386c3 Mon Sep 17 00:00:00 2001 From: remi Date: Wed, 19 Feb 2025 11:58:44 +0100 Subject: [PATCH 1/4] Update premium services pages (mongodb and elasticsearch) to reflect to current state --- sites/upsun/src/add-services/elasticsearch.md | 23 +- sites/upsun/src/add-services/mongodb.md | 198 +----------------- 2 files changed, 11 insertions(+), 210 deletions(-) diff --git a/sites/upsun/src/add-services/elasticsearch.md b/sites/upsun/src/add-services/elasticsearch.md index cc4357f35a..b04ed31dae 100644 --- a/sites/upsun/src/add-services/elasticsearch.md +++ b/sites/upsun/src/add-services/elasticsearch.md @@ -17,7 +17,9 @@ You can select the major and minor version. Patch versions are applied periodically for bug fixes and the like. When you deploy your app, you always get the latest available patches. -{{< image-versions image="elasticsearch" status="supported" environment="grid" >}} +{{% note title="No supported versions" theme="info" %}} +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). +{{% /note %}} ## Deprecated versions @@ -26,9 +28,6 @@ but they're at their end of life and are no longer receiving security updates fr {{< image-versions image="elasticsearch" status="deprecated" environment="grid" >}} -To ensure your project remains stable in the future, -switch to [a premium version](#supported-versions). - Alternatively, you can switch to one of the latest, free versions of [OpenSearch](/add-services/opensearch.md). To do so, follow the same procedure as for [upgrading](#upgrading). @@ -111,9 +110,6 @@ export APP_ELASTICSEARCH_HOST=="$(echo $RELATIONSHIPS_JSON | jq -r '.elasticsear {{< /codetabs >}} -For [premium versions](#supported-versions), -the service type is `elasticsearch-enterprise`. - ## Usage example ### 1. Configure the service @@ -127,8 +123,6 @@ services: type: elasticsearch: ``` -If you’re using a [premium version](/add-services/elasticsearch.md#supported-versions), use the ``elasticsearch-enterprise`` type instead. - 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. ### 2. Define the relationship @@ -220,8 +214,6 @@ services: type: elasticsearch:{{% latest "elasticsearch" %}} ``` -If you’re using a [premium version](/add-services/elasticsearch.md#supported-versions), use the ``elasticsearch-enterprise`` type instead. - <---> +++ @@ -245,16 +237,12 @@ services: type: elasticsearch:{{% latest "elasticsearch" %}} ``` -If you’re using a [premium version](/add-services/elasticsearch.md#supported-versions), use the ``elasticsearch-enterprise`` type instead. - {{< /codetabs >}} ### Use in app To use the configured service in your app, add a configuration file similar to the following to your project. -Note that configuration for [premium versions](#supported-versions) may differ slightly. - {{< codetabs >}} +++ @@ -359,8 +347,6 @@ To do so, include the following in your `{{< vendor/configfile "services" >}}` c {{% /snippet %}} ``` -If you're using a [premium version](#supported-versions), -use the `elasticsearch-enterprise` type. That enables mandatory HTTP Basic auth on all requests. 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 {{% /snippet %}} ``` -If you're using a [premium version](#supported-versions), -use the `elasticsearch-enterprise` type. - In this example you'd have the ICU analysis plugin and Python script support plugin. If there is a publicly available plugin you need that isn't listed here, [contact support](/learn/overview/get-support.md). diff --git a/sites/upsun/src/add-services/mongodb.md b/sites/upsun/src/add-services/mongodb.md index 822c4c3af9..07bb359ce6 100644 --- a/sites/upsun/src/add-services/mongodb.md +++ b/sites/upsun/src/add-services/mongodb.md @@ -15,7 +15,10 @@ You can select the major and minor version. Patch versions are applied periodically for bug fixes and the like. When you deploy your app, you always get the latest available patches. -{{< image-versions image="mongodb-enterprise" status="supported" environment="grid" >}} +{{% note title="No supported versions" theme="info" %}} +MongoDB Enterprise isn't available on {{< vendor/name >}} yet. Deprecated versions are free to use. +{{% /note %}} + {{% deprecated-versions %}} @@ -69,7 +72,7 @@ MONGODB_REL=mongodb MONGODB_QUERY={'is_master': True} MONGODB_PATH=main MONGODB_PASSWORD= -MONGODB_TYPE=mongodb-enterprise:{{% latest "mongodb-enterprise" %}} +MONGODB_TYPE=mongodb:{{% latest "mongodb" %}} MONGODB_PORT=27017 ``` @@ -97,7 +100,7 @@ The structure of the `PLATFORM_RELATIONSHIPS` environment variable can be obtain }, "path": "main", "password": null, - "type": "mongodb-enterprise:{{% latest "mongodb-enterprise" %}}", + "type": "mongodb:{{% latest "mongodb" %}}", "port": 27017 } ``` @@ -116,191 +119,6 @@ export APP_MONGODBDATABASE_HOST="$(echo $RELATIONSHIPS_JSON | jq -r '.mongodb[0] ## Usage example -### Enterprise edition example - -#### 1. Configure the service - -To define the service, use the ``mongodb-enterprise`` type: - -```yaml {configFile="app"} -services: - # The name of the service container. Must be unique within a project. - : - type: mongodb-enterprise: -``` - -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. - -#### 2. Define the relationship - -To define the relationship, use the following configuration: -{{< codetabs >}} - -+++ -title=Using default endpoints -+++ - -```yaml {configFile="app"} -applications: - # The name of the app container. Must be unique within a project. - : - # Relationships enable access from this app to a given service. - # The example below shows simplified configuration leveraging a default service - # (identified from the relationship name) and a default endpoint. - # See the Application reference for all options for defining relationships and endpoints. - relationships: - : -``` - -You can define `` as you like, so long as it's unique between all defined services -and matches in both the application and services configuration. - -The example above leverages [default endpoint](/create-apps/app-reference/single-runtime-image#relationships) configuration for relationships. -That is, it uses default endpoints behind-the-scenes, providing a [relationship](/create-apps/app-reference/single-runtime-image#relationships) -(the network address a service is accessible from) that is identical to the _name_ of that service. - -Depending on your needs, instead of default endpoint configuration, -you can use [explicit endpoint configuration](/create-apps/app-reference/single-runtime-image#relationships). - -With the above definition, the application container (````) now has [access to the service](#use-in-app) via the relationship ```` and its corresponding [service environment variables](/development/variables/_index.md#service-environment-variables). - -<---> - -+++ -title=Using explicit endpoints -+++ - -```yaml {configFile="apps"} -applications: - # The name of the app container. Must be unique within a project. - : - # Relationships enable access from this app to a given service. - # The example below shows configuration with an explicitly set service name and endpoint. - # See the Application reference for all options for defining relationships and endpoints. - relationships: - : - service: - endpoint: mongodb -``` - -You can define ```` and ```` as you like, so long as it's unique between all defined services and relationships -and matches in both the application and services configuration. - -The example above leverages [explicit endpoint](/create-apps/app-reference/single-runtime-image#relationships) configuration for relationships. - -Depending on your needs, instead of explicit endpoint configuration, -you can use [default endpoint configuration](/create-apps/app-reference/single-runtime-image#relationships). - -With the above definition, the application container now has [access to the service](#use-in-app) via the relationship `` and its corresponding [service environment variables](/development/variables/_index.md#service-environment-variables). - -{{< /codetabs >}} - -For PHP, enable the [extension](/languages/php/extensions.md) for the service: - -{{< codetabs >}} - -+++ -title=Using default endpoints -+++ - -```yaml {configFile="apps"} -applications: - # The name of the app container. Must be unique within a project. - : - # PHP extensions. - runtime: - extensions: - - mongodb - # Relationships enable access from this app to a given service. - # The example below shows simplified configuration leveraging a default service - # (identified from the relationship name) and a default endpoint. - # See the Application reference for all options for defining relationships and endpoints. - relationships: - : -``` - -<---> - -+++ -title=Using explicit endpoints -+++ - -```yaml {configFile="apps"} -applications: - # The name of the app container. Must be unique within a project. - : - # PHP extensions. - runtime: - extensions: - - mongodb - # Relationships enable access from this app to a given service. - # The example below shows configuration with an explicitly set service name and endpoint. - # See the Application reference for all options for defining relationships and endpoints. - relationships: - : - service: - endpoint: mongodb -``` - -{{< /codetabs >}} - -#### Example configuration - -{{< codetabs >}} - -+++ -title=Using default endpoints -+++ - -```yaml {configFile="apps"} -applications: - # The name of the app container. Must be unique within a project. - myapp: - # PHP extensions. - runtime: - extensions: - - mongodb - # Relationships enable access from this app to a given service. - # The example below shows simplified configuration leveraging a default service - # (identified from the relationship name) and a default endpoint. - # See the Application reference for all options for defining relationships and endpoints. - relationships: - mongodb-enterprise: -services: - # The name of the service container. Must be unique within a project. - mongodb-enterprise: - type: mongodb-enterprise:{{% latest "mongodb-enterprise" %}} -``` - -<---> - -+++ -title=Using explicit endpoints -+++ - -```yaml {configFile="apps"} -applications: - # The name of the app container. Must be unique within a project. - myapp: - # PHP extensions. - runtime: - extensions: - - mongodb - # Relationships enable access from this app to a given service. - # The example below shows configuration with an explicitly set service name and endpoint. - # See the Application reference for all options for defining relationships and endpoints. - relationships: - mongodb-enterprise: - service: mongodb-enterprise - endpoint: mongodb -services: - # The name of the service container. Must be unique within a project. - mongodb-enterprise: - type: mongodb-enterprise:{{% latest "mongodb-enterprise" %}} -``` - -{{< /codetabs >}} - ### Legacy edition example #### 1. Configure the service @@ -520,7 +338,7 @@ applications: mongodb: service: mongodb: - type: mongodb-enterprise:{{% latest "mongodb-enterprise" %}} + type: mongodb:{{% latest "mongodb" %}} ``` <---> @@ -553,7 +371,7 @@ applications: endpoint: mongodb service: mongodb: - type: mongodb-enterprise:{{% latest "mongodb-enterprise" %}} + type: mongodb:{{% latest "mongodb" %}} ``` {{< /codetabs >}} From f5cdb59ab5f1199e5c493e2ad2e362c8244d0712 Mon Sep 17 00:00:00 2001 From: remi Date: Wed, 19 Feb 2025 14:29:50 +0100 Subject: [PATCH 2/4] Remove 'supported versions section' --- sites/upsun/src/add-services/elasticsearch.md | 6 ------ sites/upsun/src/add-services/mongodb.md | 7 ------- 2 files changed, 13 deletions(-) diff --git a/sites/upsun/src/add-services/elasticsearch.md b/sites/upsun/src/add-services/elasticsearch.md index b04ed31dae..5e2f577401 100644 --- a/sites/upsun/src/add-services/elasticsearch.md +++ b/sites/upsun/src/add-services/elasticsearch.md @@ -11,12 +11,6 @@ premium : true See the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) for more information. -## Supported versions - -You can select the major and minor version. - -Patch versions are applied periodically for bug fixes and the like. When you deploy your app, you always get the latest available patches. - {{% note title="No supported versions" theme="info" %}} 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). {{% /note %}} diff --git a/sites/upsun/src/add-services/mongodb.md b/sites/upsun/src/add-services/mongodb.md index 07bb359ce6..3fefa5ec1b 100644 --- a/sites/upsun/src/add-services/mongodb.md +++ b/sites/upsun/src/add-services/mongodb.md @@ -8,13 +8,6 @@ premium: true {{< description >}} -## Supported versions - -You can select the major and minor version. - -Patch versions are applied periodically for bug fixes and the like. -When you deploy your app, you always get the latest available patches. - {{% note title="No supported versions" theme="info" %}} MongoDB Enterprise isn't available on {{< vendor/name >}} yet. Deprecated versions are free to use. {{% /note %}} From 38db891c50de213e365c2234a056d1be628429fa Mon Sep 17 00:00:00 2001 From: remi Date: Thu, 20 Feb 2025 16:46:42 +0100 Subject: [PATCH 3/4] Improve warning message --- sites/upsun/src/add-services/elasticsearch.md | 2 +- sites/upsun/src/add-services/mongodb.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/sites/upsun/src/add-services/elasticsearch.md b/sites/upsun/src/add-services/elasticsearch.md index 5e2f577401..f266a35792 100644 --- a/sites/upsun/src/add-services/elasticsearch.md +++ b/sites/upsun/src/add-services/elasticsearch.md @@ -12,7 +12,7 @@ premium : true See the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) for more information. {{% note title="No supported versions" theme="info" %}} -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). +Elasticsearch premium versions (>=7.17) aren't available on {{< vendor/name >}} yet. Deprecated versions are free to use. Alternatively, you can switch to one of the latest, free versions of [OpenSearch](/add-services/opensearch.md). {{% /note %}} ## Deprecated versions diff --git a/sites/upsun/src/add-services/mongodb.md b/sites/upsun/src/add-services/mongodb.md index 3fefa5ec1b..321ca88119 100644 --- a/sites/upsun/src/add-services/mongodb.md +++ b/sites/upsun/src/add-services/mongodb.md @@ -8,6 +8,7 @@ premium: true {{< description >}} + {{% note title="No supported versions" theme="info" %}} MongoDB Enterprise isn't available on {{< vendor/name >}} yet. Deprecated versions are free to use. {{% /note %}} From 00cc52a58804ff894fea15ae8eb67aabbe53b94f Mon Sep 17 00:00:00 2001 From: Kemi Elizabeth <97071326+Kemi-Elizabeth@users.noreply.github.com> Date: Fri, 21 Feb 2025 14:10:04 +0000 Subject: [PATCH 4/4] Update mongodb.md Removed support versions link --- sites/upsun/src/add-services/mongodb.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/sites/upsun/src/add-services/mongodb.md b/sites/upsun/src/add-services/mongodb.md index 321ca88119..e9b625ace2 100644 --- a/sites/upsun/src/add-services/mongodb.md +++ b/sites/upsun/src/add-services/mongodb.md @@ -13,8 +13,10 @@ premium: true MongoDB Enterprise isn't available on {{< vendor/name >}} yet. Deprecated versions are free to use. {{% /note %}} +### Deprecated versions -{{% deprecated-versions %}} +The following versions are [deprecated](/glossary.html#deprecated-versions). +They're available, but they aren't receiving security updates from upstream and aren't guaranteed to work. {{< image-versions image="mongodb-enterprise" status="deprecated" environment="grid" >}}