Merge pull request #194 from marklogic/MLE-4130/Update-Limitations-and-Compatibility-matrix

MLE-4130 : Add limitation for Path and Ingress routing

Author: rwinieski

README.md

@@ -224,4 +224,5 @@ Following table lists all the parameters supported by the latest MarkLogic Helm
 3. The latest released version of CentOS 7 has known security vulnerabilities with respect to glib2 CVE-2016-3191, CVE-2015-8385, CVE-2015-8387, CVE-2015-8390, CVE-2015-8394, CVE-2016-3191, glibc CVE-2019-1010022, pcre CVE-2015-8380, CVE-2015-8387, CVE-2015-8390, CVE-2015-8393, CVE-2015-8394, SQLite CVE-2019-5827. These libraries are included in the CentOS base image but, to-date, no fixes have been made available. Even though these libraries may be present in the base image that is used by MarkLogic Server, they are not used by MarkLogic Server itself, hence there is no impact or mitigation required.
 4. TLS cannot be turned on at the MarkLogic level for the Admin (port 8001) and Manage (port 8002) app servers. TLS can be configured for any/all other ports at the MarkLogic level and if the Admin and Manage ports need to be exposed outside of the Kubernetes network, TLS can be terminated at the load balancer. Alternatively, additional custom app servers can be configured to serve the Admin UI and Management REST API on custom ports with TLS configured.
 5. With respect to security context “allowPrivilegeEscalation” is set to TRUE by default in values.yaml file to run MarkLogic container. Work is in progress to run MarkLogic container as rootless user.
-6. The Readiness and Startup Probe are not compatible with HA deployment. At the moment these probes may fail in the case of Security database failover. As of the 1.0.2 helm chart release, the startup and readiness probes are disabled by default.
+6. The Readiness and Startup Probe are not compatible with HA deployment. At the moment these probes may fail in the case of Security database failover. As of the 1.0.2 helm chart release, the startup and readiness probes are disabled by default.
+7. Path based routing and Ingress features are only supported with MarkLogic 11.1 and higher.

charts/values.yaml

@@ -365,7 +365,8 @@ haproxy:
 
 #######################################################################
 #  IMPORTANT NOTE:                                                    #
-#  This feature is only supported starting MarkLogic 11.1 and higher. #
+#  This feature is only supported with MarkLogic 11.1 and higher.     #
+#  See Limitations and known Issues in the README file.               #
 #######################################################################
 
   pathbased: 
@@ -449,10 +450,11 @@ haproxy:
 
 ## Configure Ingress
 
-##################################################################
-#  IMPORTANT NOTE:                                               #
-#  Ingress is only supported starting MarkLogic 11.1 and higher. #
-##################################################################
+#######################################################################
+#  IMPORTANT NOTE:                                                    #
+#  Ingress is only supported with MarkLogic 11.1 and higher.          #
+#  See Limitations and known Issues in the README file.               #
+#######################################################################
 
 ## ref: https://kubernetes.io/docs/concepts/services-networking/ingress/
 ingress: