-
Notifications
You must be signed in to change notification settings - Fork 785
/
install.go
3383 lines (3000 loc) · 118 KB
/
install.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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package create
import (
"encoding/base64"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"sort"
"strings"
"time"
"github.com/jenkins-x/jx/v2/pkg/cmd/opts/upgrade"
"github.com/jenkins-x/jx/v2/pkg/errorutil"
"github.com/jenkins-x/jx/v2/pkg/vault/create"
createoptions "github.com/jenkins-x/jx/v2/pkg/cmd/create/options"
cmdvault "github.com/jenkins-x/jx/v2/pkg/cmd/create/vault"
"github.com/jenkins-x/jx/v2/pkg/packages"
"github.com/jenkins-x/jx/v2/pkg/prow"
"github.com/jenkins-x/jx/v2/pkg/platform"
"github.com/jenkins-x/jx/v2/pkg/cmd/opts/step"
"github.com/jenkins-x/jx/v2/pkg/versionstream"
"github.com/jenkins-x/jx/v2/pkg/cmd/edit"
"github.com/jenkins-x/jx/v2/pkg/cmd/initcmd"
"github.com/jenkins-x/jx/v2/pkg/kube/naming"
"github.com/spf13/viper"
"github.com/jenkins-x/jx/v2/pkg/cmd/step/env"
"github.com/jenkins-x/jx/v2/pkg/cmd/helper"
gkeStorage "github.com/jenkins-x/jx/v2/pkg/cloud/gke/storage"
"github.com/jenkins-x/jx/v2/pkg/kube/cluster"
"k8s.io/helm/pkg/chartutil"
"github.com/jenkins-x/jx/v2/pkg/cloud"
"github.com/jenkins-x/jx/v2/pkg/cloud/gke"
version2 "github.com/jenkins-x/jx/v2/pkg/version"
"github.com/ghodss/yaml"
"github.com/Pallinder/go-randomdata"
"github.com/jenkins-x/jx/v2/pkg/io/secrets"
kubevault "github.com/jenkins-x/jx/v2/pkg/kube/vault"
"github.com/jenkins-x/jx/v2/pkg/vault"
jenkinsio "github.com/jenkins-x/jx-api/pkg/apis/jenkins.io"
v1 "github.com/jenkins-x/jx-api/pkg/apis/jenkins.io/v1"
"github.com/jenkins-x/jx-logging/pkg/log"
"github.com/jenkins-x/jx/v2/pkg/addon"
"github.com/jenkins-x/jx/v2/pkg/auth"
"github.com/jenkins-x/jx/v2/pkg/cloud/aks"
"github.com/jenkins-x/jx/v2/pkg/cloud/amazon"
"github.com/jenkins-x/jx/v2/pkg/cloud/iks"
"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/features"
"github.com/jenkins-x/jx/v2/pkg/gits"
"github.com/jenkins-x/jx/v2/pkg/helm"
configio "github.com/jenkins-x/jx/v2/pkg/io"
"github.com/jenkins-x/jx/v2/pkg/kube"
"github.com/jenkins-x/jx/v2/pkg/util"
pkgvault "github.com/jenkins-x/jx/v2/pkg/vault"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"gopkg.in/AlecAivazis/survey.v1"
"gopkg.in/src-d/go-git.v4"
core_v1 "k8s.io/api/core/v1"
storagev1 "k8s.io/api/storage/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
)
// ModifySecretCallback a callback for modifying a Secret for a given name
type ModifySecretCallback func(string, func(*core_v1.Secret) error) (*core_v1.Secret, error)
// ModifyConfigMapCallback a callback for modifying a ConfigMap for a given name
type ModifyConfigMapCallback func(string, func(*core_v1.ConfigMap) error) (*core_v1.ConfigMap, error)
// InstallOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of
// referencing the cmd.Flags()
type InstallOptions struct {
*opts.CommonOptions
gits.GitRepositoryOptions
CreateJenkinsUserOptions
CreateEnvOptions
config.AdminSecretsService
kubevault.AWSConfig
InitOptions initcmd.InitOptions
Flags InstallFlags `mapstructure:"install"`
modifyConfigMapCallback ModifyConfigMapCallback
modifySecretCallback ModifySecretCallback
installValues map[string]string
}
// InstallFlags flags for the install command
type InstallFlags struct {
ConfigFile string
InstallOnly bool
Domain string
ExposeControllerURLTemplate string
ExposeControllerPathMode string
AzureRegistrySubscription string
DockerRegistry string
DockerRegistryOrg string
Provider string
VersionsRepository string
VersionsGitRef string
Version string
LocalHelmRepoName string
Namespace string
CloudEnvRepository string
NoDefaultEnvironments bool
RemoteEnvironments bool
DefaultEnvironmentPrefix string
LocalCloudEnvironment bool
EnvironmentGitOwner string
Timeout string
HelmTLS bool
RegisterLocalHelmRepo bool
CleanupTempFiles bool
Prow bool
DisableSetKubeContext bool
Dir string
Vault bool
RecreateVaultBucket bool
Tekton bool
BuildPackName string
Kaniko bool
GitOpsMode bool
NoGitOpsEnvApply bool
NoGitOpsEnvRepo bool
NoGitOpsEnvSetup bool
NoGitOpsVault bool
NextGeneration bool `mapstructure:"next-generation"`
StaticJenkins bool
LongTermStorage bool `mapstructure:"long-term-storage"`
LongTermStorageBucketName string `mapstructure:"lts-bucket"`
}
// Secrets struct for secrets
type Secrets struct {
Login string
Token string
}
const (
JX_GIT_TOKEN = "JX_GIT_TOKEN" // #nosec
JX_GIT_USER = "JX_GIT_USER"
ServerlessJenkins = "Serverless Jenkins X Pipelines with Tekton"
GitOpsChartYAML = `name: env
version: 0.0.1
description: GitOps Environment for this Environment
maintainers:
- name: Team
icon: https://www.cloudbees.com/sites/default/files/Jenkins_8.png
`
devGitOpsGitIgnore = `
# lets not accidentally check in Secret YAMLs!
secrets.yaml
mysecrets.yaml
`
devGitOpsReadMe = `
## Jenkins X Development Environment
This repository contains the source code for the Jenkins X Development Environment so that it can be managed via GitOps.
`
devGitOpsJenkinsfile = `pipeline {
agent {
label "jenkins-jx-base"
}
environment {
DEPLOY_NAMESPACE = "%s"
}
stages {
stage('Validate Environment') {
steps {
container('jx-base') {
dir('env') {
sh 'jx step helm build'
}
}
}
}
stage('Update Environment') {
when {
branch 'master'
}
steps {
container('jx-base') {
dir('env') {
sh 'jx step env apply'
}
}
}
}
}
}
`
devGitOpsJenkinsfileProw = `pipeline {
agent any
environment {
DEPLOY_NAMESPACE = "%s"
}
stages {
stage('Validate Environment') {
steps {
dir('env') {
sh 'jx step helm build'
}
}
}
stage('Update Environment') {
when {
branch 'master'
}
steps {
dir('env') {
sh 'jx step env apply'
}
}
}
}
}
`
longTermStorageFlagName = "long-term-storage"
ltsBucketFlagName = "lts-bucket"
kanikoFlagName = "kaniko"
namespaceFlagName = "namespace"
tektonFlagName = "tekton"
prowFlagName = "prow"
staticJenkinsFlagName = "static-jenkins"
gitOpsFlagName = "gitops"
)
var (
InstalLong = templates.LongDesc(`
Installs the Jenkins X platform on a Kubernetes cluster
Requires a --git-username and --git-api-token that can be used to create a new token.
This is so the Jenkins X platform can git tag your releases
For more documentation see: [https://jenkins-x.io/getting-started/install-on-cluster/](https://jenkins-x.io/getting-started/install-on-cluster/)
The current requirements are:
*RBAC is enabled on the cluster
*Insecure Docker registry is enabled for Docker registries running locally inside Kubernetes on the service IP range. See the above documentation for more detail
`)
InstalExample = templates.Examples(`
# Default installer which uses interactive prompts to generate git secrets
jx install
# Install with a GitHub personal access token
jx install --git-username jenkins-x-bot --git-api-token 9fdbd2d070cd81eb12bca87861bcd850
# If you know the cloud provider you can pass this as a CLI argument. E.g. for AWS
jx install --provider=aws
`)
)
// NewCmdInstall creates a command object for the generic "install" action, which
// installs the jenkins-x platform on a Kubernetes cluster.
func NewCmdInstall(commonOpts *opts.CommonOptions) *cobra.Command {
options := CreateInstallOptions(commonOpts)
cmd := &cobra.Command{
Use: "install [flags]",
Short: "Install Jenkins X in the current Kubernetes cluster",
Long: InstalLong,
Example: InstalExample,
Run: func(cmd *cobra.Command, args []string) {
options.Cmd = cmd
options.Args = args
err := options.Run()
helper.CheckErr(err)
},
}
options.AddInstallFlags(cmd, false)
cmd.Flags().StringVarP(&options.Flags.Provider, "provider", "", "", "Cloud service providing the Kubernetes cluster. Supported providers: "+cloud.KubernetesProviderOptions())
cmd.AddCommand(NewCmdInstallDependencies(commonOpts))
cmdvault.AwsCreateVaultOptions(cmd, &options.AWSConfig)
return cmd
}
// CreateInstallOptions creates the options for jx install
func CreateInstallOptions(commonOpts *opts.CommonOptions) InstallOptions {
commonOptsBatch := *commonOpts
commonOptsBatch.BatchMode = true
options := InstallOptions{
CreateJenkinsUserOptions: CreateJenkinsUserOptions{
Username: "admin",
CreateOptions: createoptions.CreateOptions{
CommonOptions: commonOpts,
},
},
GitRepositoryOptions: gits.GitRepositoryOptions{},
CommonOptions: commonOpts,
CreateEnvOptions: CreateEnvOptions{
HelmValuesConfig: config.HelmValuesConfig{
ExposeController: &config.ExposeController{
Config: config.ExposeControllerConfig{
HTTP: "true",
TLSAcme: "false",
Exposer: "Ingress",
},
},
},
Options: v1.Environment{
ObjectMeta: metav1.ObjectMeta{},
Spec: v1.EnvironmentSpec{
PromotionStrategy: v1.PromotionStrategyTypeAutomatic,
},
},
PromotionStrategy: string(v1.PromotionStrategyTypeAutomatic),
ForkEnvironmentGitRepo: kube.DefaultEnvironmentGitRepoURL,
CreateOptions: createoptions.CreateOptions{
CommonOptions: &commonOptsBatch,
},
},
InitOptions: initcmd.InitOptions{
CommonOptions: commonOpts,
Flags: initcmd.InitFlags{},
},
AdminSecretsService: config.AdminSecretsService{},
}
return options
}
func (options *InstallOptions) AddInstallFlags(cmd *cobra.Command, includesInit bool) {
flags := &options.Flags
flags.AddCloudEnvOptions(cmd)
cmd.Flags().StringVarP(&flags.LocalHelmRepoName, "local-helm-repo-name", "", kube.LocalHelmRepoName, "The name of the helm repository for the installed ChartMuseum")
cmd.Flags().BoolVarP(&flags.NoDefaultEnvironments, "no-default-environments", "", false, "Disables the creation of the default Staging and Production environments")
cmd.Flags().BoolVarP(&flags.RemoteEnvironments, "remote-environments", "", false, "Indicates you intend Staging and Production environments to run in remote clusters. See https://jenkins-x.io/getting-started/multi-cluster/")
cmd.Flags().StringVarP(&flags.DefaultEnvironmentPrefix, "default-environment-prefix", "", "", "Default environment repo prefix, your Git repos will be of the form 'environment-$prefix-$envName'")
cmd.Flags().StringVarP(&flags.Namespace, namespaceFlagName, "", "jx", "The namespace the Jenkins X platform should be installed into")
cmd.Flags().StringVarP(&flags.Timeout, "timeout", "", opts.DefaultInstallTimeout, "The number of seconds to wait for the helm install to complete")
cmd.Flags().StringVarP(&flags.EnvironmentGitOwner, "environment-git-owner", "", "", "The Git provider organisation to create the environment Git repositories in")
cmd.Flags().BoolVarP(&flags.RegisterLocalHelmRepo, "register-local-helmrepo", "", false, "Registers the Jenkins X ChartMuseum registry with your helm client [default false]")
cmd.Flags().BoolVarP(&flags.CleanupTempFiles, "cleanup-temp-files", "", true, "Cleans up any temporary values.yaml used by helm install [default true]")
cmd.Flags().BoolVarP(&flags.HelmTLS, "helm-tls", "", false, "Whether to use TLS with helm")
cmd.Flags().BoolVarP(&flags.InstallOnly, "install-only", "", false, "Force the install command to fail if there is already an installation. Otherwise lets update the installation")
cmd.Flags().StringVarP(&flags.AzureRegistrySubscription, "azure-acr-subscription", "", "", "The Azure subscription under which the specified docker-registry is located")
cmd.Flags().StringVarP(&flags.DockerRegistry, "docker-registry", "", "", "The Docker Registry host or host:port which is used when tagging and pushing images. If not specified it defaults to the internal registry unless there is a better provider default (e.g. ECR on AWS/EKS)")
cmd.Flags().StringVarP(&flags.DockerRegistryOrg, "docker-registry-org", "", "", "The Docker Registry organiation/user to create images inside. On GCP this is typically your Google Project ID.")
cmd.Flags().StringVarP(&flags.ExposeControllerURLTemplate, "exposecontroller-urltemplate", "", "", "The ExposeController urltemplate for how services should be exposed as URLs. Defaults to being empty, which in turn defaults to \"{{.Service}}.{{.Namespace}}.{{.Domain}}\".")
cmd.Flags().StringVarP(&flags.ExposeControllerPathMode, "exposecontroller-pathmode", "", "", "The ExposeController path mode for how services should be exposed as URLs. Defaults to using subnets. Use a value of `path` to use relative paths within the domain host such as when using AWS ELB host names")
cmd.Flags().StringVarP(&flags.Version, "version", "", "", "The specific platform version to install")
cmd.Flags().BoolVarP(&flags.Prow, prowFlagName, "", false, "Enable Prow to implement Serverless Jenkins and support ChatOps on Pull Requests")
cmd.Flags().BoolVarP(&flags.Tekton, tektonFlagName, "", false, "Enables the Tekton pipeline engine (which used to be called knative build pipeline) along with Prow to provide Serverless Jenkins. Otherwise we default to use Knative Build if you enable Prow")
cmd.Flags().BoolVarP(&flags.GitOpsMode, gitOpsFlagName, "", false, "Creates a git repository for the Dev environment to manage the installation, configuration, upgrade and addition of Apps in Jenkins X all via GitOps")
cmd.Flags().BoolVarP(&flags.NoGitOpsEnvApply, "no-gitops-env-apply", "", false, "When using GitOps to create the source code for the development environment and installation, don't run 'jx step env apply' to perform the install")
cmd.Flags().BoolVarP(&flags.NoGitOpsEnvRepo, "no-gitops-env-repo", "", false, "When using GitOps to create the source code for the development environment this flag disables the creation of a git repository for the source code")
cmd.Flags().BoolVarP(&flags.NoGitOpsVault, "no-gitops-vault", "", false, "When using GitOps to create the source code for the development environment this flag disables the creation of a vault")
cmd.Flags().BoolVarP(&flags.NoGitOpsEnvSetup, "no-gitops-env-setup", "", false, "When using GitOps to install the development environment this flag skips the post-install setup")
cmd.Flags().BoolVarP(&flags.Vault, "vault", "", false, "Sets up a Hashicorp Vault for storing secrets during installation (supported only for GKE)")
cmd.Flags().BoolVarP(&flags.RecreateVaultBucket, "vault-bucket-recreate", "", true, "If the vault bucket already exists delete it then create it empty")
cmd.Flags().StringVarP(&flags.BuildPackName, "buildpack", "", "", "The name of the build pack to use for the Team")
cmd.Flags().BoolVarP(&flags.Kaniko, kanikoFlagName, "", false, "Use Kaniko for building docker images")
cmd.Flags().BoolVarP(&flags.NextGeneration, "ng", "", false, "Use the Next Generation Jenkins X features like Prow, Tekton, No Tiller, Vault, Dev GitOps")
cmd.Flags().BoolVarP(&flags.StaticJenkins, staticJenkinsFlagName, "", false, "Install a static Jenkins master to use as the pipeline engine. Note this functionality is deprecated in favour of running serverless Tekton builds")
cmd.Flags().BoolVarP(&flags.LongTermStorage, longTermStorageFlagName, "", false, "Enable the Long Term Storage option to save logs and other assets into a GCS bucket (supported only for GKE)")
cmd.Flags().StringVarP(&flags.LongTermStorageBucketName, ltsBucketFlagName, "", "", "The bucket to use for Long Term Storage. If the bucket doesn't exist, an attempt will be made to create it, otherwise random naming will be used")
cmd.Flags().StringVar(&options.ConfigFile, "config-file", "", "Configuration file used for installation")
cmd.Flags().BoolVar(&options.NoBrew, opts.OptionNoBrew, false, "Disables brew package manager on MacOS when installing binary dependencies")
cmd.Flags().BoolVar(&options.InstallDependencies, opts.OptionInstallDeps, false, "Enables automatic dependencies installation when required")
cmd.Flags().BoolVar(&options.SkipAuthSecretsMerge, opts.OptionSkipAuthSecMerge, false, "Skips merging the secrets from local files with the secrets from Kubernetes cluster")
bindInstallConfigToFlags(cmd)
opts.AddGitRepoOptionsArgumentsWithGithubDefault(cmd, &options.GitRepositoryOptions)
options.HelmValuesConfig.AddExposeControllerValues(cmd, true)
options.AdminSecretsService.AddAdminSecretsValues(cmd)
options.InitOptions.AddInitFlags(cmd)
}
func bindInstallConfigToFlags(cmd *cobra.Command) {
_ = viper.BindPFlag(installConfigKey(namespaceFlagName), cmd.Flags().Lookup(namespaceFlagName))
_ = viper.BindPFlag(installConfigKey(kanikoFlagName), cmd.Flags().Lookup(kanikoFlagName))
_ = viper.BindPFlag(installConfigKey(tektonFlagName), cmd.Flags().Lookup(tektonFlagName))
_ = viper.BindPFlag(installConfigKey(prowFlagName), cmd.Flags().Lookup(prowFlagName))
_ = viper.BindPFlag(installConfigKey(gitOpsFlagName), cmd.Flags().Lookup(gitOpsFlagName))
_ = viper.BindPFlag(installConfigKey("next-generation"), cmd.Flags().Lookup("ng"))
_ = viper.BindPFlag(installConfigKey(staticJenkinsFlagName), cmd.Flags().Lookup(staticJenkinsFlagName))
}
func (flags *InstallFlags) AddCloudEnvOptions(cmd *cobra.Command) {
cmd.Flags().StringVarP(&flags.CloudEnvRepository, "cloud-environment-repo", "", opts.DefaultCloudEnvironmentsURL, "Cloud Environments Git repo")
cmd.Flags().StringVarP(&flags.VersionsRepository, "versions-repo", "", config.DefaultVersionsURL, "Jenkins X versions Git repo")
cmd.Flags().StringVarP(&flags.VersionsGitRef, "versions-ref", "", "", "Jenkins X versions Git repository reference (tag, branch, sha etc)")
cmd.Flags().BoolVarP(&flags.LocalCloudEnvironment, "local-cloud-environment", "", false, "Ignores default cloud-environment-repo and uses current directory ")
}
// CheckFlags validates & configures install flags
func (options *InstallOptions) CheckFlags() error {
log.Logger().Debug("checking installation flags")
flags := &options.Flags
if flags.StaticJenkins {
return fmt.Errorf("option '--static-jenkins' has been removed")
}
if flags.Prow {
flags.Tekton = true
}
if flags.Tekton {
flags.Prow = true
if !options.InitOptions.Flags.NoTiller {
log.Logger().Warnf("note that if using Serverless Jenkins with Tekton we recommend the extra flag: %s", util.ColorInfo("--no-tiller"))
}
}
if options.BatchMode && !flags.NextGeneration && !flags.Tekton && !flags.Prow {
flags.Tekton = true
flags.Prow = true
flags.Kaniko = true
options.InitOptions.Flags.NoTiller = true
}
if flags.NextGeneration {
flags.GitOpsMode = true
flags.Vault = true
flags.Prow = true
flags.Tekton = true
flags.Kaniko = true
options.InitOptions.Flags.NoTiller = true
}
// only kaniko is supported as a builder in tekton
if flags.Tekton {
if flags.Provider == cloud.GKE {
if !flags.Kaniko {
log.Logger().Warnf("When using tekton, only kaniko is supported as a builder")
}
flags.Kaniko = true
}
}
// check some flags combination for GitOps mode
if flags.GitOpsMode {
options.SkipAuthSecretsMerge = true
flags.DisableSetKubeContext = true
if !flags.Vault {
log.Logger().Warnf("GitOps mode requires %s.", util.ColorInfo("vault"))
}
initFlags := &options.InitOptions.Flags
if !initFlags.NoTiller {
log.Logger().Warnf("GitOps mode requires helm without tiller server. %s flag is automatically set", util.ColorInfo("no-tiller"))
initFlags.NoTiller = true
}
}
// If we're using external-dns then remove the namespace subdomain from the URLTemplate
if options.InitOptions.Flags.ExternalDNS {
flags.ExposeControllerURLTemplate = `"{{.Service}}-{{.Namespace}}.{{.Domain}}"`
}
// Make sure that the default environment prefix is configured. Typically it is the cluster
// name when the install command is called from create cluster.
if flags.DefaultEnvironmentPrefix == "" {
clusterName := options.installValues[kube.ClusterName]
if clusterName == "" {
flags.DefaultEnvironmentPrefix = strings.ToLower(randomdata.SillyName())
} else {
flags.DefaultEnvironmentPrefix = clusterName
}
}
if flags.DockerRegistry == "" {
dockerReg, err := options.dockerRegistryValue()
if err != nil {
log.Logger().Warnf("unable to calculate docker registry values - %s", err)
}
flags.DockerRegistry = dockerReg
}
// lets default the docker registry org to the project id
if flags.DockerRegistryOrg == "" {
flags.DockerRegistryOrg = options.installValues[kube.ProjectID]
}
log.Logger().Debugf("flags after checking - %+v", flags)
if flags.Tekton {
kind := options.GitRepositoryOptions.ServerKind
if kind != "" && kind != gits.KindGitHub {
return fmt.Errorf("Git provider: %s is not yet supported for Tekton.\nYou can work around this with '--static-jenkins'\nFor more details see: https://jenkins-x.io/about/status/", kind)
}
}
return nil
}
// CheckFeatures - determines if the various features have been enabled
func (options *InstallOptions) CheckFeatures() error {
if options.Flags.Tekton {
return features.CheckTektonEnabled()
}
return nil
}
// Run implements this command
func (options *InstallOptions) Run() error {
err := options.GetConfiguration(&options)
if err != nil {
return errors.Wrap(err, "getting install configuration")
}
err = options.selectJenkinsInstallation()
if err != nil {
return errors.Wrap(err, "selecting the Jenkins installation type")
}
// Check the provided flags before starting any installation
err = options.CheckFlags()
if err != nil {
return errors.Wrap(err, "checking the provided flags")
}
configStore := configio.NewFileStore()
ns, originalNs, err := options.setupNamespace()
if err != nil {
return errors.Wrap(err, "setting up current namespace")
}
client, err := options.KubeClient()
if err != nil {
return errors.Wrap(err, "creating the kube client")
}
err = options.registerAllCRDs()
if err != nil {
return errors.Wrap(err, "registering all CRDs")
}
gitOpsDir, gitOpsEnvDir, err := options.configureGitOpsMode(configStore, ns)
if err != nil {
return errors.Wrap(err, "configuring the GitOps mode")
}
options.configureHelm(client, ns)
err = options.installHelmBinaries()
if err != nil {
return errors.Wrap(err, "installing helm binaries")
}
err = options.configureKubectl(ns)
if err != nil {
return errors.Wrap(err, "configure the kubectl")
}
err = options.installCloudProviderDependencies()
if err != nil {
return errors.Wrap(err, "installing cloud provider dependencies")
}
options.Flags.Provider, err = options.GetCloudProvider(options.Flags.Provider)
if err != nil {
return errors.Wrapf(err, "retrieving cloud provider '%s'", options.Flags.Provider)
}
err = options.configureTeamSettings()
if err != nil {
return errors.Wrap(err, "configuring the team settings in the dev environment")
}
err = options.configureCloudProviderPreInit(client)
if err != nil {
return errors.Wrap(err, "configuring the cloud provider before initializing the platform")
}
err = options.init()
if err != nil {
return errors.Wrap(err, "initializing the Jenkins X platform")
}
err = options.configureCloudProivderPostInit(client, ns)
if err != nil {
return errors.Wrap(err, "configuring the cloud provider after initializing the platform")
}
ic, err := options.saveIngressConfig()
if err != nil {
return errors.Wrap(err, "saving the ingress configuration in a ConfigMap")
}
err = options.configureLongTermStorageBucket()
if err != nil {
return errors.Wrap(err, "configuring Long Term Storage")
}
err = options.createSystemVault(client, ns, ic)
if err != nil {
return errors.Wrap(err, "creating the system vault")
}
err = options.saveClusterConfig()
if err != nil {
return errors.Wrap(err, "saving the cluster configuration in a ConfigMap")
}
err = options.configureGitAuth()
if err != nil {
return errors.Wrap(err, "configuring the git auth")
}
err = options.configureDockerRegistry(client, ns)
if err != nil {
return errors.Wrap(err, "configuring the docker registry")
}
versionsRepoDir, _, err := options.CloneJXVersionsRepo(options.Flags.VersionsRepository, options.Flags.VersionsGitRef)
if err != nil {
return errors.Wrap(err, "cloning the jx versions repo")
}
cloudEnvDir, err := options.CloneJXCloudEnvironmentsRepo()
if err != nil {
return errors.Wrap(err, "cloning the jx cloud environments repo")
}
err = options.ConfigureKaniko()
if err != nil {
return errors.Wrap(err, "unable to generate the Kaniko configuration")
}
err = options.configureHelmValues(ns)
if err != nil {
return errors.Wrap(err, "configuring helm values")
}
if options.Flags.Provider == "" {
return fmt.Errorf("no Kubernetes provider found to match cloud-environment with")
}
providerEnvDir := filepath.Join(cloudEnvDir, fmt.Sprintf("env-%s", strings.ToLower(options.Flags.Provider)))
valuesFiles, secretsFiles, temporaryFiles, err := options.getHelmValuesFiles(configStore, providerEnvDir)
if err != nil {
return errors.Wrap(err, "getting the helm value files")
}
log.Logger().Debugf("Installing Jenkins X platform helm chart from: %s", providerEnvDir)
err = options.configureHelmRepo()
if err != nil {
return errors.Wrap(err, "configuring the Jenkins X helm repository")
}
err = options.configureProwInTeamSettings()
if err != nil {
return errors.Wrap(err, "configuring Prow in team settings")
}
err = options.configureAndInstallProw(ns, gitOpsEnvDir, valuesFiles)
if err != nil {
return errors.Wrap(err, "configuring and installing Prow")
}
err = options.verifyTiller(client, ns)
if err != nil {
return errors.Wrap(err, "verifying Tiller is running")
}
err = options.configureBuildPackMode()
if err != nil {
return errors.Wrap(err, "configuring the build pack mode")
}
log.Logger().Infof("Installing jx into namespace %s", util.ColorInfo(ns))
version, err := options.getPlatformVersion(versionsRepoDir, configStore)
if err != nil {
return errors.Wrap(err, "getting the platform version")
}
log.Logger().Infof("Installing jenkins-x-platform version: %s", util.ColorInfo(version))
if options.Flags.GitOpsMode {
err := options.installPlatformGitOpsMode(gitOpsEnvDir, gitOpsDir, configStore, kube.DefaultChartMuseumURL,
platform.JenkinsXPlatformChartName, ns, version, valuesFiles, secretsFiles)
if err != nil {
return errors.Wrap(err, "installing the Jenkins X platform in GitOps mode")
}
} else {
err := options.installPlatform(providerEnvDir, platform.JenkinsXPlatformChart, platform.JenkinsXPlatformRelease,
ns, version, valuesFiles, secretsFiles)
if err != nil {
return errors.Wrap(err, "installing the Jenkins X platform")
}
}
if options.Flags.CleanupTempFiles {
err := options.cleanupTempFiles(temporaryFiles)
if err != nil {
return errors.Wrap(err, "cleaning up the temporary files")
}
}
err = options.configureImportModeInTeamSettings()
if err != nil {
return errors.Wrap(err, "configuring ImportMode in team settings")
}
err = options.configureTillerInDevEnvironment()
if err != nil {
return errors.Wrap(err, "configuring Tiller in the dev environment")
}
err = options.configureHelm3(ns)
if err != nil {
return errors.Wrap(err, "configuring helm3")
}
err = options.installAddons()
if err != nil {
return errors.Wrap(err, "installing the Jenkins X Addons")
}
// Jenkins needs to be configured already here if running in non GitOps mode
// in order to be able to create the environments
if !options.Flags.GitOpsMode {
err = options.configureJenkins(ns)
if err != nil {
return errors.Wrap(err, "configuring Jenkins")
}
}
err = options.createEnvironments(ns)
if err != nil {
if strings.Contains(err.Error(), "com.atlassian.bitbucket.project.NoSuchProjectException") {
log.Logger().Infof("\nProject %s cannot be found. If you are using BitBucket Server, please use "+
"a project code instead of a project name (for example 'MYPR' instead of 'myproject'). ",
util.ColorInfo(options.CreateEnvOptions.GitRepositoryOptions.Owner))
return nil
}
return errors.Wrap(err, "creating the environments")
}
err = options.saveChartmuseumAuthConfig()
if err != nil {
return errors.Wrap(err, "saving the ChartMuseum auth configuration")
}
if options.Flags.RegisterLocalHelmRepo {
err = options.RegisterLocalHelmRepo(options.Flags.LocalHelmRepoName, ns)
if err != nil {
return errors.Wrapf(err, "registering the local helm repo '%s'", options.Flags.LocalHelmRepoName)
}
}
gitOpsEnvDir, err = options.generateGitOpsDevEnvironmentConfig(gitOpsDir)
if err != nil {
return errors.Wrap(err, "generating the GitOps development environment config")
}
err = options.applyGitOpsDevEnvironmentConfig(gitOpsEnvDir, ns)
if err != nil {
return errors.Wrap(err, "applying the GitOps development environment config")
}
err = options.setupGitOpsPostApply(ns)
if err != nil {
return errors.Wrap(err, "setting up GitOps post installation")
}
log.Logger().Infof("\nJenkins X installation completed successfully")
options.logAdminPassword()
options.logNameServers()
log.Logger().Infof("Your Kubernetes context is now set to the namespace: %s ", util.ColorInfo(ns))
log.Logger().Infof("To switch back to your original namespace use: %s", util.ColorInfo("jx namespace "+originalNs))
log.Logger().Infof("Or to use this context/namespace in just one terminal use: %s", util.ColorInfo("jx shell"))
log.Logger().Infof("For help on switching contexts see: %s\n", util.ColorInfo("https://jenkins-x.io/developing/kube-context/"))
log.Logger().Infof("To import existing projects into Jenkins X: %s", util.ColorInfo("jx import"))
log.Logger().Infof("To create a new Spring Boot microservice: %s", util.ColorInfo("jx create spring -d web -d actuator"))
log.Logger().Infof("To create a new microservice from a quickstart: %s", util.ColorInfo("jx create quickstart"))
return nil
}
func (options *InstallOptions) configureKubectl(namespace string) error {
if !options.Flags.DisableSetKubeContext {
context, err := options.GetCommandOutput("", "kubectl", "config", "current-context")
if err != nil {
return errors.Wrap(err, "failed to retrieve the current context from kube configuration")
}
err = options.RunCommand("kubectl", "config", "set-context", context, "--namespace", namespace)
if err != nil {
return errors.Wrapf(err, "failed to set the context '%s' in kube configuration", context)
}
}
return nil
}
func (options *InstallOptions) setupNamespace() (string, string, error) {
_, originalNs, err := options.KubeClientAndNamespace()
if err != nil {
return "", "", errors.Wrap(err, "creating kube client")
}
ns := options.Flags.Namespace
if ns == "" {
ns = originalNs
}
options.SetDevNamespace(ns)
return ns, originalNs, nil
}
func (options *InstallOptions) init() error {
initOpts := &options.InitOptions
initOpts.Flags.Provider = options.Flags.Provider
initOpts.Flags.Namespace = options.Flags.Namespace
initOpts.BatchMode = options.BatchMode
initOpts.Flags.VersionsRepository = options.Flags.VersionsRepository
initOpts.Flags.Http = true
exposeController := options.CreateEnvOptions.HelmValuesConfig.ExposeController
if exposeController != nil {
initOpts.Flags.Http = exposeController.Config.HTTP == "true"
}
if initOpts.Flags.Domain == "" && options.Flags.Domain != "" {
initOpts.Flags.Domain = options.Flags.Domain
}
if initOpts.Flags.NoTiller {
initOpts.SetHelm(nil)
}
// configure local tiller if this is required
if !initOpts.Flags.RemoteTiller && !initOpts.Flags.NoTiller {
err := helm.RestartLocalTiller()
if err != nil {
return errors.Wrap(err, "restarting local tiller")
}
initOpts.SetHelm(options.Helm())
}
// configure the helm values for expose controller
if exposeController != nil {
ecConfig := &exposeController.Config
if ecConfig.Domain == "" && options.Flags.Domain != "" {
ecConfig.Domain = options.Flags.Domain
log.Logger().Infof("set exposeController Config Domain %s", ecConfig.Domain)
}
if ecConfig.PathMode == "" && options.Flags.ExposeControllerPathMode != "" {
ecConfig.PathMode = options.Flags.ExposeControllerPathMode
log.Logger().Infof("set exposeController Config PathMode %s", ecConfig.PathMode)
}
if (ecConfig.URLTemplate == "" && options.Flags.ExposeControllerURLTemplate != "") ||
(options.Flags.ExposeControllerURLTemplate != "" && options.InitOptions.Flags.ExternalDNS) {
ecConfig.URLTemplate = options.Flags.ExposeControllerURLTemplate
log.Logger().Infof("set exposeController Config URLTemplate %s", ecConfig.URLTemplate)
}
if isOpenShiftProvider(options.Flags.Provider) {
ecConfig.Exposer = "Route"
}
}
err := initOpts.Run()
if err != nil {
return errors.Wrap(err, "initializing the Jenkins X platform")
}
// update the domain if was modified during the initialization
domain := exposeController.Config.Domain
if domain == "" {
domain = initOpts.Flags.Domain
}
if domain == "" {
client, err := options.KubeClient()
if err != nil {
return errors.Wrap(err, "getting the kubernetes client")
}
ingNamespace := initOpts.Flags.IngressNamespace
ingService := initOpts.Flags.IngressService
extIP := initOpts.Flags.ExternalIP
domain, err = options.GetDomain(client, domain,
options.Flags.Provider,
ingNamespace,
ingService,
extIP)
if err != nil {
return errors.Wrapf(err, "getting a domain for ingress service %s/%s", ingNamespace, ingService)
}
}
// checking if the domain is by any chance empty and bail out
if domain == "" {
return fmt.Errorf("the installation cannot proceed with an empty domain. Please provide a domain in the %s option",
util.ColorInfo("domain"))
}
options.Flags.Domain = domain
exposeController.Config.Domain = domain
return nil
}
func (options *InstallOptions) getPlatformVersion(cloudEnvDir string,
configStore configio.ConfigStore) (string, error) {
version := options.Flags.Version
var err error
if version == "" {
version, err = LoadVersionFromCloudEnvironmentsDir(cloudEnvDir, configStore)
if err != nil {
return "", errors.Wrap(err, "failed to load version from cloud environments dir")
}
}
return version, nil
}
func (options *InstallOptions) installPlatform(providerEnvDir string, jxChart string, jxRelName string,
namespace string, version string, valuesFiles []string, secretsFiles []string) error {
options.Helm().SetCWD(providerEnvDir)
timeout := options.Flags.Timeout
if timeout == "" {
timeout = opts.DefaultInstallTimeout
}
allValuesFiles := []string{}
allValuesFiles = append(allValuesFiles, valuesFiles...)
allValuesFiles = append(allValuesFiles, secretsFiles...)
for _, f := range allValuesFiles {
log.Logger().Debugf("Adding values file %s", util.ColorInfo(f))
}
helmOpts := helm.InstallChartOptions{
ReleaseName: jxRelName,
Chart: jxChart,
Ns: namespace,
Version: version,
ValueFiles: allValuesFiles,
InstallOnly: options.Flags.InstallOnly,
NoForce: true,
}
err := options.InstallChartWithOptionsAndTimeout(helmOpts, timeout)
if err != nil {
return errors.Wrap(err, "failed to install/upgrade the jenkins-x platform chart")
}
err = options.waitForInstallToBeReady(namespace)
if err != nil {
return errors.Wrap(err, "failed to wait for jenkins-x chart installation to be ready")
}
log.Logger().Infof("Jenkins X deployments ready in namespace %s", namespace)
return nil
}
func (options *InstallOptions) installPlatformGitOpsMode(gitOpsEnvDir string, gitOpsDir string, configStore configio.ConfigStore,
chartRepository string, chartName string, namespace string, version string, valuesFiles []string, secretsFiles []string) error {
options.CreateEnvOptions.NoDevNamespaceInit = true
chartFile := filepath.Join(gitOpsEnvDir, helm.ChartFileName)
requirementsFile := filepath.Join(gitOpsEnvDir, helm.RequirementsFileName)
secretsFile := filepath.Join(gitOpsEnvDir, helm.SecretsFileName)
valuesFile := filepath.Join(gitOpsEnvDir, helm.ValuesFileName)
platformDep := &helm.Dependency{
Name: platform.JenkinsXPlatformChartName,
Version: version,
Repository: kube.DefaultChartMuseumURL,
}
requirements := &helm.Requirements{
Dependencies: []*helm.Dependency{platformDep},
}
// lets handle if the requirements.yaml already exists we may have added some initial apps like prow etc
exists, err := util.FileExists(requirementsFile)