forked from operator-framework/operator-sdk
/
controller_kind.go
282 lines (250 loc) · 9.39 KB
/
controller_kind.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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
// 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 scaffold
import (
"fmt"
"path"
"path/filepath"
"strings"
"unicode"
"github.com/operator-framework/operator-sdk/internal/pkg/scaffold/input"
)
// ControllerKind is the input needed to generate a pkg/controller/<kind>/<kind>_controller.go file
type ControllerKind struct {
input.Input
// Resource defines the inputs for the controller's primary resource
Resource *Resource
// CustomImport holds the import path for a built-in or custom Kubernetes
// API that this controller reconciles, if specified by the scaffold invoker.
CustomImport string
// The following fields will be overwritten by GetInput().
//
// ImportMap maps all imports destined for the scaffold to their import
// identifier, if any.
ImportMap map[string]string
// GoImportIdent is the import identifier for the API reconciled by this
// controller.
GoImportIdent string
}
func (s *ControllerKind) GetInput() (input.Input, error) {
if s.Path == "" {
fileName := s.Resource.LowerKind + "_controller.go"
s.Path = filepath.Join(ControllerDir, s.Resource.LowerKind, fileName)
}
// Error if this file exists.
s.IfExistsAction = input.Error
s.TemplateBody = controllerKindTemplate
// Set imports.
if err := s.setImports(); err != nil {
return input.Input{}, err
}
return s.Input, nil
}
func (s *ControllerKind) setImports() (err error) {
s.ImportMap = controllerKindImports
importPath := ""
if s.CustomImport != "" {
importPath, s.GoImportIdent, err = getCustomAPIImportPathAndIdent(s.CustomImport)
if err != nil {
return err
}
} else {
importPath = path.Join(s.Repo, "pkg", "apis", s.Resource.GoImportGroup, s.Resource.Version)
s.GoImportIdent = s.Resource.GoImportGroup + s.Resource.Version
}
// Import identifiers must be unique within a file.
for p, id := range s.ImportMap {
if s.GoImportIdent == id && importPath != p {
// Append "api" to the conflicting import identifier.
s.GoImportIdent = s.GoImportIdent + "api"
break
}
}
s.ImportMap[importPath] = s.GoImportIdent
return nil
}
func getCustomAPIImportPathAndIdent(m string) (p string, id string, err error) {
sm := strings.Split(m, "=")
for i, e := range sm {
if i == 0 {
p = strings.TrimSpace(e)
} else if i == 1 {
id = strings.TrimSpace(e)
}
}
if p == "" {
return "", "", fmt.Errorf(`custom import "%s" path is empty`, m)
}
if id == "" {
if len(sm) == 2 {
return "", "", fmt.Errorf(`custom import "%s" identifier is empty, remove "=" from passed string`, m)
}
sp := strings.Split(p, "/")
if len(sp) > 1 {
id = sp[len(sp)-2] + sp[len(sp)-1]
} else {
id = sp[0]
}
id = strings.ToLower(id)
}
idb := &strings.Builder{}
// By definition, all package identifiers must be comprised of "_", unicode
// digits, and/or letters.
for _, r := range id {
if unicode.IsDigit(r) || unicode.IsLetter(r) || r == '_' {
if _, err := idb.WriteRune(r); err != nil {
return "", "", err
}
}
}
return p, idb.String(), nil
}
var controllerKindImports = map[string]string{
"k8s.io/api/core/v1": "corev1",
"k8s.io/apimachinery/pkg/api/errors": "",
"k8s.io/apimachinery/pkg/apis/meta/v1": "metav1",
"k8s.io/apimachinery/pkg/runtime": "",
"k8s.io/apimachinery/pkg/types": "",
"sigs.k8s.io/controller-runtime/pkg/client": "",
"sigs.k8s.io/controller-runtime/pkg/controller": "",
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil": "",
"sigs.k8s.io/controller-runtime/pkg/handler": "",
"sigs.k8s.io/controller-runtime/pkg/manager": "",
"sigs.k8s.io/controller-runtime/pkg/reconcile": "",
"sigs.k8s.io/controller-runtime/pkg/runtime/log": "logf",
"sigs.k8s.io/controller-runtime/pkg/source": "",
}
const controllerKindTemplate = `package {{ .Resource.LowerKind }}
import (
"context"
{{range $p, $i := .ImportMap -}}
{{$i}} "{{$p}}"
{{end}}
)
var log = logf.Log.WithName("controller_{{ .Resource.LowerKind }}")
/**
* USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller
* business logic. Delete these comments after modifying this file.*
*/
// Add creates a new {{ .Resource.Kind }} Controller and adds it to the Manager. The Manager will set fields on the Controller
// and Start it when the Manager is Started.
func Add(mgr manager.Manager) error {
return add(mgr, newReconciler(mgr))
}
// newReconciler returns a new reconcile.Reconciler
func newReconciler(mgr manager.Manager) reconcile.Reconciler {
return &Reconcile{{ .Resource.Kind }}{client: mgr.GetClient(), scheme: mgr.GetScheme()}
}
// add adds a new Controller to mgr with r as the reconcile.Reconciler
func add(mgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New("{{ .Resource.LowerKind }}-controller", mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
// Watch for changes to primary resource {{ .Resource.Kind }}
err = c.Watch(&source.Kind{Type: &{{ .GoImportIdent }}.{{ .Resource.Kind }}{}}, &handler.EnqueueRequestForObject{})
if err != nil {
return err
}
// TODO(user): Modify this to be the types you create that are owned by the primary resource
// Watch for changes to secondary resource Pods and requeue the owner {{ .Resource.Kind }}
err = c.Watch(&source.Kind{Type: &corev1.Pod{}}, &handler.EnqueueRequestForOwner{
IsController: true,
OwnerType: &{{ .GoImportIdent }}.{{ .Resource.Kind }}{},
})
if err != nil {
return err
}
return nil
}
// blank assignment to verify that Reconcile{{ .Resource.Kind }} implements reconcile.Reconciler
var _ reconcile.Reconciler = &Reconcile{{ .Resource.Kind }}{}
// Reconcile{{ .Resource.Kind }} reconciles a {{ .Resource.Kind }} object
type Reconcile{{ .Resource.Kind }} struct {
// This client, initialized using mgr.Client() above, is a split client
// that reads objects from the cache and writes to the apiserver
client client.Client
scheme *runtime.Scheme
}
// Reconcile reads that state of the cluster for a {{ .Resource.Kind }} object and makes changes based on the state read
// and what is in the {{ .Resource.Kind }}.Spec
// TODO(user): Modify this Reconcile function to implement your Controller logic. This example creates
// a Pod as an example
// Note:
// The Controller will requeue the Request to be processed again if the returned error is non-nil or
// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
func (r *Reconcile{{ .Resource.Kind }}) Reconcile(request reconcile.Request) (reconcile.Result, error) {
reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
reqLogger.Info("Reconciling {{ .Resource.Kind }}")
// Fetch the {{ .Resource.Kind }} instance
instance := &{{ .GoImportIdent }}.{{ .Resource.Kind }}{}
err := r.client.Get(context.TODO(), request.NamespacedName, instance)
if err != nil {
if errors.IsNotFound(err) {
// Request object not found, could have been deleted after reconcile request.
// Owned objects are automatically garbage collected. For additional cleanup logic use finalizers.
// Return and don't requeue
return reconcile.Result{}, nil
}
// Error reading the object - requeue the request.
return reconcile.Result{}, err
}
// Define a new Pod object
pod := newPodForCR(instance)
// Set {{ .Resource.Kind }} instance as the owner and controller
if err := controllerutil.SetControllerReference(instance, pod, r.scheme); err != nil {
return reconcile.Result{}, err
}
// Check if this Pod already exists
found := &corev1.Pod{}
err = r.client.Get(context.TODO(), types.NamespacedName{Name: pod.Name, Namespace: pod.Namespace}, found)
if err != nil && errors.IsNotFound(err) {
reqLogger.Info("Creating a new Pod", "Pod.Namespace", pod.Namespace, "Pod.Name", pod.Name)
err = r.client.Create(context.TODO(), pod)
if err != nil {
return reconcile.Result{}, err
}
// Pod created successfully - don't requeue
return reconcile.Result{}, nil
} else if err != nil {
return reconcile.Result{}, err
}
// Pod already exists - don't requeue
reqLogger.Info("Skip reconcile: Pod already exists", "Pod.Namespace", found.Namespace, "Pod.Name", found.Name)
return reconcile.Result{}, nil
}
// newPodForCR returns a busybox pod with the same name/namespace as the cr
func newPodForCR(cr *{{ .GoImportIdent }}.{{ .Resource.Kind }}) *corev1.Pod {
labels := map[string]string{
"app": cr.Name,
}
return &corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: cr.Name + "-pod",
Namespace: cr.Namespace,
Labels: labels,
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "busybox",
Image: "busybox",
Command: []string{"sleep", "3600"},
},
},
},
}
}
`