Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 181
Expand file tree
/
Copy pathconfig_controller_additional_ca_test.go
More file actions
349 lines (308 loc) · 12.7 KB
/
Copy pathconfig_controller_additional_ca_test.go
File metadata and controls
349 lines (308 loc) · 12.7 KB
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
//go:build test_e2e
package tests
import (
"context"
_ "embed"
"fmt"
"regexp"
"testing"
"time"
"github.com/stackrox/rox/pkg/namespaces"
"github.com/stretchr/testify/suite"
appsV1 "k8s.io/api/apps/v1"
v1 "k8s.io/api/core/v1"
apiErrors "k8s.io/apimachinery/pkg/api/errors"
metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
const (
configControllerNs = namespaces.StackRox
configControllerProxyNs = "qa-config-controller-ca" // Must match the certificate X509v3 Subject Alternative Name
configControllerDeployment = "config-controller"
configControllerContainer = "manager"
configControllerCentralEndpoint = "ROX_CENTRAL_ENDPOINT"
configControllerProxySecretName = "quay"
configControllerAdditionalCAName = "additional-ca"
)
// Embed certificates from config-controller-ca directory.
// These certs have SANs for *.qa-config-controller-ca namespace.
//
//go:embed "config-controller-ca/root-ca.crt"
var configControllerAdditionalCA []byte
//go:embed "config-controller-ca/server.crt"
var configControllerProxyCert []byte
//go:embed "config-controller-ca/server.key"
var configControllerProxyKey []byte
func TestConfigControllerAdditionalCA(t *testing.T) {
suite.Run(t, new(ConfigControllerCASuite))
}
type ConfigControllerCASuite struct {
KubernetesSuite
ctx context.Context
cleanupCtx context.Context
cancel func()
originalCentralEndpoint string
hadAdditionalCASecret bool
originalAdditionalCAContent map[string][]byte
}
func (s *ConfigControllerCASuite) SetupSuite() {
s.KubernetesSuite.SetupSuite()
s.ctx, s.cleanupCtx, s.cancel = testContexts(s.T(), "TestConfigControllerAdditionalCA", 10*time.Minute)
// Check if config-controller is running before test.
s.waitUntilK8sDeploymentReady(s.ctx, configControllerNs, configControllerDeployment)
// Save original central endpoint (if any).
s.logf("Gathering original central endpoint value from config-controller...")
var err error
s.originalCentralEndpoint, err = s.getDeploymentEnvVal(s.ctx, configControllerNs, configControllerDeployment, configControllerContainer, configControllerCentralEndpoint)
requireNoErrorOrEnvVarNotFound(s.T(), err)
s.logf("Original value is %q. (Will restore this value on cleanup.)", s.originalCentralEndpoint)
// Save existing additional-ca secret content if it exists.
existingSecret, err := s.k8s.CoreV1().Secrets(configControllerNs).Get(s.ctx, configControllerAdditionalCAName, metaV1.GetOptions{})
if err == nil {
s.hadAdditionalCASecret = true
s.originalAdditionalCAContent = existingSecret.Data
s.logf("Found existing additional-ca secret with %d certificate(s). Will restore after test.", len(existingSecret.Data))
// Delete the existing secret so we can create our test version.
err = s.k8s.CoreV1().Secrets(configControllerNs).Delete(s.ctx, configControllerAdditionalCAName, metaV1.DeleteOptions{})
s.Require().NoError(err, "cannot delete existing additional-ca secret")
} else if !apiErrors.IsNotFound(err) {
s.Require().NoError(err, "error checking for existing additional-ca secret")
}
s.setupProxy()
s.createAdditionalCASecret()
s.restartConfigController()
}
func (s *ConfigControllerCASuite) TearDownSuite() {
s.cleanupProxy(s.cleanupCtx)
s.cleanupAdditionalCASecret(s.cleanupCtx)
// Restore original central endpoint.
if s.originalCentralEndpoint != "" {
_ = s.mustSetDeploymentEnvVal(s.cleanupCtx, configControllerNs, configControllerDeployment, configControllerContainer, configControllerCentralEndpoint, s.originalCentralEndpoint)
} else {
s.mustDeleteDeploymentEnvVar(s.cleanupCtx, configControllerNs, configControllerDeployment, configControllerCentralEndpoint)
}
// Restart to restore normal operation.
s.restartConfigController()
s.waitUntilK8sDeploymentReady(s.cleanupCtx, configControllerNs, configControllerDeployment)
s.cancel()
}
func (s *ConfigControllerCASuite) TestConfigControllerConnectsThroughProxyWithAdditionalCA() {
// The proxy is deployed in qa-config-controller-ca namespace using certs
// with SAN for *.qa-config-controller-ca.
const (
proxyServiceName = "nginx-proxy"
proxyEndpoint = proxyServiceName + "." + configControllerProxyNs + ":443"
)
s.logf("Pointing config-controller at the proxy...")
patchedDeploy := s.mustSetDeploymentEnvVal(s.ctx, configControllerNs, configControllerDeployment, configControllerContainer, configControllerCentralEndpoint, proxyEndpoint)
s.waitUntilK8sDeploymentGenerationReady(s.ctx, configControllerNs, configControllerDeployment, patchedDeploy.GetGeneration())
s.logf("Config-controller will now attempt connecting via the nginx proxy.")
// Wait for config-controller to successfully connect through the proxy.
// The manager logs "Starting manager" when it successfully initializes.
s.waitUntilLog(s.ctx, configControllerNs,
map[string]string{"app": "config-controller"},
configControllerContainer,
"show successful initialization",
containsLineMatching(regexp.MustCompile(`(Starting manager|Reconciler started|successfully connected)`)),
)
// Verify config-controller is healthy (readiness probe passes).
s.waitUntilK8sDeploymentReady(s.ctx, configControllerNs, configControllerDeployment)
s.logf("Config-controller successfully connected through proxy with additional CA")
}
func (s *ConfigControllerCASuite) setupProxy() {
// Deploy nginx proxy in qa-config-controller-ca namespace using certs
// with SANs for *.qa-config-controller-ca.
proxyNs := configControllerProxyNs
name := "nginx-proxy"
nginxLabels := map[string]string{"app": "nginx-proxy"}
nginxTLSSecretName := "nginx-tls-conf" //nolint:gosec // G101
nginxConfigName := "nginx-proxy-conf"
s.logf("Setting up nginx proxy in namespace %q...", proxyNs)
s.createProxyNamespace(proxyNs)
s.installProxyImagePullSecret(proxyNs)
s.createProxyTLSSecret(proxyNs, nginxTLSSecretName)
s.createProxyConfigMap(proxyNs, nginxConfigName)
s.createService(s.ctx, proxyNs, name, nginxLabels, map[int32]int32{443: 8443})
s.createProxyDeployment(proxyNs, name, nginxLabels, nginxConfigName, nginxTLSSecretName)
s.waitUntilK8sDeploymentReady(s.ctx, proxyNs, name)
s.logf("Nginx proxy is now set up in namespace %q.", proxyNs)
}
func (s *ConfigControllerCASuite) createProxyNamespace(proxyNs string) {
_, err := s.k8s.CoreV1().Namespaces().Create(s.ctx, &v1.Namespace{ObjectMeta: metaV1.ObjectMeta{Name: proxyNs}}, metaV1.CreateOptions{})
if apiErrors.IsAlreadyExists(err) {
return
}
s.Require().NoError(err, "cannot create proxy namespace %q", proxyNs)
}
func (s *ConfigControllerCASuite) installProxyImagePullSecret(proxyNs string) {
s.ensureQuayImagePullSecretExists(s.ctx, proxyNs, configControllerProxySecretName)
}
func (s *ConfigControllerCASuite) createProxyTLSSecret(proxyNs, nginxTLSSecretName string) {
var certChain []byte
certChain = append(certChain, configControllerProxyCert...)
certChain = append(certChain, configControllerAdditionalCA...)
s.ensureSecretExists(s.ctx, proxyNs, nginxTLSSecretName, v1.SecretTypeTLS, map[string][]byte{
v1.TLSCertKey: certChain,
v1.TLSPrivateKeyKey: configControllerProxyKey,
})
}
func (s *ConfigControllerCASuite) createProxyConfigMap(proxyNs, nginxConfigName string) {
// The proxy forwards gRPC traffic to the real Central.
centralEndpoint := fmt.Sprintf("central.%s.svc:443", configControllerNs)
const nginxConfigTmpl = `
server {
listen 8443 ssl http2;
ssl_certificate /run/secrets/tls/tls.crt;
ssl_certificate_key /run/secrets/tls/tls.key;
proxy_temp_path /tmp/nginx_proxy_temp;
client_body_temp_path /tmp/nginx_client_temp;
fastcgi_temp_path /tmp/nginx_fastcgi;
uwsgi_temp_path /tmp/nginx_uwsgi;
scgi_temp_path /tmp/nginx_scgi;
location / {
client_max_body_size 50M;
grpc_pass grpcs://%s;
grpc_ssl_verify off;
}
}
`
s.ensureConfigMapExists(s.ctx, proxyNs, nginxConfigName, map[string]string{
"nginx-proxy-grpc-tls.conf": fmt.Sprintf(nginxConfigTmpl, centralEndpoint),
})
}
func (s *ConfigControllerCASuite) createProxyDeployment(proxyNs, name string, nginxLabels map[string]string, nginxConfigName, nginxTLSSecretName string) {
d := &appsV1.Deployment{
ObjectMeta: metaV1.ObjectMeta{
Name: name,
Labels: nginxLabels,
},
Spec: appsV1.DeploymentSpec{
Selector: &metaV1.LabelSelector{
MatchLabels: nginxLabels,
},
MinReadySeconds: 15,
Template: v1.PodTemplateSpec{
ObjectMeta: metaV1.ObjectMeta{
Labels: nginxLabels,
},
Spec: v1.PodSpec{
ImagePullSecrets: []v1.LocalObjectReference{
{Name: configControllerProxySecretName},
},
Containers: []v1.Container{
{
Image: "quay.io/rhacs-eng/qa-multi-arch:nginx-1-17-1",
Name: "nginx-proxy",
VolumeMounts: []v1.VolumeMount{
{
Name: "config",
ReadOnly: true,
MountPath: "/etc/nginx/conf.d/",
},
{
Name: "tls",
ReadOnly: true,
MountPath: "/run/secrets/tls",
},
{
Name: "varrun",
MountPath: "/var/run",
},
},
},
},
Volumes: []v1.Volume{
{
Name: "config",
VolumeSource: v1.VolumeSource{
ConfigMap: &v1.ConfigMapVolumeSource{
LocalObjectReference: v1.LocalObjectReference{
Name: nginxConfigName,
},
},
},
},
{
Name: "tls",
VolumeSource: v1.VolumeSource{
Secret: &v1.SecretVolumeSource{
SecretName: nginxTLSSecretName,
},
},
},
{
Name: "varrun",
VolumeSource: v1.VolumeSource{
EmptyDir: &v1.EmptyDirVolumeSource{},
},
},
},
},
},
},
}
_, err := s.k8s.AppsV1().Deployments(proxyNs).Create(s.ctx, d, metaV1.CreateOptions{})
if apiErrors.IsAlreadyExists(err) {
return
}
s.Require().NoError(err, "cannot create deployment %q in namespace %q", name, proxyNs)
}
func (s *ConfigControllerCASuite) createAdditionalCASecret() {
s.logf("Creating additional-ca secret in namespace %q...", configControllerNs)
s.ensureSecretExists(s.ctx, configControllerNs, configControllerAdditionalCAName, v1.SecretTypeOpaque, map[string][]byte{
"custom-ca.crt": configControllerAdditionalCA,
})
}
func (s *ConfigControllerCASuite) restartConfigController() {
s.logf("Restarting config-controller to pick up additional CA...")
err := s.k8s.CoreV1().Pods(configControllerNs).DeleteCollection(s.ctx,
metaV1.DeleteOptions{},
metaV1.ListOptions{LabelSelector: "app=config-controller"})
s.Require().NoError(err, "cannot delete config-controller pods")
// Wait for new pod to be ready.
s.waitUntilK8sDeploymentReady(s.ctx, configControllerNs, configControllerDeployment)
}
func (s *ConfigControllerCASuite) cleanupProxy(ctx context.Context) {
proxyNs := configControllerProxyNs
if s.T().Failed() {
s.logf("Test failed. Collecting k8s artifacts before cleanup.")
collectLogs(s.T(), configControllerNs, "config-controller-ca-failure")
collectLogs(s.T(), proxyNs, "config-controller-ca-failure")
}
s.logf("Cleaning up nginx proxy in namespace %q...", proxyNs)
err := s.k8s.CoreV1().Namespaces().Delete(ctx, proxyNs, metaV1.DeleteOptions{})
if apiErrors.IsNotFound(err) {
return
}
s.Require().NoError(err, "cannot delete proxy namespace %q", proxyNs)
}
func (s *ConfigControllerCASuite) cleanupAdditionalCASecret(ctx context.Context) {
if s.hadAdditionalCASecret {
// Restore original secret content.
s.logf("Restoring original additional-ca secret with %d certificate(s) in namespace %q...", len(s.originalAdditionalCAContent), configControllerNs)
// First delete the test secret.
err := s.k8s.CoreV1().Secrets(configControllerNs).Delete(ctx, configControllerAdditionalCAName, metaV1.DeleteOptions{})
if err != nil && !apiErrors.IsNotFound(err) {
s.Require().NoError(err, "cannot delete test additional-ca secret")
}
// Recreate with original content.
secret := &v1.Secret{
ObjectMeta: metaV1.ObjectMeta{
Name: configControllerAdditionalCAName,
Namespace: configControllerNs,
},
Type: v1.SecretTypeOpaque,
Data: s.originalAdditionalCAContent,
}
_, err = s.k8s.CoreV1().Secrets(configControllerNs).Create(ctx, secret, metaV1.CreateOptions{})
s.Require().NoError(err, "cannot restore original additional-ca secret in namespace %q", configControllerNs)
s.logf("Successfully restored original additional-ca secret")
return
}
// Delete the secret if it didn't exist before the test.
s.logf("Cleaning up additional-ca secret in namespace %q...", configControllerNs)
err := s.k8s.CoreV1().Secrets(configControllerNs).Delete(ctx, configControllerAdditionalCAName, metaV1.DeleteOptions{})
if apiErrors.IsNotFound(err) {
return
}
s.Require().NoError(err, "cannot delete additional-ca secret in namespace %q", configControllerNs)
}
You can’t perform that action at this time.