Rejecting valid Environment Variable Names #47

[pswica]

What type of PR is this?
/kind bug

What this PR does / why we need it:
Allows using ':' chars in kubectl --env, e.g. kubectl run myname --image=myimage:86 --port=80 --env="ConnectionStrings:DefaultConnection=Data Source=tcp:mySqlServer,1433;Initial Catalog=myDB;User Id=myUser;Password=mypassword;":
Which issue(s) this PR fixes:
Fixes kubernetes/kubectl#47

Special notes for your reviewer:
NONE
Does this PR introduce a user-facing change?:

Allows the use of ':' in environment names kubectl --env

[k8s-ci-robot]

Hi @pswica. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: pswica
To complete the pull request process, please assign lavalamp
You can assign the PR to them by writing /assign @lavalamp in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• staging/src/k8s.io/apimachinery/pkg/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[pswica]

/priority backlog

[pswica]

/cc @apelisse

[apelisse]

Yeah, this should be mentioned in the kubectl issue, but there is already a long discussion about that somewhere else. Let me find you a reference.

[liggitt]

xref #69415 (comment)

[pswica]

Thanks a lot @liggitt, everyone working actively on Kubernetes has been so helpful in getting me started and understanding a lot of the nuances when changing source code.

I will say this. I have tested what happens to resources that were created with a colon ':' and are then rolled back. I did this (with persistent etcd thanks to @dims) by

1. making my changes in the PR
2. running hack/local-up-cluster.sh
3. creating a deployment with a colon in an environmental variable name:
4. rolling back my changes in the PR
5. running hack/local-up-cluster.sh

Here is what I found:

1. I can view and use the resource just fine and I got no error messages interacting with it
2. I can delete the resource just fine and got no errors deleting it
3. I could not scale the resource

This leads me to think that, perhaps, this change could be introduced by simply providing a warning to the user when they make a resource with a colon in an environment name:

 if strings.Contains(value, ":") {
    klog.Warningf("You are using an environment variable name that contains a colon: '%v'. This is a new feature, and if you rollback your Kubernetes version you will only be able to get and delete this resource", value)
}                                                                       

Perhaps first expand the validation (as in your 1a, b) and then Error out saying that allowing colons will happens soon. Then in the 1.X release can add the warning.

[liggitt]

• I can view and use the resource just fine and I got no error messages interacting with it
• I can delete the resource just fine and got no errors deleting it
• I could not scale the resource

Even not being able to scale the resource would be reason enough to need to phase this in, but there are additional scenarios that would break:

• HA API servers skewed n-1 would not allow the resource to be updated
• If a finalizer was added to the object, it would not be able to be removed via an n-1 API server

Relaxing validation on a GA API must be phased in over two releases as described

[fedebongio]

/assign @apelisse

[pswica]

@fedebongio
Thank you for performing an /assign but this has already been reviewed by @apelisse and @liggitt . If anything, this can likely be closed as it causes an API breaking change. The goal now, for me, is to come up with a way so that v1.16 works if it has environmental names with a ":" (and others). E.g. it would not create environmental variables with ":" in the name but it could live with them.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[liggitt]

thanks for the PR. let's coordinate on desired approach in #53201 (comment) before proceeding (and be aware there are other PRs trying to address the same issue)

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

[k8s-ci-robot]

@fejta-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/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.