Added the behavior of double dollar signs in env, command and args #101916

MartinKanters · 2021-05-11T18:23:52Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

The documentation currently mentions that only the $(VAR) syntax can be escaped with $$(VAR). It's very confusing that every $$ will be reduced to one $. To me, this is a bug, which I delivered a fix for. While still open, it was softly declined since this is the current behavior for 5 years already, so we cannot break it for those users (which is fair). The final thing what we can do it to at least document it correctly.

Which issue(s) this PR fixes:

Fixes #101137

Special notes for your reviewer:

This bug was found and reported first in Tekton Pipelines issue 3871.
Please read the comments on the issue and original PR for more background.

Also, I'm not sure if this docs directly affect the reference documentation somehow. Please let me know if I need to change something else.

Release notes

Corrected the documentation for escaping dollar signs in a container's env, command and args property.

k8s-ci-robot · 2021-05-11T18:24:00Z

@MartinKanters: This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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 · 2021-05-11T18:24:01Z

Hi @MartinKanters. 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.

sftim · 2021-05-11T18:28:00Z

/ok-to-test

sftim

There's a guide somewhere about the commands you need to run to generate related code, and then commit that (2 commits in total).

It's not all in one page and when I need to do this I often have to go hunting for the exact runes to use. If you have a working Golang development environment locally, make generated_files should do what you need.

MartinKanters · 2021-05-11T18:47:58Z

There's a guide somewhere about the commands you need to run to generate related code, and then commit that (2 commits in total).

It's not all in one page and when I need to do this I often have to go hunting for the exact runes to use. If you have a working Golang development environment locally, make generated_files should do what you need.

Alright thanks! That's only after this PR gets approved and merged, I'm guessing?

fejta-bot · 2021-05-11T20:19:27Z

This PR may require API review.

If so, when the changes are ready, complete the pre-review checklist and request an API review.

Status of requested reviews is tracked in the API Review project.

sftim · 2021-05-12T08:35:47Z

Replying to #101916 (comment)

You need to add that second commit to this PR before it'll pass tests, and it won't get “LGTM” review until tests are green.
If you'd like help adding that second commit, reply and I hope someone'll make time to offer advice.

sftim · 2021-05-12T08:36:06Z

Please also see #101916 (comment)

MartinKanters · 2021-05-12T19:47:11Z

I just noticed I changed the file at pkg/apis/core/types.go instead of staging/src/k8s.io/api/core/v1/types.go. I need to fix that and will then generate the docs.

MartinKanters · 2021-05-13T13:10:06Z

/retest

thockin

Super minor nits but the repeat several times :)

thockin · 2021-05-17T23:50:18Z

pkg/apis/core/types.go

@@ -1828,10 +1828,10 @@ type EnvVar struct {
 	// Optional: Defaults to ""; variable references $(VAR_NAME) are expanded
 	// using the previous defined environment variables in the container and


while we are editing - s/previous/previously/

Nice find, I've took it with my doc changes

thockin · 2021-05-17T23:51:59Z

pkg/apis/core/types.go

-	// exists or not.
+	// the reference in the input string will be unchanged.  Double $$ are
+	// reduced to a single $, which allows for escaping the $(VAR_NAME)
+	// syntax: i.e. $$(VAR_NAME).  Escaped references will never be expanded,


i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded,

Thanks, that makes it more clear indeed. I've processed it.

thockin

Thanks!

/lgtm
/approve

k8s-ci-robot · 2021-05-18T23:28:48Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: MartinKanters, thockin

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~api/OWNERS~~ [thockin]
~~pkg/apis/OWNERS~~ [thockin]
~~staging/src/k8s.io/api/OWNERS~~ [thockin]

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

fejta-bot · 2021-05-19T01:31:14Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

fejta-bot · 2021-05-19T07:11:15Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

MartinKanters · 2021-05-19T08:48:19Z

/retest

Added the behavior of double dollar signs in env, command and args

3bbb1f3

k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 11, 2021

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels May 11, 2021

k8s-ci-robot requested review from mikedanese and yifan-gu May 11, 2021 18:24

k8s-ci-robot added sig/apps Categorizes an issue or PR as relevant to SIG Apps. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels May 11, 2021

MartinKanters mentioned this pull request May 11, 2021

Double dollar signs in a container's args or env section are incorrectly treated as escape characters #101137

Closed

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 11, 2021

sftim reviewed May 11, 2021

View reviewed changes

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels May 12, 2021

MartinKanters added 3 commits May 13, 2021 08:04

Corrected the $$ documentation in staging/src as well

538f92d

Generated doc files

5ac2f8a

Ran gofmt

6d77ed7

thockin reviewed May 18, 2021

View reviewed changes

thockin self-assigned this May 18, 2021

MartinKanters added 2 commits May 18, 2021 21:11

Processed review suggestions

8a4cdb8

Generated doc files

ee1047a

thockin reviewed May 18, 2021

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 18, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 18, 2021

k8s-ci-robot merged commit 1d0e5ac into kubernetes:master May 19, 2021

k8s-ci-robot added this to the v1.22 milestone May 19, 2021

github-actions bot mentioned this pull request May 26, 2021

Week Ending May 23, 2021 dev-obs/actus#383

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added the behavior of double dollar signs in env, command and args #101916

Added the behavior of double dollar signs in env, command and args #101916

MartinKanters commented May 11, 2021 •

edited

k8s-ci-robot commented May 11, 2021

k8s-ci-robot commented May 11, 2021

sftim commented May 11, 2021

sftim left a comment

MartinKanters commented May 11, 2021 •

edited

fejta-bot commented May 11, 2021

sftim commented May 12, 2021

sftim commented May 12, 2021

MartinKanters commented May 12, 2021

MartinKanters commented May 13, 2021

thockin left a comment

thockin May 17, 2021

MartinKanters May 18, 2021

thockin May 17, 2021

MartinKanters May 18, 2021

thockin left a comment

k8s-ci-robot commented May 18, 2021

fejta-bot commented May 19, 2021

fejta-bot commented May 19, 2021

MartinKanters commented May 19, 2021

		@@ -1828,10 +1828,10 @@ type EnvVar struct {
		// Optional: Defaults to ""; variable references $(VAR_NAME) are expanded
		// using the previous defined environment variables in the container and

Added the behavior of double dollar signs in env, command and args #101916

Added the behavior of double dollar signs in env, command and args #101916

Conversation

MartinKanters commented May 11, 2021 • edited

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Release notes

k8s-ci-robot commented May 11, 2021

k8s-ci-robot commented May 11, 2021

sftim commented May 11, 2021

sftim left a comment

Choose a reason for hiding this comment

MartinKanters commented May 11, 2021 • edited

fejta-bot commented May 11, 2021

sftim commented May 12, 2021

sftim commented May 12, 2021

MartinKanters commented May 12, 2021

MartinKanters commented May 13, 2021

thockin left a comment

Choose a reason for hiding this comment

thockin May 17, 2021

Choose a reason for hiding this comment

MartinKanters May 18, 2021

Choose a reason for hiding this comment

thockin May 17, 2021

Choose a reason for hiding this comment

MartinKanters May 18, 2021

Choose a reason for hiding this comment

thockin left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 18, 2021

fejta-bot commented May 19, 2021

fejta-bot commented May 19, 2021

MartinKanters commented May 19, 2021

MartinKanters commented May 11, 2021 •

edited

MartinKanters commented May 11, 2021 •

edited