CR webhook conversion documentation #10986

mbohlool · 2018-11-13T19:11:13Z

CRD webhook conversion documentation.

k8sio-netlify-preview-bot · 2018-11-13T19:16:45Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 7926c50

https://deploy-preview-10986--kubernetes-io-master-staging.netlify.com

tfogo · 2018-11-19T21:44:35Z

Hi @bgrant0607 @davidopp - could you please review this PR as soon as you get a chance? We need to get all 1.13 PRs reviewed and approved by November 27th. Thanks!

liggitt · 2018-11-19T21:50:58Z

/unassign @bgrant0607 @davidopp
/assign sttts liggitt

liggitt · 2018-11-19T21:51:16Z

/uncc @bgrant0607 @davidopp
/cc sttts liggitt

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md

kbhawkey · 2018-11-21T16:20:05Z

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md

-its decision wrapped in `conversionResponse`. Note that the request
-contains a list of CRs that need to be converted independently without
+`ConversionReview` requests sent by the apiservers, and sends back conversion
+result wrapped in `ConversionResponse`. Note that the request


sends back one conversion result or many wrapped in a ConversionResponse?

not sure about this one. why we put emphasis on one vs many?

@mbohlool, just asking for clarification. Initially, I had trouble parsing this sentence.

Oh. I thought you are suggesting. It is one or many wrapped in a response object.

mbohlool · 2018-11-23T05:13:38Z

Ptal

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md

kbhawkey · 2018-11-26T00:57:04Z

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md


 * custom resource is requested in a different version than stored version.
 * Watch is created in one version but the changed object is stored in another version.
 * custom resource PUT request is in a different version than storage version.

-To cover all of these cases and to optimize conversion on apiserver side, the conversion requests carry as many object as possible in order to minimize the calls to the webhook. These conversions should happened independently. The grouping of custom resources does not represent any relation between them.
+To cover all of these cases and to optimize conversion by the API server, the conversion requests contain as many objects as possible in order to minimize the calls to the webhook. These conversions should happened independently. The grouping of custom resources does not represent any relation between them.



nit: These conversions happen independently.

nit: The grouping of custom resources ...
What grouping? The order of custom resources listed in the conversion request?

suggestion: "the conversion requests may contain multiple objects in order to minimize the calls to the webhook"

I think you can drop the sentence "The grouping of custom resources does not represent any relation between them."

i've revised this paragraph. please look at it again.

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md

liggitt · 2018-11-26T17:55:30Z

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md


 * custom resource is requested in a different version than stored version.
 * Watch is created in one version but the changed object is stored in another version.
 * custom resource PUT request is in a different version than storage version.

-To cover all of these cases and to optimize conversion on apiserver side, the conversion requests carry as many object as possible in order to minimize the calls to the webhook. These conversions should happened independently. The grouping of custom resources does not represent any relation between them.
+To cover all of these cases and to optimize conversion by the API server, the conversion requests contain as many objects as possible in order to minimize the calls to the webhook. These conversions should happened independently. The grouping of custom resources does not represent any relation between them.



suggestion: "the conversion requests may contain multiple objects in order to minimize the calls to the webhook"

I think you can drop the sentence "The grouping of custom resources does not represent any relation between them."

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md

liggitt · 2018-11-26T18:19:34Z

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md

+    storage: true
+    # Each version can define it's own schema when there is no top-level
+    # schema is defined.
+    Schema:


should be lowercase schema, right (below as well)? can you verify the examples all create with kubectl successfully?

Tried the example with kubectl -f and it works (need to remove caBundle part though as it is not a real BASE64 string)

mbohlool · 2018-11-27T11:50:21Z

@liggitt @kbhawkey PTAL

liggitt · 2018-11-27T14:09:07Z

/lgtm

