test(integration): Added custom image pull secrets test

[chan-tim-sumo]

Overview

• github issue: Add tests for global configuration attributes #2699
• jira: https://sumologic.atlassian.net/browse/OSC-766
• added image pull secrets test

Checklist

• Changelog updated or skip changelog label added
• Documentation updated
• Template tests added for new features
• Integration tests added or modified for major features

[sumo-drosiek]

I have an impression than some configuration has been added but not used (like for example for tracesGateway)

[chan-tim-sumo]

I have an impression than some configuration has been added but not used (like for example for tracesGateway)

this was exactly my gut feeling cause i didn't see pull secrets being used in tracesGateway, but when i ran the tests, got these errors:

        	Error Trace:	/Users/timothy.chan/Desktop/sumologic-kubernetes-collection/tests/helm/common_test.go:757
        	Error:      	Should be true
        	Test:       	TestCustomImagePullSecrets
        	Messages:   	Expected imagePullSecret customImagePullSecrets not found in Deployment col-test-kube-state-metrics
    common_test.go:729: Processing kind: Deployment
    common_test.go:757: 
        	Error Trace:	/Users/timothy.chan/Desktop/sumologic-kubernetes-collection/tests/helm/common_test.go:757
        	Error:      	Should be true
        	Test:       	TestCustomImagePullSecrets
        	Messages:   	Expected imagePullSecret customImagePullSecrets not found in Deployment col-test-opentelemetry-operator
    common_test.go:729: Processing kind: Deployment
    common_test.go:757: 
        	Error Trace:	/Users/timothy.chan/Desktop/sumologic-kubernetes-collection/tests/helm/common_test.go:757
        	Error:      	Should be true
        	Test:       	TestCustomImagePullSecrets
        	Messages:   	Expected imagePullSecret customImagePullSecrets not found in Deployment col-test-sumologic-traces-gateway
    common_test.go:729: Processing kind: Deployment
    common_test.go:757: 
        	Error Trace:	/Users/timothy.chan/Desktop/sumologic-kubernetes-collection/tests/helm/common_test.go:757
        	Error:      	Should be true
        	Test:       	TestCustomImagePullSecrets
        	Messages:   	Expected imagePullSecret customImagePullSecrets not found in Deployment col-test-sumologic-traces-sampler

which i thought maybe there was some internal knowledge i didn't know about (which is alot) and these were actually using pull secrets but just wasn't added to this repo yet 😆

[sumo-drosiek]

Helm is very simple. It is just templates, and unless you don't use the content of values.yaml in templates directory, they are not used. You fixed the error by adding the following:

      {{- if $.Values.sumologic.pullSecrets }}
      imagePullSecrets:
{{- range $.Values.sumologic.pullSecrets }}
        - name: {{ .name }}
{{- end }}
      {{- end }} 

so configuration of tracesGateway is still not used so we can drop it from values.yaml

[chan-tim-sumo]

Helm is very simple. It is just templates, and unless you don't use the content of values.yaml in templates directory, they are not used. You fixed the error by adding the following:

      {{- if $.Values.sumologic.pullSecrets }}
      imagePullSecrets:
{{- range $.Values.sumologic.pullSecrets }}
        - name: {{ .name }}
{{- end }}
      {{- end }} 

so configuration of tracesGateway is still not used so we can drop it from values.yaml

ah got confused, found the documentation for pull secrets:

sumologic-kubernetes-collection/docs/working-with-container-registries.md

Lines 37 to 50 in 2ea0cff

	## Using pull secrets with `sumologic-kubernetes-collection` helm chart
	Full list of `user-values.yaml` keys for all the images that are used, can be found below:
	| Image | `user-values.yaml` key |
	| --------------------- | ----------------------------------------------- |
	| setup job | `sumologic.setup.job.pullSecrets` |
	| Sumo Logic OT distro | `sumologic.pullSecrets` |
	| remote-write-proxy | `sumologic.pullSecrets` |
	| kube-prometheus-stack | `kube-prometheus-stack.global.imagePullSecrets` |
	| metrics-server | `metrics-server.image.pullSecrets` |
	| telegraf-operator | `telegraf-operator.imagePullSecrets` |
	| falco | `falco.image.pullSecrets` |

seems like only 7 images/objects that uses pull secrets, but currently since i was trying to use the same logic as previous integ test cases (running ALL objects) which is probably why it gave me the error for tracesGateway, kube-state-metrics, and others.

[sumo-drosiek]

seems like only 7 images/objects that uses pull secrets, but currently since i was trying to use the same logic as previous integ test cases (running ALL objects) which is probably why it gave me the error for tracesGateway, kube-state-metrics, and others.

You should run test for ALL objects, and using sumologic.pullSecrets has been missing in some objects, so they should be added. And it's enough to add this change:

      {{- if $.Values.sumologic.pullSecrets }}
      imagePullSecrets:
{{- range $.Values.sumologic.pullSecrets }}
        - name: {{ .name }}
{{- end }}
      {{- end }} 

as this is using sumologic.pullSecrets from values.yaml to set imagePullSecrets

There is no need to add anything more to default values.yaml

[sumo-drosiek]

This is needed (uses $.Values.sumologic.pullSecrets):

sumologic-kubernetes-collection/deploy/helm/sumologic/templates/instrumentation/traces-gateway/deployment.yaml

Lines 49 to 54 in 70b9285

	{{- if $.Values.sumologic.pullSecrets }}
	imagePullSecrets:
	{{- range $.Values.sumologic.pullSecrets }}
	- name: {{ .name }}
	{{- end }}
	{{- end }}

This is not needed (this option is not used by any template):

sumologic-kubernetes-collection/deploy/helm/sumologic/values.yaml

Line 1829 in 70b9285

imagePullSecrets: []

[chan-tim-sumo]

This is needed (uses $.Values.sumologic.pullSecrets):

sumologic-kubernetes-collection/deploy/helm/sumologic/templates/instrumentation/traces-gateway/deployment.yaml

Lines 49 to 54 in 70b9285

	{{- if $.Values.sumologic.pullSecrets }}
	imagePullSecrets:
	{{- range $.Values.sumologic.pullSecrets }}
	- name: {{ .name }}
	{{- end }}
	{{- end }}

This is not needed (this option is not used by any template):

sumologic-kubernetes-collection/deploy/helm/sumologic/values.yaml

Line 1829 in 70b9285

imagePullSecrets: []

ah gotcha, was on the right track in the beginning but just don't need to add imagePullSecrets: [] to values.yaml

[sumo-drosiek]

I would add also changelogs for the templates you modified, e.g. events statefulset

Converting to comment 😅

[sumo-drosiek]

LGTM, thanks

We should enable all possible components (except windows as is experimental), but we can do it in another PR