cluster-api-provider-aws icon indicating copy to clipboard operation
cluster-api-provider-aws copied to clipboard

additionalTags with whitespace in the key

Open mimmus opened this issue 2 years ago • 12 comments
trafficstars

/kind bug

Unfortunately, I have a company's mandatory tag with a space in the key:

apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: AWSCluster
...
spec:
  additionalTags:
    "Patch Group": nopatch
...

but I'm getting: The AWSCluster "mycluster-dr" is invalid: spec.additionalTags: Invalid value: "Patch Group": key cannot have characters other than alphabets, numbers, spaces and _ . : / = + - @

  • Cluster-api-provider-aws version: 1.5.1

mimmus avatar Nov 20 '23 13:11 mimmus

As the error message says we should be allowing space, so this needs fixing.

/triage accepted /priority important-soon /help /good-first-issue

richardcase avatar Nov 21 '23 07:11 richardcase

@richardcase: This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to this:

As the error message says we should be allowing space, so this needs fixing.

/triage accepted /priority important-soon /help /good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Nov 21 '23 07:11 k8s-ci-robot

For anyone picking this issue up, this is where we do the validation: https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/14ca4d886e339d72f9abbe5f0fb305fa72336f14/api/v1beta2/tags.go#L77

richardcase avatar Nov 21 '23 07:11 richardcase

Hi @richardcase I'm new contributing to k8s and would love to take on this bug (I'm not familiar with the time expectation of the tags, but I believe I can have a PR before next week) I've been going through the dev guide, but wanted to ask you if I should go with tilt (never used it before) over setting the local environment? Also there is room for improvement on the developer guide, if that's an acceptable issue to create for a docs pr I will take on it after this one. Thanks!

Msesto avatar Nov 21 '23 19:11 Msesto

Alright, I managed to get my local environment running, and digging into the issue, it was fixed with #3702 Not entirely sure how you guys manage the versioning nor when something stops beings maintained, I've yet to dig deep into the docs..

Msesto avatar Nov 21 '23 22:11 Msesto

Great! An extra "" in regex!

Only another question:

  • is this bug a regression or was it always present?

I'm not so good to look into Github history.

mimmus avatar Nov 22 '23 09:11 mimmus

Sure, the regex validation for the tags was added with 3398, and the bug seems to only be present on 1.5.X I'm not sure how the project's releases works, but I guess the fix can be cherrypicked into 1.5?

Msesto avatar Nov 22 '23 10:11 Msesto

fixed with https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/3702

Can we close this ticket @mimmus ?

If you want it cherrypicked into the 1.5.x release branch - you can do that pr too! The last 1.5.x release was 1.5.5 in April of 2023.

philjb avatar Dec 26 '23 20:12 philjb

Wonderful!

No, thanks: I’m using CAPI/CAPA as a customer of a commercial product (D2iq DKP/Konvoy).

mimmus avatar Dec 26 '23 20:12 mimmus

This issue is labeled with priority/important-soon but has not been updated in over 90 days, and should be re-triaged. Important-soon issues must be staffed and worked on either currently, or very soon, ideally in time for the next release.

You can:

  • Confirm that this issue is still relevant with /triage accepted (org members only)
  • Deprioritize it with /priority important-longterm or /priority backlog
  • Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

k8s-triage-robot avatar Mar 25 '24 21:03 k8s-triage-robot

Version 1.5.1 is quite old now. I suggest upgrading to a more recent version: the fix https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/3702 is from 2022 so any recent release should have this issue solved.

I recommend closing this ticket.

/close

philjb avatar Mar 26 '24 16:03 philjb

@philjb: You can't close an active issue/PR unless you authored it or you are a collaborator.

In response to this:

Version 1.5.1 is quite old now. I suggest upgrading to a more recent version: the fix https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/3702 is from 2022 so any recent release should have this issue solved.

I recommend closing this ticket.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Mar 26 '24 16:03 k8s-ci-robot