Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add validation that externalServers.hosts is not set to HCP-managed cluster's addresses when global.cloud.enabled #3315

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Add validation that externalServers.hosts is not set to HCP-managed cluster's addresses when global.cloud.enabled #3315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f38e29f
Add validation that externalServers.hosts is not set to HCP-managed c…
Dec 6, 2023
2dd26bf
Reorder template validation of externalHosts
zalimeni Dec 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/3315.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:improvement
helm: add validation that global.cloud.enabled is not set with externalServers.hosts set to HCP-managed clusters
```
3 changes: 3 additions & 0 deletions charts/consul/templates/connect-inject-deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
{{ template "consul.validateVaultWebhookCertConfiguration" . }}
{{- template "consul.reservedNamesFailer" (list .Values.connectInject.consulNamespaces.consulDestinationNamespace "connectInject.consulNamespaces.consulDestinationNamespace") }}
{{- if and .Values.externalServers.enabled (not .Values.externalServers.hosts) }}{{ fail "externalServers.hosts must be set if externalServers.enabled is true" }}{{ end -}}
{{- if and .Values.externalServers.enabled .Values.global.cloud.enabled }}
{{- if and (gt (len .Values.externalServers.hosts) 0) (regexMatch ".+.hashicorp.cloud$" ( first .Values.externalServers.hosts )) }}{{fail "global.cloud.enabled cannot be used in combination with an HCP-managed cluster address in externalServers.hosts. global.cloud.enabled is for linked self-managed clusters."}}{{- end }}
{{- end }}
Comment on lines +9 to +11
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because of the check directly above this one, we should never attempt to evaluate the inner if unless .Values.externalServers.hosts has been set.

{{- if and .Values.externalServers.skipServerWatch (not .Values.externalServers.enabled) }}{{ fail "externalServers.enabled must be set if externalServers.skipServerWatch is true" }}{{ end -}}
{{- $dnsEnabled := (or (and (ne (.Values.dns.enabled | toString) "-") .Values.dns.enabled) (and (eq (.Values.dns.enabled | toString) "-") .Values.connectInject.transparentProxy.defaultEnabled)) -}}
{{- $dnsRedirectionEnabled := (or (and (ne (.Values.dns.enableRedirection | toString) "-") .Values.dns.enableRedirection) (and (eq (.Values.dns.enableRedirection | toString) "-") .Values.connectInject.transparentProxy.defaultEnabled)) -}}
Expand Down
24 changes: 24 additions & 0 deletions charts/consul/test/unit/connect-inject-deployment.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2639,6 +2639,30 @@ reservedNameTest() {
[ "${actual}" = "true" ]
}

@test "connectInject/Deployment: validates that externalServers.hosts is not set with an HCP-managed cluster's address" {
cd `chart_dir`
run helm template \
-s templates/connect-inject-deployment.yaml \
--set 'global.enabled=false' \
--set 'connectInject.enabled=true' \
--set 'global.tls.enabled=true' \
--set 'global.tls.enableAutoEncrypt=true' \
--set 'externalServers.enabled=true' \
--set 'externalServers.hosts[0]=abc.aws.hashicorp.cloud' \
--set 'global.cloud.enabled=true' \
--set 'global.cloud.clientId.secretName=client-id-name' \
--set 'global.cloud.clientId.secretKey=client-id-key' \
--set 'global.cloud.clientSecret.secretName=client-secret-id-name' \
--set 'global.cloud.clientSecret.secretKey=client-secret-id-key' \
--set 'global.cloud.resourceId.secretName=resource-id-name' \
--set 'global.cloud.resourceId.secretKey=resource-id-key' \
. > /dev/stderr

[ "$status" -eq 1 ]

[[ "$output" =~ "global.cloud.enabled cannot be used in combination with an HCP-managed cluster address in externalServers.hosts. global.cloud.enabled is for linked self-managed clusters." ]]
}

@test "connectInject/Deployment: can provide a TLS server name for the sidecar-injector when global.cloud.enabled is set" {
cd `chart_dir`
local env=$(helm template \
Expand Down
8 changes: 6 additions & 2 deletions charts/consul/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,8 +655,12 @@ global:
# Enables installing an HCP Consul Central self-managed cluster.
# Requires Consul v1.14+.
cloud:
# If true, the Helm chart will enable the installation of an HCP Consul Central
# self-managed cluster.
# If true, the Helm chart will link a [self-managed cluster to HCP](https://developer.hashicorp.com/hcp/docs/consul/self-managed).
# This can either be used to [configure a new cluster](https://developer.hashicorp.com/hcp/docs/consul/self-managed/new)
# or [link an existing one](https://developer.hashicorp.com/hcp/docs/consul/self-managed/existing).
#
# Note: this setting should not be enabled for [HashiCorp-managed clusters](https://developer.hashicorp.com/hcp/docs/consul/hcp-managed).
# It is strictly for linking self-managed clusters.
enabled: false

# The resource id of the HCP Consul Central cluster to link to. Eg:
Expand Down