Skip to content

Commit 2883da0

Browse files
committed
ddev_and_ibexa_cloud.md: Use both add-ons
1 parent 176f82b commit 2883da0

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

docs/ibexa_cloud/ddev_and_ibexa_cloud.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,24 @@ description: Use DDEV to run an Ibexa Cloud project locally.
66

77
Two ways are available to run an [[= product_name_cloud =]] project locally with DDEV:
88

9-
- [by using the Platform.sh's `ddev-ibexa-cloud` add-on](#with-the-ddev-ibexa-cloud-add-on)
9+
- [by using the Platform.sh's `ddev-platformsh` and `ddev-ibexa-cloud` add-ons](#with-the-ddev-platformsh-and-ddev-ibexa-cloud-add-ons)
1010
- [like other existing project, without this add-on](#without-the-ibexa-cloud-add-on).
1111

1212
!!! note
1313

1414
The following examples use [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.co/).
1515

16-
## With the `ddev-ibexa-cloud` add-on
16+
## With the `ddev-platformsh` and `ddev-ibexa-cloud` add-ons
1717

18-
To configure the [`ddev/ddev-ibexa-cloud` add-on](https://github.com/ddev/ddev-ibexa-cloud), you need a [Platform.sh API Token](https://docs.platform.sh/administration/cli/api-tokens.html).
18+
To configure [`ddev/ddev-platformsh` add-on](https://github.com/ddev/ddev-platformsh) and [`ddev/ddev-ibexa-cloud` add-on](https://github.com/ddev/ddev-ibexa-cloud), you need a [Platform.sh API Token](https://docs.platform.sh/administration/cli/api-tokens.html).
1919

20-
The `ddev/ddev-ibexa-cloud` add-on configures the document root, the PHP version, the database, and the cache pool according to the [[= product_name_cloud =]] configuration.
20+
The `ddev/ddev-platformsh` add-on configures the document root, the PHP version, the database, and the cache pool according to the [[= product_name_cloud =]] configuration.
2121
About the search engine, the add-on can configure Elasticsearch but can't configure Solr.
2222
If you use Solr on [[= product_name_cloud =]] and want to add it to your DDEV stack, see [Clustering with DDEV and `ibexa/ddev-solr` add-on](clustering_with_ddev.md#solr).
2323

24+
The `ddev/ddev-ibexa-cloud` add-on integrate the `ibexa_cloud` command,
25+
and eases the pull of cloud contents into the local installation.
26+
2427
`env:COMPOSER_AUTH` from Platform.sh can't be used, because JSON commas are incorrectly interpreted by `--web-environment-add`, which sees them as multiple variable separators.
2528
But the variable must exist for Platform.sh `hooks` scripts to work.
2629
To use an `auth.json` file for this purpose, see [Using `auth.json`](install_with_ddev.md#using-authjson).
@@ -29,20 +32,21 @@ You must remove Node.js and NVM installations as they're already included in DDE
2932

3033
The following sequence of commands:
3134

32-
1. Downloads the [[= product_name_cloud =]] project from the default environment "production" into a new directory (for example `my-ddev-project`),
33-
using the [`ibexa_cloud` command](https://cli.ibexa.co/).
34-
(Replace `<project-ID>` with the hash of your own project.
35+
1. Downloads the [[= product_name_cloud =]] project from the default environment "production"
36+
into a new directory (for example `my-ddev-project`), using the [`ibexa_cloud` command](https://cli.ibexa.co/).
37+
(Replace `<project-ID>` with the hash of your own project.
3538
See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment).
3639
1. Configures a new DDEV project.
3740
1. Configures the `ddev/ddev-ibexa-cloud` add-on with `<project-ID>` and environment name (for example, `production`).
3841
1. Configures `ibexa_cloud` command token. See [Create an API token](https://docs.platform.sh/administration/cli/api-tokens.html#2-create-an-api-token) for more information.
3942
1. Ignores `.ddev/` directory from Git.
40-
(Some DDEV config could be committed like in [this documentation](https://ddev.readthedocs.io/en/latest/users/extend/customization-extendibility/#extending-configyaml-with-custom-configyaml-files).)
43+
(Some DDEV config could be committed like in [this documentation](https://ddev.readthedocs.io/en/latest/users/extend/customization-extendibility/#extending-configyaml-with-custom-configyaml-files).)
4144
1. Sets Composer authentication by using an already existing `auth.json` file.
45+
1. Installs the `ddev/ddev-platformsh` add-on which prompts for the Platform.sh API token, project ID and environment name.
46+
1. Changes `maxmemory-policy` from default `allkeys-lfu` to a [value accepted by the `RedisTagAwareAdapter`](https://github.com/symfony/cache/blob/5.4/Adapter/RedisTagAwareAdapter.php#L95).
47+
(Check `.ddev/config.platformsh.yaml` and adapt if needed. For example, you may have to comment out New Relic.)
4248
1. Installs the `ddev/ddev-ibexa-cloud` add-on.
43-
(Check `.ddev/config.ibexa-cloud.yaml` and adapt if needed. For example, you may have to comment out New Relic.)
4449
1. Starts the project.
45-
1. Install dependencies.
4650
1. Gets the content from [[= product_name_cloud =]], both database and binary files by using `ddev pull ibexa-cloud` feature from the add-on.
4751
1. Displays information about the project services.
4852
1. Opens the project in a browser.
@@ -54,9 +58,10 @@ ddev config --web-environment-add IBEXA_PROJECT=<project-ID>,IBEXA_ENVIRONMENT=p
5458
ddev config --web-environment-add IBEXA_CLI_TOKEN=<api-token>
5559
echo '.ddev/' >> .gitignore
5660
mkdir -p .ddev/homeadditions/.composer && cp <path-to-an>/auth.json .ddev/homeadditions/.composer
61+
ddev add-on get ddev/ddev-platformsh
62+
sed -i 's/maxmemory-policy allkeys-lfu/maxmemory-policy volatile-lfu/' .ddev/redis/redis.conf
5763
ddev add-on get ddev/ddev-ibexa-cloud
5864
ddev start
59-
ddev composer install
6065
ddev pull ibexa-cloud -y
6166
ddev describe
6267
ddev launch

0 commit comments

Comments
 (0)