-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cmd: keep openapi with deprecation and instructions for migrating
- Loading branch information
1 parent
920bd3b
commit 9dc62c2
Showing
6 changed files
with
230 additions
and
7 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
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,82 @@ | ||
| // Copyright 2019 The Operator-SDK 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 generate | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/operator-framework/operator-sdk/cmd/operator-sdk/internal/genutil" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func newGenerateOpenAPICmd() *cobra.Command { | ||
| return &cobra.Command{ | ||
| Hidden: true, | ||
| Use: "openapi", | ||
| Short: "Generates OpenAPI specs for API's", | ||
| Long: `generate openapi generates OpenAPI validation specs in Go from tagged types | ||
| in all pkg/apis/<group>/<version> directories. Go code is generated under | ||
| pkg/apis/<group>/<version>/zz_generated.openapi.go. CRD's are generated, or | ||
| updated if they exist for a particular group + version + kind, under | ||
| deploy/crds/<full group>_<resource>_crd.yaml; OpenAPI V3 validation YAML | ||
| is generated as a 'validation' object. | ||
| Example: | ||
| $ operator-sdk generate openapi | ||
| $ tree pkg/apis | ||
| pkg/apis/ | ||
| └── app | ||
| └── v1alpha1 | ||
| ├── zz_generated.openapi.go | ||
| $ tree deploy/crds | ||
| ├── deploy/crds/app.example.com_v1alpha1_appservice_cr.yaml | ||
| ├── deploy/crds/app.example.com_appservices_crd.yaml | ||
| `, | ||
| RunE: openAPIFunc, | ||
| } | ||
| } | ||
|
|
||
| const deprecationTemplate = "\033[1;36m%s\033[0m" | ||
|
|
||
| func openAPIFunc(cmd *cobra.Command, args []string) error { | ||
| fmt.Printf(deprecationTemplate, `[Deprecation notice] The 'operator-sdk generate openapi' command is deprecated! | ||
| - To generate CRDs, use 'operator-sdk generate crds'. | ||
| - To generate Go OpenAPI code, use 'openapi-gen'. For example: | ||
| # Build the latest openapi-gen from source | ||
| which ./bin/openapi-gen > /dev/null || go build -o ./bin/openapi-gen k8s.io/kube-openapi/cmd/openapi-gen | ||
| # Run openapi-gen for each of your API group/version packages | ||
| ./bin/openapi-gen --logtostderr=true -o "" -i ./pkg/apis/<group>/<version> -O zz_generated.openapi -p ./pkg/apis/<group>/<version> -h ./hack/boilerplate.go.txt -r "-" | ||
| `) | ||
|
|
||
| if len(args) != 0 { | ||
| return fmt.Errorf("command %s doesn't accept any arguments", cmd.CommandPath()) | ||
| } | ||
|
|
||
| fs := []func() error{ | ||
| genutil.OpenAPIGen, | ||
| genutil.CRDGen, | ||
| } | ||
| for _, f := range fs { | ||
| if err := f(); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } |
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,99 @@ | ||
| // Copyright 2018 The Operator-SDK 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 genutil | ||
|
|
||
| import ( | ||
| "flag" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "github.com/operator-framework/operator-sdk/internal/scaffold" | ||
| "github.com/operator-framework/operator-sdk/internal/util/k8sutil" | ||
| "github.com/operator-framework/operator-sdk/internal/util/projutil" | ||
|
|
||
| "github.com/pkg/errors" | ||
| log "github.com/sirupsen/logrus" | ||
| generatorargs "k8s.io/kube-openapi/cmd/openapi-gen/args" | ||
| "k8s.io/kube-openapi/pkg/generators" | ||
| ) | ||
|
|
||
| // OpenAPIGen generates OpenAPI validation specs for all CRD's in dirs. | ||
| func OpenAPIGen() error { | ||
| projutil.MustInProjectRoot() | ||
|
|
||
| repoPkg := projutil.GetGoPkg() | ||
|
|
||
| gvMap, err := k8sutil.ParseGroupSubpackages(scaffold.ApisDir) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to parse group versions: (%v)", err) | ||
| } | ||
| gvb := &strings.Builder{} | ||
| for g, vs := range gvMap { | ||
| gvb.WriteString(fmt.Sprintf("%s:%v, ", g, vs)) | ||
| } | ||
|
|
||
| log.Infof("Running OpenAPI code-generation for Custom Resource group versions: [%v]\n", gvb.String()) | ||
|
|
||
| apisPkg := filepath.Join(repoPkg, scaffold.ApisDir) | ||
| fqApis := k8sutil.CreateFQAPIs(apisPkg, gvMap) | ||
| f := func(a string) error { return openAPIGen(a, fqApis) } | ||
| if err = generateWithHeaderFile(f); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| log.Info("Code-generation complete.") | ||
| return nil | ||
| } | ||
|
|
||
| func openAPIGen(hf string, fqApis []string) error { | ||
| wd, err := os.Getwd() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if err := flag.Set("logtostderr", "true"); err != nil { | ||
| return err | ||
| } | ||
| for _, api := range fqApis { | ||
| api = filepath.FromSlash(api) | ||
| // Use relative API path so the generator writes to the correct path. | ||
| apiPath := "." + string(filepath.Separator) + api[strings.Index(api, scaffold.ApisDir):] | ||
| args, cargs := generatorargs.NewDefaults() | ||
| // Ignore default output base and set our own output path. | ||
| args.OutputBase = "" | ||
| // openapi-gen already generates a "do not edit" comment. | ||
| args.GeneratedByCommentTemplate = "" | ||
| args.InputDirs = []string{apiPath} | ||
| args.OutputFileBaseName = "zz_generated.openapi" | ||
| args.OutputPackagePath = filepath.Join(wd, apiPath) | ||
| args.GoHeaderFilePath = hf | ||
| // Print API rule violations to stdout | ||
| cargs.ReportFilename = "-" | ||
| if err := generatorargs.Validate(args); err != nil { | ||
| return errors.Wrap(err, "openapi-gen argument validation error") | ||
| } | ||
|
|
||
| err := args.Execute( | ||
| generators.NameSystems(), | ||
| generators.DefaultNameSystem(), | ||
| generators.Packages, | ||
| ) | ||
| if err != nil { | ||
| return errors.Wrap(err, "openapi-gen generator error") | ||
| } | ||
| } | ||
| return nil | ||
| } |
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