📖 add doc for admission webhooks #776

mengqiy · 2019-06-11T18:19:20Z

There is a section about suggested development workflow with kind, so this fixes #400

k8s-ci-robot · 2019-06-11T18:19:29Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mengqiy

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~~ [mengqiy]

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

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

DirectXMan12 · 2019-06-11T19:51:00Z

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

+	allErrs := c.validateCronJobSpec()
+	if len(c.ObjectMeta.Name) > apimachineryutilvalidation.DNS1035LabelMaxLength-11 {
+		// The cronjob controller appends a 11-character suffix to the cronjob (`-$TIMESTAMP`) when
+		// creating a job. The job name length limit is 63 characters.


say why -- the job name length is 63 character like all Kubernetes objects (which must fit in a DNS subdomain)

Add a note that we could validate this declaratively, but we keep it here as an example

Add a note that we could validate this declaratively

This is ObjectMeta.Name which is not owned by the user. Not sure if it's doable through validation schema. Thoughts?

it's explicitly doable, in fact. GenerateName and Name are the only things that are allowed to have validation, going forward. Unfortunately, we don't have a good way to accomplish it in KB, but it's doable in in Kubernetes.

Yes, that's what I meant.
Upstream k/k can add a marker for ObjectMeta.Name to have maximum 63 length. But as a downstream user, if I can't change the marker in upstream to accomplish my need which is 52 max length.

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

docs/book/src/cronjob-tutorial/webhook-implementation.md

docs/book/src/cronjob-tutorial/webhook-overview.md

mengqiy · 2019-06-13T04:07:53Z

PTAL

droot

I have a few minor comments, otherwise looks good.

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

docs/book/src/cronjob-tutorial/testdata/project/config/default/kustomization.yaml

docs/book/src/reference/admission-webhook.md

DirectXMan12 · 2019-06-13T18:59:08Z

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

+	spec := c.Spec
+	fldPath := field.NewPath("spec")
+
+	if len(spec.Schedule) == 0 {


perhaps put an example of actually parsing the schedule and seeing if it has an error?

mengqiy · 2019-06-17T16:55:27Z

PTAL

mengqiy · 2019-06-18T20:23:41Z

Rebased to resolve conflict.
PTAL

DirectXMan12

a bunch a minor grammar or wording comments, and a couple of structure comments

docs/book/src/SUMMARY.md

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

docs/book/src/reference/webhook-overview.md

docs/book/src/reference/admission-webhook.md

mengqiy · 2019-07-03T21:41:23Z

PTAL
I will squash commits before merging.

c10l · 2019-07-05T16:30:31Z

Shouldn't automated tests (ginkgo/gomega) be a part of this?

mengqiy · 2019-07-08T18:43:13Z

@cassianoleal kubebuilder v2 ATM doesn't scaffold much testing files, since we are trying to figure out what is the best way to scaffold tests. We do have plan to support it soon after we have resolve our v2 release blockers :)

mengqiy · 2019-07-09T00:50:50Z

This should be ready to go.

droot

Looks good. Noticed config not being rendered properly on the kind reference.

docs/book/src/reference/kind.md

mengqiy · 2019-07-10T18:35:07Z

Ready to ship.

mengqiy · 2019-07-12T21:12:51Z

Thanks for raising this.
We have noticed this yesterday. We plan to temporarily drop it from the example #853.
We will add it back when we fix it in controller-tools.

mengqiy · 2019-07-13T00:11:45Z

filed kubernetes-sigs/controller-tools#256 to track

mengqiy · 2019-07-15T16:40:41Z

@gautamkmr #857 fixed it.

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 11, 2019

k8s-ci-robot requested review from Liujingfang1 and pwittrock June 11, 2019 18:19

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 11, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 11, 2019

DirectXMan12 requested changes Jun 11, 2019

View reviewed changes

droot added this to Code Awaiting Review in 2.0.0 cross-project tracking Jun 11, 2019

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

mengqiy force-pushed the webhookdoc branch from 0cb30a6 to 3348ad5 Compare June 13, 2019 03:47

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 13, 2019

mengqiy force-pushed the webhookdoc branch from 3348ad5 to 10b8325 Compare June 13, 2019 03:52

droot reviewed Jun 13, 2019

View reviewed changes

DirectXMan12 reviewed Jun 13, 2019

View reviewed changes

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

mengqiy force-pushed the webhookdoc branch from 10b8325 to 2fc84f0 Compare June 15, 2019 22:19

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 15, 2019

mengqiy added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 18, 2019

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

mengqiy force-pushed the webhookdoc branch from 2fc84f0 to 2f02568 Compare June 18, 2019 20:23

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 18, 2019

mengqiy mentioned this pull request Jun 25, 2019

Admission Webhook Docs #817

Closed

kragniz mentioned this pull request Jun 26, 2019

Question about how to run examples kubernetes-sigs/controller-runtime#491

Closed

DirectXMan12 requested changes Jun 27, 2019

View reviewed changes

mengqiy force-pushed the webhookdoc branch from 2f02568 to 6034ddd Compare July 3, 2019 20:56

📖 update project deploy config

3deb70f

mengqiy force-pushed the webhookdoc branch from 6034ddd to b387f21 Compare July 9, 2019 00:50

mengqiy removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 9, 2019

droot reviewed Jul 10, 2019

View reviewed changes

docs/book/src/reference/kind.md Outdated Show resolved Hide resolved

docs/book/src/reference/kind.md Outdated Show resolved Hide resolved

📖 add webhook documents

6aea2c7

mengqiy force-pushed the webhookdoc branch from b387f21 to 6aea2c7 Compare July 10, 2019 18:33

droot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 11, 2019

k8s-ci-robot merged commit 450508e into kubernetes-sigs:master Jul 11, 2019

2.0.0 cross-project tracking automation moved this from Code Awaiting Review to Done Jul 11, 2019

mengqiy deleted the webhookdoc branch July 12, 2019 21:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 add doc for admission webhooks #776

📖 add doc for admission webhooks #776

mengqiy commented Jun 11, 2019 •

edited

Loading

k8s-ci-robot commented Jun 11, 2019

DirectXMan12 Jun 11, 2019

DirectXMan12 Jun 11, 2019

mengqiy Jun 11, 2019

DirectXMan12 Jun 13, 2019

mengqiy Jun 13, 2019

mengqiy commented Jun 13, 2019

droot left a comment

DirectXMan12 Jun 13, 2019

mengqiy commented Jun 17, 2019

mengqiy commented Jun 18, 2019

DirectXMan12 left a comment

mengqiy commented Jul 3, 2019

c10l commented Jul 5, 2019

mengqiy commented Jul 8, 2019

mengqiy commented Jul 9, 2019

droot left a comment

mengqiy commented Jul 10, 2019

mengqiy commented Jul 12, 2019

mengqiy commented Jul 13, 2019

mengqiy commented Jul 15, 2019

📖 add doc for admission webhooks #776

📖 add doc for admission webhooks #776

Conversation

mengqiy commented Jun 11, 2019 • edited Loading

k8s-ci-robot commented Jun 11, 2019

DirectXMan12 Jun 11, 2019

Choose a reason for hiding this comment

DirectXMan12 Jun 11, 2019

Choose a reason for hiding this comment

mengqiy Jun 11, 2019

Choose a reason for hiding this comment

DirectXMan12 Jun 13, 2019

Choose a reason for hiding this comment

mengqiy Jun 13, 2019

Choose a reason for hiding this comment

mengqiy commented Jun 13, 2019

droot left a comment

Choose a reason for hiding this comment

DirectXMan12 Jun 13, 2019

Choose a reason for hiding this comment

mengqiy commented Jun 17, 2019

mengqiy commented Jun 18, 2019

DirectXMan12 left a comment

Choose a reason for hiding this comment

mengqiy commented Jul 3, 2019

c10l commented Jul 5, 2019

mengqiy commented Jul 8, 2019

mengqiy commented Jul 9, 2019

droot left a comment

Choose a reason for hiding this comment

mengqiy commented Jul 10, 2019

mengqiy commented Jul 12, 2019

mengqiy commented Jul 13, 2019

mengqiy commented Jul 15, 2019

mengqiy commented Jun 11, 2019 •

edited

Loading