Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend webhook marker documentation #353

Merged
merged 1 commit into from
Jan 30, 2020

Conversation

anyasabo
Copy link
Contributor

@anyasabo anyasabo commented Nov 1, 2019

Extends the marker documentation for webhook generation for name and path.

The OpenAPI specs for webhooks require the name is a domain name.

The path is handled specially by controller-runtime, so this adds documentation on how controller-runtime handles it here:
https://github.com/kubernetes-sigs/controller-runtime/blob/master/pkg/builder/webhook.go#L158

Otherwise the webhook configuration generated by controller-tools will not match what actually runs with controller-runtime

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 1, 2019
@k8s-ci-robot
Copy link
Contributor

Welcome @anyasabo!

It looks like this is your first PR to kubernetes-sigs/controller-tools 🎉. 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-sigs/controller-tools 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. 😃

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 1, 2019
@anyasabo
Copy link
Contributor Author

anyasabo commented Nov 1, 2019

/assign @droot

@@ -70,9 +70,15 @@ type Config struct {
// Versions specifies the API versions that this webhook receives requests for.
Versions []string

// Name indicates the name of this webhook configuration.
// Name indicates the name of this webhook configuration. Should be a domain with at least three segments separated by dots
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be a domain with at least three segments separated by dots

Probably just say:
Name should be fully qualified, e.g. imagepolicy.kubebuilder.io.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An FQDN can also simply be kubebuilder.io, so this is more specific about the requirements I think. This is simply using the wording direct from the webhook validation. This is the error you receive if you try to apply a webhook with a name with < 3 labels:

The ValidatingWebhookConfiguration "validating-webhook-configuration" is invalid: webhooks[0].name: Invalid value: "funfunfun": should be a domain with at least three segments separated by dots

Copy link
Member

@mengqiy mengqiy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 30, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

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

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 30, 2020
@k8s-ci-robot k8s-ci-robot merged commit 9d85d10 into kubernetes-sigs:master Jan 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants