-
Notifications
You must be signed in to change notification settings - Fork 537
/
step.go
280 lines (249 loc) · 10.8 KB
/
step.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
package catalog
import (
"context"
"fmt"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apiextensionsv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
apiextensionsv1client "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/typed/apiextensions/v1"
apiextensionsv1beta1client "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/typed/apiextensions/v1beta1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/dynamic"
"github.com/operator-framework/api/pkg/operators/v1alpha1"
listersv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/listers/operators/v1alpha1"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/internal/alongside"
crdlib "github.com/operator-framework/operator-lifecycle-manager/pkg/lib/crd"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorclient"
)
// Stepper manages cluster interactions based on the step.
type Stepper interface {
Status() (v1alpha1.StepStatus, error)
}
// StepperFunc fulfills the Stepper interface.
type StepperFunc func() (v1alpha1.StepStatus, error)
func (s StepperFunc) Status() (v1alpha1.StepStatus, error) {
return s()
}
// Builder holds clients and data structures required for the StepBuilder to work
// Builder attributes are not to meant to be accessed outside the StepBuilder method
type builder struct {
plan *v1alpha1.InstallPlan
csvLister listersv1alpha1.ClusterServiceVersionLister
opclient operatorclient.ClientInterface
dynamicClient dynamic.Interface
manifestResolver ManifestResolver
logger logrus.FieldLogger
annotator alongside.Annotator
}
func newBuilder(plan *v1alpha1.InstallPlan, csvLister listersv1alpha1.ClusterServiceVersionLister, opclient operatorclient.ClientInterface, dynamicClient dynamic.Interface, manifestResolver ManifestResolver, logger logrus.FieldLogger) *builder {
return &builder{
plan: plan,
csvLister: csvLister,
opclient: opclient,
dynamicClient: dynamicClient,
manifestResolver: manifestResolver,
logger: logger,
}
}
type notSupportedStepperErr struct {
message string
}
func (n notSupportedStepperErr) Error() string {
return n.message
}
// step is a factory that creates StepperFuncs based on the install plan step Kind.
func (b *builder) create(step v1alpha1.Step) (Stepper, error) {
manifest, err := b.manifestResolver.ManifestForStep(&step)
if err != nil {
return nil, err
}
switch step.Resource.Kind {
case crdKind:
version, err := crdlib.Version(&manifest)
if err != nil {
return nil, err
}
switch version {
case crdlib.V1Version:
return b.NewCRDV1Step(b.opclient.ApiextensionsInterface().ApiextensionsV1(), &step, manifest), nil
case crdlib.V1Beta1Version:
return b.NewCRDV1Beta1Step(b.opclient.ApiextensionsInterface().ApiextensionsV1beta1(), &step, manifest), nil
}
}
return nil, notSupportedStepperErr{fmt.Sprintf("stepper interface does not support %s", step.Resource.Kind)}
}
func (b *builder) NewCRDV1Step(client apiextensionsv1client.ApiextensionsV1Interface, step *v1alpha1.Step, manifest string) StepperFunc {
return func() (v1alpha1.StepStatus, error) {
switch step.Status {
case v1alpha1.StepStatusPresent:
return v1alpha1.StepStatusPresent, nil
case v1alpha1.StepStatusCreated:
return v1alpha1.StepStatusCreated, nil
case v1alpha1.StepStatusWaitingForAPI:
crd, err := client.CustomResourceDefinitions().Get(context.TODO(), step.Resource.Name, metav1.GetOptions{})
if err != nil {
if k8serrors.IsNotFound(err) {
return v1alpha1.StepStatusNotPresent, nil
} else {
return v1alpha1.StepStatusNotPresent, errors.Wrapf(err, "error finding the %s CRD", crd.Name)
}
}
established, namesAccepted := false, false
for _, cdt := range crd.Status.Conditions {
switch cdt.Type {
case apiextensionsv1.Established:
if cdt.Status == apiextensionsv1.ConditionTrue {
established = true
}
case apiextensionsv1.NamesAccepted:
if cdt.Status == apiextensionsv1.ConditionTrue {
namesAccepted = true
}
}
}
if established && namesAccepted {
return v1alpha1.StepStatusCreated, nil
}
case v1alpha1.StepStatusUnknown, v1alpha1.StepStatusNotPresent:
crd, err := crdlib.UnmarshalV1(manifest)
if err != nil {
return v1alpha1.StepStatusUnknown, err
}
setInstalledAlongsideAnnotation(b.annotator, crd, b.plan.GetNamespace(), step.Resolving, b.csvLister, crd)
_, createError := client.CustomResourceDefinitions().Create(context.TODO(), crd, metav1.CreateOptions{})
if k8serrors.IsAlreadyExists(createError) {
currentCRD, _ := client.CustomResourceDefinitions().Get(context.TODO(), crd.GetName(), metav1.GetOptions{})
crd.SetResourceVersion(currentCRD.GetResourceVersion())
if err = validateV1CRDCompatibility(b.dynamicClient, currentCRD, crd); err != nil {
return v1alpha1.StepStatusUnknown, errors.Wrapf(err, "error validating existing CRs against new CRD's schema: %s", step.Resource.Name)
}
// check to see if stored versions changed and whether the upgrade could cause potential data loss
safe, err := crdlib.SafeStorageVersionUpgrade(currentCRD, crd)
if !safe {
b.logger.Errorf("risk of data loss updating %s: %s", step.Resource.Name, err)
return v1alpha1.StepStatusUnknown, errors.Wrapf(err, "risk of data loss updating %s", step.Resource.Name)
}
if err != nil {
return v1alpha1.StepStatusUnknown, errors.Wrapf(err, "checking CRD for potential data loss updating %s", step.Resource.Name)
}
// Update CRD to new version
setInstalledAlongsideAnnotation(b.annotator, crd, b.plan.GetNamespace(), step.Resolving, b.csvLister, crd, currentCRD)
_, err = client.CustomResourceDefinitions().Update(context.TODO(), crd, metav1.UpdateOptions{})
if err != nil {
return v1alpha1.StepStatusUnknown, errors.Wrapf(err, "error updating CRD: %s", step.Resource.Name)
}
// If it already existed, mark the step as Present.
// they were equal - mark CRD as present
return v1alpha1.StepStatusPresent, nil
} else if createError != nil {
// Unexpected error creating the CRD.
return v1alpha1.StepStatusUnknown, createError
}
// If no error occured, make sure to wait for the API to become available.
return v1alpha1.StepStatusWaitingForAPI, nil
}
return v1alpha1.StepStatusUnknown, nil
}
}
func (b *builder) NewCRDV1Beta1Step(client apiextensionsv1beta1client.ApiextensionsV1beta1Interface, step *v1alpha1.Step, manifest string) StepperFunc {
return func() (v1alpha1.StepStatus, error) {
switch step.Status {
case v1alpha1.StepStatusPresent:
return v1alpha1.StepStatusPresent, nil
case v1alpha1.StepStatusCreated:
return v1alpha1.StepStatusCreated, nil
case v1alpha1.StepStatusWaitingForAPI:
crd, err := client.CustomResourceDefinitions().Get(context.TODO(), step.Resource.Name, metav1.GetOptions{})
if err != nil {
if k8serrors.IsNotFound(err) {
return v1alpha1.StepStatusNotPresent, nil
} else {
return v1alpha1.StepStatusNotPresent, errors.Wrapf(err, "error finding the %s CRD", crd.Name)
}
}
established, namesAccepted := false, false
for _, cdt := range crd.Status.Conditions {
switch cdt.Type {
case apiextensionsv1beta1.Established:
if cdt.Status == apiextensionsv1beta1.ConditionTrue {
established = true
}
case apiextensionsv1beta1.NamesAccepted:
if cdt.Status == apiextensionsv1beta1.ConditionTrue {
namesAccepted = true
}
}
}
if established && namesAccepted {
return v1alpha1.StepStatusCreated, nil
}
case v1alpha1.StepStatusUnknown, v1alpha1.StepStatusNotPresent:
crd, err := crdlib.UnmarshalV1Beta1(manifest)
if err != nil {
return v1alpha1.StepStatusUnknown, err
}
setInstalledAlongsideAnnotation(b.annotator, crd, b.plan.GetNamespace(), step.Resolving, b.csvLister, crd)
_, createError := client.CustomResourceDefinitions().Create(context.TODO(), crd, metav1.CreateOptions{})
if k8serrors.IsAlreadyExists(createError) {
currentCRD, _ := client.CustomResourceDefinitions().Get(context.TODO(), crd.GetName(), metav1.GetOptions{})
crd.SetResourceVersion(currentCRD.GetResourceVersion())
if err = validateV1Beta1CRDCompatibility(b.dynamicClient, currentCRD, crd); err != nil {
return v1alpha1.StepStatusUnknown, errors.Wrapf(err, "error validating existing CRs against new CRD's schema: %s", step.Resource.Name)
}
// check to see if stored versions changed and whether the upgrade could cause potential data loss
safe, err := crdlib.SafeStorageVersionUpgrade(currentCRD, crd)
if !safe {
b.logger.Errorf("risk of data loss updating %s: %s", step.Resource.Name, err)
return v1alpha1.StepStatusUnknown, errors.Wrapf(err, "risk of data loss updating %s", step.Resource.Name)
}
if err != nil {
return v1alpha1.StepStatusUnknown, errors.Wrapf(err, "checking CRD for potential data loss updating %s", step.Resource.Name)
}
// Update CRD to new version
setInstalledAlongsideAnnotation(b.annotator, crd, b.plan.GetNamespace(), step.Resolving, b.csvLister, crd, currentCRD)
_, err = client.CustomResourceDefinitions().Update(context.TODO(), crd, metav1.UpdateOptions{})
if err != nil {
return v1alpha1.StepStatusUnknown, errors.Wrapf(err, "error updating CRD: %s", step.Resource.Name)
}
// If it already existed, mark the step as Present.
// they were equal - mark CRD as present
return v1alpha1.StepStatusPresent, nil
} else if createError != nil {
// Unexpected error creating the CRD.
return v1alpha1.StepStatusUnknown, createError
}
// If no error occured, make sure to wait for the API to become available.
return v1alpha1.StepStatusWaitingForAPI, nil
}
return v1alpha1.StepStatusUnknown, nil
}
}
func setInstalledAlongsideAnnotation(a alongside.Annotator, dst metav1.Object, namespace string, name string, lister listersv1alpha1.ClusterServiceVersionLister, srcs ...metav1.Object) {
var (
nns []alongside.NamespacedName
)
// Only keep references to existing and non-copied CSVs to
// avoid unbounded growth.
for _, src := range srcs {
for _, nn := range a.FromObject(src) {
if nn.Namespace == namespace && nn.Name == name {
continue
}
if csv, err := lister.ClusterServiceVersions(nn.Namespace).Get(nn.Name); k8serrors.IsNotFound(err) {
continue
} else if err == nil && csv.IsCopied() {
continue
}
// CSV exists and is not copied OR err is non-nil, but
// not 404. Safer to assume it exists in unhandled
// error cases and try again next time.
nns = append(nns, nn)
}
}
if namespace != "" && name != "" {
nns = append(nns, alongside.NamespacedName{Namespace: namespace, Name: name})
}
a.ToObject(dst, nns)
}