docs: improve 0.48 migration doc (#5731)

ovh · Mar 8, 2021 · 3be850e · 3be850e
1 parent 7b6dcd8
commit 3be850e
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 4 deletions.
diff --git a/docs/content/hosting/ready-to-run/docker-compose/docker-compose.md b/docs/content/hosting/ready-to-run/docker-compose/docker-compose.md
@@ -33,7 +33,7 @@ $ export HOSTNAME=$(hostname)
 $ export CDS_DOCKER_IMAGE=ovhcom/cds-engine:{{< param "version" "latest" >}}
 
 # Get the latest version
-$ docker pull ovhcom/cds-engine:latest
+$ docker pull ovhcom/cds-engine:{{< param "version" "latest" >}}
 
 # Create PostgreSQL database, redis and elasticsearch
 $ docker-compose up --no-recreate -d cds-db cds-cache elasticsearch dockerhost

diff --git a/docs/content/hosting/ready-to-run/docker-compose/full-example.md b/docs/content/hosting/ready-to-run/docker-compose/full-example.md
@@ -192,7 +192,7 @@ curl https://raw.githubusercontent.com/ovh/cds/{{< param "version" "master" >}}/
 export HOSTNAME=$(hostname)
 export CDS_DOCKER_IMAGE=ovhcom/cds-engine:{{< param "version" "latest" >}}
 
-docker pull ovhcom/cds-engine:latest
+docker pull ovhcom/cds-engine:{{< param "version" "latest" >}}
 docker-compose up --no-recreate -d cds-db cds-cache elasticsearch dockerhost
 sleep 3
 docker-compose logs| grep 'database system is ready to accept connections'

diff --git a/...content/hosting/upgrade/migrate_0.48.0.md → docs/content/hosting/upgrade/migrate_0.48.md b/...content/hosting/upgrade/migrate_0.48.0.md → docs/content/hosting/upgrade/migrate_0.48.md
@@ -1,9 +1,11 @@
 ---
-title: "Migrate 0.48.0"
+title: "Migrate 0.48"
 weight: 1
 ---
 
-The release 0.48.0 introduced a new CDS service called CDN. This service is dedicated to receive and store CDS’s job logs.
+## CDN service
+
+The release 0.48 introduced a new CDS service called CDN. This service is dedicated to receive and store CDS’s job logs.
 
 We created this service to be able to move out job's logs from CDS database to an object storage provider (more information about this list of providers [here]({{< relref "/docs/components/cdn.md">}})).
 
@@ -84,3 +86,16 @@ $ cdsctl admin cdn status
 ```
 
 ![CDN_STATUS](/images/cdn_status.png)
+
+## Other changes
+- The CDS migrate service is now able to manage SQL migrations on both API and CDN databases. Its configuration file format changed to add CDN database config.
+Please use the following command to generate a config example and update your existing one to this new format.
+```sh
+$ engine config new migrate
+```
+- Workflow Run will now contains a snapshot of required secrets when starting. This allows changing a secret on CDS entities without breaking existing runs. A migration script will generate this snapshot for recent Workflow Runs (< 3 Months), others will be set to read only mode.
+- CDS UI service will now proxy both API and CDN calls, please add the following lines in your existing config.
+```sh
+# CDN µService URL
+cdnURL = "http://localhost:8089" # change this URL if needed to match CDN address
+```