Documented ibexa/cloud package by mnocon · Pull Request #2985 · ibexa/documentation-developer

mnocon · 2025-12-15T21:57:57Z

Documentation for https://github.com/ibexa/cloud , including ibexa/cloud#2 and ibexa/recipes-dev#222

github-actions · 2025-12-15T22:10:31Z

Preview of modified files

Preview of modified Markdown:

docs/administration/project_organization/bundles.md

docs/resources/new_in_doc.md

docs/ibexa_cloud/environment_variables.md

+
+- `database` - main application database
+- `dfs_database` - DFS database (required name for DFS functionality)
+- `rediscache` - Redis for cache


barw4 · 2025-12-22T09:50:12Z

docs/infrastructure_and_maintenance/cache/persistence_cache.md

 !!! note "[[= product_name_cloud =]]"

-    For [[= product_name_cloud =]]/Platform.sh: This is automatically configured in `vendor/ibexa/core/src/bundle/Core/DependencyInjection/IbexaCoreExtension.php` if you have enabled Redis as `rediscache` Platform.sh service.
+    For [[= product_name_cloud =]]/Platform.sh, it's configured based on the `.platform.app.yaml` file by the [`ibexa/cloud` package](install_on_ibexa_cloud.md).


Should we migrate naming to "Upsun"?

barw4 · 2025-12-22T09:53:30Z

docs/search/search_engines/solr_search_engine/install_solr.md

-            dsn: '%solr_dsn%'
-            core: '%solr_main_core%'
+            dsn: '%env(string:SOLR_DSN)%'
+            core: '%env(string:SOLR_MAIN_CORE)%'


I think *_CORE are not exposed, it's rather *_HOST now, something to be verified

mnocon · 2026-01-21T08:15:21Z

Thanky you @barw4 , I've added improvements in f8b7e1e

Two questions that came to my mind:

Should we still mention Memcached? It's not supported in v5
Should we somehow mention Valkey here? We probably should, but is it correctly detected etc.?

barw4 · 2026-02-17T09:15:50Z

Should we still mention Memcached? It's not supported in v5

If it's not supported, let's not mention it.

Should we somehow mention Valkey here? We probably should, but is it correctly detected etc.?

Yes, we are supporting it and I think @micszo tested it already

mnocon · 2026-02-17T12:54:18Z

Memcached mentions removed in b286cd9

sonarqubecloud · 2026-02-26T10:10:00Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

dabrt · 2026-02-26T11:34:07Z

