-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
⚠️ update deps to use k8s 1.22 #2340
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -113,6 +113,10 @@ func (p *createAPISubcommand) BindFlags(fs *pflag.FlagSet) { | |
fs.BoolVar(&p.options.DoController, "controller", true, | ||
"if set, generate the controller without prompting the user") | ||
p.controllerFlag = fs.Lookup("controller") | ||
|
||
// (not required raise an error in this case) | ||
// nolint:errcheck,gosec | ||
fs.MarkDeprecated("crd-version", deprecateMsg) | ||
} | ||
|
||
func (p *createAPISubcommand) InjectConfig(c config.Config) error { | ||
|
@@ -182,6 +186,16 @@ func (p *createAPISubcommand) Scaffold(fs machinery.Filesystem) error { | |
} | ||
|
||
func (p *createAPISubcommand) PostScaffold() error { | ||
|
||
// Update the makefile to allow generate Webhooks to ensure backwards compatibility | ||
// todo: it should be removed for go/v4 | ||
// nolint:lll,gosec | ||
if p.resource.API.CRDVersion == "v1beta1" { | ||
if err := applyScaffoldCustomizationsForVbeta1(); err != nil { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. would we still be supporting this in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To ensure backwards compatibility:
We cannot remove the option for go/v3. That would be a breaking change and we will allow to do that only when we create go/v4. |
||
return err | ||
} | ||
} | ||
|
||
err := util.RunCmd("Update dependencies", "go", "mod", "tidy") | ||
if err != nil { | ||
return err | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
/* | ||
Copyright 2021 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 v3 | ||
|
||
import ( | ||
"fmt" | ||
"io/ioutil" | ||
"path/filepath" | ||
"strings" | ||
|
||
log "github.com/sirupsen/logrus" | ||
|
||
"sigs.k8s.io/kubebuilder/v3/pkg/plugin/util" | ||
"sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v3/scaffolds" | ||
) | ||
|
||
const deprecateMsg = "The v1beta1 API version for CRDs and Webhooks are deprecated and are no longer supported since " + | ||
"the Kubernetes release 1.22. This flag no longer required to exist in future releases. Also, we would like to " + | ||
"recommend you no longer use these API versions." + | ||
"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22" | ||
|
||
// Update the makefile to allow generate CRDs/Webhooks with v1beta1 to ensure backwards compatibility | ||
// nolint:lll,gosec | ||
func applyScaffoldCustomizationsForVbeta1() error { | ||
makefilePath := filepath.Join("Makefile") | ||
bs, err := ioutil.ReadFile(makefilePath) | ||
if err != nil { | ||
return err | ||
} | ||
if !strings.Contains(string(bs), "CRD_OPTIONS") { | ||
|
||
log.Warn("The v1beta1 API version for CRDs and Webhooks are deprecated and are no longer supported " + | ||
"since the Kubernetes release 1.22. In order to help you out use these versions" + | ||
"we will need to try to update the Makefile and go.mod files of this project. Please," + | ||
"ensure that these changes were done accordingly with your customizations.\n" + | ||
"Also, we would like to recommend you no longer use these API versions." + | ||
"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22") | ||
|
||
const makefileTarget = `$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases` | ||
const makefileTargetForV1beta1 = `$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases` | ||
|
||
if err := util.ReplaceInFile("Makefile", makefileTarget, makefileTargetForV1beta1); err != nil { | ||
fmt.Printf("unable to update the makefile to allow the usage of v1beta1: %s", err) | ||
} | ||
|
||
const makegentarget = ` | ||
manifests: controller-gen` | ||
const makegenV1beta1Options = `# Produce CRDs that work back to Kubernetes 1.11 (no version conversion) | ||
CRD_OPTIONS ?= "crd:crdVersions={v1beta1},trivialVersions=true,preserveUnknownFields=false" | ||
manifests: controller-gen` | ||
|
||
if err := util.ReplaceInFile("Makefile", makegentarget, makegenV1beta1Options); err != nil { | ||
log.Warnf("unable to update the Makefile with %s: %s", makegenV1beta1Options, err) | ||
} | ||
|
||
// latest version of controller-tools where v1beta1 is supported | ||
const controllerToolsVersionForVBeta1 = "v0.6.2" | ||
if err := util.ReplaceInFile("Makefile", | ||
fmt.Sprintf("controller-gen@%s", | ||
scaffolds.ControllerToolsVersion), | ||
fmt.Sprintf("controller-gen@%s", | ||
controllerToolsVersionForVBeta1)); err != nil { | ||
log.Warnf("unable to update the Makefile with %s: %s", fmt.Sprintf("controller-gen@%s", | ||
controllerToolsVersionForVBeta1), err) | ||
} | ||
|
||
if err := util.ReplaceInFile("Makefile", | ||
"ENVTEST_K8S_VERSION = 1.22", | ||
"ENVTEST_K8S_VERSION = 1.21"); err != nil { | ||
log.Warnf("unable to update the Makefile with %s: %s", "ENVTEST_K8S_VERSION = 1.21", err) | ||
} | ||
|
||
// latest version of controller-runtime where v1beta1 is supported | ||
const controllerRuntimeVersionForVBeta1 = "v0.9.2" | ||
|
||
if err := util.ReplaceInFile("go.mod", | ||
fmt.Sprintf("sigs.k8s.io/controller-runtime %s", scaffolds.ControllerRuntimeVersion), | ||
fmt.Sprintf("sigs.k8s.io/controller-runtime %s", controllerRuntimeVersionForVBeta1)); err != nil { | ||
log.Warnf("unable to update the go.mod with sigs.k8s.io/controller-runtime %s: %s", | ||
controllerRuntimeVersionForVBeta1, err) | ||
} | ||
|
||
if err := util.ReplaceInFile("go.mod", | ||
"k8s.io/api v0.22.1", | ||
"k8s.io/api v0.21.2"); err != nil { | ||
log.Warnf("unable to update the go.mod with k8s.io/api v0.21.2: %s", err) | ||
} | ||
|
||
if err := util.ReplaceInFile("go.mod", | ||
"k8s.io/apimachinery v0.22.1", | ||
"k8s.io/apimachinery v0.21.2"); err != nil { | ||
log.Warnf("unable to update the go.mod with k8s.io/apimachinery v0.21.2: %s", err) | ||
} | ||
|
||
if err := util.ReplaceInFile("go.mod", | ||
"k8s.io/apimachinery v0.22.1", | ||
"k8s.io/apimachinery v0.21.2"); err != nil { | ||
log.Warnf("unable to update the go.mod with k8s.io/apimachinery v0.21.2: %s", err) | ||
} | ||
|
||
err = util.RunCmd("Update dependencies", "go", "mod", "tidy") | ||
if err != nil { | ||
return err | ||
} | ||
} | ||
return nil | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a blocker at all, but since the PR is still open we could do 0.10.1 of controller-runtime too as it has k8s bumped to 1.22.2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes. I think we can -)