-
Notifications
You must be signed in to change notification settings - Fork 107
/
resultserver.go
275 lines (249 loc) · 8.48 KB
/
resultserver.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
package compliancescan
import (
"context"
"fmt"
"strconv"
"strings"
"github.com/go-logr/logr"
ocpapisecv1 "github.com/openshift/api/security/v1"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
compv1alpha1 "github.com/openshift/compliance-operator/pkg/apis/compliance/v1alpha1"
"github.com/openshift/compliance-operator/pkg/controller/common"
"github.com/openshift/compliance-operator/pkg/utils"
)
const resultserverSA = "resultserver"
const (
defaultPodFSGroup int64 = 2000
defaultPodUid int64 = 1000
)
// The result-server is a pod that listens for results from other pods and
// stores them in a PVC.
// It's comprised of the PVC for the scan, the pod and a service that fronts it
func (r *ReconcileComplianceScan) createResultServer(instance *compv1alpha1.ComplianceScan, logger logr.Logger) error {
ctx := context.Background()
resultServerLabels := getResultServerLabels(instance)
logger.Info("Creating scan result server pod")
podFSGroup, podFSGroupErr := r.getPodFSGroup(ctx)
if podFSGroupErr != nil {
return podFSGroupErr
}
podUid, podUidErr := r.getPodUid(ctx)
if podUidErr != nil {
return podUidErr
}
deployment := resultServer(instance, resultServerLabels, podFSGroup, podUid, logger)
err := r.client.Create(ctx, deployment)
if err != nil && !errors.IsAlreadyExists(err) {
logger.Error(err, "Cannot create deployment", "deployment", deployment)
return err
}
logger.Info("ResultServer Deployment launched", "Deployment.Name", deployment.Name)
service := resultServerService(instance, resultServerLabels)
err = r.client.Create(ctx, service)
if err != nil && !errors.IsAlreadyExists(err) {
logger.Error(err, "Cannot create service", "service", service)
return err
}
logger.Info("ResultServer Service launched", "Service.Name", service.Name)
return nil
}
func (r *ReconcileComplianceScan) scaleDownResultServer(instance *compv1alpha1.ComplianceScan, logger logr.Logger) error {
ctx := context.TODO()
key := types.NamespacedName{
Name: getResultServerName(instance),
Namespace: common.GetComplianceOperatorNamespace(),
}
rslog := logger.WithValues(
"Deployment.Name", key.Name,
"Deployment.Namespace", key.Namespace)
rslog.Info("Scaling down result server")
found := &appsv1.Deployment{}
err := r.client.Get(ctx, key, found)
if err != nil {
if errors.IsNotFound(err) {
rslog.Info("result server doesn't exist. " +
"This is a non-issue since we were scaling down anyway")
return nil
}
rslog.Error(err, "Error getting result server in preparation of scale-down")
return err
}
// scale down
var zeroRepls int32 = 0
rs := found.DeepCopy()
rs.Spec.Replicas = &zeroRepls
rslog.Info("Updating result server for scale-down")
return r.client.Update(ctx, rs)
}
func (r *ReconcileComplianceScan) deleteResultServer(instance *compv1alpha1.ComplianceScan, logger logr.Logger) error {
resultServerLabels := getResultServerLabels(instance)
logger.Info("Deleting scan result server pod")
deployment := resultServer(instance, resultServerLabels, 0, 0, logger)
err := r.client.Delete(context.TODO(), deployment)
if err != nil && !errors.IsNotFound(err) {
logger.Error(err, "Cannot delete deployment", "deployment", deployment)
return err
}
logger.Info("ResultServer Deployment deleted", "Deployment.Name", deployment.Name)
logger.Info("Deleting scan result server service")
service := resultServerService(instance, resultServerLabels)
err = r.client.Delete(context.TODO(), service)
if err != nil && !errors.IsNotFound(err) {
logger.Error(err, "Cannot delete service", "service", service)
return err
}
logger.Info("ResultServer Service deleted", "Service.Name", service.Name)
return nil
}
func getResultServerLabels(instance *compv1alpha1.ComplianceScan) map[string]string {
return map[string]string{
compv1alpha1.ComplianceScanLabel: instance.Name,
"workload": "resultserver",
}
}
func (r *ReconcileComplianceScan) getPodFSGroup(ctx context.Context) (int64, error) {
return r.getRangeFromNSorDefault(ctx, ocpapisecv1.SupplementalGroupsAnnotation, defaultPodFSGroup)
}
func (r *ReconcileComplianceScan) getPodUid(ctx context.Context) (int64, error) {
return r.getRangeFromNSorDefault(ctx, ocpapisecv1.UIDRangeAnnotation, defaultPodUid)
}
func (r *ReconcileComplianceScan) getRangeFromNSorDefault(
ctx context.Context,
rangeTypeAnnotation string,
defaultValue int64,
) (int64, error) {
key := types.NamespacedName{
Name: common.GetComplianceOperatorNamespace(),
}
ns := corev1.Namespace{}
if geterr := r.client.Get(ctx, key, &ns); geterr != nil {
return 0, geterr
}
anns := ns.GetAnnotations()
targetrange, found := anns[rangeTypeAnnotation]
if !found {
return defaultValue, nil
}
rangeInfo := strings.Split(targetrange, "/")[0]
rangeinit, err := strconv.Atoi(rangeInfo)
if err != nil {
return 0, err
}
return int64(rangeinit), nil
}
// Serve up arf reports for a compliance scan with a web service protected by openshift auth (oauth-proxy sidecar).
// Needs corresponding Service (with service-serving cert).
// Need to aggregate reports into one service ? on subdirs?
func resultServer(scanInstance *compv1alpha1.ComplianceScan, labels map[string]string,
podFSGroup, podUid int64, logger logr.Logger) *appsv1.Deployment {
falseP := false
trueP := true
return &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: getResultServerName(scanInstance),
Namespace: common.GetComplianceOperatorNamespace(),
},
Spec: appsv1.DeploymentSpec{
Replicas: &oneReplica,
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: labels,
Annotations: map[string]string{
"workload.openshift.io/management": `{"effect": "PreferredDuringScheduling"}`,
},
},
Spec: corev1.PodSpec{
NodeSelector: scanInstance.Spec.RawResultStorage.NodeSelector,
Tolerations: scanInstance.Spec.RawResultStorage.Tolerations,
ServiceAccountName: resultserverSA,
SecurityContext: &corev1.PodSecurityContext{
FSGroup: &podFSGroup,
RunAsNonRoot: &trueP,
RunAsUser: &podUid,
},
Containers: []corev1.Container{
{
Name: "result-server",
Image: utils.GetComponentImage(utils.OPERATOR),
ImagePullPolicy: corev1.PullAlways,
Command: []string{
"compliance-operator", "resultserver",
"--path=/reports/",
"--address=0.0.0.0",
fmt.Sprintf("--port=%d", ResultServerPort),
fmt.Sprintf("--scan-index=%d", scanInstance.Status.CurrentIndex),
fmt.Sprintf("--rotation=%d", scanInstance.Spec.RawResultStorage.Rotation),
"--tls-server-cert=/etc/pki/tls/tls.crt",
"--tls-server-key=/etc/pki/tls/tls.key",
"--tls-ca=/etc/pki/tls/ca.crt",
},
SecurityContext: &corev1.SecurityContext{
AllowPrivilegeEscalation: &falseP,
ReadOnlyRootFilesystem: &trueP,
},
VolumeMounts: []corev1.VolumeMount{
{
Name: "arfreports",
MountPath: "/reports",
},
{
Name: "tls",
MountPath: "/etc/pki/tls",
ReadOnly: true,
},
},
},
},
Volumes: []corev1.Volume{
{
Name: "arfreports",
VolumeSource: corev1.VolumeSource{
PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
ClaimName: getPVCForScanName(scanInstance.Name),
},
},
},
{
Name: "tls",
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: ServerCertPrefix + scanInstance.Name,
},
},
},
},
},
},
},
}
}
func resultServerService(scanInstance *compv1alpha1.ComplianceScan, labels map[string]string) *corev1.Service {
return &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: getResultServerName(scanInstance),
Namespace: common.GetComplianceOperatorNamespace(),
},
Spec: corev1.ServiceSpec{
Selector: labels,
Ports: []corev1.ServicePort{
{
Protocol: corev1.Protocol("TCP"),
Port: ResultServerPort,
},
},
},
}
}
func getResultServerName(instance *compv1alpha1.ComplianceScan) string {
return instance.Name + "-rs"
}
func getResultServerURI(instance *compv1alpha1.ComplianceScan) string {
return "https://" + getResultServerName(instance) + fmt.Sprintf(":%d/", ResultServerPort)
}