/
operator.go
432 lines (368 loc) · 14.1 KB
/
operator.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
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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
// Copyright © 2019 Banzai Cloud
//
// 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 vault
import (
"context"
"encoding/json"
"fmt"
"time"
"emperror.dev/errors"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
k8srest "k8s.io/client-go/rest"
"github.com/banzaicloud/pipeline/internal/common"
"github.com/banzaicloud/pipeline/internal/integratedservices"
"github.com/banzaicloud/pipeline/internal/integratedservices/integratedserviceadapter"
"github.com/banzaicloud/pipeline/internal/integratedservices/services"
"github.com/banzaicloud/pipeline/pkg/backoff"
"github.com/banzaicloud/pipeline/src/auth"
)
// IntegratedServiceOperator implements the Vault integrated service operator
type IntegratedServicesOperator struct {
clusterGetter integratedserviceadapter.ClusterGetter
clusterService integratedservices.ClusterService
helmService services.HelmService
kubernetesService KubernetesService
secretStore services.SecretStore
config Config
logger services.Logger
}
// MakeIntegratedServicesOperator returns a Vault integrated service operator
func MakeIntegratedServicesOperator(
clusterGetter integratedserviceadapter.ClusterGetter,
clusterService integratedservices.ClusterService,
helmService services.HelmService,
kubernetesService KubernetesService,
secretStore services.SecretStore,
config Config,
logger services.Logger,
) IntegratedServicesOperator {
return IntegratedServicesOperator{
clusterGetter: clusterGetter,
clusterService: clusterService,
helmService: helmService,
kubernetesService: kubernetesService,
secretStore: secretStore,
config: config,
logger: logger,
}
}
// Name returns the name of the Vault integrated service
func (op IntegratedServicesOperator) Name() string {
return integratedServiceName
}
// Apply applies the provided specification to the cluster integrated service
func (op IntegratedServicesOperator) Apply(ctx context.Context, clusterID uint, spec integratedservices.IntegratedServiceSpec) error {
ctx, err := op.ensureOrgIDInContext(ctx, clusterID)
if err != nil {
return err
}
if err := op.clusterService.CheckClusterReady(ctx, clusterID); err != nil {
return err
}
logger := op.logger.WithContext(ctx).WithFields(map[string]interface{}{"cluster": clusterID, "integrated service": integratedServiceName})
boundSpec, err := bindIntegratedServiceSpec(spec)
if err != nil {
return integratedservices.InvalidIntegratedServiceSpecError{
IntegratedServiceName: integratedServiceName,
Problem: err.Error(),
}
}
orgID, ok := auth.GetCurrentOrganizationID(ctx)
if !ok {
return errors.New("organization ID missing from context")
}
// install vault-secrets-webhook
if err := op.installOrUpdateWebhook(ctx, logger, orgID, clusterID, boundSpec); err != nil {
return errors.WrapIf(err, "failed to deploy helm chart for integrated service")
}
// create the token reviwer service account
tokenReviewerJWT, err := op.configureClusterTokenReviewer(ctx, logger, clusterID)
if err != nil {
return errors.WrapIf(err, "failed to configure Cluster with token reviewer service account")
}
// get kubeconfig for cluster
kubeConfig, err := op.kubernetesService.GetKubeConfig(ctx, clusterID)
if err != nil {
return errors.WrapIf(err, "failed to get cluster kube config")
}
// configure the target Vault instance if needed, with the k8s auth info of the cluster
if err := op.configureVault(ctx, logger, orgID, clusterID, boundSpec, tokenReviewerJWT, kubeConfig); err != nil {
return errors.WrapIf(err, "failed to configure Vault")
}
return nil
}
func (op IntegratedServicesOperator) configureClusterTokenReviewer(
ctx context.Context,
logger common.Logger,
clusterID uint,
) (string, error) {
pipelineSystemNamespace := op.config.Namespace
// Prepare cluster first with the proper token reviewer SA
serviceAccount := corev1.ServiceAccount{
ObjectMeta: metav1.ObjectMeta{
Name: vaultTokenReviewer,
Namespace: pipelineSystemNamespace,
},
}
err := op.kubernetesService.EnsureObject(ctx, clusterID, &serviceAccount)
if err != nil {
return "", errors.WrapIf(err, "failed to create token reviewer ServiceAccount")
}
// Prepare a custom ServiceAccountToken for the above SA in a controlled way, since the creation of
// SA tokens is async and naming is random, so we can't control when it gets created and with what name.
// See:
// https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/#token-controller
// https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#manually-create-a-service-account-api-token
serviceAccountToken := corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: vaultTokenReviewer,
Namespace: pipelineSystemNamespace,
Annotations: map[string]string{
corev1.ServiceAccountNameKey: vaultTokenReviewer,
},
},
Type: corev1.SecretTypeServiceAccountToken,
}
err = op.kubernetesService.EnsureObject(ctx, clusterID, &serviceAccountToken)
if err != nil {
return "", errors.WrapIf(err, "failed to create token reviewer ServiceAccountToken")
}
tokenReviewerRoleBinding := rbacv1.ClusterRoleBinding{
ObjectMeta: metav1.ObjectMeta{
Name: vaultTokenReviewer,
},
RoleRef: rbacv1.RoleRef{
APIGroup: rbacv1.GroupName,
Kind: "ClusterRole",
Name: "system:auth-delegator",
},
Subjects: []rbacv1.Subject{
{
Kind: "ServiceAccount",
Name: serviceAccount.Name,
Namespace: serviceAccount.Namespace,
},
},
}
err = op.kubernetesService.EnsureObject(ctx, clusterID, &tokenReviewerRoleBinding)
if err != nil {
return "", errors.WrapIf(err, "failed to create token reviewer cluster role binding")
}
var tokenReviewerJWT string
backoffPolicy := backoff.NewConstantBackoffPolicy(backoff.ConstantBackoffConfig{
Delay: 5 * time.Second,
MaxRetries: 5,
})
return tokenReviewerJWT, backoff.Retry(func() error {
serviceAccountToken.SetResourceVersion("")
err = op.kubernetesService.EnsureObject(ctx, clusterID, &serviceAccountToken)
if err != nil {
return errors.WrapIf(err, "failed to query token reviewer ServiceAccount token")
}
tokenReviewerJWT = string(serviceAccountToken.Data[corev1.ServiceAccountTokenKey])
if tokenReviewerJWT == "" {
return errors.New("tokenReviewerJWT is empty")
}
logger.Info("kubernetes service account created in Kubernetes for vault token review")
return nil
}, backoffPolicy)
}
func (op IntegratedServicesOperator) configureVault(
ctx context.Context,
logger common.Logger,
orgID,
clusterID uint,
boundSpec vaultIntegratedServiceSpec,
tokenReviewerJWT string,
kubeConfig *k8srest.Config,
) error {
if !boundSpec.CustomVault.Enabled || boundSpec.CustomVault.SecretID != "" {
// custom Vault with token or CP's vault
logger.Debug("start to setup Vault")
var token string
if boundSpec.CustomVault.SecretID != "" {
// get token from vault
tokenValues, err := op.secretStore.GetSecretValues(ctx, boundSpec.CustomVault.SecretID)
if err != nil {
return errors.WrapIf(err, "failed get token from Vault")
}
token = tokenValues[vaultTokenKey]
}
// create Vault manager
vaultManager, err := newVaultManager(boundSpec, orgID, clusterID, token, op.logger)
if err != nil {
return errors.WrapIf(err, "failed to create Vault manager")
}
defer vaultManager.close()
// create policy
var policy string
if boundSpec.CustomVault.Enabled {
policy = boundSpec.CustomVault.Policy
} else {
policy = getDefaultPolicy(orgID)
}
if err := vaultManager.createPolicy(policy); err != nil {
return errors.WrapIf(err, "failed to create policy")
}
logger.Info("policy created successfully")
// enable auth method
if err := vaultManager.enableAuth(getAuthMethodPath(orgID, clusterID), authMethodType); err != nil {
return errors.WrapIf(err, fmt.Sprintf("failed to enabling %s auth method for vault", authMethodType))
}
logger.Info(fmt.Sprintf("auth method %q enabled for vault", authMethodType))
// config auth method
if _, err := vaultManager.configureAuth(tokenReviewerJWT, kubeConfig.Host, kubeConfig.CAData); err != nil {
return errors.WrapIf(err, fmt.Sprintf("failed to configure %s auth method for vault", authMethodType))
}
logger.Info(fmt.Sprintf("auth method %q configured for vault", authMethodType))
// create role
if _, err := vaultManager.createRole(boundSpec.Settings.ServiceAccounts, boundSpec.Settings.Namespaces); err != nil {
return errors.WrapIf(err, fmt.Sprintf("failed to create role in the auth method %q", authMethodType))
}
logger.Info(fmt.Sprintf("role created in auth method %q for vault", authMethodType))
}
return nil
}
func getPolicyName(orgID, clusterID uint) string {
return fmt.Sprintf("%s_%d_%d", policyNamePrefix, orgID, clusterID)
}
func (op IntegratedServicesOperator) installOrUpdateWebhook(
ctx context.Context,
logger common.Logger,
orgID, clusterID uint,
spec vaultIntegratedServiceSpec,
) error {
// create chart values
vaultExternalAddress := op.config.Managed.Endpoint
if spec.CustomVault.Enabled {
vaultExternalAddress = spec.CustomVault.Address
}
pipelineSystemNamespace := op.config.Namespace
chartValues := &webhookValues{
Env: map[string]string{
vaultAddressEnvKey: vaultExternalAddress,
vaultPathEnvKey: getAuthMethodPath(orgID, clusterID),
vaultRoleEnvKey: getRoleName(spec.CustomVault.Enabled),
},
NamespaceSelector: namespaceSelector{
MatchExpressions: []matchExpressions{
{
Key: "name",
Operator: "NotIn",
Values: []string{
kubeSysNamespace,
pipelineSystemNamespace,
},
},
},
},
}
valuesBytes, err := json.Marshal(chartValues)
if err != nil {
logger.Debug("failed to marshal chartValues")
return errors.WrapIf(err, "failed to decode chartValues")
}
chartName := op.config.Charts.Webhook.Chart
chartVersion := op.config.Charts.Webhook.Version
return op.helmService.ApplyDeployment(
ctx,
clusterID,
pipelineSystemNamespace,
chartName,
vaultWebhookReleaseName,
valuesBytes,
chartVersion,
)
}
// Deactivate deactivates the cluster integrated service
func (op IntegratedServicesOperator) Deactivate(ctx context.Context, clusterID uint, spec integratedservices.IntegratedServiceSpec) error {
ctx, err := op.ensureOrgIDInContext(ctx, clusterID)
if err != nil {
return err
}
if err := op.clusterService.CheckClusterReady(ctx, clusterID); err != nil {
return err
}
logger := op.logger.WithContext(ctx).WithFields(map[string]interface{}{"cluster": clusterID, "integrated service": integratedServiceName})
// delete deployment
if err := op.helmService.DeleteDeployment(ctx, clusterID, vaultWebhookReleaseName, op.config.Namespace); err != nil {
logger.Info("failed to delete integrated service deployment")
return errors.WrapIf(err, "failed to uninstall integrated service")
}
logger.Info("vault webhook deployment deleted successfully")
boundSpec, err := bindIntegratedServiceSpec(spec)
if err != nil {
return integratedservices.InvalidIntegratedServiceSpecError{
IntegratedServiceName: integratedServiceName,
Problem: err.Error(),
}
}
if !boundSpec.CustomVault.Enabled || boundSpec.CustomVault.SecretID != "" {
orgID, ok := auth.GetCurrentOrganizationID(ctx)
if !ok {
return errors.New("organization ID missing from context")
}
var token string
if boundSpec.CustomVault.Enabled {
// get token from Vault
tokenValues, err := op.secretStore.GetSecretValues(ctx, boundSpec.CustomVault.SecretID)
if err != nil {
return errors.WrapIf(err, "failed get token from Vault")
}
token = tokenValues[vaultTokenKey]
}
// create Vault manager
vaultManager, err := newVaultManager(boundSpec, orgID, clusterID, token, op.logger)
if err != nil {
return errors.WrapIf(err, "failed to create Vault manager")
}
defer vaultManager.close()
// disable auth method
if err := vaultManager.disableAuth(getAuthMethodPath(orgID, clusterID)); err != nil {
logger.Warn(fmt.Sprintf("failed to disable %q auth method in vault: %v", authMethodType, err))
} else {
logger.Info(fmt.Sprintf("auth method %q in vault deactivated successfully", authMethodType))
}
// delete policy
if err := vaultManager.deletePolicy(); err != nil {
logger.Warn(fmt.Sprintf("failed to delete policy in vault: %v", err))
} else {
logger.Info("vault policy deleted successfully")
}
// delete kubernetes service account
pipelineSystemNamespace := op.config.Namespace
if err := op.kubernetesService.DeleteObject(ctx, clusterID, &corev1.ServiceAccount{ObjectMeta: metav1.ObjectMeta{Name: vaultTokenReviewer, Namespace: pipelineSystemNamespace}}); err != nil {
return errors.WrapIf(err, fmt.Sprintf("failed to delete kubernetes service account"))
}
logger.Info("kubernetes service account deleted successfully")
// delete kubernetes cluster role binding
if err := op.kubernetesService.DeleteObject(ctx, clusterID, &rbacv1.ClusterRoleBinding{ObjectMeta: metav1.ObjectMeta{Name: vaultTokenReviewer}}); err != nil {
return errors.WrapIf(err, fmt.Sprintf("failed to delete kubernetes cluster role binding"))
}
logger.Info("kubernetes cluster role binding deleted successfully")
}
return nil
}
func (op IntegratedServicesOperator) ensureOrgIDInContext(ctx context.Context, clusterID uint) (context.Context, error) {
if _, ok := auth.GetCurrentOrganizationID(ctx); !ok {
cluster, err := op.clusterGetter.GetClusterByIDOnly(ctx, clusterID)
if err != nil {
return ctx, errors.WrapIf(err, "failed to get cluster by ID")
}
ctx = auth.SetCurrentOrganizationID(ctx, cluster.GetOrganizationId())
}
return ctx, nil
}