Skip to content

Commit 211b7f2

Browse files
committed
CLD-620: Add warning if FQDN is over 64 charictars.
Add known issues and limitations section to README Document this limitiation in the known limitations section of the README Move FQDN declaration to _helpers.tpl so it is globally useable
1 parent 0fcc2d1 commit 211b7f2

File tree

3 files changed

+18
-4
lines changed

3 files changed

+18
-4
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@
3535
- [Notice](#notice)
3636
- [Uninstalling the Chart](#uninstalling-thechart)
3737
- [Parameters](#parameters)
38+
- [Known Issues and Limitations](#Known-Issues-and-Limitations)
39+
3840

3941
# Introduction
4042

@@ -475,3 +477,7 @@ This table describes the list of available parameters for Helm Chart.
475477
| `logCollection.files.requestLogs` | Enable this parameter to enable collection of Marklogics request logs when log collection is enabled | `true` |
476478
| `logCollection.files.crashLogs` | Enable this parameter to enable collection of Marklogics crash logs when log collection is enabled | `true` |
477479
| `logCollection.files.auditLogs` | Enable this parameter to enable collection of Marklogics audit logs when log collection is enabled | `true` |
480+
481+
# Known Issues and Limitations
482+
483+
1. If the hostname is greater than 64 characters there may be issues with certificates. The certificates may shorten the name or use SANs for hostnames in the certificates.

charts/templates/NOTES.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
{{- define "marklogic.fqdn" -}}
2-
{{- printf "%s-0.%s.%s.svc.cluster.local" (include "marklogic.fullname" .) (include "marklogic.headlessServiceName" .) .Release.Namespace }}
3-
{{- end}}
4-
51
Thank you for installing {{ .Chart.Name }}.
62

73
Your release is named {{ .Release.Name }}.
84

95
FQDN is {{ include "marklogic.fqdn" . }}
6+
{{- if gt (len (include "marklogic.fqdn" .)) 64 }}
7+
WARNING: The hostname is greater than 64 characters
8+
There may be issues with certificates
9+
The certificates may shorten the name or use SANs for hostnames in the certificates
10+
{{- end }}
1011

1112
Group {{ .Values.group.name }} is created on the MarkLogic cluster.
1213

charts/templates/_helpers.tpl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,10 @@ Create the name of the service account to use
7575
{{- default "default" .Values.serviceAccount.name }}
7676
{{- end }}
7777
{{- end }}
78+
79+
{{/*
80+
Fully qualified domain name
81+
*/}}
82+
{{- define "marklogic.fqdn" -}}
83+
{{- printf "%s-0.%s.%s.svc.cluster.local" (include "marklogic.fullname" .) (include "marklogic.headlessServiceName" .) .Release.Namespace }}
84+
{{- end}}

0 commit comments

Comments
 (0)