-
Notifications
You must be signed in to change notification settings - Fork 787
/
step_boot_vault.go
557 lines (478 loc) · 20 KB
/
step_boot_vault.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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
package boot
import (
"bytes"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"text/template"
"github.com/jenkins-x/jx-logging/pkg/log"
"github.com/jenkins-x/jx/v2/pkg/cloud"
gkevault "github.com/jenkins-x/jx/v2/pkg/cloud/gke/vault"
"github.com/jenkins-x/jx/v2/pkg/cmd/helper"
"github.com/jenkins-x/jx/v2/pkg/cmd/opts"
"github.com/jenkins-x/jx/v2/pkg/cmd/templates"
"github.com/jenkins-x/jx/v2/pkg/config"
"github.com/jenkins-x/jx/v2/pkg/helm"
"github.com/jenkins-x/jx/v2/pkg/io/secrets"
"github.com/jenkins-x/jx/v2/pkg/kube"
kubevault "github.com/jenkins-x/jx/v2/pkg/kube/vault"
"github.com/jenkins-x/jx/v2/pkg/util"
"github.com/jenkins-x/jx/v2/pkg/vault"
pkgvault "github.com/jenkins-x/jx/v2/pkg/vault"
"github.com/jenkins-x/jx/v2/pkg/vault/create"
"github.com/pkg/errors"
"github.com/spf13/cobra"
corev1 "k8s.io/api/core/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/helm/pkg/chartutil"
)
type vaultSelector struct {
vaultURL string
serviceAccountName string
namespace string
}
func NewVaultSelector(vault vault.Vault) kubevault.Selector {
selector := &vaultSelector{
vaultURL: vault.URL,
serviceAccountName: vault.ServiceAccountName,
namespace: vault.Namespace,
}
return selector
}
// GetVault retrieve the given vault by name
func (v *vaultSelector) GetVault(name string, namespace string, useIngressURL bool) (*vault.Vault, error) {
vault := vault.Vault{
Name: name,
Namespace: namespace,
URL: v.vaultURL,
ServiceAccountName: v.serviceAccountName,
}
return &vault, nil
}
// StepBootVaultOptions contains the command line flags
type StepBootVaultOptions struct {
*opts.CommonOptions
Dir string
ProviderValuesDir string
Namespace string
}
var (
stepBootVaultLong = templates.LongDesc(`
This step boots up Vault in the current cluster if its enabled in the 'jx-requirements.yml' file and is not already installed.
This step is intended to be used in the Jenkins X Boot Pipeline: https://jenkins-x.io/docs/getting-started/setup/boot/
`)
stepBootVaultExample = templates.Examples(`
# boots up Vault if its required
jx step boot vault
`)
)
// NewCmdStepBootVault creates the command
func NewCmdStepBootVault(commonOpts *opts.CommonOptions) *cobra.Command {
o := StepBootVaultOptions{
CommonOptions: commonOpts,
}
cmd := &cobra.Command{
Use: "vault",
Short: "This step boots up Vault in the current cluster if its enabled in the 'jx-requirements.yml' file and is not already installed",
Long: stepBootVaultLong,
Example: stepBootVaultExample,
Run: func(cmd *cobra.Command, args []string) {
o.Cmd = cmd
o.Args = args
err := o.Run()
helper.CheckErr(err)
},
}
cmd.Flags().StringVarP(&o.Dir, "dir", "d", ".", fmt.Sprintf("the directory to look for the requirements file: %s", config.RequirementsConfigFileName))
cmd.Flags().StringVarP(&o.ProviderValuesDir, "provider-values-dir", "", "", "The optional directory of kubernetes provider specific files")
cmd.Flags().StringVarP(&o.Namespace, "namespace", "", "", "the namespace that Jenkins X will be booted into. If not specified it defaults to $DEPLOY_NAMESPACE")
return cmd
}
// Run runs the command
func (o *StepBootVaultOptions) Run() error {
ns, err := o.GetDeployNamespace(o.Namespace)
if err != nil {
return err
}
requirements, fileName, err := config.LoadRequirementsConfig(o.Dir, config.DefaultFailOnValidationError)
if err != nil {
return err
}
info := util.ColorInfo
if requirements.SecretStorage != config.SecretStorageTypeVault {
log.Logger().Infof("Not attempting to boot Vault as using secret storage: %s\n", info(string(requirements.SecretStorage)))
return nil
}
kubeClient, err := o.KubeClient()
if err != nil {
return errors.Wrapf(err, "failed to create Kubernetes client")
}
internal := requirements.Vault.URL == ""
// if we are not in batch mode and the key values in jx-requirements.yml are not set, interactively query the user
if !o.BatchMode && requirements.Vault.URL == "" && requirements.Vault.Name == "" {
internal, err = o.interactiveVaultConfiguration(internal, requirements, fileName)
if err != nil {
return errors.Wrapf(err, "failed to interactively configure Vault")
}
}
if internal {
return o.setupInClusterVault(requirements, ns, kubeClient)
}
return o.setupExternalVault(requirements, ns, kubeClient)
}
func (o *StepBootVaultOptions) interactiveVaultConfiguration(internal bool, requirements *config.RequirementsConfig, fileName string) (bool, error) {
help := "Jenkins X uses Vault to store secrets. You can provide your own Vault instance or let Jenkins X create one for you."
message := "Do you want Jenkins X to create and manage Vault?"
internal, err := util.Confirm(message, true, help, o.GetIOFileHandles())
if err != nil {
return false, errors.Wrapf(err, "unable to process user input")
}
if internal {
return true, nil
}
err = o.askExternalVaultParameters(requirements, o.GetIOFileHandles())
if err != nil {
return false, errors.Wrapf(err, "unable to ask user for Vault configuration")
}
err = requirements.SaveConfig(fileName)
if err != nil {
return false, errors.Wrap(err, "unable to write updated requirements file")
}
return false, nil
}
func (o *StepBootVaultOptions) askExternalVaultParameters(requirements *config.RequirementsConfig, fileHandles util.IOFileHandles) error {
url, err := util.PickValue("URL to Vault instance: ", "", true, "Please specify the URL to the Vault instance for storing your Jenkins X secrets", fileHandles)
if err != nil {
return errors.Wrap(err, "unable to get Vault URL from user")
}
requirements.Vault.URL = url
sa, err := util.PickValue("Authenticating service account: ", fmt.Sprintf("%s-vt", requirements.Cluster.ClusterName), true, "Please specify the service account used to authenticate against Vault", fileHandles)
if err != nil {
return errors.Wrap(err, "unable to get service account from user")
}
requirements.Vault.ServiceAccount = sa
ns, err := util.PickValue("Namespace of authenticating service account: ", requirements.Cluster.Namespace, true, "Please specify the namespace of the authenticating service account", fileHandles)
if err != nil {
return errors.Wrap(err, "unable to get namespace from user")
}
requirements.Vault.Namespace = ns
authPath, err := util.PickValue("Path under which to enable Vault's Kubernetes auth plugin: ", vault.DefaultKubernetesAuthPath, true, "Please specify the path for Vault's Kubernetes auth plugin. See https://www.vaultproject.io/docs/auth/kubernetes.", fileHandles)
if err != nil {
return errors.Wrap(err, "unable to get Kubernetes auth path from user")
}
requirements.Vault.KubernetesAuthPath = authPath
mountPoint, err := util.PickValue("Mount point for Vault's KV secret engine: ", vault.DefaultKVEngineMountPoint, true, "Please specify the mount point for Vault's KV secrets engine. See https://www.vaultproject.io/docs/secrets/kv", fileHandles)
if err != nil {
return errors.Wrap(err, "unable to get Vault URL from user")
}
requirements.Vault.SecretEngineMountPoint = mountPoint
return nil
}
func (o *StepBootVaultOptions) setupExternalVault(requirements *config.RequirementsConfig, ns string, kubeClient kubernetes.Interface) error {
namespace := requirements.Vault.Namespace
if namespace == "" {
namespace = ns
}
vault, err := vault.NewExternalVault(requirements.Vault.URL, requirements.Vault.ServiceAccount, namespace, requirements.Vault.SecretEngineMountPoint, requirements.Vault.KubernetesAuthPath)
if err != nil {
return errors.Wrapf(err, "invalid configuration for external Vault setup")
}
selector := NewVaultSelector(vault)
vaultFactory, err := kubevault.NewVaultClientFactoryWithSelector(kubeClient, selector, ns)
if err != nil {
return errors.Wrap(err, "unable to create Vault factory for external Vault instance")
}
_, err = vaultFactory.NewVaultClientForURL(vault, false)
if err != nil {
return errors.Wrap(err, "unable to create Vault client for external Vault instance")
}
err = o.storeExternalVaultConfig(kubeClient, ns, vault)
if err != nil {
return errors.Wrapf(err, "unable to store Vault configuration in ConfigMap '%s'", kube.ConfigMapNameJXInstallConfig)
}
log.Logger().Infof("Using external Vault instance %s - %s", vault.URL, util.ColorInfo("OK"))
return nil
}
func (o *StepBootVaultOptions) setupInClusterVault(requirements *config.RequirementsConfig, ns string, kubeClient kubernetes.Interface) error {
if requirements.Vault.Name == "" {
requirements.Vault.Name = kubevault.SystemVaultNameForCluster(requirements.Cluster.ClusterName)
}
log.Logger().Debugf("Using vault name '%s'", requirements.Vault.Name)
vault, err := vault.NewInternalVault(requirements.Vault.Name, requirements.Vault.ServiceAccount, ns)
if err != nil {
return errors.Wrapf(err, "invalid configuration for external Vault setup")
}
err = o.installOperator(requirements, ns)
if err != nil {
return errors.Wrapf(err, "unable to install Vault operator")
}
_, err = o.verifyVaultIngress(requirements, kubeClient, ns, requirements.Vault.Name)
if err != nil {
return err
}
err = o.storeInternalVaultConfig(kubeClient, vault, ns)
if err != nil {
return err
}
vaultOperatorClient, err := o.VaultOperatorClient()
if err != nil {
return errors.Wrap(err, "creating vault operator client")
}
resolver, err := o.CreateVersionResolver(requirements.VersionStream.URL, requirements.VersionStream.Ref)
if err != nil {
return errors.Wrap(err, "unable to create version stream resolver")
}
provider := requirements.Cluster.Provider
// only allow to make changes to cloud resources when running locally via `jx boot`
// when run in pipeline, the pipeline SA does not have permissions to create buckets, etc
// the assumption is that when the code runs in the pipeline all cloud resources already exist
// (`jx boot` has been executed once at least)
createCloudResources := o.IsJXBoot()
vaultCreateParam := create.VaultCreationParam{
VaultName: requirements.Vault.Name,
Namespace: ns,
ClusterName: requirements.Cluster.ClusterName,
ServiceAccountName: requirements.Vault.ServiceAccount,
SecretsPathPrefix: pkgvault.DefaultSecretsPathPrefix,
KubeProvider: provider,
KubeClient: kubeClient,
VaultOperatorClient: vaultOperatorClient,
VersionResolver: *resolver,
FileHandles: o.GetIOFileHandles(),
CreateCloudResources: createCloudResources,
Boot: true,
BatchMode: true,
}
if provider == cloud.GKE {
gkeParam := &create.GKEParam{
ProjectID: gkevault.GetGoogleProjectID(kubeClient, ns),
Zone: gkevault.GetGoogleZone(kubeClient, ns),
BucketName: requirements.Vault.Bucket,
KeyringName: requirements.Vault.Keyring,
KeyName: requirements.Vault.Key,
RecreateBucket: requirements.Vault.RecreateBucket,
}
vaultCreateParam.GKE = gkeParam
} else if provider == cloud.EKS {
awsParam, err := o.createAWSParam(requirements)
if err != nil {
return errors.Wrap(err, "unable to create Vault creation parameter from requirements")
}
vaultCreateParam.AWS = &awsParam
} else if provider == cloud.AKS {
azureParam, err := o.createAzureParam(requirements)
if err != nil {
return errors.Wrap(err, "unable to create Vault creation parameter from requirements")
}
vaultCreateParam.Azure = &azureParam
}
vaultCreator := create.NewVaultCreator()
err = vaultCreator.CreateOrUpdateVault(vaultCreateParam)
if err != nil {
return errors.Wrap(err, "unable to create/update Vault")
}
return nil
}
func (o *StepBootVaultOptions) createAWSParam(requirements *config.RequirementsConfig) (create.AWSParam, error) {
if requirements.Vault.AWSConfig == nil {
return create.AWSParam{}, errors.New("missing AWS configuration for Vault in requirements")
}
awsConfig := requirements.Vault.AWSConfig
secretAccessKey := os.Getenv("VAULT_AWS_SECRET_ACCESS_KEY")
accessKeyID := os.Getenv("VAULT_AWS_ACCESS_KEY_ID")
if !awsConfig.AutoCreate && (checkRequiredResource("dynamoDBTable", awsConfig.DynamoDBTable) ||
checkRequiredResource("secretAccessKey", secretAccessKey) ||
checkRequiredResource("accessKeyID", accessKeyID) ||
checkRequiredResource("kmsKeyId", awsConfig.KMSKeyID) ||
checkRequiredResource("s3Bucket", awsConfig.S3Bucket)) {
log.Logger().Info("Some of the required provided values are empty - We will create all resources")
awsConfig.AutoCreate = true
}
templatesDir := filepath.Join(o.Dir, o.ProviderValuesDir, cloud.EKS, "templates")
defaultRegion := requirements.Cluster.Region
if defaultRegion == "" {
return create.AWSParam{}, errors.New("unable to find cluster region in requirements")
}
dynamoDBRegion := awsConfig.DynamoDBRegion
if dynamoDBRegion == "" {
dynamoDBRegion = defaultRegion
log.Logger().Infof("Region not specified for DynamoDB, defaulting to %s", util.ColorInfo(defaultRegion))
}
kmsRegion := awsConfig.KMSRegion
if kmsRegion == "" {
kmsRegion = defaultRegion
log.Logger().Infof("Region not specified for KMS, defaulting to %s", util.ColorInfo(defaultRegion))
}
s3Region := awsConfig.S3Region
if s3Region == "" {
s3Region = defaultRegion
log.Logger().Infof("Region not specified for S3, defaulting to %s", util.ColorInfo(defaultRegion))
}
awsParam := create.AWSParam{
IAMUsername: awsConfig.ProvidedIAMUsername,
S3Bucket: awsConfig.S3Bucket,
S3Region: s3Region,
S3Prefix: awsConfig.S3Prefix,
TemplatesDir: templatesDir,
DynamoDBTable: awsConfig.DynamoDBTable,
DynamoDBRegion: dynamoDBRegion,
KMSKeyID: awsConfig.KMSKeyID,
KMSRegion: kmsRegion,
AccessKeyID: accessKeyID,
SecretAccessKey: secretAccessKey,
AutoCreate: awsConfig.AutoCreate,
}
return awsParam, nil
}
func (o *StepBootVaultOptions) createAzureParam(requirements *config.RequirementsConfig) (create.AzureParam, error) {
if requirements.Vault.AzureConfig == nil {
return create.AzureParam{}, errors.New("missing Azure configuration for Vault in requirements")
}
azureConfig := requirements.Vault.AzureConfig
storageAccessKey := os.Getenv("VAULT_AZURE_STORAGE_ACCESS_KEY")
azureParam := create.AzureParam{
TenantID: azureConfig.TenantID,
StorageAccountKey: storageAccessKey,
StorageAccountName: azureConfig.StorageAccountName,
ContainerName: azureConfig.ContainerName,
KeyName: azureConfig.KeyName,
VaultName: azureConfig.VaultName,
}
return azureParam, nil
}
func (o *StepBootVaultOptions) storeInternalVaultConfig(kubeClient kubernetes.Interface, vaultConfig vault.Vault, ns string) error {
_, err := kube.DefaultModifyConfigMap(kubeClient, ns, kube.ConfigMapNameJXInstallConfig,
func(configMap *corev1.ConfigMap) error {
configMap.Data[secrets.SecretsLocationKey] = string(secrets.VaultLocationKind)
vaultConfig := vaultConfig.ToMap()
configMap.Data = util.MergeMaps(configMap.Data, vaultConfig)
return nil
}, nil)
if err != nil {
return errors.Wrapf(err, "error saving system vault name in ConfigMap %s in namespace %s", kube.ConfigMapNameJXInstallConfig, ns)
}
return nil
}
func (o *StepBootVaultOptions) storeExternalVaultConfig(kubeClient kubernetes.Interface, ns string, vaultConfig vault.Vault) error {
_, err := kube.DefaultModifyConfigMap(kubeClient, ns, kube.ConfigMapNameJXInstallConfig,
func(configMap *corev1.ConfigMap) error {
configMap.Data[secrets.SecretsLocationKey] = string(secrets.VaultLocationKind)
vaultConfig := vaultConfig.ToMap()
configMap.Data = util.MergeMaps(configMap.Data, vaultConfig)
return nil
}, nil)
if err != nil {
return errors.Wrapf(err, "error saving external Vault configuration in ConfigMap %s in namespace %s", kube.ConfigMapNameJXInstallConfig, ns)
}
return nil
}
func (o *StepBootVaultOptions) installOperator(requirements *config.RequirementsConfig, ns string) error {
tag, err := o.vaultOperatorImageTag(&requirements.VersionStream)
if err != nil {
return errors.Wrap(err, "unable to determine Vault operator version")
}
releaseName := o.ReleaseName
if releaseName == "" {
releaseName = kube.DefaultVaultOperatorReleaseName
}
values := []string{
"image.repository=" + kubevault.VaultOperatorImage,
"image.tag=" + tag,
}
log.Logger().Infof("Installing %s operator with helm values: %v", util.ColorInfo(releaseName), util.ColorInfo(values))
helmOptions := helm.InstallChartOptions{
Chart: kube.ChartVaultOperator,
ReleaseName: releaseName,
Version: o.Version,
Ns: ns,
SetValues: values,
}
err = o.InstallChartWithOptions(helmOptions)
if err != nil {
return errors.Wrap(err, "unable to install vault operator")
}
log.Logger().Infof("Vault operator installed in namespace %s", ns)
return nil
}
// verifyVaultIngress verifies there is a Vault ingress and if not create one if there is a file at
func (o *StepBootVaultOptions) verifyVaultIngress(requirements *config.RequirementsConfig, kubeClient kubernetes.Interface, ns string, systemVaultName string) (bool, error) {
fileName := filepath.Join(o.Dir, "vault-ing.tmpl.yaml")
exists, err := util.FileExists(fileName)
if err != nil {
return false, errors.Wrapf(err, "failed to check if file exists %s", fileName)
}
if !exists {
log.Logger().Warnf("failed to find file %s\n", fileName)
return false, nil
}
data, err := readYamlTemplate(fileName, requirements)
if err != nil {
return true, errors.Wrapf(err, "failed to load vault ingress template file %s", fileName)
}
log.Logger().Infof("Applying vault ingress in namespace %s for vault name %s\n", util.ColorInfo(ns), util.ColorInfo(systemVaultName))
tmpFile, err := ioutil.TempFile("", "vault-ingress-")
if err != nil {
return true, errors.Wrapf(err, "failed to create temporary file for vault YAML")
}
tmpFileName := tmpFile.Name()
err = ioutil.WriteFile(tmpFileName, data, util.DefaultWritePermissions)
if err != nil {
return true, errors.Wrapf(err, "failed to save vault ingress YAML file %s", tmpFileName)
}
args := []string{"apply", "--force", "-f", tmpFileName, "-n", ns}
err = o.RunCommand("kubectl", args...)
if err != nil {
return true, errors.Wrapf(err, "failed to apply vault ingress YAML")
}
return true, nil
}
// vaultOperatorImageTag lookups the vault operator image tag in the version stream
func (o *StepBootVaultOptions) vaultOperatorImageTag(versionStream *config.VersionStreamConfig) (string, error) {
resolver, err := o.CreateVersionResolver(versionStream.URL, versionStream.Ref)
if err != nil {
return "", errors.Wrap(err, "creating the vault-operator docker image version resolver")
}
fullImage, err := resolver.ResolveDockerImage(kubevault.VaultOperatorImage)
if err != nil {
return "", errors.Wrapf(err, "looking up the vault-operator %q image into the version stream",
kubevault.VaultOperatorImage)
}
parts := strings.Split(fullImage, ":")
if len(parts) != 2 {
return "", fmt.Errorf("no tag found for image %q in version stream", kubevault.VaultOperatorImage)
}
return parts[1], nil
}
// readYamlTemplate evaluates the given go template file and returns the output data
func readYamlTemplate(templateFile string, requirements *config.RequirementsConfig) ([]byte, error) {
_, name := filepath.Split(templateFile)
funcMap := helm.NewFunctionMap()
tmpl, err := template.New(name).Option("missingkey=error").Funcs(funcMap).ParseFiles(templateFile)
if err != nil {
return nil, errors.Wrapf(err, "failed to parse Ingress template: %s", templateFile)
}
requirementsMap, err := requirements.ToMap()
if err != nil {
return nil, errors.Wrapf(err, "failed turn requirements into a map: %v", requirements)
}
templateData := map[string]interface{}{
"Requirements": chartutil.Values(requirementsMap),
"Environments": chartutil.Values(requirements.EnvironmentMap()),
}
var buf bytes.Buffer
err = tmpl.Execute(&buf, templateData)
if err != nil {
return nil, errors.Wrapf(err, "failed to execute Ingress template: %s", templateFile)
}
data := buf.Bytes()
return data, nil
}
func checkRequiredResource(resourceName string, value string) bool {
if value == "" {
log.Logger().Warnf("Vault.AutoCreate is false but required property %s is missing", resourceName)
return true
}
return false
}