Change allowLongHostname to allowLongHostnames (#224)

* Update appVersion to 11.2.0

* Update Reference link for docker image issue and limitation

* update readme from PR review

* update allowLongHostname to allowLongHostnames

* update readme and template test

---------

Co-authored-by: Peng Zhou <[email protected]>

Author: pengzhouml

README.md

@@ -107,11 +107,12 @@ Following table lists all the parameters supported by the latest MarkLogic Helm
 | `updateStrategy.type`                               | Update strategy for MarkLogic pods                                                                                                                                                     | `OnDelete`                 |
 | `terminationGracePeriod`                            | Seconds the MarkLogic Pod terminate gracefully                                                                                                                                         | `120`                      |
 | `clusterDomain`                                     | Domain for the Kubernetes cluster                                                                                                                                                      | `cluster.local`            |
+| `allowLongHostnames`                                | Allow deployment with hostname over 64 characters                                                    | `false` |∂
 | `group.name`                                        | Group name for joining MarkLogic cluster                                                                                                                                               | `Default`                  |
 | `group.enableXdqpSsl`                               | SSL encryption for XDQP                                                                                                                                                                | `true`                     |
 | `bootstrapHostName`                                 | Host name of MarkLogic bootstrap host (to join a cluster)                                                                                                                              | `""`                       |
 | `image.repository`                                  | Repository for MarkLogic image                                                                                                                                                         | `marklogicdb/marklogic-db` |
-| `image.tag`                                         | Image tag for MarkLogic image                                                                                                                                                          | `11.1.0-centos-1.1.2`      |
+| `image.tag`                                         | Image tag for MarkLogic image                                                                                                                                                          | `11.2.0-centos-1.1.2`      |
 | `image.pullPolicy`                                  | Image pull policy for MarkLogic image                                                                                                                                                  | `IfNotPresent`             |
 | `initContainers.configureGroup.image`               | Image for configureGroup InitContainer                                                                                                                                                 | `curlimages/curl:8.6.0`    |
 | `initContainers.configureGroup.pullPolicy`          | Pull policy for configureGroup InitContainer                                                                                                                                           | `IfNotPresent`             |

charts/templates/_helpers.tpl

@@ -145,8 +145,8 @@ Validate values file
 */}}
 {{- define "marklogic.checkInputError" -}}
 {{- $fqdn := include "marklogic.fqdn" . }}
-{{- if and (gt (len $fqdn) 64) (not .Values.allowLongHostname) }}
-{{- $errorMessage := printf "%s%s%s" "The FQDN: " $fqdn " is longer than 64. Please use a shorter release name and try again. MarkLogic App Server does not support turning on SSL with FQDN over 64 characters. If you still want to install with an FQDN longer than 64 characters, you can override this restriction by setting allowLongHostname: true in your Helm values file." }}
+{{- if and (gt (len $fqdn) 64) (not .Values.allowLongHostnames) }}
+{{- $errorMessage := printf "%s%s%s" "The FQDN: " $fqdn " is longer than 64. Please use a shorter release name and try again. MarkLogic App Server does not support turning on SSL with FQDN over 64 characters. If you still want to install with an FQDN longer than 64 characters, you can override this restriction by setting allowLongHostnames: true in your Helm values file." }}
 {{- fail $errorMessage }}
 {{- end }}
 {{- end }}

charts/values.yaml

@@ -15,11 +15,11 @@ terminationGracePeriod: 120
 ## Kubernetes cluster domain name
 clusterDomain: cluster.local
 
-## To allow deployment with hostname over 64 characters
+## Allow deployment with hostname over 64 characters
 ## This is not remmended as it may cause issues when turning on TLS on MarkLogic Server
 ## Because MarkLogic Server only supports using CN as hostname in the certificate
 ## There is a limit of 64 characters for CN in the certificate
-allowLongHostname: false
+allowLongHostnames: false
 
 ## Group related settings
 group:

makefile

@@ -70,7 +70,7 @@ prepare:
 .PHONY: lint
 lint:
 	@echo "> Linting helm charts....."
-	helm lint --set allowLongHostname=true --with-subcharts charts/ $(if $(saveOutput),> helm-lint-output.txt,)
+	helm lint --set allowLongHostnames=true --with-subcharts charts/ $(if $(saveOutput),> helm-lint-output.txt,)
 
 	@echo "> Linting all tests....."
 	golangci-lint run --timeout=5m $(if $(saveOutput),> test-lint-output.txt,)

test/template/template_test.go

@@ -138,7 +138,7 @@ func TestTemplatePersistence(t *testing.T) {
 	require.Equal(t, statefulset.Spec.VolumeClaimTemplates[1].Spec.Resources.Requests.Storage().String(), additionalVolumeClaimTemplatesResourcesRequestsStorage)
 }
 
-func TestAllowLongHostname(t *testing.T) {
+func TestAllowLongHostnames(t *testing.T) {
 	// Path to the helm chart we will test
 	helmChartPath, err := filepath.Abs("../../charts")
 	require.NoError(t, err)
@@ -148,7 +148,7 @@ func TestAllowLongHostname(t *testing.T) {
 	// Setup the args for helm install
 	options := &helm.Options{
 		SetValues: map[string]string{
-			"allowLongHostname": "false",
+			"allowLongHostnames": "false",
 		},
 		KubectlOptions: k8s.NewKubectlOptions("", "", namespaceName),
 	}
@@ -163,9 +163,9 @@ func TestAllowLongHostname(t *testing.T) {
 	require.NoError(t, err, "Expected no error due to short release name")
 
 	options.SetValues = map[string]string{
-		"allowLongHostname": "true",
+		"allowLongHostnames": "true",
 	}
 	_, err = helm.RenderTemplateE(t, options, helmChartPath, longReleaseName, []string{"templates/statefulset.yaml"})
-	require.NoError(t, err, "Expected no error with longReleaseName due to set allowLongHostname to true")
+	require.NoError(t, err, "Expected no error with longReleaseName due to set allowLongHostnames to true")
 
 }