docs/administration/project_organization/bundles.md

 |[ibexa/i18n](https://github.com/ibexa/i18n)|Centralized translations to ease synchronization with Crowdin|
 |[ibexa/notifications](https://github.com/ibexa/notifications)| Sending [notifications](notifications.md)|
-|[ibexa/post-install](https://github.com/ibexa/post-install)|Post installation tool|
+|[ibexa/cloud](https://github.com/ibexa/cloud)|(Optional) [[= product_name_cloud =]] integration package|


If the package is optional, shouldn't it be treates like an LTS update, which by definition are opt-in bundles?

dabrt · 2026-02-26T11:34:57Z

docs/administration/project_organization/bundles.md

 |[ibexa/notifications](https://github.com/ibexa/notifications)| Sending [notifications](notifications.md)|
-|[ibexa/post-install](https://github.com/ibexa/post-install)|Post installation tool|
+|[ibexa/cloud](https://github.com/ibexa/cloud)|(Optional) [[= product_name_cloud =]] integration package|
+|[ibexa/post-install](https://github.com/ibexa/post-install)|Bundle containing Apache and nginx templates|


dabrt · 2026-02-26T12:00:13Z

docs/ibexa_cloud/environment_variables.md

+
+# Environment variables on Ibexa Cloud
+
+[[= product_name_cloud =]] automatically generates environment variables based on the Upsun relationships and routes configuration.


Suggested change

[[= product_name_cloud =]] automatically generates environment variables based on the Upsun relationships and routes configuration.

[[= product_name_cloud =]] automatically generates environment variables based on the Upsun relationship and route configuration.

Is it "configuration of relationships and routes" or "relationships and configurations of routes"?

dabrt · 2026-02-26T12:33:33Z

docs/ibexa_cloud/environment_variables.md

+
+Environment variable prefixes are created by converting relationship names to uppercase and replacing hyphens with underscores.
+
+When multiple endpoints are defined for a single relationship, numerical indices are used for all entries except the first one, for example: `SOLR`, `SOLR_1_`, `SOLR_2`.


Would it be SOLR_1_ or SOLR_1 ?

dabrt · 2026-02-26T12:35:36Z

docs/ibexa_cloud/environment_variables.md

+
+## Environment variables in configuration files
+
+If you're referencing [[= product_name_cloud =]] environment variables in your configuration files, you must define placeholder values for them in your `.env` file to prevent Symfony container initialization failures.


Would this call for a warning?, if yes, I'd put "To prevent..." first, followed by "you must define"

dabrt · 2026-02-26T12:46:58Z

docs/infrastructure_and_maintenance/cache/persistence_cache.md

 !!! note "[[= product_name_cloud =]]"

-    For [[= product_name_cloud =]]: This is automatically configured in `vendor/ibexa/core/src/bundle/Core/DependencyInjection/IbexaCoreExtension.php` if you have enabled Redis as `rediscache` Upsun service.
+    For [[= product_name_cloud =]], it's configured based on the `.platform.app.yaml` file by the [`ibexa/cloud` package](install_on_ibexa_cloud.md).


Suggested change

For [[= product_name_cloud =]], it's configured based on the `.platform.app.yaml` file by the [`ibexa/cloud` package](install_on_ibexa_cloud.md).

For [[= product_name_cloud =]] installations, the [`ibexa/cloud` package](install_on_ibexa_cloud.md) performs configuration based on the `.platform.app.yaml` file.

dabrt · 2026-02-26T12:48:18Z

docs/infrastructure_and_maintenance/sessions.md

 !!! note "[[= product_name_cloud =]]"

-    For [[= product_name_cloud =]], this is already configured based on `.platform.app.yaml` config.
+    For [[= product_name_cloud =]], it's configured based on the `.platform.app.yaml` file by the [`ibexa/cloud` package](install_on_ibexa_cloud.md).


Suggested change

For [[= product_name_cloud =]], it's configured based on the `.platform.app.yaml` file by the [`ibexa/cloud` package](install_on_ibexa_cloud.md).

For [[= product_name_cloud =]] installations, the [`ibexa/cloud` package](install_on_ibexa_cloud.md) performs configuration based on the `.platform.app.yaml` file.

dabrt · 2026-02-26T12:49:39Z

docs/release_notes/ibexa_dxp_v5.0.md

+A new `ibexa/cloud` package is now available for [[= product_name_cloud =]] deployments.
+This package replaces the previous `composer ibexa:setup --platformsh` command with a dedicated console command.
+
+The package automatically generates environment variables based on [[= product_name_cloud =]] relationships and routes configuration, making it easier to configure services like databases, cache, search engines, and session storage.


Suggested change

The package automatically generates environment variables based on [[= product_name_cloud =]] relationships and routes configuration, making it easier to configure services like databases, cache, search engines, and session storage.

The package automatically generates environment variables based on [[= product_name_cloud =]] relationship and route configuration, making it easier to configure such services as databases, cache, search engines, and session storage.

Is it "configuration of relationships and routes" or "relationships and configurations of routes"?

dabrt · 2026-02-26T12:50:56Z

docs/resources/new_in_doc.md

+
+### Ibexa Cloud
+
+- Added documentation describing [how to use the new `ibexa/cloud` package](install_on_ibexa_cloud.md) and the [environment variables it provides]


Suggested change

- Added documentation describing [how to use the new `ibexa/cloud` package](install_on_ibexa_cloud.md) and the [environment variables it provides]

- Added documentation describing [how to use the new `ibexa/cloud` package](install_on_ibexa_cloud.md) and the [environment variables it provides](environment_variables.md)

dabrt · 2026-02-26T12:53:23Z

docs/resources/new_in_doc.md

+### Configuration
+
+- Updated [DFS](clustering.md#configuring-the-dfs-io-handler) and [Solr](install_solr.md#configure-the-bundle) configuration examples to use environment variables directly with [Environment Variable Processors]([[= symfony_doc =]]/configuration/env_var_processors.html) syntax instead of intermediate parameters.
+This promotes skipping rebuilding the Symfony container when environment variable values change.


Suggested change

This promotes skipping rebuilding the Symfony container when environment variable values change.

This helps prevent rebuilding the Symfony container when environment variable values change.

or... "This promotes skipping the rebuild of ..."

mnocon force-pushed the ibea-cloud branch 2 times, most recently from df66a49 to f4bdd53 Compare December 16, 2025 12:23

mnocon marked this pull request as ready for review December 16, 2025 12:34

mnocon added the Needs DEV review label Dec 16, 2025

mnocon requested review from barw4 and micszo December 16, 2025 12:35

mnocon commented Dec 17, 2025

View reviewed changes

docs/administration/project_organization/bundles.md Outdated Show resolved Hide resolved

docs/resources/new_in_doc.md Outdated Show resolved Hide resolved

docs/ibexa_cloud/environment_variables.md Outdated Show resolved Hide resolved

barw4 reviewed Dec 22, 2025

View reviewed changes

mnocon added 4 commits January 20, 2026 16:58

Added documentation for ibexa/cloud package

efeb0a5

Mention the package again

7815d84

Apply suggestions from code review

2060a44

Review feedback

f8b7e1e

mnocon force-pushed the ibea-cloud branch from a87ad43 to f8b7e1e Compare January 20, 2026 17:17

mnocon requested a review from barw4 January 22, 2026 08:25

mnocon added 5 commits February 10, 2026 09:36

Added Valkey mentions

350b333

Removed note about DFS and PostgreSQL

1c434e7

Merge remote-tracking branch 'origin/5.0' into ibea-cloud

9ff9ab2

Rebuild

29f39b2

Renamed Platform.sh to Ibexa Cloud

92ff475

mnocon added the Wait with merge PRs that shouldn't be merged instantly label Feb 10, 2026

mnocon added 3 commits February 11, 2026 12:19

Added info about placeholders

029dc09

Added remark that not all variables must be defined

2a2451a

Clarified the example even more

29696f8

Removed Memcached mentions

b286cd9

barw4 approved these changes Feb 26, 2026

View reviewed changes

Vale/self-review

88baab2

mnocon added Needs DOC review and removed Needs DEV review labels Feb 26, 2026

mnocon requested a review from a team February 26, 2026 09:43

ibexa-workflow-automation-1 bot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team February 26, 2026 09:43

Rebuild

51901bf

dabrt requested changes Feb 26, 2026

View reviewed changes

	\|[ibexa/post-install](https://github.com/ibexa/post-install)\|Bundle containing Apache and nginx templates\|
	\|[ibexa/post-install](https://github.com/ibexa/post-install)\|Apache and nginx templates\|


		# Environment variables on Ibexa Cloud

		[[= product_name_cloud =]] automatically generates environment variables based on the Upsun relationships and routes configuration.


		Environment variable prefixes are created by converting relationship names to uppercase and replacing hyphens with underscores.

		When multiple endpoints are defined for a single relationship, numerical indices are used for all entries except the first one, for example: `SOLR`, `SOLR_1_`, `SOLR_2`.


		## Environment variables in configuration files

		If you're referencing [[= product_name_cloud =]] environment variables in your configuration files, you must define placeholder values for them in your `.env` file to prevent Symfony container initialization failures.

	For [[= product_name_cloud =]], it's configured based on the `.platform.app.yaml` file by the [`ibexa/cloud` package](install_on_ibexa_cloud.md).
	For [[= product_name_cloud =]] installations, the [`ibexa/cloud` package](install_on_ibexa_cloud.md) performs configuration based on the `.platform.app.yaml` file.

	The package automatically generates environment variables based on [[= product_name_cloud =]] relationships and routes configuration, making it easier to configure services like databases, cache, search engines, and session storage.
	The package automatically generates environment variables based on [[= product_name_cloud =]] relationship and route configuration, making it easier to configure such services as databases, cache, search engines, and session storage.


		### Ibexa Cloud

		- Added documentation describing [how to use the new `ibexa/cloud` package](install_on_ibexa_cloud.md) and the [environment variables it provides]

	This promotes skipping rebuilding the Symfony container when environment variable values change.
	This helps prevent rebuilding the Symfony container when environment variable values change.

Conversation

mnocon commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview of modified files

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

barw4 Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mnocon commented Jan 21, 2026

Uh oh!

barw4 commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mnocon commented Feb 17, 2026

Uh oh!

sonarqubecloud bot commented Feb 26, 2026

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mnocon commented Dec 15, 2025 •

edited

Loading

github-actions bot commented Dec 15, 2025 •

edited

Loading

barw4 Dec 22, 2025 •

edited

Loading

barw4 commented Feb 17, 2026 •

edited

Loading