bug in BB 0.17.0's logic of the hostname --> domain keyvalue rename

Bug

BigBang Version

0.17.0

Description

I updated the bb engineering cohort labs from 0.15.3 --> 0.17.0 and everything broke all at once / found lots of issues, so I created #856 (closed), #857 (closed), added issue related notes to #825 (closed), and also ran into #802 (closed).

I noticed ingress stopped working so I checked the release notes. and saw hostname got renamed to domain

so I updated ~/Desktop/bootstrap/dev/configmap.yaml (where bootstrap = my clone of customer template repo)
line 1 from
hostname: bigbang.dev
to
domain: chrism.bigbang.dev

My helm values ended up looking like this:
helm get values bigbang -n=bigbang

...
domain: chrism.bigbang.dev
...
hostname: bigbang.dev

k get vs -A

NAMESPACE    NAME                                      GATEWAYS                HOSTS                        AGE
jaeger       jaeger                                    [istio-system/public]   [tracing.bigbang.dev]        143m
kiali        kiali                                     [istio-system/public]   [kiali.bigbang.dev]          142m
logging      kibana                                    [istio-system/public]   [kibana.bigbang.dev]         147m
monitoring   monitoring-monitoring-kube-alertmanager   [istio-system/public]   [alertmanager.bigbang.dev]   145m
monitoring   monitoring-monitoring-kube-grafana        [istio-system/public]   [grafana.bigbang.dev]        145m
monitoring   monitoring-monitoring-kube-prometheus     [istio-system/public]   [prometheus.bigbang.dev]     145m

The bug is that I believe domain should take precedence over hostname.
based on https://repo1.dso.mil/platform-one/big-bang/bigbang/-/merge_requests/843 which was mentioned in the 1.17.0 release notes.

changed title from bug in domain: logic to bug in logic of the hostname --> domain keyvalue rename

changed the description

changed title from bug in logic of the hostname --> domain keyvalue rename to bug in logic of the hostname --> domain keyvalue rename in BB 0.17.0

changed title from bug in logic of the hostname --> domain keyvalue rename in BB 0.17.0 to bug in BB 0.17.0's logic of the hostname --> domain keyvalue rename

mentioned in issue #857 (closed)

assigned to @kevin.wilder

changed the description

Additional data point that might be helpful:
After working through issues related to
#857 (closed) (implicit default helm values need to be made explicit),
#825 (closed) (latest flux cli 1.18.0 doesn't work need to use 0.17.2), and
#802 (closed) (need to use 443 when testing, non standard ports no longer work)

I tried updating to 1.18.0, and using hostname: chrism.bigbang.dev, and not domain: chrism.bigbang.dev (basically ignoring the release notes about updating hostname to domain, and then things pretty much worked.)

mentioned in commit platform-one/onboarding/big-bang/engineering-cohort@094599aa

added BB Customer Issues label

added BB Documentation Standards label

added Big Bang Core label

added priority6 label

removed Big Bang Core label

added teamcore/security label

Good find and I think that was unintentional as you mentioned...it essentially breaks any support of the "deprecated" value since we have a default set for domain.

@kevin.wilder is that correct?

The change from hostname to domain is designed to be backwards compatible. While hostname is deprecated it is still supported. Nothing should be broken.
If you change line 1 from hostname to domain. Then you also need to change istio.gateways.public.hosts
from this

      hosts:
      - "*.{{ .Values.hostname }}"

to this

      hosts:
      - "*.{{ .Values.domain }}"

I can meet with you drill down and discover what the problem is.

You're right my mistake, I think I misread the template the other day. The logic looks right in our templates.

I think the issue is that I was pulling from an old copy of the customer template repo it originally had: "hostname: bigbang.dev" set in both /base/configmap.yaml and /dev/configmap.yaml so when I changed it in to "domain: chrism.bigbang.dev" in /dev/configmap.yaml, that caused both values "hostname: bigbang.dev" and "domain: chrism.bigbang.dev" to exist simultaneously in my values file. (And hostname overrides domain for the purpose of backwards compatibility / that's desired behavior.)

In the lastest version of the BB customer template repo + the upstream chart everything it set to domain, https://repo1.dso.mil/platform-one/big-bang/customers/template/-/blob/main/base/configmap.yaml so in the latest version: "domain: bigbang.dev" set in both /base/configmap.yaml and /dev/configmap.yaml which means the resulting values file will only have domain and won't have an entry for hostname, so hostname having higher precedence / won't be an issue. Since both hostname: and domain: won't exist simultaneously, the domain thing should work as expected according to the release notes.

So after talking with the product team I think this has been fixed as of a week ago / no longer an issue at this point. (I probably cloned the repo just before the change and that's why I ran into the issue, but a normal customer would clone fresh value and not run into the issue.)

closed