/
backstage_deployment.go
238 lines (202 loc) · 8.57 KB
/
backstage_deployment.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
//
// Copyright (c) 2023 Red Hat, Inc.
// 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 controller
import (
"context"
"fmt"
appsv1 "k8s.io/api/apps/v1"
v1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
bs "redhat-developer/red-hat-developer-hub-operator/api/v1alpha1"
)
const (
_defaultBackstageInitContainerName = "install-dynamic-plugins"
_defaultBackstageMainContainerName = "backstage-backend"
_containersWorkingDir = "/opt/app-root/src"
)
// ContainerVisitor is called with each container
type ContainerVisitor func(container *v1.Container)
// visitContainers invokes the visitor function for every container in the given pod template spec
func visitContainers(podTemplateSpec *v1.PodTemplateSpec, visitor ContainerVisitor) {
for i := range podTemplateSpec.Spec.InitContainers {
visitor(&podTemplateSpec.Spec.InitContainers[i])
}
for i := range podTemplateSpec.Spec.Containers {
visitor(&podTemplateSpec.Spec.Containers[i])
}
for i := range podTemplateSpec.Spec.EphemeralContainers {
visitor((*v1.Container)(&podTemplateSpec.Spec.EphemeralContainers[i].EphemeralContainerCommon))
}
}
func (r *BackstageReconciler) reconcileBackstageDeployment(ctx context.Context, backstage *bs.Backstage, ns string) error {
deployment := &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{
Name: getDefaultObjName(*backstage),
Namespace: ns},
}
if _, err := controllerutil.CreateOrUpdate(ctx, r.Client, deployment, r.deploymentObjectMutFun(ctx, deployment, *backstage, ns)); err != nil {
if errors.IsConflict(err) {
return retryReconciliation(err)
}
msg := fmt.Sprintf("failed to deploy Backstage Deployment: %s", err)
setStatusCondition(backstage, bs.ConditionDeployed, metav1.ConditionFalse, bs.DeployFailed, msg)
return fmt.Errorf(msg)
}
return nil
}
func (r *BackstageReconciler) deploymentObjectMutFun(ctx context.Context, targetDeployment *appsv1.Deployment, backstage bs.Backstage, ns string) controllerutil.MutateFn {
return func() error {
deployment := &appsv1.Deployment{}
targetDeployment.ObjectMeta.DeepCopyInto(&deployment.ObjectMeta)
err := r.readConfigMapOrDefault(ctx, backstage.Spec.RawRuntimeConfig.BackstageConfigName, "deployment.yaml", ns, deployment)
if err != nil {
return fmt.Errorf("failed to read config: %s", err)
}
// Override deployment name
deployment.Name = getDefaultObjName(backstage)
r.setDefaultDeploymentImage(deployment)
r.applyBackstageLabels(backstage, deployment)
if err = r.addParams(ctx, backstage, ns, deployment); err != nil {
return err
}
r.applyApplicationParamsFromCR(backstage, deployment)
if err = r.validateAndUpdatePsqlSecretRef(backstage, deployment); err != nil {
return fmt.Errorf("failed to validate database secret, reason: %s", err)
}
if r.OwnsRuntime {
if err = controllerutil.SetControllerReference(&backstage, deployment, r.Scheme); err != nil {
return fmt.Errorf("failed to set owner reference: %s", err)
}
}
deployment.ObjectMeta.DeepCopyInto(&targetDeployment.ObjectMeta)
deployment.Spec.DeepCopyInto(&targetDeployment.Spec)
return nil
}
}
func (r *BackstageReconciler) addParams(ctx context.Context, backstage bs.Backstage, ns string, deployment *appsv1.Deployment) error {
if err := r.addVolumes(ctx, backstage, ns, deployment); err != nil {
return fmt.Errorf("failed to add volumes to Backstage deployment, reason: %s", err)
}
if err := r.addVolumeMounts(ctx, backstage, ns, deployment); err != nil {
return fmt.Errorf("failed to add volume mounts to Backstage deployment, reason: %s", err)
}
if err := r.addContainerArgs(ctx, backstage, ns, deployment); err != nil {
return fmt.Errorf("failed to add container args to Backstage deployment, reason: %s", err)
}
if err := r.addEnvVars(backstage, ns, deployment); err != nil {
return fmt.Errorf("failed to add env vars to Backstage deployment, reason: %s", err)
}
return nil
}
func (r *BackstageReconciler) addVolumes(ctx context.Context, backstage bs.Backstage, ns string, deployment *appsv1.Deployment) error {
dpConfVol, err := r.getDynamicPluginsConfVolume(ctx, backstage, ns)
if err != nil {
return err
}
if dpConfVol != nil {
deployment.Spec.Template.Spec.Volumes = append(deployment.Spec.Template.Spec.Volumes, *dpConfVol)
}
backendAuthAppConfig, err := r.getBackendAuthAppConfig(ctx, backstage, ns)
if err != nil {
return err
}
deployment.Spec.Template.Spec.Volumes = append(deployment.Spec.Template.Spec.Volumes, r.appConfigsToVolumes(backstage, backendAuthAppConfig)...)
deployment.Spec.Template.Spec.Volumes = append(deployment.Spec.Template.Spec.Volumes, r.extraFilesToVolumes(backstage)...)
return nil
}
func (r *BackstageReconciler) addVolumeMounts(ctx context.Context, backstage bs.Backstage, ns string, deployment *appsv1.Deployment) error {
err := r.addDynamicPluginsConfVolumeMount(ctx, backstage, ns, deployment)
if err != nil {
return err
}
backendAuthAppConfig, err := r.getBackendAuthAppConfig(ctx, backstage, ns)
if err != nil {
return err
}
err = r.addAppConfigsVolumeMounts(ctx, backstage, ns, deployment, backendAuthAppConfig)
if err != nil {
return err
}
return r.addExtraFilesVolumeMounts(ctx, backstage, ns, deployment)
}
func (r *BackstageReconciler) addContainerArgs(ctx context.Context, backstage bs.Backstage, ns string, deployment *appsv1.Deployment) error {
backendAuthAppConfig, err := r.getBackendAuthAppConfig(ctx, backstage, ns)
if err != nil {
return err
}
return r.addAppConfigsContainerArgs(ctx, backstage, ns, deployment, backendAuthAppConfig)
}
func (r *BackstageReconciler) addEnvVars(backstage bs.Backstage, ns string, deployment *appsv1.Deployment) error {
r.addExtraEnvs(backstage, deployment)
return nil
}
func (r *BackstageReconciler) validateAndUpdatePsqlSecretRef(backstage bs.Backstage, deployment *appsv1.Deployment) error {
for i, c := range deployment.Spec.Template.Spec.Containers {
if c.Name != _defaultBackstageMainContainerName {
continue
}
for k, from := range deployment.Spec.Template.Spec.Containers[i].EnvFrom {
if from.SecretRef.Name != postGresSecret {
continue
}
if len(backstage.Spec.Database.AuthSecretName) == 0 {
from.SecretRef.Name = getDefaultPsqlSecretName(&backstage)
} else {
from.SecretRef.Name = backstage.Spec.Database.AuthSecretName
}
deployment.Spec.Template.Spec.Containers[i].EnvFrom[k] = from
break
}
}
return nil
}
func (r *BackstageReconciler) setDefaultDeploymentImage(deployment *appsv1.Deployment) {
if envBackstageImage != "" {
visitContainers(&deployment.Spec.Template, func(container *v1.Container) {
container.Image = envBackstageImage
})
}
}
func (r *BackstageReconciler) applyBackstageLabels(backstage bs.Backstage, deployment *appsv1.Deployment) {
setBackstageAppLabel(&deployment.Spec.Template.ObjectMeta.Labels, backstage)
setBackstageAppLabel(&deployment.Spec.Selector.MatchLabels, backstage)
r.labels(&deployment.ObjectMeta, backstage)
}
func (r *BackstageReconciler) applyApplicationParamsFromCR(backstage bs.Backstage, deployment *appsv1.Deployment) {
if backstage.Spec.Application != nil {
deployment.Spec.Replicas = backstage.Spec.Application.Replicas
if backstage.Spec.Application.Image != nil {
visitContainers(&deployment.Spec.Template, func(container *v1.Container) {
container.Image = *backstage.Spec.Application.Image
})
}
if backstage.Spec.Application.ImagePullSecrets != nil { // use image pull secrets from the CR spec
deployment.Spec.Template.Spec.ImagePullSecrets = nil
if len(*backstage.Spec.Application.ImagePullSecrets) > 0 {
for _, imagePullSecret := range *backstage.Spec.Application.ImagePullSecrets {
deployment.Spec.Template.Spec.ImagePullSecrets = append(deployment.Spec.Template.Spec.ImagePullSecrets, v1.LocalObjectReference{
Name: imagePullSecret,
})
}
}
}
}
}
func getDefaultObjName(backstage bs.Backstage) string {
return fmt.Sprintf("backstage-%s", backstage.Name)
}
func getDefaultDbObjName(backstage bs.Backstage) string {
return fmt.Sprintf("backstage-psql-%s", backstage.Name)
}