docs: add deployment tips

Zooz · Oct 17, 2020 · fd2015c · fd2015c
1 parent 9312d2f
commit fd2015c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -63,7 +63,8 @@ To see the progress of `v1.5.0` [click here](https://github.com/Zooz/predator/is
 ### Important Deployment Tips
 Predator is production ready and fully tested and can be deployed in all of the following platforms listed. Please follow these guidelines when deploying Predator:
 1. Deploy Predator using only tagged releases and not `latest`.
-2. Predator-Runner docker image version (`zooz/predator-runner:$TAGGED_VERSION`) must match the Predator's version running in order to be fully compatible with all features.
+2. Predator-Runner docker image version (`zooz/predator-runner:$TAGGED_VERSION`) must match the Predator's `major.minor` version running in order to be fully compatible with all features. Patched versions don't have to match, but it is recommended to use latest patch version.
+    - For example, Predator version 1.6 (`zooz/predator:1.6`) should run Predator-Runner version 1.6 as well (`zooz/predator-runner:1.6`). 
 
 ### Kubernetes
 Predator is designed to seamlessly deploy into your Kubernetes cluster. Install Predator from the [Helm Hub](https://hub.helm.sh/charts/zooz/predator)

diff --git a/docs/devguide/docs/installation.md b/docs/devguide/docs/installation.md
@@ -4,6 +4,12 @@ Before Predator, running two or more tests simultaneously was limited due to thi
 
 You're probably eager to get your hands dirty, so let's go ahead and install Predator.
 
+## Important Deployment Tips
+Predator is production ready and fully tested and can be deployed in all of the following platforms listed. Please follow these guidelines when deploying Predator:
+1. Deploy Predator using only tagged releases and not `latest`.
+2. Predator-Runner docker image version (`zooz/predator-runner:$TAGGED_VERSION`) must match the Predator's `major.minor` version running in order to be fully compatible with all features. Patched versions don't have to match, but it is recommended to use latest patch version.
+    - For example, Predator version 1.6 (`zooz/predator:1.6`) should run Predator-Runner version 1.6 as well (`zooz/predator-runner:1.6`). 
+
 ## Kubernetes
 
 Install Predator from the [Helm Hub](https://hub.helm.sh/charts/zooz/predator)