Merge pull request #46 from genestack/feat/ODM-10929-update-docs

feat/ODM-10929 update docs

docs/home/release-notes/v1.50-v1.59.md

@@ -2,26 +2,231 @@
 
 ## Version 1.58
 
-!!! danger
+!!! warning
 
     This version must be installed before proceeding with the next update.
 
+!!! tip ""
+    Helm chart version 1.x.x
+
 ### Clickhouse migration
 
-In current release we moved from standalone Clickhouse container to the Clickhouse cluster that will be controlled by Altinity clickhouse operator.  
+In current release we moved from standalone Clickhouse container to the Clickhouse cluster that will be controlled by [Altinity clickhouse operator](https://github.com/Altinity/clickhouse-operator).  
 We automated process of transferring data from the standalone version to the cluster version of clickhouse, migration will be executed during upgrade process.
 
 Things that you have keep in mind before upgrading process:
 
 - Migration time depends on resources(mostly on CPU and Disk IO) allocated for Clickhouse instances, during our tests we've mentioned average speed 50Gb per hour for instances with 4CPU/16Gb RAM
 
-- It's necessary **not to set** flags as `--wait` and `--timeout` during upgrading process because of migration time  
+- It's necessary **not to set** flags as `--wait` and `--timeout` during upgrading process because of migration time
+
+- The new ClickHouse cluster must have 25% more disk space than the standalone variant.
 
 - Optional: We've developed [a tool that checks consistency of data](../troubleshooting/sanity-check.md), you could use it before and after the upgrading process and compare results of those checks just to be sure that everything went as expected
 
+### Helm examples changes
+
+- New examples for different ODM configuration options have been added to the `examples` helm chart directory, and all old ones have been updated.
+
+- Additionally, recommendations for computing resources have been included.
+
+### Helm configuration changes
+
+- From this release, we are using fully original Docker images for the OSS components of ODM. It is not recommended to update them independently.
+
+  From
+
+  ```yaml
+  mysql:
+    image:
+      registry: 091468197733.dkr.ecr.us-east-1.amazonaws.com
+      repository: genestack/mysql
+
+  mailcatcher:
+    image:
+      registry: 091468197733.dkr.ecr.us-east-1.amazonaws.com
+      repository: genestack/mailcatcher
+
+  clickhouse:
+    image:
+      registry: 091468197733.dkr.ecr.us-east-1.amazonaws.com
+      repository: genestack/clickhouse
+
+  nginx:
+    image:
+      registry: 091468197733.dkr.ecr.us-east-1.amazonaws.com
+      repository: genestack/nginx
+  ```
+
+  To
+
+  ```yaml
+  mysql:
+    image:
+      registry: docker.io
+      repository: mysql
+      tag: 8.4.1
+
+  mailcatcher:
+    image:
+      registry: docker.io
+      repository: dockage/mailcatcher
+      tag: 0.9.0
+
+  clickhouse:
+    image:
+      registry: docker.io
+      repository: clickhouse/clickhouse-server
+      tag: 24.6.2
+
+  nginx:
+    image:
+      registry: docker.io
+      repository: nginxinc/nginx-unprivileged
+      tag: 1.27.0-alpine
+  ```
+
+- Now you can mount any file with any content into any container in ODM! For example, your certificates. This feature required adding the full path in all existing ODM configuration files.
+
+    From
+
+    ```yaml
+    core:
+      configurationFiles:
+        "application.yaml":
+
+    applications:
+      configurationFiles:
+        "application.yaml":
+        "microsoft.openid.ini":
+        "okta.openid.ini":
+        "google.openid.ini":
+
+    mysql:
+      configurationFiles:
+        "genestack.cnf":
+
+    funcFile:
+      configurationFiles:
+        "application.yaml":
+
+    funcJob:
+      configurationFiles:
+        "application.yaml":
+
+    linkService:
+      configurationFiles:
+        "application.yaml":
+
+    clickhouse:
+      configurationFiles:
+        "config.yaml":
+        "users.yaml":
+
+    nginx:
+      configurationFiles:
+        "odm.conf":
+        "proxy-pass-parameters.conf":
+    ```
+
+    To
+
+    ```yaml
+    core:
+      files:
+      "/var/lib/genestack/properties/application.yaml":
+
+    applications:
+      files:
+      "/var/lib/genestack/properties/application.yaml":
+      "/var/lib/genestack/properties/microsoft.openid.ini":
+      "/var/lib/genestack/properties/okta.openid.ini":
+      "/var/lib/genestack/properties/google.openid.ini":
+
+    mysql:
+      files:
+        "/etc/mysql/conf.d/genestack.cnf":
+
+    funcFile:
+      files:
+        "/app/config/application.yaml":
+
+    funcJob:
+      files:
+        "/app/config/application.yaml":
+
+    linkService:
+      files:
+        "/app/config/application.yaml":
+
+    clickhouse:
+      files:
+        "/etc/clickhouse-server/config.d/config.yaml":
+        "/etc/clickhouse-server/users.d/users.yaml":
+
+    nginx:
+      files:
+        "/etc/nginx/conf.d/odm.conf":
+        "/etc/nginx/conf.d/proxy-pass-parameters.conf":
+    ```
+
+- The AWS credentials for connecting to S3 in `core` and `applications` have been removed. If you have these parameters, you can safely delete them.
+
+    ```yaml
+    core:
+      files:
+        "/var/lib/genestack/properties/application.yaml":
+          backend:
+            aws:
+              region: ""
+              endpoint:
+                url: ""
+              access:
+                key: ""
+              secret:
+                key: ""
+    ```
+
+    !!! danger
+
+        Important! The AWS region in the `application` must remain! You can delete only the `endpoint`, `access` and `secret` parameters.
+
+    ```yaml
+    applications:
+      files:
+        "/var/lib/genestack/properties/application.yaml":
+          frontend:
+            aws:
+              region: "{{ .Values.credentials.awsS3Region }}"
+              endpoint:
+                url: ""
+              access:
+                key: ""
+              secret:
+                key: ""
+    ```
+
+- Configuration file `settings.py.local` has been removed. If you are using it, you can safely delete it.
+
+    ```yaml
+    core:
+      files:
+        "settings.py.local":
+    ```
+
+- The previously added `BusyBox` image for `ClickHouse` has been removed. If you are using it, you can safely delete it.
+
+    ```yaml
+    clickhouse:
+      busyboxImage:
+        registry: docker.io
+        repository: busybox
+        tag: 1.36.1
+    ```
+
 ## Version 1.57
 
-!!! danger
+!!! warning
 
     This version must be installed before proceeding with the next update.