From 1f112383a7bf36e4ceab12256f4d82b786a75661 Mon Sep 17 00:00:00 2001 From: Andrew Azores Date: Mon, 27 Nov 2023 15:41:33 -0500 Subject: [PATCH] docs(readme): add version compatibility matrix (#270) --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e0417ed1..aa218798 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,24 @@ Plugin as an attachable JVM agent that can be included in a target application t location to Cryostat. ## REQUIREMENTS -Build Requirements: + +### Run Requirements +- JDK11+ +- a Cryostat server instance + +The Cryostat project follows [semantic versioning](https://semver.org/). Generally, each Cryostat Agent minor version +is developed to and compatible with a specific Cryostat server minor release version. Other version combinations +outside of this matrix may work but are neither tested nor supported. If you run into any issues, please check if there +is an available version upgrade and ensure both your Agent and server match this version matrix. + +| Cryostat Release | Server version | Agent version | +|-----------------:|---------------:|--------------:| +| < 2.3.0 | ≤ v2.2.1 | N/A | +| 2.3.0 | v2.3.0 | v0.2.0 | +| 2.3.1 | v2.3.1 | v0.2.3 | +| 2.4.0 | v2.4.0 | v0.3.0 | + +### Build Requirements - Git - JDK11+ - Maven 3+