feat!: truncate fullname after 22 characters

[aboguszewski-sumo]

Fixes #3057

The longest name for a statefulset I found was *-otelcloudwatch-logs-collector, the suffix here is 30 characters.

According to kubernetes/kubernetes#64023 the statefulset name should be 52 characters or shorter.

I did not manage to fail rendering the template, I tried using both fail and required function but without success. This is why I'm only truncating the sumologic.fullname name.

Checklist

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

[swiatekm]

I actually think the limit for this wasn't determined by StatefulSets, but by label values. Can you make sure this test:

sumologic-kubernetes-collection/tests/helm/common_test.go

Line 124 in 55b7ab0

func TestNameAndLabelLength(t *testing.T) {

also enables otel cloudwatch?

We also need a note about this change in the v4 migration doc.

[github-actions]

This pull request contains invalid labels. Please remove all of the following labels: ['do-not-merge/hold']

[aboguszewski-sumo]

Changes applies. But, please note that because this does not cause template rendering to fail, the test actually does not check anything more.

[swiatekm]

I think we want to make the same change for sumologic.name above.

[aboguszewski-sumo]

Is it used anywhere? I grepped for that name and it seems that it's not used anywhere

[swiatekm]

Huh, we should delete it then.

[aboguszewski-sumo]

I'll do it in another pr

[swiatekm]

Changes applies. But, please note that because this does not cause template rendering to fail, the test actually does not check anything more.

The test checks the actual object names and label values.

[aboguszewski-sumo]

What about this then?

sumologic-kubernetes-collection/tests/helm/common_test.go

Line 197 in 55b7ab0

// TODO: Add an error check here after we start enforcing the limit: https://github.com/SumoLogic/sumologic-kubernetes-collection/issues/3057

What should we check here if we're not failing the rendering?

[swiatekm]

What about this then?

sumologic-kubernetes-collection/tests/helm/common_test.go

Line 197 in 55b7ab0

// TODO: Add an error check here after we start enforcing the limit: https://github.com/SumoLogic/sumologic-kubernetes-collection/issues/3057

What should we check here if we're not failing the rendering?

Maybe just delete that test? We're checking the limits on K8s objects here:

sumologic-kubernetes-collection/tests/helm/common_test.go

Line 124 in 55b7ab0

func TestNameAndLabelLength(t *testing.T) {

. Truncating instead of erroring is probably the better choice here.

[swiatekm]

You should also remove the warning I added in #3054. Incidentally, does putting the fail in that file not work?

[aboguszewski-sumo]

Incidentally, does putting the fail in that file not work?

in _common.tpl? No, but I only used helm template to test that, maybe an install would fail.

[aboguszewski-sumo]

Ok, I tested and fail works when put in NOTES.txt. But we still prefer to truncate, right?

[swiatekm]

Yeah, seems better all around.

[aboguszewski-sumo]

Warning removed and tests fixed.

[swiatekm]

Why is this change necessary?

[aboguszewski-sumo]

Else we get such failures: https://github.com/SumoLogic/sumologic-kubernetes-collection/actions/runs/6109112931/job/16579492782
and I found it easier to modify the constant instead of modifying the tests

[swiatekm]

But why does this change cause these failures. collection-test is less than 22 characters, so it shouldn't make any difference, right?

[aboguszewski-sumo]

But -sumologic is added to that. And as a result we truncate collection-test-sumologic, which is more than 22 chars.