update godoc for webhook #147

mengqiy · 2018-09-18T08:22:12Z

No description provided.

pwittrock · 2018-09-18T16:40:19Z

pkg/doc.go

+
+There are 2 types of admission webhook: mutating and validating admission webhook.
+Mutating webhook is used to mutate a core API object or a CRD instance before the API server admit it.
+Validting webhook is used to validate if a core API object or a CRD instance meet certain requirements.


pwittrock · 2018-09-18T16:40:42Z

pkg/doc.go

@@ -49,6 +49,18 @@ system must be read for each Reconciler.

 * Controller require Watches to be configured to enqueue reconcile.Requests in response to events.

+Webhook
+
+Admission Webhook is a mechanism for extending kubernetes APIs. The API server will send AdmissionRequests to


Admission Webhooks are

pwittrock · 2018-09-18T16:41:59Z

pkg/doc.go

+mutate and (or) validate the object embedded in the AdmissionReview requests.
+
+There are 2 types of admission webhook: mutating and validating admission webhook.
+Mutating webhook is used to mutate a core API object or a CRD instance before the API server admit it.


before the API server admits it

pwittrock · 2018-09-18T16:42:50Z

pkg/doc.go

+
+There are 2 types of admission webhook: mutating and validating admission webhook.
+Mutating webhook is used to mutate a core API object or a CRD instance before the API server admit it.
+Validting webhook is used to validate if a core API object or a CRD instance meet certain requirements.


validate if an object meets certain

pwittrock · 2018-09-18T16:44:03Z

pkg/webhook/admission/builder/doc.go

+/*
+Package builder provides methods to build admission webhooks.
+
+For most users, we recommend to use Operations and ForType to construct a webhook.


Either explain why these or recommended or omit this line

pwittrock · 2018-09-18T16:44:27Z

pkg/webhook/admission/builder/doc.go

+		// handle error
+	}
+
+Note: To build a webhook for CRD, you need to ensure the manager is


webhook for a CRD

pwittrock · 2018-09-18T16:45:02Z

pkg/webhook/admission/builder/doc.go

+	}
+
+Note: To build a webhook for CRD, you need to ensure the manager is
+constructed from the scheme that understands your CRD.


Explain what this means more, show a code snippet of getting a manager constructed from a Scheme

pwittrock · 2018-09-18T16:47:30Z

pkg/webhook/admission/doc.go

+		return nil
+	}
+
+	// InjectDecoder injects the decoder into the Handler


// InjectDecoder is called by the Manager and provides a types.Decoder to the Mutator instance.

pwittrock · 2018-09-18T16:47:49Z

pkg/webhook/admission/doc.go

+		return admission.PatchResponse(pod, copy)
+	}
+
+	// InjectClient injects the client into the Handler


// InjectClient is called by the Manager and provides a client.Client to the Mutator instance.

mengqiy · 2018-09-18T17:37:22Z

Addressed comments. PTAL

Liujingfang1 · 2018-09-18T20:53:06Z

pkg/doc.go

+Webhook
+
+Admission Webhooks are a mechanism for extending kubernetes APIs. The API server will send AdmissionRequests to
+the webhooks according to the configured target event type (object Create, Update, Delete). The webhooks may


Maybe change to

When webhooks are configured with target event type(object Create, Update, Delete), the API server will send AdmissionRequests to them when those events happen.

Liujingfang1 · 2018-09-18T20:56:13Z

pkg/doc.go

+
+Admission Webhooks are a mechanism for extending kubernetes APIs. The API server will send AdmissionRequests to
+the webhooks according to the configured target event type (object Create, Update, Delete). The webhooks may
+mutate and (or) validate the object embedded in the AdmissionReview requests.


and send back the response to API server.

Liujingfang1 · 2018-09-18T21:00:19Z

pkg/webhook/admission/builder/doc.go

+
+For most users, we recommend to use Operations and ForType to construct a webhook,
+since it is more intuitive and easier to pass the target operations to Operations method and
+a empty target object to ForType method than passing a complex RuleWithOperations struct to Rules method.


Maybe move this explanation to the later part of the doc and show the example webhooks first.

since it is more intuitive and easier to pass the target operations to Operations method and a empty target object to ForType method than passing a complex RuleWithOperations struct to Rules method.

Liujingfang1 · 2018-09-18T21:04:45Z

pkg/webhook/doc.go

-Package webhook provides functions to build and bootstrap an admission webhook server for a k8s cluster.
+Package webhook provides methods to build and bootstrap a webhook server.
+
+Currently, it only supports hosting admission webhooks.


Can you add some explanation of hosting admission webhooks?

Liujingfang1 · 2018-09-18T22:02:13Z

/lgtm

k8s-ci-robot · 2018-09-18T22:08:23Z

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

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

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

update godoc for webhook

Format go templates

mengqiy requested a review from pwittrock September 18, 2018 08:22

k8s-ci-robot requested review from DirectXMan12 and droot September 18, 2018 08:22

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 18, 2018

pwittrock reviewed Sep 18, 2018

View reviewed changes

Liujingfang1 reviewed Sep 18, 2018

View reviewed changes

update godoc for webhook

43e4a85

mengqiy force-pushed the godoc branch from 7d971bc to 43e4a85 Compare September 18, 2018 21:40

k8s-ci-robot assigned Liujingfang1 Sep 18, 2018

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

mengqiy added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 18, 2018

k8s-ci-robot merged commit 0f4719b into kubernetes-sigs:master Sep 18, 2018

mengqiy deleted the godoc branch September 18, 2018 22:13

justinsb pushed a commit to justinsb/controller-runtime that referenced this pull request Dec 7, 2018

Merge pull request kubernetes-sigs#147 from mengqiy/godoc

66b09f5

update godoc for webhook

DirectXMan12 pushed a commit that referenced this pull request Jan 31, 2020

Merge pull request #147 from kragniz/gofmt-templates

7ed8000

Format go templates

update godoc for webhook #147

update godoc for webhook #147

Uh oh!

Conversation

mengqiy commented Sep 18, 2018

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!

mengqiy commented Sep 18, 2018

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!

Liujingfang1 commented Sep 18, 2018

Uh oh!

k8s-ci-robot commented Sep 18, 2018

Uh oh!

Uh oh!