-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
init.go
145 lines (121 loc) · 4.63 KB
/
init.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
Copyright 2020 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 scaffolds
import (
"fmt"
"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
"github.com/spf13/afero"
"sigs.k8s.io/kubebuilder/v3/pkg/config"
"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
"sigs.k8s.io/kubebuilder/v3/pkg/plugins"
kustomizecommonv1 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/common/kustomize/v1"
kustomizecommonv2 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/common/kustomize/v2"
"sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v3/scaffolds/internal/templates"
"sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v3/scaffolds/internal/templates/hack"
)
const (
// ControllerRuntimeVersion is the kubernetes-sigs/controller-runtime version to be used in the project
ControllerRuntimeVersion = "v0.12.0"
// ControllerToolsVersion is the kubernetes-sigs/controller-tools version to be used in the project
ControllerToolsVersion = "v0.8.0"
// KustomizeVersion is the kubernetes-sigs/kustomize version to be used in the project
// @Deprecated. This information ought to come from kustomize plugin
// Note that by updating the following value nothing will change for the go/3 plugin
// it is no longer used and it was not removed only because it would be a breaking
// change for the API. (api-diff check)
//
// NOTE: If you want to update the kustomize version used by this plugin
// then you need to update it in pkg/plugins/common/kustomize/v1/plugin.go
// Todo: we should remove it for the next go/v4 plugin
KustomizeVersion = "v3.8.7"
imageName = "controller:latest"
)
var _ plugins.Scaffolder = &initScaffolder{}
var kustomizeVersion string
type initScaffolder struct {
config config.Config
boilerplatePath string
license string
owner string
// fs is the filesystem that will be used by the scaffolder
fs machinery.Filesystem
}
// NewInitScaffolder returns a new Scaffolder for project initialization operations
func NewInitScaffolder(config config.Config, license, owner string) plugins.Scaffolder {
return &initScaffolder{
config: config,
boilerplatePath: hack.DefaultBoilerplatePath,
license: license,
owner: owner,
}
}
// InjectFS implements cmdutil.Scaffolder
func (s *initScaffolder) InjectFS(fs machinery.Filesystem) {
s.fs = fs
}
// Scaffold implements cmdutil.Scaffolder
func (s *initScaffolder) Scaffold() error {
fmt.Println("Writing scaffold for you to edit...")
// Initialize the machinery.Scaffold that will write the boilerplate file to disk
// The boilerplate file needs to be scaffolded as a separate step as it is going to
// be used by the rest of the files, even those scaffolded in this command call.
scaffold := machinery.NewScaffold(s.fs,
machinery.WithConfig(s.config),
)
bpFile := &hack.Boilerplate{
License: s.license,
Owner: s.owner,
}
bpFile.Path = s.boilerplatePath
if err := scaffold.Execute(bpFile); err != nil {
return err
}
boilerplate, err := afero.ReadFile(s.fs.FS, s.boilerplatePath)
if err != nil {
return err
}
// Initialize the machinery.Scaffold that will write the files to disk
scaffold = machinery.NewScaffold(s.fs,
machinery.WithConfig(s.config),
machinery.WithBoilerplate(string(boilerplate)),
)
// If the KustomizeV2 was used to do the scaffold then
// we need to ensure that we use its supported Kustomize Version
// in order to support it
kustomizeVersion = kustomizecommonv1.KustomizeVersion
kustomizev2 := kustomizecommonv2.Plugin{}
pluginKeyForKustomizeV2 := plugin.KeyFor(kustomizev2)
for _, pluginKey := range s.config.GetPluginChain() {
if pluginKey == pluginKeyForKustomizeV2 {
kustomizeVersion = kustomizecommonv2.KustomizeVersion
break
}
}
return scaffold.Execute(
&templates.Main{},
&templates.GoMod{
ControllerRuntimeVersion: ControllerRuntimeVersion,
},
&templates.GitIgnore{},
&templates.Makefile{
Image: imageName,
BoilerplatePath: s.boilerplatePath,
ControllerToolsVersion: ControllerToolsVersion,
KustomizeVersion: kustomizeVersion,
ControllerRuntimeVersion: ControllerRuntimeVersion,
},
&templates.Dockerfile{},
&templates.DockerIgnore{},
&templates.Readme{},
)
}