-
Notifications
You must be signed in to change notification settings - Fork 344
/
base.go
290 lines (262 loc) · 7.22 KB
/
base.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
/*
Copyright 2018 Heptio 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 driver
import (
"crypto/ecdsa"
"crypto/tls"
"crypto/x509"
"encoding/pem"
"fmt"
"strings"
"github.com/pkg/errors"
"github.com/vmware-tanzu/sonobuoy/pkg/plugin"
"github.com/vmware-tanzu/sonobuoy/pkg/plugin/manifest"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// Base is the struct that stores state for plugin drivers and contains helper methods.
type Base struct {
Definition manifest.Manifest
SessionID string
Namespace string
SonobuoyImage string
CleanedUp bool
ImagePullPolicy string
ImagePullSecrets string
CustomAnnotations map[string]string
}
// GetSessionID returns the session id associated with the plugin.
func (b *Base) GetSessionID() string {
return b.SessionID
}
// GetName returns the name of this Job plugin.
func (b *Base) GetName() string {
return b.Definition.SonobuoyConfig.PluginName
}
// GetSecretName gets a name for a secret based on the plugin name and session ID.
func (b *Base) GetSecretName() string {
return fmt.Sprintf("sonobuoy-plugin-%s-%s", b.GetName(), b.GetSessionID())
}
// GetDriver returns the Driver for this plugin.
func (b *Base) GetDriver() string {
return b.Definition.SonobuoyConfig.Driver
}
// SkipCleanup returns whether cleanup for this plugin should be skipped or not.
func (b *Base) SkipCleanup() bool {
return b.Definition.SonobuoyConfig.SkipCleanup
}
// GetResultFormat returns the ResultFormat of this plugin.
func (b *Base) GetResultFormat() string {
return b.Definition.SonobuoyConfig.ResultFormat
}
// GetResultFiles returns the files to be post-processed for this plugin.
func (b *Base) GetResultFiles() []string {
return b.Definition.SonobuoyConfig.ResultFiles
}
// MakeTLSSecret makes a Kubernetes secret object for the given TLS certificate.
func (b *Base) MakeTLSSecret(cert *tls.Certificate, ownerPod *v1.Pod) (*v1.Secret, error) {
rsaKey, ok := cert.PrivateKey.(*ecdsa.PrivateKey)
if !ok {
return nil, errors.New("private key not ECDSA")
}
if len(cert.Certificate) <= 0 {
return nil, errors.New("no certs in tls.certificate")
}
certDER := cert.Certificate[0]
certPEM := pem.EncodeToMemory(&pem.Block{
Type: "CERTIFICATE",
Bytes: certDER,
})
keyPEM, err := getKeyPEM(rsaKey)
if err != nil {
return nil, errors.Wrap(err, "couldn't PEM encode TLS key")
}
return &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: b.GetSecretName(),
Namespace: b.Namespace,
OwnerReferences: []metav1.OwnerReference{
{
APIVersion: "v1",
Kind: "Pod",
Name: ownerPod.GetName(),
UID: ownerPod.GetUID(),
},
},
},
Data: map[string][]byte{
v1.TLSPrivateKeyKey: keyPEM,
v1.TLSCertKey: certPEM,
},
Type: v1.SecretTypeTLS,
}, nil
}
// getCACertPEM extracts the CA cert from a tls.Certificate.
// If the provided Certificate has only one certificate in the chain, the CA
// will be the leaf cert.
func getCACertPEM(cert *tls.Certificate) string {
cacert := ""
if len(cert.Certificate) > 0 {
caCertDER := cert.Certificate[len(cert.Certificate)-1]
cacert = string(pem.EncodeToMemory(&pem.Block{
Type: "CERTIFICATE",
Bytes: caCertDER,
}))
}
return cacert
}
// getKeyPEM turns an RSA Private Key into a PEM-encoded string
func getKeyPEM(key *ecdsa.PrivateKey) ([]byte, error) {
derKEY, err := x509.MarshalECPrivateKey(key)
if err != nil {
return nil, err
}
return pem.EncodeToMemory(&pem.Block{
Type: "EC PRIVATE KEY",
Bytes: derKEY,
}), nil
}
func (b *Base) workerEnvironment(hostname string, cert *tls.Certificate, progressPort string) []v1.EnvVar {
envVars := []v1.EnvVar{
{
Name: "NODE_NAME",
ValueFrom: &v1.EnvVarSource{
FieldRef: &v1.ObjectFieldSelector{
FieldPath: "spec.nodeName",
},
},
},
{
Name: "RESULTS_DIR",
Value: plugin.ResultsDir,
},
{
Name: "RESULT_TYPE",
Value: b.GetName(),
},
{
Name: "MASTER_URL",
Value: hostname,
},
{
Name: "CA_CERT",
Value: getCACertPEM(cert),
},
{
Name: "CLIENT_CERT",
ValueFrom: &v1.EnvVarSource{
SecretKeyRef: &v1.SecretKeySelector{
LocalObjectReference: v1.LocalObjectReference{
Name: b.GetSecretName(),
},
Key: "tls.crt",
},
},
},
{
Name: "CLIENT_KEY",
ValueFrom: &v1.EnvVarSource{
SecretKeyRef: &v1.SecretKeySelector{
LocalObjectReference: v1.LocalObjectReference{
Name: b.GetSecretName(),
},
Key: "tls.key",
},
},
},
{
Name: "SONOBUOY_PROGRESS_PORT",
Value: progressPort,
},
}
return envVars
}
// CreateWorkerContainerDefintion creates the container definition to run the Sonobuoy worker for a plugin.
func (b *Base) CreateWorkerContainerDefintion(hostname string, cert *tls.Certificate, command, args []string, progressPort string) v1.Container {
container := v1.Container{
Name: "sonobuoy-worker",
Image: b.SonobuoyImage,
Command: command,
Args: args,
Env: b.workerEnvironment(hostname, cert, progressPort),
ImagePullPolicy: v1.PullPolicy(b.ImagePullPolicy),
VolumeMounts: []v1.VolumeMount{
{
Name: "results",
ReadOnly: false,
MountPath: plugin.ResultsDir,
},
},
}
return container
}
// defaultDaemonSetPodSpec returns the default PodSpec used by DaemonSet plugins
func defaultDaemonSetPodSpec() v1.PodSpec {
podSpec := v1.PodSpec{
Containers: []v1.Container{},
DNSPolicy: v1.DNSClusterFirstWithHostNet,
HostIPC: true,
HostPID: true,
HostNetwork: true,
ServiceAccountName: "sonobuoy-serviceaccount",
Tolerations: []v1.Toleration{
{
Operator: v1.TolerationOpExists,
},
},
Volumes: []v1.Volume{
{
Name: "root",
VolumeSource: v1.VolumeSource{
HostPath: &v1.HostPathVolumeSource{
Path: "/",
},
},
},
},
}
return podSpec
}
// defaultJobPodSpec returns the default PodSpec used by Job plugins
func defaultJobPodSpec() v1.PodSpec {
return v1.PodSpec{
Containers: []v1.Container{},
RestartPolicy: v1.RestartPolicyNever,
ServiceAccountName: "sonobuoy-serviceaccount",
Tolerations: []v1.Toleration{
{
Key: "node-role.kubernetes.io/master",
Operator: v1.TolerationOpExists,
Effect: v1.TaintEffectNoSchedule,
},
{
Key: "CriticalAddonsOnly",
Operator: v1.TolerationOpExists,
},
{
Key: "kubernetes.io/e2e-evict-taint-key",
Operator: v1.TolerationOpExists,
},
},
Volumes: []v1.Volume{},
}
}
// DefaultPodSpec returns the default pod spec used for the given plugin driver type.
func DefaultPodSpec(d string) v1.PodSpec {
switch strings.ToLower(d) {
case "daemonset":
return defaultDaemonSetPodSpec()
default:
return defaultJobPodSpec()
}
}