IBX-9395: ddev-ibexa-cloud add-on

docs/ibexa_cloud/ddev_and_ibexa_cloud.md

@@ -6,59 +6,62 @@ description: Use DDEV to run an Ibexa Cloud project locally.
 
 Two ways are available to run an [[= product_name_cloud =]] project locally with DDEV:
 
-- [by using the Platform.sh's `ddev-platformsh` add-on](#with-the-ddev-platformsh-add-on)
-- [like other existing project, without this add-on](#without-the-platformsh-add-on).
+- [by using the `ddev-platformsh` and `ddev-ibexa-cloud` add-ons](#with-ibexa-cloud-add-ons)
+- [like other existing project, without these add-ons](#without-ibexa-cloud-add-ons).
 
 !!! note
 
     The following examples use [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.co/).
 
-## With the `ddev-platformsh` add-on
+## With Ibexa Cloud add-ons
 
-To configure the [`ddev/ddev-platformsh` add-on](https://github.com/ddev/ddev-platformsh), you need a [Platform.sh API Token](https://docs.platform.sh/administration/cli/api-tokens.html).
+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).
 
 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.
 About the search engine, the add-on can configure Elasticsearch but can't configure Solr.
 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).
 
-`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.
+The `ddev/ddev-ibexa-cloud` add-on integrates the `ibexa_cloud` command inside the container,
+and eases the pull of cloud contents into the local installation.
+
+`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.
 But the variable must exist for Platform.sh `hooks` scripts to work.
 To use an `auth.json` file for this purpose, see [Using `auth.json`](install_with_ddev.md#using-authjson).
 
-You must remove Node.js and NVM installations as they're already included in DDEV.
-
 The following sequence of commands:
 
-1. Downloads the [[= product_name_cloud =]] Platform.sh project from the default environment "production" into a new directory, based on the [Platform.sh CLI alias `ibexa_cloud` defined in introduction](#ibexa-cloud-and-ddev).
-(Replace `<project-ID>` with the hash of your own project.
+1. Downloads the [[= product_name_cloud =]] project from the default environment "production"
+   into a new directory (for example `my-ddev-project`), using the [`ibexa_cloud` command](https://cli.ibexa.co/).
+   (Replace `<project-ID>` with the hash of your own project.
 See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment).
 1. Configures a new DDEV project.
+1. Configures the `ddev/ddev-ibexa-cloud` add-on with `<project-ID>`, environment name (for example, `production`),
+   and application name (for example, `app` from `name: app` line in `.platform.app.yaml` file).
+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.
 1. Ignores `.ddev/` directory from Git.
-(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).)
+   (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).)
 1. Sets Composer authentication by using an already existing `auth.json` file.
-1. Creates a `public/var` directory if it doesn't exist, to allow the creation of `public/var/.platform.installed` by Platform.sh hook script.
 1. Installs the `ddev/ddev-platformsh` add-on which prompts for the Platform.sh API token, project ID and environment name.
-1. Comments out the Node.js and NVM installations from the hooks copied in `.ddev/config.platformsh.yaml`.
-(In this file, you may have to discard other specific features like New Relic.)
 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).
+   (Check `.ddev/config.platformsh.yaml` and adapt if needed. For example, you may have to comment out New Relic.)
+1. Installs the `ddev/ddev-ibexa-cloud` add-on.
 1. Starts the project.
-1. Gets the content from Platform.sh, both database and binary files by using `ddev pull platform` feature from the add-on.
-1. Restarts the project.
+1. Gets the content from [[= product_name_cloud =]], both database and binary files by using `ddev pull ibexa-cloud` feature from the add-on.
 1. Displays information about the project services.
 1. Opens the project in a browser.
 
 ```bash
 ibexa_cloud project:get <project-ID> my-ddev-project && cd my-ddev-project
-ddev config --project-type=php --web-environment-add COMPOSER_AUTH=''
+ddev config --project-type=php --php-version 8.1 --web-environment-add COMPOSER_AUTH='',DATABASE_URL=mysql://db:db@db:3306/db
+ddev config --web-environment-add IBEXA_PROJECT=<project-ID>,IBEXA_ENVIRONMENT=production,IBEXA_APP=app
+ddev config --web-environment-add IBEXA_CLI_TOKEN=<api-token>
 echo '.ddev/' >> .gitignore
 mkdir -p .ddev/homeadditions/.composer && cp <path-to-an>/auth.json .ddev/homeadditions/.composer
-if [ ! -d public/var ]; then mkdir public/var; fi
-ddev get ddev/ddev-platformsh
-sed -i -E "s/( +)(.*nvm (install|use).*)/\1#\2/" .ddev/config.platformsh.yaml
+ddev add-on get ddev/ddev-platformsh
 sed -i 's/maxmemory-policy allkeys-lfu/maxmemory-policy volatile-lfu/' .ddev/redis/redis.conf
+ddev add-on get ddev/ddev-ibexa-cloud
 ddev start
-ddev pull platform -y
-ddev restart
+ddev pull ibexa-cloud -y
 ddev describe
 ddev launch
 ```
@@ -67,13 +70,13 @@ ddev launch
 
     The Platform.sh API token is set at user profile level, therefore it's stored globally under current user root as `PLATFORMSH_CLI_TOKEN` in `~/.ddev/global_config.yaml`.
 
-## Without the Platform.sh add-on
+## Without Ibexa Cloud add-ons
 
 The following example adapts the [manual method to run an already existing project](install_with_ddev.md#run-an-already-existing-project) to the Platform.sh case:
 
 The following sequence of commands:
 
-1. Downloads the [[= product_name_cloud =]] Platform.sh project from the default environment "production" into a new directory, based on the [Platform.sh CLI alias `ibexa_cloud` defined in introduction](#ibexa-cloud-and-ddev).
+1. Downloads the [[= product_name_cloud =]] Platform.sh project from the default environment "production" into a new directory, using the [[[= product_name_cloud =]] CLI](https://cli.ibexa.co/).
 (Replace `<project-ID>` with the hash of your own project. See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment).
 1. Configures a new DDEV project.
 1. Ignores `.ddev/` directory from Git.
@@ -94,7 +97,7 @@ echo '.ddev/' >> .gitignore
 ddev start
 ddev composer config --global http-basic.updates.ibexa.co <installation-key> <token-password>
 ibexa_cloud db:dump --gzip --file=production.sql.gz
-ddev import-db --src=production.sql.gz && rm production.sql.gz
+ddev import-db --file=production.sql.gz && rm production.sql.gz
 ibexa_cloud mount:download --mount public/var --target public/var
 ddev composer install
 ddev describe

docs/ibexa_cloud/install_on_ibexa_cloud.md

@@ -70,7 +70,19 @@ You can set this token as an environment variable.
 When you do, make sure the **Visible during runtime** box in Platform.sh configuration is unchecked.
 This ensures that the token isn't exposed.
 
-![Setting token to be invisible during runtime](psh_addvariable.png)
+### Composer authentication using the web console
+
+In **Settings** (top right gear icon) -> **Project Settings** -> **Variables** -> **+ Create variable**
+
+![Setting token to be invisible during runtime](ibexa_cloud-composer_auth.png)
+
+### Composer authentication using the CLI command
+
+```bash
+ibexa_cloud variable:create --level project --name env:COMPOSER_AUTH \
+  --json true --visible-runtime false --sensitive true --visible-build true \
+  --value '{"http-basic": {"updates.ibexa.co": {"username": "<installation-key>", "password": "<token-password>"}}}'
+```
 
 ## 4. Push the project