Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: kubectl secret creation from env file (solves #1610) #125430

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

plusiv
Copy link

@plusiv plusiv commented Jun 11, 2024

What type of PR is this?

/kind bug

What this PR does / why we need it:

Currently Kubectl does not supports the creation of secrets with multiline values from an env file. That's because the code reads line by line the files.

This PR checks the quotes surrounding to detect the begin and the end of a value in the env file. This will allow the support for multiline values without neither breaking changes nor adding external dependencies.

Which issue(s) this PR fixes:

Fixes kubernetes/kubectl#1610

Special notes for your reviewer:

I added corresponding test cases.

Does this PR introduce a user-facing change?


Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot
Copy link
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 11, 2024
@k8s-ci-robot
Copy link
Contributor

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-sigs/prow repository.

@k8s-ci-robot
Copy link
Contributor

Welcome @plusiv!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @plusiv. 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-sigs/prow repository.

@k8s-ci-robot 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 Jun 11, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: plusiv
Once this PR has been reviewed and has the lgtm label, please assign soltysh for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jun 11, 2024
@plusiv
Copy link
Author

plusiv commented Jun 24, 2024

Hi people @ardaguclu @brianpursley !

What do you think about this PR?

@brianpursley
Copy link
Member

I'd like to see this issue be triaged first, to agree on an implementation. Currently, people can use the --from-file flag to read a multi-line secret and I wonder if that is good enough to satisfy the use case.

But regarding this specific PR...

I don't think it would always preserve the existing behavior. For example, these edge cases I think would be a problem:

MY_PASSWORD="*2KHjkdf!@kdlq

or

MY_PASSWORD="*2KHjkdf!@kdlq
SOME_OTHER_VALUE=hjef@!kjdfo"

If this issue does get triaged accepted, I think that something like this might be a more robust (and easier to implement) way of doing it:

MY_MULTILINE_VALUE="""
Line 1
Line 2
"""

That way, the only potential breaking change would be if someone really did have a secret that was exactly three double quotes """ which is very unlikely.

Before doing any more work on it though, it is probably best to bring this issue up in the next monthly SIG-CLI "bug scrub" meeting where we usually discuss new, un-triaged issues, or as a topic at the next regular bi-weekly SIG-CLI meeting.

@plusiv
Copy link
Author

plusiv commented Jun 26, 2024

Thanks for your feedback @brianpursley .

Regarding to this:

I'd like to see this issue be triaged first, to agree on an implementation. Currently, people can use the --from-file flag to read a multi-line secret and I wonder if that is good enough to satisfy the use case.

I believe it's very common for developers to store all their secrets in a single file (usually a .env file). So, it would be better to avoid using multiple files if possible.

@dims dims added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/bug Categorizes issue or PR as related to a bug. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. 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. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

Kubectl does not support secret creation from .env files with multiline values
4 participants