Add simple compatibility section

traefik · May 7, 2020 · 7139e52 · 7139e52
1 parent b6b7618
commit 7139e52
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/content/compatibility.md b/docs/content/compatibility.md
@@ -0,0 +1,18 @@
+# Compatibility
+
+Maesh supports [similiar to Kubernetes](https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions) at least the latest 3 minor versions of Kubernetes, therefore currently:
+
+* 1.16
+* 1.17
+* 1.18
+
+General functionality can not be guaranted for versions older than that. However, we expect it to work with Kubernetes down to 1.11 currently.
+
+## Compatibility by Features
+
+Some of Maesh's features are only supported on certain Kubernetes versions. Please see the table below.
+
+ | Features              | K8s 1.16 | K8s 1.17 | K8s 1.18 |
+ |-----------------------|----------|----------|----------|
+ | General functionality | ✔        | ✔        | ✔        |
+ | Service Topology      | ✘        | ✔        | ✔        |
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -67,6 +67,7 @@ nav:
   - 'Quickstart': 'quickstart.md'
   - 'Installation': 'install.md'
   - 'Configuration': 'configuration.md'
+  - 'Compatibility': 'compatibility.md'
   - 'Examples': 'examples.md'
   - 'API': 'api.md'
   - 'Migration':