Add migration guide

bakdata · Apr 30, 2024 · b56b1ba · b56b1ba
1 parent 9fa3d0d
commit b56b1ba
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/docs/user/migration-guide/v4-v5.md b/docs/docs/user/migration-guide/v4-v5.md
@@ -0,0 +1,22 @@
+# Migrate from V4 to V5
+
+## [Allow custom timeout for external services](https://github.com/bakdata/kpops/pull/485)
+
+The global `timeout` setting has been removed. Instead, an individual timeout can be set for each external service.
+
+#### config.yaml
+
+```diff
+- timeout: 300
+
+  kafka_rest:
+    url: "http://my-custom-rest.url:8082"
++   timeout: 300
+  kafka_connect:
+    url: "http://my-custom-connect.url:8083"
++   timeout: 300
+  schema_registry:
+    enabled: true
+    url: "http://my-custom-sr.url:8081"
++   timeout: 300
+```
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -112,6 +112,7 @@ nav:
               - Migrate from v1 to v2: user/migration-guide/v1-v2.md
               - Migrate from v2 to v3: user/migration-guide/v2-v3.md
               - Migrate from v3 to v4: user/migration-guide/v3-v4.md
+              - Migrate from v4 to v5: user/migration-guide/v4-v5.md
           - CLI usage: user/references/cli-commands.md
           - Editor integration: user/references/editor-integration.md
           - CI integration: