-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add a new command `kubebuilder create webhook` to scaffold the webhooks. --defaulting and --imperative-validation can be used to scaffold mutating and validating webhooks.
- Loading branch information
Mengqi Yu
committed
Jun 28, 2019
1 parent
b18a4e3
commit b34e3e9
Showing
24 changed files
with
661 additions
and
176 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /* | ||
| Copyright 2018 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func newCreateCmd() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "create", | ||
| Short: "Scaffold a Kubernetes API or webhook.", | ||
| Long: `Scaffold a Kubernetes API or webhook.`, | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| fmt.Println("Coming soon.") | ||
| }, | ||
| } | ||
| cmd.AddCommand( | ||
| newAPICommand(), | ||
| newWebhookV2Cmd(), | ||
| ) | ||
| return cmd | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| /* | ||
| Copyright 2019 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "github.com/gobuffalo/flect" | ||
| "github.com/spf13/cobra" | ||
|
|
||
| "sigs.k8s.io/kubebuilder/pkg/scaffold" | ||
| "sigs.k8s.io/kubebuilder/pkg/scaffold/input" | ||
| "sigs.k8s.io/kubebuilder/pkg/scaffold/project" | ||
| "sigs.k8s.io/kubebuilder/pkg/scaffold/v1/resource" | ||
| resourcev2 "sigs.k8s.io/kubebuilder/pkg/scaffold/v2" | ||
| "sigs.k8s.io/kubebuilder/pkg/scaffold/v2/webhook" | ||
| ) | ||
|
|
||
| func newWebhookV2Cmd() *cobra.Command { | ||
| o := webhookV2Options{} | ||
|
|
||
| cmd := &cobra.Command{ | ||
| Use: "webhook", | ||
| Short: "Scaffold a webhook for an API resource.", | ||
| Long: `Scaffold a webhook for an API resource. You can choose to scaffold defaulting and (or) validating webhooks.`, | ||
| Example: ` # Create defaulting and validating webhooks for CRD of group crew, version v1 and kind FirstMate. | ||
| kubebuilder webhook --group crew --version v1 --kind FirstMate --defaulting --programmatic-validation | ||
| `, | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| dieIfNoProject() | ||
|
|
||
| projectInfo, err := scaffold.LoadProjectFile("PROJECT") | ||
| if err != nil { | ||
| log.Fatalf("failed to read the PROJECT file: %v", err) | ||
| } | ||
|
|
||
| if projectInfo.Version != project.Version2 { | ||
| fmt.Printf("kubebuilder webhook is for project version: 2, the version of this project is: %s \n", projectInfo.Version) | ||
| os.Exit(0) | ||
| } | ||
|
|
||
| if !o.defaulting && !o.validation { | ||
| fmt.Printf("kubebuilder webhook requires at least one of --defaulting and --programmatic-validation") | ||
| os.Exit(0) | ||
| } | ||
|
|
||
| fmt.Println(filepath.Join("api", fmt.Sprintf("%s_webhook.go", strings.ToLower(o.res.Kind)))) | ||
| webhookScaffolder := &webhook.Webhook{ | ||
| Resource: o.res, | ||
| Defaulting: o.defaulting, | ||
| Validating: o.validation, | ||
| } | ||
| err = (&scaffold.Scaffold{}).Execute( | ||
| input.Options{}, | ||
| webhookScaffolder, | ||
| ) | ||
| if err != nil { | ||
| fmt.Printf("error scaffolding webhook: %v", err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| err = (&resourcev2.Main{}).Update( | ||
| &resourcev2.MainUpdateOptions{ | ||
| Project: &projectInfo, | ||
| WireResource: false, | ||
| WireController: false, | ||
| WireWebhook: true, | ||
| Resource: o.res, | ||
| }) | ||
| if err != nil { | ||
| fmt.Printf("error updating main.go: %v", err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| if projectInfo.Version != project.Version1 { | ||
| fmt.Printf("webhook scaffolding is not supported for this project version: %s \n", projectInfo.Version) | ||
| os.Exit(0) | ||
| } | ||
|
|
||
| fmt.Println("Writing scaffold for you to edit...") | ||
|
|
||
| if len(o.res.Resource) == 0 { | ||
| o.res.Resource = flect.Pluralize(strings.ToLower(o.res.Kind)) | ||
| } | ||
| }, | ||
| } | ||
| o.res = gvkForFlags(cmd.Flags()) | ||
| cmd.Flags().BoolVar(&o.defaulting, "defaulting", false, | ||
| "if set, scaffold the defaulting webhook") | ||
| cmd.Flags().BoolVar(&o.validation, "programmatic-validation", false, | ||
| "if set, scaffold the validating webhook") | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| // webhookOptions represents commandline options for scaffolding a webhook. | ||
| type webhookV2Options struct { | ||
| res *resource.Resource | ||
| defaulting bool | ||
| validation bool | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /* | ||
| Copyright 2019 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package util | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "sigs.k8s.io/kubebuilder/pkg/scaffold/input" | ||
| "sigs.k8s.io/kubebuilder/pkg/scaffold/v1/resource" | ||
| ) | ||
|
|
||
| func GetResourceInfo(r *resource.Resource, in input.Input) (resourcePackage, groupDomain string) { | ||
| // Use the k8s.io/api package for core resources | ||
| coreGroups := map[string]string{ | ||
| "apps": "", | ||
| "admission": "k8s.io", | ||
| "admissionregistration": "k8s.io", | ||
| "auditregistration": "k8s.io", | ||
| "apiextensions": "k8s.io", | ||
| "authentication": "k8s.io", | ||
| "authorization": "k8s.io", | ||
| "autoscaling": "", | ||
| "batch": "", | ||
| "certificates": "k8s.io", | ||
| "coordination": "k8s.io", | ||
| "core": "", | ||
| "events": "k8s.io", | ||
| "extensions": "", | ||
| "imagepolicy": "k8s.io", | ||
| "networking": "k8s.io", | ||
| "node": "k8s.io", | ||
| "metrics": "k8s.io", | ||
| "policy": "", | ||
| "rbac.authorization": "k8s.io", | ||
| "scheduling": "k8s.io", | ||
| "setting": "k8s.io", | ||
| "storage": "k8s.io", | ||
| } | ||
| resourcePath := filepath.Join("api", r.Version, fmt.Sprintf("%s_types.go", strings.ToLower(r.Kind))) | ||
| if _, err := os.Stat(resourcePath); os.IsNotExist(err) { | ||
| if domain, found := coreGroups[r.Group]; found { | ||
| // TODO: support apiextensions.k8s.io and metrics.k8s.io. | ||
| // apiextensions.k8s.io is in k8s.io/apiextensions-apiserver/pkg/apis/apiextensions | ||
| // metrics.k8s.io is in k8s.io/metrics/pkg/apis/metrics | ||
| resourcePackage := path.Join("k8s.io", "api", r.Group) | ||
| groupDomain = r.Group | ||
| if domain != "" { | ||
| groupDomain = r.Group + "." + domain | ||
| } | ||
| return resourcePackage, groupDomain | ||
| } | ||
| // TODO: need to support '--resource-pkg-path' flag for specifying resourcePath | ||
| } | ||
| return path.Join(in.Repo, "api"), r.Group + "." + in.Domain | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.