kbhawkey · 2018-11-27T14:56:32Z

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md


 ### Write a conversion webhook server

 Please refer to the implementation of the [custom resource conversion webhook
-server](https://github.com/kubernetes/kubernetes/blob/v1.13.0-beta.1/test/images/crd-conversion-webhook/main.go)
+server](https://github.com/kubernetes/kubernetes/tree/v1.13.0/test/images/crd-conversion-webhook/main.go)


LGTM, 👍, except for 404 on the link,
https://github.com/kubernetes/kubernetes/tree/v1.13.0/test/images/crd-conversion-webhook/main.go

Try:
https://github.com/kubernetes/kubernetes/blob/master/test/images/crd-conversion-webhook/main.go

@mbohlool, I was unable to get to this link from the preview page.
nit: There is a note on the page that should capitalize Kubernetes v1.13.
nit: Another note: When using ClientConfig.service ... where or what does this apply to, or is it unrelated to sample spec?

the link will be valid when the 1.13.0 release is tagged. Linking to specific files in master is unstable.

capitalized text kubernetes -> Kubernetes.
About ClientConfig.service, it is related to the sample as the sample has ClientConfig.service. The use of https is forced as to another note and here we are just stating what name should the server certificate be valid for, for this config to work.

kbhawkey · 2018-11-28T18:27:05Z

Good to go. I can't give a formal LGTM, but 👍
@tfogo is there still time to merge to dev-1.13?

tfogo · 2018-11-29T17:54:59Z

@kbhawkey Yep, all good!

/lgtm
/approve

btw, I noticed there's a "TODO" at the end of this doc. Is anybody working on that?

k8s-ci-robot · 2018-11-29T17:55:12Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tfogo

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:

~~content/en/OWNERS~~ [tfogo]

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

kbhawkey · 2018-11-29T18:31:11Z

@kbhawkey Yep, all good!

/lgtm
/approve

btw, I noticed there's a "TODO" at the end of this doc. Is anybody working on that?
@tfogo , I did not see a TODO?

tfogo · 2018-11-29T19:24:41Z

@kbhawkey Oh you're right - I had the 1.12 version open and that had a TODO. Got confused between the two.

* CR Conversion * Addressing comments * Addressing more comments * Addressing even more comments * Addressing even^2 more comments

* Update metadata.generation behaviour for custom resources (#10705) * update docs promoting plugins to beta (#10796) * docs update to promote TaintBasedEvictions to beta (#10765) * First Korean l10n work for dev-1.13 (#10719) * Update outdated l10n(ko) contents (#10689) fixes #10686 * Translate concepts/overview/what-is-kubernetes in Korean (#10690) * Translate concepts/overview/what-is-kubernetes in Korean * Feedback from ClaudiaJKang * Translate concepts/overview/components in Korean (#10882) * Translate concepts/overview/components in Korean #10717 * Translate concepts/overview/components in Korean * Translate concepts/overview/components in Korean * Apply Korean glossary: 서비스 어카운트 * Translate concepts/overview/kubernetes-api in Korean (#10773) * Translate concepts/overview/kubernetes-api in Korean * Applied feedback from ianychoi * kubeadm: update the configuration docs to v1beta1 (#10959) * kubeadm: add small v1beta1 related updates (#10988) * ADD content/zh/docs/reference/setup-tools/kubeadm/kubeadm.md (#11031) * ADD content/zh/docs/reference/setup-tools/kubeadm/kubeadm.md * ADD content/zh/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md * Update content/zh/docs/reference/setup-tools/kubeadm/kubeadm.md Accepted Co-Authored-By: YouthLab <tsui@highyouth.com> * do not change 'master' or 'worker' nodes to '主从' * Doc updates for volume scheduling GA (#10743) * Doc updates for volume scheduling GA * Make trivial change to kick build * Document nodelease feature (#10699) * advanced audit doc for ModeBlockingStrict (#10203) * Rename EncryptionConfig to EncryptionConfiguration (#11080) EncryptionConfig was renamed to EncryptedConfiguration and added to the `apiserver.config.k8s.io` API group in Kubernetes 1.13. The feature was previously in alpha and was not handling versions properly, which lead to an originally unnoticed `v1` in the docs. * content/zh/docs/reference/setup-tools/kubeadm/kubeadm-init.md * trsanlate create-cluster-kubeadm.md to chinese (#11041) * trsanlate create-cluster-kubeadm.md to chinese * Update create-cluster-kubeadm.md * update the feature stage in v1.13 (#11307) * update new feature gates to document (#11295) * refresh controller role list on rbac description page (#11290) * node labeling restriction docs (#10944) * Update 1.13 docs for CSI GA (#10893) * dynamic audit documentation (#9947) * adds dynamic audit documentation * Copyedit for clarity See also inline question/s * Fix feature state shortcode * Update feature state * changes wording for dynamic audit flag behavior * Minor copyedit * fix dynamic audit yaml * adds api enablement command to dynamic audit docs * change ordering dynamic audit appears in * add references to dynamic audit in webhook backend * reword dynamic audit reference * updates stages field for audit sink object * changes audit sink api definition; rewords policy * kubeadm: remove kube-proxy workaround (#11162) * zh-trans content/en/docs/setup/independent/install-kubeadm.md (#11338) * zh-trans content/en/docs/setup/independent/install-kubeadm.md * Update install-kubeadm.md * Update dry run feature to beta (#11140) * vSphere volume raw block support doc update (#10932) * Add docs for Windows DNS configurations (#10036) * Update docs for fields allowed at root of CRD schema (#9973) * Add docs for Windows DNS configurations * add device monitoring documentation (#9945) * kubeadm: adds upgrade instructions for 1.13 (#11138) * kubeadm: adds upgrade instructions for 1.13 Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * add minor copyedits Addressed a couple of copyedit comments a bit more cleanly. * kubeadm: add improvements to HA docs (#11094) * kubeadm: add information and diagrams for HA topologies * kubeadm: update HA doc with simplified steps * kubeadm: update HA doc with simplified steps * edit ha, add new topology topic, reorder by weight * troubleshoot markdown * fix more markdown, fix links * more markdown * more markdown * more markdown * changes after reviewer comments * add steps about Weave * update note about stacked topology * kubeadm external etcd HA upgrade 1.13 (#11364) * kubeadm external etcd HA upgrade 1.13 Signed-off-by: Ruben Orduz <rubenoz@gmail.com> * Update stacked controlplane steps * kubeadm cert documentation (#11093) * kubeadm certificate API and CSR documentation * copyedits * fix typo * PR for diff docs (#10789) * Empty commit against dev-1.13 for diff documentation * Complete Declarative maangement with diff commands * Second Korean l10n work for dev-1.13. (#11030) * Update outdated l10n(ko) contents (#10915) * Translate main menu for l10n(ko) docs (#10916) * Translate tasks/run-application/horizontal-pod-autoscale-walkthrough (#10980) * Translate content/ko/docs/concepts/overview/working-with-objects/kubernetes-object in Korean #11104 (#11332) * Pick-right-solution page translates into Korean. (#11340) * ko-trans: add jd/..., sap/..., ebay/..., homeoffice/... (#11336) * Translate concept/workloads/pods/pod-overview.md (#11092) Co-authored-by: June Yi <june.yi@samsung.com> Co-authored-by: Jesang Myung <jesang.myung@gmail.com> Co-authored-by: zerobig <38598117+zer0big@users.noreply.github.com> Co-authored-by: Claudia J.Kang <claudiajkang@gmail.com> Co-authored-by: lIuDuI <1693291525@qq.com> Co-authored-by: Woojin Na(Eddie) <cheapluv@gmail.com> * Rename encryption-at-rest related objects (#11059) EncryptionConfig was renamed to EncryptedConfiguration and added to the `apiserver.config.k8s.io` API group in Kubernetes 1.13. The feature was previously in alpha and was not handling versions properly, which lead to an originally unnoticed `v1` in the docs. Also, the `--experimental-encryption-provider-config` flag is now called just `--encryption-provider-config`. * Documenting FlexVolume Resize alpha feature. (#10097) * CR webhook conversion documentation (#10986) * CR Conversion * Addressing comments * Addressing more comments * Addressing even more comments * Addressing even^2 more comments * Remove references to etcd2 in v1.13 since support has been removed (#11414) * Remove etcd2 references as etcd2 is deprecated Link back to the v1.12 version of the etcd3 doc for the etcd2->etcd3 migration instructions. I updated the kube-apiserver reference manually, unsure if that is auto-generated somehow. The federation-apiserver can still potentially support etcd2 so I didn't touch that. * Remove outdated {master,node}.yaml files There are master/node yaml files that reference etcd2.service that are likely highly out of date. I couldn't find any docs that actually reference these templates so I removed them * Address review comments * Final Korean l10n work for dev-1.13 (#11440) * Update outdated l10n(ko) contents (#11425) fixes #11424 * Remove references to etcd2 in content/ko (#11416) * Resolve conflicts against master for /ko contents (#11438) * Fix unopened caution shortcode * kubeadm: update the reference docs for 1.13 (#10960) * docs update to promote TaintBasedEvictions to beta (#10765) * First Korean l10n work for dev-1.13 (#10719) * Update outdated l10n(ko) contents (#10689) fixes #10686 * Translate concepts/overview/what-is-kubernetes in Korean (#10690) * Translate concepts/overview/what-is-kubernetes in Korean * Feedback from ClaudiaJKang * Translate concepts/overview/components in Korean (#10882) * Translate concepts/overview/components in Korean #10717 * Translate concepts/overview/components in Korean * Translate concepts/overview/components in Korean * Apply Korean glossary: 서비스 어카운트 * Translate concepts/overview/kubernetes-api in Korean (#10773) * Translate concepts/overview/kubernetes-api in Korean * Applied feedback from ianychoi * kubeadm: update the configuration docs to v1beta1 (#10959) * kubeadm: add small v1beta1 related updates (#10988) * update new feature gates to document (#11295) * Update dry run feature to beta (#11140) * kubeadm: add improvements to HA docs (#11094) * kubeadm: add information and diagrams for HA topologies * kubeadm: update HA doc with simplified steps * kubeadm: update HA doc with simplified steps * edit ha, add new topology topic, reorder by weight * troubleshoot markdown * fix more markdown, fix links * more markdown * more markdown * more markdown * changes after reviewer comments * add steps about Weave * update note about stacked topology * kubeadm: update reference docs - add section about working with phases under kubeadm-init.md - update GA / beta status of features - kubeadm alpha phase was moved to kubeadm init phase - new commands were added under kubeadm alpha - included new CoreDNS usage examples * Generate components and tools reference * Add generated federation API Reference (#11491) * Add generated federation API Reference * Add front matter to federation reference * Remove whitespace from federation front matter * Remove more whitespace from federation front matter * Remove superfluous kubefed reference * Add frontmatter to generated kubefed reference * Fix kubefed reference page frontmatter * Generate kubectl reference docs 1.13 (#11487) * Generate kubectl reference docs 1.13 * Fix links in kubectl reference * Add 1.13 API reference (#11489) * Update config.toml (#11486) * Update config.toml Preparing for 1.13 release, updating the config.toml and dropping the 1.8 docs reference. * update dot releases and docsbranch typo * adding .Site. to Params.currentUrl (#11503) see #11502 for context * Add 1.13 Release notes (#11499)

porridge · 2021-04-13T11:00:13Z

Could it be that this PR should have also updated the section near the bottom (which says that conversion from storage to serving version is never performed)?
I hope this was simply forgotten by mistake, otherwise the documentation seems self-conflicting...
See #27534

mbohlool added this to the 1.13 milestone Nov 13, 2018

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 13, 2018

k8s-ci-robot requested review from bgrant0607 and davidopp November 13, 2018 19:11

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. language/en Issues or PRs related to English language labels Nov 13, 2018

mbohlool mentioned this pull request Nov 13, 2018

Webhook Conversion for Custom Resources kubernetes/enhancements#598

Closed

k8s-ci-robot added the language/ko Issues or PRs related to Korean language label Nov 13, 2018

tfogo changed the base branch from master to dev-1.13 November 14, 2018 17:23

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Nov 14, 2018

claudiajkang removed the language/ko Issues or PRs related to Korean language label Nov 17, 2018

mbohlool force-pushed the crd_conversion branch from 7926c50 to c7380cb Compare November 17, 2018 22:47

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 17, 2018

CR Conversion

e4c11d6

mbohlool force-pushed the crd_conversion branch from c7380cb to e4c11d6 Compare November 17, 2018 23:23

mbohlool changed the title ~~WIP: CR webhook conversion documentation~~ CR webhook conversion documentation Nov 17, 2018

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 17, 2018

k8s-ci-robot assigned liggitt and sttts Nov 19, 2018

k8s-ci-robot requested review from liggitt and sttts and removed request for bgrant0607 and davidopp November 19, 2018 21:51

kbhawkey reviewed Nov 21, 2018

View reviewed changes

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md Outdated Show resolved Hide resolved

kbhawkey reviewed Nov 21, 2018

View reviewed changes

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md Outdated Show resolved Hide resolved

kbhawkey reviewed Nov 21, 2018

View reviewed changes

mbohlool added 2 commits November 22, 2018 03:49

Addressing comments

5351b17

Addressing more comments

d5825b7

mbohlool force-pushed the crd_conversion branch from 670a3ea to d5825b7 Compare November 22, 2018 00:20

kbhawkey reviewed Nov 25, 2018

View reviewed changes

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md Show resolved Hide resolved

kbhawkey reviewed Nov 26, 2018

View reviewed changes

...n/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning.md Outdated Show resolved Hide resolved

kbhawkey reviewed Nov 26, 2018

View reviewed changes

liggitt reviewed Nov 26, 2018

View reviewed changes

Addressing even more comments

9d8d1ee

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 27, 2018

kbhawkey reviewed Nov 27, 2018

View reviewed changes

Addressing even^2 more comments

505e061

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2018

k8s-ci-robot assigned tfogo Nov 29, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 29, 2018

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 29, 2018

k8s-ci-robot merged commit ead3348 into kubernetes:dev-1.13 Nov 29, 2018

tfogo pushed a commit that referenced this pull request Dec 1, 2018

CR webhook conversion documentation (#10986)

7ce937a

* CR Conversion * Addressing comments * Addressing more comments * Addressing even more comments * Addressing even^2 more comments

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CR webhook conversion documentation #10986

CR webhook conversion documentation #10986

mbohlool commented Nov 13, 2018 •

edited

Loading

k8sio-netlify-preview-bot commented Nov 13, 2018

tfogo commented Nov 19, 2018

liggitt commented Nov 19, 2018

liggitt commented Nov 19, 2018

kbhawkey Nov 21, 2018

mbohlool Nov 21, 2018

kbhawkey Nov 22, 2018

mbohlool Nov 22, 2018

mbohlool commented Nov 23, 2018

kbhawkey Nov 26, 2018

liggitt Nov 26, 2018

mbohlool Nov 27, 2018

liggitt Nov 26, 2018

liggitt Nov 26, 2018

mbohlool Nov 27, 2018

mbohlool commented Nov 27, 2018

liggitt commented Nov 27, 2018

kbhawkey Nov 27, 2018 •

edited

Loading

liggitt Nov 27, 2018 •

edited

Loading

kbhawkey Nov 27, 2018

mbohlool Nov 28, 2018

kbhawkey commented Nov 28, 2018

tfogo commented Nov 29, 2018

k8s-ci-robot commented Nov 29, 2018

kbhawkey commented Nov 29, 2018

tfogo commented Nov 29, 2018

porridge commented Apr 13, 2021

CR webhook conversion documentation #10986

CR webhook conversion documentation #10986

Conversation

mbohlool commented Nov 13, 2018 • edited Loading

k8sio-netlify-preview-bot commented Nov 13, 2018

tfogo commented Nov 19, 2018

liggitt commented Nov 19, 2018

liggitt commented Nov 19, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbohlool commented Nov 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbohlool commented Nov 27, 2018

liggitt commented Nov 27, 2018

kbhawkey Nov 27, 2018 • edited Loading

Choose a reason for hiding this comment

liggitt Nov 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbhawkey commented Nov 28, 2018

tfogo commented Nov 29, 2018

k8s-ci-robot commented Nov 29, 2018

kbhawkey commented Nov 29, 2018

tfogo commented Nov 29, 2018

porridge commented Apr 13, 2021

mbohlool commented Nov 13, 2018 •

edited

Loading

kbhawkey Nov 27, 2018 •

edited

Loading

liggitt Nov 27, 2018 •

edited

Loading