/
clusterserviceversion_updaters.go
402 lines (360 loc) · 14.1 KB
/
clusterserviceversion_updaters.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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
// Copyright 2020 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 clusterserviceversion
import (
"encoding/json"
"errors"
"fmt"
"sort"
"strings"
operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
"github.com/operator-framework/api/pkg/validation"
"github.com/operator-framework/operator-registry/pkg/registry"
log "github.com/sirupsen/logrus"
admissionregv1 "k8s.io/api/admissionregistration/v1"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
"k8s.io/apimachinery/pkg/version"
"github.com/operator-framework/operator-sdk/internal/generate/collector"
"github.com/operator-framework/operator-sdk/internal/util/k8sutil"
)
// ApplyTo applies relevant manifests in c to csv, sorts the applied updates,
// and validates the result.
func ApplyTo(c *collector.Manifests, csv *operatorsv1alpha1.ClusterServiceVersion) error {
// Apply manifests to the CSV object.
if err := apply(c, csv); err != nil {
return err
}
// Set fields required by namespaced operators. This is a no-op for cluster-scoped operators.
setNamespacedFields(csv)
// Sort all updated fields.
sortUpdates(csv)
return validate(csv)
}
// apply applies relevant manifests in c to csv.
func apply(c *collector.Manifests, csv *operatorsv1alpha1.ClusterServiceVersion) error {
strategy := getCSVInstallStrategy(csv)
switch strategy.StrategyName {
case operatorsv1alpha1.InstallStrategyNameDeployment:
applyRoles(c, &strategy.StrategySpec)
applyClusterRoles(c, &strategy.StrategySpec)
applyDeployments(c, &strategy.StrategySpec)
}
csv.Spec.InstallStrategy = strategy
applyCustomResourceDefinitions(c, csv)
if err := applyCustomResources(c, csv); err != nil {
return fmt.Errorf("error applying Custom Resource examples to CSV %s: %v", csv.GetName(), err)
}
applyWebhooks(c, csv)
return nil
}
// Get install strategy from csv.
func getCSVInstallStrategy(csv *operatorsv1alpha1.ClusterServiceVersion) operatorsv1alpha1.NamedInstallStrategy {
// Default to a deployment strategy if none found.
if csv.Spec.InstallStrategy.StrategyName == "" {
csv.Spec.InstallStrategy.StrategyName = operatorsv1alpha1.InstallStrategyNameDeployment
}
return csv.Spec.InstallStrategy
}
// This service account exists in every namespace as the default.
const defaultServiceAccountName = "default"
// applyRoles applies Roles to strategy's permissions field by combining Roles bound to ServiceAccounts
// into one set of permissions.
func applyRoles(c *collector.Manifests, strategy *operatorsv1alpha1.StrategyDetailsDeployment) { //nolint:dupl
objs, _ := c.SplitCSVPermissionsObjects()
roleSet := make(map[string]*rbacv1.Role)
for i := range objs {
switch t := objs[i].(type) {
case *rbacv1.Role:
roleSet[t.GetName()] = t
}
}
saToPermissions := make(map[string]operatorsv1alpha1.StrategyDeploymentPermissions)
for _, dep := range c.Deployments {
saName := dep.Spec.Template.Spec.ServiceAccountName
if saName == "" {
saName = defaultServiceAccountName
}
saToPermissions[saName] = operatorsv1alpha1.StrategyDeploymentPermissions{ServiceAccountName: saName}
}
// Collect all role names by their corresponding service accounts via bindings. This lets us
// look up all service accounts a role is bound to and create one set of permissions per service account.
for _, binding := range c.RoleBindings {
if role, hasRole := roleSet[binding.RoleRef.Name]; hasRole {
for _, subject := range binding.Subjects {
if perm, hasSA := saToPermissions[subject.Name]; hasSA && subject.Kind == "ServiceAccount" {
perm.Rules = append(perm.Rules, role.Rules...)
saToPermissions[subject.Name] = perm
}
}
}
}
// Apply relevant roles to each service account.
perms := []operatorsv1alpha1.StrategyDeploymentPermissions{}
for _, perm := range saToPermissions {
if len(perm.Rules) != 0 {
perms = append(perms, perm)
}
}
strategy.Permissions = perms
}
// applyClusterRoles applies ClusterRoles to strategy's clusterPermissions field by combining ClusterRoles
// bound to ServiceAccounts into one set of clusterPermissions.
func applyClusterRoles(c *collector.Manifests, strategy *operatorsv1alpha1.StrategyDetailsDeployment) { //nolint:dupl
objs, _ := c.SplitCSVClusterPermissionsObjects()
roleSet := make(map[string]*rbacv1.ClusterRole)
for i := range objs {
switch t := objs[i].(type) {
case *rbacv1.ClusterRole:
roleSet[t.GetName()] = t
}
}
saToPermissions := make(map[string]operatorsv1alpha1.StrategyDeploymentPermissions)
for _, dep := range c.Deployments {
saName := dep.Spec.Template.Spec.ServiceAccountName
if saName == "" {
saName = defaultServiceAccountName
}
saToPermissions[saName] = operatorsv1alpha1.StrategyDeploymentPermissions{ServiceAccountName: saName}
}
// Collect all role names by their corresponding service accounts via bindings. This lets us
// look up all service accounts a role is bound to and create one set of permissions per service account.
for _, binding := range c.ClusterRoleBindings {
if role, hasRole := roleSet[binding.RoleRef.Name]; hasRole {
for _, subject := range binding.Subjects {
if perm, hasSA := saToPermissions[subject.Name]; hasSA && subject.Kind == "ServiceAccount" {
perm.Rules = append(perm.Rules, role.Rules...)
saToPermissions[subject.Name] = perm
}
}
}
}
// Apply relevant roles to each service account.
perms := []operatorsv1alpha1.StrategyDeploymentPermissions{}
for _, perm := range saToPermissions {
if len(perm.Rules) != 0 {
perms = append(perms, perm)
}
}
strategy.ClusterPermissions = perms
}
// applyDeployments updates strategy's deployments with the Deployments
// in the collector.
func applyDeployments(c *collector.Manifests, strategy *operatorsv1alpha1.StrategyDetailsDeployment) {
depSpecs := []operatorsv1alpha1.StrategyDeploymentSpec{}
for _, dep := range c.Deployments {
depSpecs = append(depSpecs, operatorsv1alpha1.StrategyDeploymentSpec{
Name: dep.GetName(),
Spec: dep.Spec,
})
}
strategy.DeploymentSpecs = depSpecs
}
const (
// WatchNamespaceEnv is a constant for internal use.
WatchNamespaceEnv = "WATCH_NAMESPACE"
// TargetNamespacesRef references the target namespaces a CSV is installed in.
// This is required by legacy project Deployments.
TargetNamespacesRef = "metadata.annotations['olm.targetNamespaces']"
)
// setNamespacedFields sets static fields in a CSV required by namespaced
// operators.
func setNamespacedFields(csv *operatorsv1alpha1.ClusterServiceVersion) {
for _, dep := range csv.Spec.InstallStrategy.StrategySpec.DeploymentSpecs {
// Set WATCH_NAMESPACE if it exists in a deployment spec..
envVar := newFieldRefEnvVar(WatchNamespaceEnv, TargetNamespacesRef)
setContainerEnvVarIfExists(&dep.Spec, envVar)
}
}
// setContainerEnvVarIfExists overwrites all references to ev.Name with ev.
func setContainerEnvVarIfExists(spec *appsv1.DeploymentSpec, ev corev1.EnvVar) {
for _, c := range spec.Template.Spec.Containers {
for i := 0; i < len(c.Env); i++ {
if c.Env[i].Name == ev.Name {
c.Env[i] = ev
}
}
}
}
// newFieldRefEnvVar creates a new environment variable referencing fieldPath.
func newFieldRefEnvVar(name, fieldPath string) corev1.EnvVar {
return corev1.EnvVar{
Name: name,
ValueFrom: &corev1.EnvVarSource{
FieldRef: &corev1.ObjectFieldSelector{
FieldPath: fieldPath,
},
},
}
}
// applyCustomResourceDefinitions updates csv's customresourcedefinitions.owned
// with CustomResourceDefinitions in the collector.
// customresourcedefinitions.required are left as-is, since they are
// manually-defined values.
func applyCustomResourceDefinitions(c *collector.Manifests, csv *operatorsv1alpha1.ClusterServiceVersion) {
ownedDescs := []operatorsv1alpha1.CRDDescription{}
descMap := map[registry.DefinitionKey]operatorsv1alpha1.CRDDescription{}
for _, owned := range csv.Spec.CustomResourceDefinitions.Owned {
defKey := registry.DefinitionKey{
Name: owned.Name,
Version: owned.Version,
Kind: owned.Kind,
}
descMap[defKey] = owned
}
var defKeys []registry.DefinitionKey
v1crdKeys := k8sutil.DefinitionsForV1CustomResourceDefinitions(c.V1CustomResourceDefinitions...)
defKeys = append(defKeys, v1crdKeys...)
v1beta1crdKeys := k8sutil.DefinitionsForV1beta1CustomResourceDefinitions(c.V1beta1CustomResourceDefinitions...)
defKeys = append(defKeys, v1beta1crdKeys...)
// crdDescriptions don't have a 'group' field.
for i := 0; i < len(defKeys); i++ {
defKeys[i].Group = ""
}
for _, defKey := range defKeys {
if owned, ownedExists := descMap[defKey]; ownedExists {
ownedDescs = append(ownedDescs, owned)
} else {
ownedDescs = append(ownedDescs, operatorsv1alpha1.CRDDescription{
Name: defKey.Name,
Version: defKey.Version,
Kind: defKey.Kind,
})
}
}
csv.Spec.CustomResourceDefinitions.Owned = ownedDescs
}
// applyWebhooks updates csv's webhookDefinitions with any
// mutating and validating webhooks in the collector.
func applyWebhooks(c *collector.Manifests, csv *operatorsv1alpha1.ClusterServiceVersion) {
webhookDescriptions := []operatorsv1alpha1.WebhookDescription{}
for _, webhook := range c.ValidatingWebhooks {
webhookDescriptions = append(webhookDescriptions, validatingToWebhookDescription(webhook))
}
for _, webhook := range c.MutatingWebhooks {
webhookDescriptions = append(webhookDescriptions, mutatingToWebhookDescription(webhook))
}
csv.Spec.WebhookDefinitions = webhookDescriptions
}
// validatingToWebhookDescription transforms webhook into a WebhookDescription.
func validatingToWebhookDescription(webhook admissionregv1.ValidatingWebhook) operatorsv1alpha1.WebhookDescription {
description := operatorsv1alpha1.WebhookDescription{
Type: operatorsv1alpha1.ValidatingAdmissionWebhook,
GenerateName: webhook.Name,
Rules: webhook.Rules,
FailurePolicy: webhook.FailurePolicy,
MatchPolicy: webhook.MatchPolicy,
ObjectSelector: webhook.ObjectSelector,
SideEffects: webhook.SideEffects,
TimeoutSeconds: webhook.TimeoutSeconds,
AdmissionReviewVersions: webhook.AdmissionReviewVersions,
}
if serviceRef := webhook.ClientConfig.Service; serviceRef != nil {
if serviceRef.Port != nil {
description.ContainerPort = *serviceRef.Port
}
description.DeploymentName = strings.TrimSuffix(serviceRef.Name, "-service")
description.WebhookPath = serviceRef.Path
}
return description
}
// mutatingToWebhookDescription transforms webhook into a WebhookDescription.
func mutatingToWebhookDescription(webhook admissionregv1.MutatingWebhook) operatorsv1alpha1.WebhookDescription {
description := operatorsv1alpha1.WebhookDescription{
Type: operatorsv1alpha1.MutatingAdmissionWebhook,
GenerateName: webhook.Name,
Rules: webhook.Rules,
FailurePolicy: webhook.FailurePolicy,
MatchPolicy: webhook.MatchPolicy,
ObjectSelector: webhook.ObjectSelector,
SideEffects: webhook.SideEffects,
TimeoutSeconds: webhook.TimeoutSeconds,
AdmissionReviewVersions: webhook.AdmissionReviewVersions,
ReinvocationPolicy: webhook.ReinvocationPolicy,
}
if serviceRef := webhook.ClientConfig.Service; serviceRef != nil {
if serviceRef.Port != nil {
description.ContainerPort = *serviceRef.Port
}
description.DeploymentName = strings.TrimSuffix(serviceRef.Name, "-service")
description.WebhookPath = serviceRef.Path
}
return description
}
// applyCustomResources updates csv's "alm-examples" annotation with the
// Custom Resources in the collector.
func applyCustomResources(c *collector.Manifests, csv *operatorsv1alpha1.ClusterServiceVersion) error {
examples := []json.RawMessage{}
for _, cr := range c.CustomResources {
crBytes, err := cr.MarshalJSON()
if err != nil {
return err
}
examples = append(examples, json.RawMessage(crBytes))
}
examplesJSON, err := json.MarshalIndent(examples, "", " ")
if err != nil {
return err
}
if csv.GetAnnotations() == nil {
csv.SetAnnotations(make(map[string]string))
}
csv.GetAnnotations()["alm-examples"] = string(examplesJSON)
return nil
}
// sortUpdates sorts all fields updated in csv.
// TODO(estroz): sort other modified fields.
func sortUpdates(csv *operatorsv1alpha1.ClusterServiceVersion) {
sort.Sort(descSorter(csv.Spec.CustomResourceDefinitions.Owned))
sort.Sort(descSorter(csv.Spec.CustomResourceDefinitions.Required))
}
// descSorter sorts a set of crdDescriptions.
type descSorter []operatorsv1alpha1.CRDDescription
var _ sort.Interface = descSorter{}
func (descs descSorter) Len() int { return len(descs) }
func (descs descSorter) Less(i, j int) bool {
if descs[i].Name == descs[j].Name {
if descs[i].Kind == descs[j].Kind {
return version.CompareKubeAwareVersionStrings(descs[i].Version, descs[j].Version) > 0
}
return descs[i].Kind < descs[j].Kind
}
return descs[i].Name < descs[j].Name
}
func (descs descSorter) Swap(i, j int) { descs[i], descs[j] = descs[j], descs[i] }
// validate will validate csv using the api validation library.
// More info: https://github.com/operator-framework/api
func validate(csv *operatorsv1alpha1.ClusterServiceVersion) error {
if csv == nil {
return errors.New("empty ClusterServiceVersion")
}
hasErrors := false
results := validation.ClusterServiceVersionValidator.Validate(csv)
for _, r := range results {
for _, w := range r.Warnings {
log.Warnf("ClusterServiceVersion validation: [%s] %s", w.Type, w.Detail)
}
for _, e := range r.Errors {
log.Errorf("ClusterServiceVersion validation: [%s] %s", e.Type, e.Detail)
}
if r.HasError() {
hasErrors = true
}
}
if hasErrors {
return errors.New("invalid generated ClusterServiceVersion")
}
return nil
}