sigs.k8s.io/kubebuilder/v3@v3.14.0/pkg/plugins/common/kustomize/v1/plugin.go (about)

     1  /*
     2  Copyright 2022 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  //go:deprecated This package has been deprecated in favor of v2
    18  package v1
    19  
    20  import (
    21  	"sigs.k8s.io/kubebuilder/v3/pkg/config"
    22  	cfgv3 "sigs.k8s.io/kubebuilder/v3/pkg/config/v3"
    23  	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
    24  	"sigs.k8s.io/kubebuilder/v3/pkg/plugins"
    25  )
    26  
    27  // KustomizeVersion is the kubernetes-sigs/kustomize version to be used in the project
    28  const KustomizeVersion = "v3.8.7"
    29  
    30  const pluginName = "kustomize.common." + plugins.DefaultNameQualifier
    31  
    32  var (
    33  	pluginVersion            = plugin.Version{Number: 1}
    34  	supportedProjectVersions = []config.Version{cfgv3.Version}
    35  )
    36  
    37  var (
    38  	_ plugin.Init          = Plugin{}
    39  	_ plugin.CreateAPI     = Plugin{}
    40  	_ plugin.CreateWebhook = Plugin{}
    41  )
    42  
    43  // Plugin implements the plugin.Full interface
    44  type Plugin struct {
    45  	initSubcommand
    46  	createAPISubcommand
    47  	createWebhookSubcommand
    48  }
    49  
    50  // Name returns the name of the plugin
    51  func (Plugin) Name() string { return pluginName }
    52  
    53  // Version returns the version of the plugin
    54  func (Plugin) Version() plugin.Version { return pluginVersion }
    55  
    56  // SupportedProjectVersions returns an array with all project versions supported by the plugin
    57  func (Plugin) SupportedProjectVersions() []config.Version { return supportedProjectVersions }
    58  
    59  // GetInitSubcommand will return the subcommand which is responsible for scaffolding init project
    60  func (p Plugin) GetInitSubcommand() plugin.InitSubcommand { return &p.initSubcommand }
    61  
    62  // GetCreateAPISubcommand will return the subcommand which is responsible for scaffolding apis
    63  func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand { return &p.createAPISubcommand }
    64  
    65  // GetCreateWebhookSubcommand will return the subcommand which is responsible for scaffolding webhooks
    66  func (p Plugin) GetCreateWebhookSubcommand() plugin.CreateWebhookSubcommand {
    67  	return &p.createWebhookSubcommand
    68  }
    69  
    70  func (p Plugin) DeprecationWarning() string {
    71  	return "This version is deprecated.The kustomize/v1 plugin used within go/v3 projects uses an old version " +
    72  		"of kustomize (v3). It is recommended that you upgrade your project to use the go/v4 and kustomize/v2 plugins."
    73  }