python icon indicating copy to clipboard operation
python copied to clipboard

Add ability to use server_side_apply to utils.create_from_yaml

Open dcmcand opened this issue 1 year ago • 7 comments

What type of PR is this?

/kind feature

What this PR does / why we need it:

Allows utils.create_from_yaml functions to optionally use server side apply. This is a feature that has been requested numerous times. It will allow applying a manifest more than once without throwing an error or updating manifests and reapplying (similar to how kubectl apply works).

Which issue(s) this PR fixes:

Fixes #2251 Addresses #2030 Part of #1737

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Added the ability to use the optional `apply` parameter for functions within the `utils.create_from_yaml` submodule. This allows these functions to optionally use the `DynamicClient.server_side_apply` function to apply yaml manifests.

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

[Usage]: create_from_yaml(kubernetes_client, manifest, apply=True)

dcmcand avatar Jun 27 '24 23:06 dcmcand

Welcome @dcmcand!

It looks like this is your first PR to kubernetes-client/python 🎉. 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-client/python 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. :smiley:

k8s-ci-robot avatar Jun 27 '24 23:06 k8s-ci-robot

/assign @yliaog @roycaihw

dcmcand avatar Jul 02 '24 18:07 dcmcand

@yliaog, is there anything I can do to help get this looked at?

dcmcand avatar Jul 08 '24 18:07 dcmcand

@yliaog @roycaihw Is there anything I can do to help get this looked at?

dcmcand avatar Jul 24 '24 16:07 dcmcand

When should i expect this to be released?

troll-warlord avatar Jul 30 '24 07:07 troll-warlord

Hey @yliaog @roycaihw! We could use this feature in our project. Are you planning to review this anytime soon? Thanks for all the work!

marcelovilla avatar Sep 12 '24 15:09 marcelovilla

sure, i'll take a look in the next couple of days.

yliaog avatar Sep 12 '24 15:09 yliaog

/lgtm /approve

yliaog avatar Sep 16 '24 13:09 yliaog

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dcmcand, yliaog

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:

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 avatar Sep 16 '24 13:09 k8s-ci-robot

This is beautiful. I tried 31.0.0 and did not see this in the latest release. For folks wanting this prior to its release, you can add the lib and point the version to the master branch of this repo.

pip: https://stackoverflow.com/questions/20101834/pip-install-from-git-repo-branch poetry: https://python-poetry.org/docs/dependency-specification/#git-dependencies

scottrbrtsn avatar Oct 24 '24 18:10 scottrbrtsn

@yliaog this change is incredibly useful, is there a chance there could be a 31.1.0 release for the client with this change so downstream users can make use of it without having to rely on using a branch source as @scottrbrtsn mentioned above?

MatthewCane avatar Nov 13 '24 16:11 MatthewCane

https://github.com/kubernetes/sig-release/tree/master/releases/release-1.32

it will be included in 1.32 release, which is coming soon.

yliaog avatar Nov 13 '24 21:11 yliaog

Great news! Thank you for the update!

MatthewCane avatar Nov 14 '24 09:11 MatthewCane