add examples to demonstrate the usage of dynamic client #1448

Priyankasaggu11929 · 2021-05-01T17:18:31Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR adds example python scripts to demonstrate the usage of dynamic client. Below are the files, I've added:

cluster_scoped_custom_resource.py
Output:
namespaced_custom_resource.py
Output:
configmap.py
Output:
node.py
Output:
replication_controller.py
Output:
service.py
Output:

Which issue(s) this PR fixes:

Fixes #1429

Does this PR introduce a user-facing change?

NONE

k8s-ci-robot · 2021-05-01T17:18:33Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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. I understand the commands that are listed here.

…ate.py

examples/dynamic-client/cluster_scoped_custom_resource.py

yliaog · 2021-05-02T18:17:23Z

examples/dynamic-client/cluster_scoped_custom_resource.py

+    ingressroute_manifest_second["spec"]["entrypoints"] = ["web"]
+
+    patch_ingressroute_one = ingressroute_api.patch(
+        body=ingressroute_manifest_one, content_type="application/merge-patch+json"


better to use strategic-merge-patch

Hi @yliaog, thanks for all your useful pointers.
In case of applying a patch on a custom_object with content_type="application/strategic-merge-patch" as you suggested,

patch_ingressroute_second = ingressroute_api.patch( body=ingressroute_manifest_second, content_type="application/strategic-merge-patch+json" )

it throws the following error:

Reason: Unsupported Media Type HTTP response headers: HTTPHeaderDict({'Audit-Id': 'a7b2fb82-0b68-40ee-8439-183cc9c1c0f0', 'Cache-Control': 'no-cache, private', 'Content-Type': 'application/json', 'X-Kubernetes-Pf-Flowschema-Uid': 'd4c6d349-a9e2-454c-b88f-5beb06b64c0b', 'X-Kubernetes-Pf-Prioritylevel-Uid': 'fa2d2d6c-312f-41bb-bc32-d00c53695884', 'Date': 'Mon, 03 May 2021 07:14:43 GMT', 'Content-Length': '293'}) HTTP response body: b'{"kind":"Status","apiVersion":"v1","metadata":{},"status":"Failure","message":"the body of the request was in an unknown format - accepted media types include: application/json-patch+json, application/merge-patch+json, application/apply-patch+yaml","reason":"UnsupportedMediaType","code":415}\n'

I also see in the CustomObjectApi not mentioning application/strategic-merge-patch anywhere in the content-type headers: https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/CustomObjectsApi.md#http-request-headers-18

Could you please point me if content_type="application/strategic-merge-patch" is actually not supported & needs to be implemented in the CustomObjectApi or I'm doing something wrong here?

789e374#diff-5a785a7fc5b19b934975d4d49eb71d730de127362b35f89e368179b8355796c8 is the patch to support strategic merge patch.

@roycaihw do you know why is this error?

@yliaog @roycaihw just adding information

The kubernetes python module (I'm using locally) is version 12.0.1

>>> import kubernetes >>> kubernetes.__version__ '12.0.1'

ok, strategic merge patch is not supported currently for custom resources

Thank you @yliaog, for confirming.

One question: as you pointed in the comments above, that there is already a patch for supporting strategic-merge-patch. Is that something that would be available in the upcoming releases? Or that is not a patch for supporting strategic-merge-patch using dynamic-client?

Thank you.

native k8s resources like "deployment" support strategic-merge-patch. CR does not currently have that support. The support needs to be on the k8s server side, not on the python client side.

understood. Thank you. :)

yliaog · 2021-05-02T18:17:31Z

examples/dynamic-client/cluster_scoped_custom_resource.py

+        body=ingressroute_manifest_one, content_type="application/merge-patch+json"
+    )
+    patch_ingressroute_second = ingressroute_api.patch(
+        body=ingressroute_manifest_second, content_type="application/merge-patch+json"


examples/dynamic-client/namespaced_custom_resource.py

yliaog · 2021-05-02T18:21:12Z

examples/dynamic-client/namespaced_custom_resource.py

+    ingressroute_manifest_second["spec"]["entrypoints"] = ["web"]
+
+    patch_ingressroute_one = ingressroute_api.patch(
+        body=ingressroute_manifest_one, content_type="application/merge-patch+json"


use strategic-merge-patch.

yliaog · 2021-05-02T18:21:18Z

examples/dynamic-client/namespaced_custom_resource.py

+        body=ingressroute_manifest_one, content_type="application/merge-patch+json"
+    )
+    patch_ingressroute_second = ingressroute_api.patch(
+        body=ingressroute_manifest_second, content_type="application/merge-patch+json"


yliaog · 2021-05-04T16:18:23Z

/lgtm
/approve

k8s-ci-robot · 2021-05-04T16:18:31Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, 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:

~~OWNERS~~ [yliaog]

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

yliaog · 2021-05-04T16:37:09Z

/lgtm

Priyankasaggu11929 · 2021-05-05T17:00:11Z

Hi @yliaog , could you please mark it /lgtm again. The tests passed after the PR was approved.

Thank you!

yliaog · 2021-05-05T17:03:39Z

/lgtm

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels May 1, 2021

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label May 1, 2021

k8s-ci-robot requested review from roycaihw and yliaog May 1, 2021 17:18

k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 1, 2021

Priyankasaggu11929 changed the title ~~add-dynamic-client-examples~~ add examples to demonstrate the usage of dynamic client May 1, 2021

Priyankasaggu11929 force-pushed the psaggu-add-dynamic-client-examples branch from 1d75c7b to c936623 Compare May 1, 2021 17:44

jonasdlindner and others added 2 commits May 1, 2021 23:24

examples: comment improvement in remote_cluster.py and deployment_cre…

7bc9f78

…ate.py

add-dynamic-client-examples

553f6ae

Priyankasaggu11929 force-pushed the psaggu-add-dynamic-client-examples branch from c936623 to 553f6ae Compare May 1, 2021 17:56

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels May 1, 2021

yliaog reviewed May 2, 2021

View reviewed changes

Priyankasaggu11929 force-pushed the psaggu-add-dynamic-client-examples branch 2 times, most recently from fa40565 to 62fd897 Compare May 3, 2021 19:56

k8s-ci-robot assigned yliaog May 4, 2021

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

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

Priyankasaggu11929 force-pushed the psaggu-add-dynamic-client-examples branch from 62fd897 to 1d9ba9f Compare May 4, 2021 16:30

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

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

Priyankasaggu11929 force-pushed the psaggu-add-dynamic-client-examples branch from 1d9ba9f to 22bb5b2 Compare May 4, 2021 17:49

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

correct CRD's apiVersion, manifest & naming typos

1ff6ece

Priyankasaggu11929 force-pushed the psaggu-add-dynamic-client-examples branch from 22bb5b2 to 1ff6ece Compare May 4, 2021 18:07

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

k8s-ci-robot merged commit def8b28 into kubernetes-client:master May 5, 2021

Priyankasaggu11929 mentioned this pull request May 13, 2021

REQUEST: New membership for Priyankasaggu11929 kubernetes/org#2712

Closed

6 tasks

add examples to demonstrate the usage of dynamic client #1448

add examples to demonstrate the usage of dynamic client #1448

Uh oh!

Conversation

Priyankasaggu11929 commented May 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?

Uh oh!

k8s-ci-robot commented May 1, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yliaog commented May 4, 2021

Uh oh!

k8s-ci-robot commented May 4, 2021

Uh oh!

yliaog commented May 4, 2021

Uh oh!

Priyankasaggu11929 commented May 5, 2021

Uh oh!

yliaog commented May 5, 2021

Uh oh!

Uh oh!

Priyankasaggu11929 commented May 1, 2021 •

edited

Loading