kubectl: add env option to deployment creation #93269

Xercoy · 2020-07-20T23:31:39Z

What type of PR is this?
/kind feature

What this PR does / why we need it:
Creating a deployment using kubectl with environment variables was done with kubectl run. Since most of the generators have been deprecated, including the one for deployments (#87077), this PR adds functionality to the preferred method of deployment creation, kubectl create deployment.

I think this feature would be useful in providing more flexibility for deployments with kubectl create. Additionally, resources related to deployment creation with environment variables via kubectl run can be updated and remain useful rather than eventually being deprecated.

I did not create an issue/enhancement beforehand but I would be more than happy to do so. Apologies especially in case I had missed any content which deemed that this feature shouldn't be implemented.

Supporting documentation/PRs:

and also attached in the docs section.

Special notes for your reviewer:
In addition to running and providing tests, I built the kubectl binary and tested that the new flag/feature works as expected; the intent is for its behavior to be similar to how the flag was in kubectl run.

Please let me know if any changes or amendments should be made, or if I'm not adhering to any guidelines or processes. Would also be more than happy to refactor any recommendations for changes.

Thank you very much to all reviewers, maintainers, and contributors for the time and effort!

Does this PR introduce a user-facing change?:
Yes, this will add an optional flag --env which expects a key value pair of an environment name and value. This flag can be repeated to provide multiple environment variables.

Added the --env flag to allow environment variables to be provided to deployments made with kubectl create.

- [#91113](https://github.com/kubernetes/kubernetes/pull/91113)
- [#87077](https://github.com/kubernetes/kubernetes/pull/87077)
- [#68132](https://github.com/kubernetes/kubernetes/pull/68132)

k8s-ci-robot · 2020-07-20T23:31:47Z

Welcome @Xercoy!

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 · 2020-07-20T23:31:47Z

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

Xercoy · 2020-07-20T23:31:54Z

/cc @kubernetes/sig-cli-api-reviews @kubernetes/sig-cli-pr-reviews
/sig cli

k8s-ci-robot · 2020-07-20T23:32:03Z

@Xercoy: Reiterating the mentions to trigger a notification:
@kubernetes/sig-cli-api-reviews, @kubernetes/sig-cli-pr-reviews

In response to this:

/cc @kubernetes/sig-cli-api-reviews @kubernetes/sig-cli-pr-reviews
/sig cli

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 · 2020-07-20T23:32:17Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Xercoy
To complete the pull request process, please assign brendandburns
You can assign the PR to them by writing /assign @brendandburns 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/kubectl/OWNERS
test/cmd/OWNERS

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

fejta-bot · 2020-07-21T00:04:40Z

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.

zhouya0

Code lgtm but:
The main goal is to make create command simple as possible, other need to create deployment should use kubectl apply instead. Before we add --port, --replicas flag since they are commonly used in deployment . Not sure we really want to continue add more.

Xercoy · 2020-07-21T06:44:01Z

@zhouya0 , thank you for the quick review! I definitely agree with you in that kubectl create deployment should be as simple as possible.

For whatever purposes that are required when using kubectl to create a deployment, whether it's debugging, testing, learning, or teaching, I agree and say that you're right again in that the previous options that were added affect configurations which are commonly used in deployments:

--port: the ability to specify a port for a deployment
--replicas: the ability to control the number of replicas
the ability to provide a command to a deployment

I also think that the ability to provide a deployment with environment variables can also be considered a core configuration of a deployment. I believe that it is commonly used and that the benefits from this feature would outweigh the simplicity that the changes in this PR removes.

The flags listed above enable users to create a deployment which dictates the command, number of replicas, and port. One of the most important pieces of an application's operations are configuration values; many applications need some kind of configuration values to run smoothly. Adding --env provides the create command with the ability to create deployments with the information they need to run, if such configuration is necessary.

Manipulating deployments with kubectl apply or through Helm charts are definitely the best way to have the most control and customization, but I still think that use cases for kubectl create would largely benefit from having --env. The create command is much more than capable of creating deployments for images other than busybox or nginx. This flag would improve on that capability by providing deployments with data that they may need to run.

From my perspective as a user, someone who shares knowledge about Kubernetes, and one who still tries to use kubectl run for many things, this PR improves how deployments can be created with the create command.

As a contributor with this PR, the changes make use of utility/helper functions that already exist, includes tests, and adds code changes that matches how other flags are handled, such as --replicas and --port. In my opinion, this last detail keeps things simple and ensures that refactoring is just as easy (I hope), or at least not too difficult.

While I do agree with you on both points in that the create command should be as simple as possible, and again when you mentioned that the flags mentioned above are commonly used in deployments, adding --env and regarding it as commonly a used configuration from the points I mentioned should be considered.

Of course, I defer the decision to validate the need for this PR to you and the consensus of the community. Overall, it's been an awesome learning experience and a great chance to collaborate and make contributions to a project that has given so much to me. Thanks again.

zhouya0 · 2020-07-21T08:10:41Z

/ok-to-test

Xercoy · 2020-07-21T15:17:29Z

/retest - for flakiness

Xercoy · 2020-07-22T04:44:04Z

/retest

Xercoy · 2020-07-22T09:03:13Z

/retest

Xercoy · 2020-07-22T19:36:29Z

@zhouya0 while Tide is mentioning that this PR isn't mergeable yet, all tests are passing. Thanks again for the review and enabling tests! For the time being, I'll try to promote visibility but please let me know if there's anything else I can do to help.

Xercoy · 2020-07-23T05:58:27Z

staging/src/k8s.io/kubectl/pkg/cmd/create/create_deployment_test.go

+			"SingleEnvVar",
+			[]string{
+				"FOO=bar",
+				"FIZZ=buzz",


This test case should have only one env var set, will fix.

Xercoy · 2020-07-23T11:13:16Z

/retest

Xercoy · 2020-07-23T12:24:20Z

/retest

Xercoy · 2020-07-23T17:32:50Z

/priority backlog

eddiezane · 2020-08-12T17:37:04Z

Holding this while we explore other options as discussed in SIG-CLI meeting.

/hold

fejta-bot · 2020-11-10T18:01:43Z

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

fejta-bot · 2020-12-10T18:46:35Z

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 · 2021-01-09T19:31:19Z

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 · 2021-01-09T19:31:26Z

@Xercoy: PR needs rebase.

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-01-09T19:31:31Z

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

kubectl: add env option to deployment creation

6e3a7aa

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 20, 2020

k8s-ci-robot added sig/cli Categorizes an issue or PR as relevant to SIG CLI. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jul 20, 2020

k8s-ci-robot requested review from seans3 and smarterclayton July 20, 2020 23:32

k8s-ci-robot added area/kubectl area/test sig/testing Categorizes an issue or PR as relevant to SIG Testing. labels Jul 20, 2020

zhouya0 reviewed Jul 21, 2020

View reviewed changes

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 Jul 21, 2020

integration tests: fix error in run_deployment_test

71595b6

kubectl create: update BUILD

24fd2a2

Xercoy commented Jul 23, 2020

View reviewed changes

kubectl create: fix env var test case

fb5b087

k8s-ci-robot added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Jul 23, 2020

armujahid mentioned this pull request Jul 28, 2020

Enhance kubectl create (Add useful flags from kubectl run e.g. replicas, labels, requests, limits, env, port etc.) kubernetes/kubectl#898

Closed

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 12, 2020

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 10, 2020

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Dec 10, 2020

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 9, 2021

k8s-ci-robot closed this Jan 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kubectl: add env option to deployment creation #93269

kubectl: add env option to deployment creation #93269

Xercoy commented Jul 20, 2020 •

edited

Loading

k8s-ci-robot commented Jul 20, 2020

k8s-ci-robot commented Jul 20, 2020

Xercoy commented Jul 20, 2020

k8s-ci-robot commented Jul 20, 2020

k8s-ci-robot commented Jul 20, 2020

fejta-bot commented Jul 21, 2020

zhouya0 left a comment •

edited

Loading

Xercoy commented Jul 21, 2020 •

edited

Loading

zhouya0 commented Jul 21, 2020

Xercoy commented Jul 21, 2020 •

edited

Loading

Xercoy commented Jul 22, 2020

Xercoy commented Jul 22, 2020

Xercoy commented Jul 22, 2020

Xercoy Jul 23, 2020

Xercoy commented Jul 23, 2020

Xercoy commented Jul 23, 2020

Xercoy commented Jul 23, 2020

eddiezane commented Aug 12, 2020 •

edited

Loading

fejta-bot commented Nov 10, 2020

fejta-bot commented Dec 10, 2020

fejta-bot commented Jan 9, 2021

k8s-ci-robot commented Jan 9, 2021

k8s-ci-robot commented Jan 9, 2021

kubectl: add env option to deployment creation #93269

kubectl: add env option to deployment creation #93269

Conversation

Xercoy commented Jul 20, 2020 • edited Loading

k8s-ci-robot commented Jul 20, 2020

k8s-ci-robot commented Jul 20, 2020

Xercoy commented Jul 20, 2020

k8s-ci-robot commented Jul 20, 2020

k8s-ci-robot commented Jul 20, 2020

fejta-bot commented Jul 21, 2020

zhouya0 left a comment • edited Loading

Choose a reason for hiding this comment

Xercoy commented Jul 21, 2020 • edited Loading

zhouya0 commented Jul 21, 2020

Xercoy commented Jul 21, 2020 • edited Loading

Xercoy commented Jul 22, 2020

Xercoy commented Jul 22, 2020

Xercoy commented Jul 22, 2020

Xercoy Jul 23, 2020

Choose a reason for hiding this comment

Xercoy commented Jul 23, 2020

Xercoy commented Jul 23, 2020

Xercoy commented Jul 23, 2020

eddiezane commented Aug 12, 2020 • edited Loading

fejta-bot commented Nov 10, 2020

fejta-bot commented Dec 10, 2020

fejta-bot commented Jan 9, 2021

k8s-ci-robot commented Jan 9, 2021

k8s-ci-robot commented Jan 9, 2021

Xercoy commented Jul 20, 2020 •

edited

Loading

zhouya0 left a comment •

edited

Loading

Xercoy commented Jul 21, 2020 •

edited

Loading

Xercoy commented Jul 21, 2020 •

edited

Loading

eddiezane commented Aug 12, 2020 •

edited

Loading