Skip to content

Commit 9d85d10

Browse files
authored
Merge pull request #353 from anyasabo/webhookdocs
Extend webhook marker documentation
2 parents 2bc3f5e + b8aeffd commit 9d85d10

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

pkg/webhook/parser.go

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,15 @@ type Config struct {
7070
// Versions specifies the API versions that this webhook receives requests for.
7171
Versions []string
7272

73-
// Name indicates the name of this webhook configuration.
73+
// Name indicates the name of this webhook configuration. Should be a domain with at least three segments separated by dots
7474
Name string
75-
// Path specifies that path that the API server should connect to this webhook on.
75+
76+
// Path specifies that path that the API server should connect to this webhook on. Must be
77+
// prefixed with a '/validate-' or '/mutate-' depending on the type, and followed by
78+
// $GROUP-$VERSION-$KIND where all values are lower-cased and the periods in the group
79+
// are substituted for hyphens. For example, a validating webhook path for type
80+
// batch.tutorial.kubebuilder.io/v1,Kind=CronJob would be
81+
// /validate-batch-tutorial-kubebuilder-io-v1-cronjob
7682
Path string
7783
}
7884

0 commit comments

Comments
 (0)