-
Notifications
You must be signed in to change notification settings - Fork 148
/
piped.go
1242 lines (1117 loc) · 36.8 KB
/
piped.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
// Copyright 2023 The PipeCD Authors.
//
// 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 config
import (
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"os"
"strings"
"github.com/pipe-cd/pipecd/pkg/model"
)
const (
maskString = "******"
)
var defaultKubernetesPlatformProvider = PipedPlatformProvider{
Name: "kubernetes-default",
Type: model.PlatformProviderKubernetes,
KubernetesConfig: &PlatformProviderKubernetesConfig{},
}
// PipedSpec contains configurable data used to while running Piped.
type PipedSpec struct {
// The identifier of the PipeCD project where this piped belongs to.
ProjectID string `json:"projectID"`
// The unique identifier generated for this piped.
PipedID string `json:"pipedID"`
// The path to the file containing the generated Key string for this piped.
PipedKeyFile string `json:"pipedKeyFile,omitempty"`
// Base64 encoded string of Piped key.
PipedKeyData string `json:"pipedKeyData,omitempty"`
// The name of this piped.
Name string `json:"name,omitempty"`
// The address used to connect to the control-plane's API.
APIAddress string `json:"apiAddress"`
// The address to the control-plane's Web.
WebAddress string `json:"webAddress,omitempty"`
// How often to check whether an application should be synced.
// Default is 1m.
SyncInterval Duration `json:"syncInterval,omitempty" default:"1m"`
// How often to check whether an application configuration file should be synced.
// Default is 1m.
AppConfigSyncInterval Duration `json:"appConfigSyncInterval,omitempty" default:"1m"`
// Git configuration needed for git commands.
Git PipedGit `json:"git,omitempty"`
// List of git repositories this piped will handle.
Repositories []PipedRepository `json:"repositories,omitempty"`
// List of helm chart repositories that should be added while starting up.
ChartRepositories []HelmChartRepository `json:"chartRepositories,omitempty"`
// List of helm chart registries that should be logged in while starting up.
ChartRegistries []HelmChartRegistry `json:"chartRegistries,omitempty"`
// List of cloud providers can be used by this piped.
// Deprecated: use PlatformProvider instead.
CloudProviders []PipedPlatformProvider `json:"cloudProviders,omitempty"`
// List of platform providers can be used by this piped.
PlatformProviders []PipedPlatformProvider `json:"platformProviders,omitempty"`
// List of analysis providers can be used by this piped.
AnalysisProviders []PipedAnalysisProvider `json:"analysisProviders,omitempty"`
// Sending notification to Slack, Webhook…
Notifications Notifications `json:"notifications"`
// What secret management method should be used.
SecretManagement *SecretManagement `json:"secretManagement,omitempty"`
// Optional settings for event watcher.
EventWatcher PipedEventWatcher `json:"eventWatcher"`
// List of labels to filter all applications this piped will handle.
AppSelector map[string]string `json:"appSelector,omitempty"`
}
func (s *PipedSpec) UnmarshalJSON(data []byte) error {
type Alias PipedSpec
ps := &struct {
*Alias
}{
Alias: (*Alias)(s),
}
if err := json.Unmarshal(data, &ps); err != nil {
return err
}
// Add all CloudProviders configuration as PlatformProviders configuration.
s.PlatformProviders = append(s.PlatformProviders, ps.CloudProviders...)
s.CloudProviders = nil
return nil
}
// Validate validates configured data of all fields.
func (s *PipedSpec) Validate() error {
if s.ProjectID == "" {
return errors.New("projectID must be set")
}
if s.PipedID == "" {
return errors.New("pipedID must be set")
}
if s.PipedKeyData == "" && s.PipedKeyFile == "" {
return errors.New("either pipedKeyFile or pipedKeyData must be set")
}
if s.PipedKeyData != "" && s.PipedKeyFile != "" {
return errors.New("only pipedKeyFile or pipedKeyData can be set")
}
if s.APIAddress == "" {
return errors.New("apiAddress must be set")
}
if s.SyncInterval < 0 {
return errors.New("syncInterval must be greater than or equal to 0")
}
for _, r := range s.ChartRepositories {
if err := r.Validate(); err != nil {
return err
}
}
for _, r := range s.ChartRegistries {
if err := r.Validate(); err != nil {
return err
}
}
if s.SecretManagement != nil {
if err := s.SecretManagement.Validate(); err != nil {
return err
}
}
if err := s.EventWatcher.Validate(); err != nil {
return err
}
for _, n := range s.Notifications.Receivers {
if n.Slack != nil {
if err := n.Slack.Validate(); err != nil {
return err
}
}
}
for _, p := range s.AnalysisProviders {
if err := p.Validate(); err != nil {
return err
}
}
return nil
}
// Clone generates a cloned PipedSpec object.
func (s *PipedSpec) Clone() (*PipedSpec, error) {
js, err := json.Marshal(s)
if err != nil {
return nil, err
}
var clone PipedSpec
if err = json.Unmarshal(js, &clone); err != nil {
return nil, err
}
return &clone, nil
}
// Mask masks confidential fields.
func (s *PipedSpec) Mask() {
if len(s.PipedKeyFile) != 0 {
s.PipedKeyFile = maskString
}
if len(s.PipedKeyData) != 0 {
s.PipedKeyData = maskString
}
s.Git.Mask()
for i := 0; i < len(s.ChartRepositories); i++ {
s.ChartRepositories[i].Mask()
}
for i := 0; i < len(s.ChartRegistries); i++ {
s.ChartRegistries[i].Mask()
}
for _, p := range s.PlatformProviders {
p.Mask()
}
for _, p := range s.AnalysisProviders {
p.Mask()
}
s.Notifications.Mask()
if s.SecretManagement != nil {
s.SecretManagement.Mask()
}
}
// EnableDefaultKubernetesPlatformProvider adds the default kubernetes cloud provider if it was not specified.
func (s *PipedSpec) EnableDefaultKubernetesPlatformProvider() {
for _, cp := range s.PlatformProviders {
if cp.Name == defaultKubernetesPlatformProvider.Name {
return
}
}
s.PlatformProviders = append(s.PlatformProviders, defaultKubernetesPlatformProvider)
}
// HasPlatformProvider checks whether the given provider is configured or not.
func (s *PipedSpec) HasPlatformProvider(name string, t model.ApplicationKind) bool {
_, contains := s.FindPlatformProvider(name, t)
return contains
}
// FindPlatformProvider finds and returns a Platform Provider by name and type.
func (s *PipedSpec) FindPlatformProvider(name string, t model.ApplicationKind) (PipedPlatformProvider, bool) {
requiredProviderType := t.CompatiblePlatformProviderType()
for _, p := range s.PlatformProviders {
if p.Name != name {
continue
}
if p.Type != requiredProviderType {
continue
}
return p, true
}
return PipedPlatformProvider{}, false
}
// FindPlatformProvidersByLabels finds all PlatformProviders which match the provided labels.
func (s *PipedSpec) FindPlatformProvidersByLabels(labels map[string]string, t model.ApplicationKind) []PipedPlatformProvider {
requiredProviderType := t.CompatiblePlatformProviderType()
out := make([]PipedPlatformProvider, 0)
labelMatch := func(providerLabels map[string]string) bool {
if len(providerLabels) < len(labels) {
return false
}
for k, v := range labels {
if v != providerLabels[k] {
return false
}
}
return true
}
for _, p := range s.PlatformProviders {
if p.Type != requiredProviderType {
continue
}
if !labelMatch(p.Labels) {
continue
}
out = append(out, p)
}
return out
}
// GetRepositoryMap returns a map of repositories where key is repo id.
func (s *PipedSpec) GetRepositoryMap() map[string]PipedRepository {
m := make(map[string]PipedRepository, len(s.Repositories))
for _, repo := range s.Repositories {
m[repo.RepoID] = repo
}
return m
}
// GetRepository finds a repository with the given ID from the configured list.
func (s *PipedSpec) GetRepository(id string) (PipedRepository, bool) {
for _, repo := range s.Repositories {
if repo.RepoID == id {
return repo, true
}
}
return PipedRepository{}, false
}
// GetAnalysisProvider finds and returns an Analysis Provider config whose name is the given string.
func (s *PipedSpec) GetAnalysisProvider(name string) (PipedAnalysisProvider, bool) {
for _, p := range s.AnalysisProviders {
if p.Name == name {
return p, true
}
}
return PipedAnalysisProvider{}, false
}
func (s *PipedSpec) IsInsecureChartRepository(name string) bool {
for _, cr := range s.ChartRepositories {
if cr.Name == name {
return cr.Insecure
}
}
return false
}
func (s *PipedSpec) LoadPipedKey() ([]byte, error) {
if s.PipedKeyData != "" {
return base64.StdEncoding.DecodeString(s.PipedKeyData)
}
if s.PipedKeyFile != "" {
return os.ReadFile(s.PipedKeyFile)
}
return nil, errors.New("either pipedKeyFile or pipedKeyData must be set")
}
type PipedGit struct {
// The username that will be configured for `git` user.
// Default is "piped".
Username string `json:"username,omitempty"`
// The email that will be configured for `git` user.
// Default is "pipecd.dev@gmail.com".
Email string `json:"email,omitempty"`
// Where to write ssh config file.
// Default is "$HOME/.ssh/config".
SSHConfigFilePath string `json:"sshConfigFilePath,omitempty"`
// The host name.
// e.g. github.com, gitlab.com
// Default is "github.com".
Host string `json:"host,omitempty"`
// The hostname or IP address of the remote git server.
// e.g. github.com, gitlab.com
// Default is the same value with Host.
HostName string `json:"hostName,omitempty"`
// The path to the private ssh key file.
// This will be used to clone the source code of the specified git repositories.
SSHKeyFile string `json:"sshKeyFile,omitempty"`
// Base64 encoded string of ssh-key.
SSHKeyData string `json:"sshKeyData,omitempty"`
}
func (g PipedGit) ShouldConfigureSSHConfig() bool {
return g.SSHKeyData != "" || g.SSHKeyFile != ""
}
func (g PipedGit) LoadSSHKey() ([]byte, error) {
if g.SSHKeyData != "" && g.SSHKeyFile != "" {
return nil, errors.New("only either sshKeyFile or sshKeyData can be set")
}
if g.SSHKeyData != "" {
return base64.StdEncoding.DecodeString(g.SSHKeyData)
}
if g.SSHKeyFile != "" {
return os.ReadFile(g.SSHKeyFile)
}
return nil, errors.New("either sshKeyFile or sshKeyData must be set")
}
func (g *PipedGit) Mask() {
if len(g.SSHConfigFilePath) != 0 {
g.SSHConfigFilePath = maskString
}
if len(g.SSHKeyFile) != 0 {
g.SSHKeyFile = maskString
}
if len(g.SSHKeyData) != 0 {
g.SSHKeyData = maskString
}
}
type PipedRepository struct {
// Unique identifier for this repository.
// This must be unique in the piped scope.
RepoID string `json:"repoId"`
// Remote address of the repository used to clone the source code.
// e.g. git@github.com:org/repo.git
Remote string `json:"remote"`
// The branch will be handled.
Branch string `json:"branch"`
}
type HelmChartRepositoryType string
const (
HTTPHelmChartRepository HelmChartRepositoryType = "HTTP"
GITHelmChartRepository HelmChartRepositoryType = "GIT"
)
type HelmChartRepository struct {
// The repository type. Currently, HTTP and GIT are supported.
// Default is HTTP.
Type HelmChartRepositoryType `json:"type" default:"HTTP"`
// Configuration for HTTP type.
// The name of the Helm chart repository.
Name string `json:"name,omitempty"`
// The address to the Helm chart repository.
Address string `json:"address,omitempty"`
// Username used for the repository backed by HTTP basic authentication.
Username string `json:"username,omitempty"`
// Password used for the repository backed by HTTP basic authentication.
Password string `json:"password,omitempty"`
// Whether to skip TLS certificate checks for the repository or not.
Insecure bool `json:"insecure"`
// Configuration for GIT type.
// Remote address of the Git repository used to clone Helm charts.
// e.g. git@github.com:org/repo.git
GitRemote string `json:"gitRemote,omitempty"`
// The path to the private ssh key file used while cloning Helm charts from above Git repository.
SSHKeyFile string `json:"sshKeyFile,omitempty"`
}
func (r *HelmChartRepository) IsHTTPRepository() bool {
return r.Type == HTTPHelmChartRepository
}
func (r *HelmChartRepository) IsGitRepository() bool {
return r.Type == GITHelmChartRepository
}
func (r *HelmChartRepository) Validate() error {
if r.IsHTTPRepository() {
if r.Name == "" {
return errors.New("name must be set")
}
if r.Address == "" {
return errors.New("address must be set")
}
return nil
}
if r.IsGitRepository() {
if r.GitRemote == "" {
return errors.New("gitRemote must be set")
}
return nil
}
return fmt.Errorf("either %s repository or %s repository must be configured", HTTPHelmChartRepository, GITHelmChartRepository)
}
func (r *HelmChartRepository) Mask() {
if len(r.Password) != 0 {
r.Password = maskString
}
if len(r.SSHKeyFile) != 0 {
r.SSHKeyFile = maskString
}
}
func (s *PipedSpec) HTTPHelmChartRepositories() []HelmChartRepository {
repos := make([]HelmChartRepository, 0, len(s.ChartRepositories))
for _, r := range s.ChartRepositories {
if r.IsHTTPRepository() {
repos = append(repos, r)
}
}
return repos
}
func (s *PipedSpec) GitHelmChartRepositories() []HelmChartRepository {
repos := make([]HelmChartRepository, 0, len(s.ChartRepositories))
for _, r := range s.ChartRepositories {
if r.IsGitRepository() {
repos = append(repos, r)
}
}
return repos
}
type HelmChartRegistryType string
// The registry types that hosts Helm charts.
const (
OCIHelmChartRegistry HelmChartRegistryType = "OCI"
)
type HelmChartRegistry struct {
// The registry type. Currently, only OCI is supported.
Type HelmChartRegistryType `json:"type" default:"OCI"`
// The address to the Helm chart registry.
Address string `json:"address"`
// Username used for the registry authentication.
Username string `json:"username,omitempty"`
// Password used for the registry authentication.
Password string `json:"password,omitempty"`
}
func (r *HelmChartRegistry) IsOCI() bool {
return r.Type == OCIHelmChartRegistry
}
func (r *HelmChartRegistry) Validate() error {
if r.IsOCI() {
if r.Address == "" {
return errors.New("address must be set")
}
return nil
}
return fmt.Errorf("%s registry must be configured", OCIHelmChartRegistry)
}
func (r *HelmChartRegistry) Mask() {
if len(r.Password) != 0 {
r.Password = maskString
}
}
type PipedPlatformProvider struct {
Name string `json:"name"`
Type model.PlatformProviderType `json:"type"`
Labels map[string]string `json:"labels,omitempty"`
KubernetesConfig *PlatformProviderKubernetesConfig
TerraformConfig *PlatformProviderTerraformConfig
CloudRunConfig *PlatformProviderCloudRunConfig
LambdaConfig *PlatformProviderLambdaConfig
ECSConfig *PlatformProviderECSConfig
}
type genericPipedPlatformProvider struct {
Name string `json:"name"`
Type model.PlatformProviderType `json:"type"`
Labels map[string]string `json:"labels,omitempty"`
Config json.RawMessage `json:"config"`
}
func (p *PipedPlatformProvider) MarshalJSON() ([]byte, error) {
var (
err error
config json.RawMessage
)
switch p.Type {
case model.PlatformProviderKubernetes:
config, err = json.Marshal(p.KubernetesConfig)
case model.PlatformProviderTerraform:
config, err = json.Marshal(p.TerraformConfig)
case model.PlatformProviderCloudRun:
config, err = json.Marshal(p.CloudRunConfig)
case model.PlatformProviderLambda:
config, err = json.Marshal(p.LambdaConfig)
case model.PlatformProviderECS:
config, err = json.Marshal(p.ECSConfig)
default:
err = fmt.Errorf("unsupported platform provider type: %s", p.Name)
}
if err != nil {
return nil, err
}
return json.Marshal(&genericPipedPlatformProvider{
Name: p.Name,
Type: p.Type,
Labels: p.Labels,
Config: config,
})
}
func (p *PipedPlatformProvider) UnmarshalJSON(data []byte) error {
var err error
gp := genericPipedPlatformProvider{}
if err = json.Unmarshal(data, &gp); err != nil {
return err
}
p.Name = gp.Name
p.Type = gp.Type
p.Labels = gp.Labels
switch p.Type {
case model.PlatformProviderKubernetes:
p.KubernetesConfig = &PlatformProviderKubernetesConfig{}
if len(gp.Config) > 0 {
err = json.Unmarshal(gp.Config, p.KubernetesConfig)
}
case model.PlatformProviderTerraform:
p.TerraformConfig = &PlatformProviderTerraformConfig{}
if len(gp.Config) > 0 {
err = json.Unmarshal(gp.Config, p.TerraformConfig)
}
case model.PlatformProviderCloudRun:
p.CloudRunConfig = &PlatformProviderCloudRunConfig{}
if len(gp.Config) > 0 {
err = json.Unmarshal(gp.Config, p.CloudRunConfig)
}
case model.PlatformProviderLambda:
p.LambdaConfig = &PlatformProviderLambdaConfig{}
if len(gp.Config) > 0 {
err = json.Unmarshal(gp.Config, p.LambdaConfig)
}
case model.PlatformProviderECS:
p.ECSConfig = &PlatformProviderECSConfig{}
if len(gp.Config) > 0 {
err = json.Unmarshal(gp.Config, p.ECSConfig)
}
default:
err = fmt.Errorf("unsupported platform provider type: %s", p.Name)
}
return err
}
func (p *PipedPlatformProvider) Mask() {
if p.CloudRunConfig != nil {
p.CloudRunConfig.Mask()
}
if p.LambdaConfig != nil {
p.LambdaConfig.Mask()
}
if p.ECSConfig != nil {
p.ECSConfig.Mask()
}
}
type PlatformProviderKubernetesConfig struct {
// The master URL of the kubernetes cluster.
// Empty means in-cluster.
MasterURL string `json:"masterURL,omitempty"`
// The path to the kubeconfig file.
// Empty means in-cluster.
KubeConfigPath string `json:"kubeConfigPath,omitempty"`
// Configuration for application resource informer.
AppStateInformer KubernetesAppStateInformer `json:"appStateInformer"`
// Version of kubectl will be used.
KubectlVersion string `json:"kubectlVersion"`
}
type KubernetesAppStateInformer struct {
// Only watches the specified namespace.
// Empty means watching all namespaces.
Namespace string `json:"namespace,omitempty"`
// List of resources that should be added to the watching targets.
IncludeResources []KubernetesResourceMatcher `json:"includeResources,omitempty"`
// List of resources that should be ignored from the watching targets.
ExcludeResources []KubernetesResourceMatcher `json:"excludeResources,omitempty"`
}
type KubernetesResourceMatcher struct {
// The APIVersion of the kubernetes resource.
APIVersion string `json:"apiVersion,omitempty"`
// The kind name of the kubernetes resource.
// Empty means all kinds are matching.
Kind string `json:"kind,omitempty"`
}
type PlatformProviderTerraformConfig struct {
// List of variables that will be set directly on terraform commands with "-var" flag.
// The variable must be formatted by "key=value" as below:
// "image_id=ami-abc123"
// 'image_id_list=["ami-abc123","ami-def456"]'
// 'image_id_map={"us-east-1":"ami-abc123","us-east-2":"ami-def456"}'
Vars []string `json:"vars,omitempty"`
// Enable drift detection.
// TODO: This is a temporary option because Terraform drift detection is buggy and has performace issues. This will be possibly removed in the future release.
DriftDetectionEnabled *bool `json:"driftDetectionEnabled" default:"true"`
}
type PlatformProviderCloudRunConfig struct {
// The GCP project hosting the CloudRun service.
Project string `json:"project"`
// The region of running CloudRun service.
Region string `json:"region"`
// The path to the service account file for accessing CloudRun service.
CredentialsFile string `json:"credentialsFile,omitempty"`
}
func (c *PlatformProviderCloudRunConfig) Mask() {
if len(c.CredentialsFile) != 0 {
c.CredentialsFile = maskString
}
}
type PlatformProviderLambdaConfig struct {
// The region to send requests to. This parameter is required.
// e.g. "us-west-2"
// A full list of regions is: https://docs.aws.amazon.com/general/latest/gr/rande.html
Region string `json:"region"`
// Path to the shared credentials file.
CredentialsFile string `json:"credentialsFile,omitempty"`
// The IAM role arn to use when assuming an role.
RoleARN string `json:"roleARN,omitempty"`
// Path to the WebIdentity token the SDK should use to assume a role with.
TokenFile string `json:"tokenFile,omitempty"`
// AWS Profile to extract credentials from the shared credentials file.
// If empty, the environment variable "AWS_PROFILE" is used.
// "default" is populated if the environment variable is also not set.
Profile string `json:"profile,omitempty"`
}
func (c *PlatformProviderLambdaConfig) Mask() {
if len(c.CredentialsFile) != 0 {
c.CredentialsFile = maskString
}
if len(c.RoleARN) != 0 {
c.RoleARN = maskString
}
if len(c.TokenFile) != 0 {
c.TokenFile = maskString
}
}
type PlatformProviderECSConfig struct {
// The region to send requests to. This parameter is required.
// e.g. "us-west-2"
// A full list of regions is: https://docs.aws.amazon.com/general/latest/gr/rande.html
Region string `json:"region"`
// Path to the shared credentials file.
CredentialsFile string `json:"credentialsFile,omitempty"`
// The IAM role arn to use when assuming an role.
RoleARN string `json:"roleARN,omitempty"`
// Path to the WebIdentity token the SDK should use to assume a role with.
TokenFile string `json:"tokenFile,omitempty"`
// AWS Profile to extract credentials from the shared credentials file.
// If empty, the environment variable "AWS_PROFILE" is used.
// "default" is populated if the environment variable is also not set.
Profile string `json:"profile,omitempty"`
}
func (c *PlatformProviderECSConfig) Mask() {
if len(c.CredentialsFile) != 0 {
c.CredentialsFile = maskString
}
if len(c.RoleARN) != 0 {
c.RoleARN = maskString
}
if len(c.TokenFile) != 0 {
c.TokenFile = maskString
}
}
type PipedAnalysisProvider struct {
Name string `json:"name"`
Type model.AnalysisProviderType `json:"type"`
PrometheusConfig *AnalysisProviderPrometheusConfig
DatadogConfig *AnalysisProviderDatadogConfig
StackdriverConfig *AnalysisProviderStackdriverConfig
}
func (p *PipedAnalysisProvider) Mask() {
if p.PrometheusConfig != nil {
p.PrometheusConfig.Mask()
}
if p.DatadogConfig != nil {
p.DatadogConfig.Mask()
}
if p.StackdriverConfig != nil {
p.StackdriverConfig.Mask()
}
}
type genericPipedAnalysisProvider struct {
Name string `json:"name"`
Type model.AnalysisProviderType `json:"type"`
Config json.RawMessage `json:"config"`
}
func (p *PipedAnalysisProvider) MarshalJSON() ([]byte, error) {
var (
err error
config json.RawMessage
)
switch p.Type {
case model.AnalysisProviderDatadog:
config, err = json.Marshal(p.DatadogConfig)
case model.AnalysisProviderPrometheus:
config, err = json.Marshal(p.PrometheusConfig)
case model.AnalysisProviderStackdriver:
config, err = json.Marshal(p.StackdriverConfig)
default:
err = fmt.Errorf("unsupported analysis provider type: %s", p.Name)
}
if err != nil {
return nil, err
}
return json.Marshal(&genericPipedAnalysisProvider{
Name: p.Name,
Type: p.Type,
Config: config,
})
}
func (p *PipedAnalysisProvider) UnmarshalJSON(data []byte) error {
var err error
gp := genericPipedAnalysisProvider{}
if err = json.Unmarshal(data, &gp); err != nil {
return err
}
p.Name = gp.Name
p.Type = gp.Type
switch p.Type {
case model.AnalysisProviderPrometheus:
p.PrometheusConfig = &AnalysisProviderPrometheusConfig{}
if len(gp.Config) > 0 {
err = json.Unmarshal(gp.Config, p.PrometheusConfig)
}
case model.AnalysisProviderDatadog:
p.DatadogConfig = &AnalysisProviderDatadogConfig{}
if len(gp.Config) > 0 {
err = json.Unmarshal(gp.Config, p.DatadogConfig)
}
case model.AnalysisProviderStackdriver:
p.StackdriverConfig = &AnalysisProviderStackdriverConfig{}
if len(gp.Config) > 0 {
err = json.Unmarshal(gp.Config, p.StackdriverConfig)
}
default:
err = fmt.Errorf("unsupported analysis provider type: %s", p.Name)
}
return err
}
func (p *PipedAnalysisProvider) Validate() error {
switch p.Type {
case model.AnalysisProviderPrometheus:
return p.PrometheusConfig.Validate()
case model.AnalysisProviderDatadog:
return p.DatadogConfig.Validate()
case model.AnalysisProviderStackdriver:
return p.StackdriverConfig.Validate()
default:
return fmt.Errorf("unknow provider type: %s", p.Type)
}
}
type AnalysisProviderPrometheusConfig struct {
Address string `json:"address"`
// The path to the username file.
UsernameFile string `json:"usernameFile,omitempty"`
// The path to the password file.
PasswordFile string `json:"passwordFile,omitempty"`
}
func (a *AnalysisProviderPrometheusConfig) Validate() error {
if a.Address == "" {
return fmt.Errorf("prometheus analysis provider requires the address")
}
return nil
}
func (a *AnalysisProviderPrometheusConfig) Mask() {
if len(a.PasswordFile) != 0 {
a.PasswordFile = maskString
}
}
type AnalysisProviderDatadogConfig struct {
// The address of Datadog API server.
// Only "datadoghq.com", "us3.datadoghq.com", "datadoghq.eu", "ddog-gov.com" are available.
// Defaults to "datadoghq.com"
Address string `json:"address,omitempty"`
// Required: The path to the api key file.
APIKeyFile string `json:"apiKeyFile"`
// Required: The path to the application key file.
ApplicationKeyFile string `json:"applicationKeyFile"`
// Base64 API Key for Datadog API server.
APIKeyData string `json:"apiKeyData,omitempty"`
// Base64 Application Key for Datadog API server.
ApplicationKeyData string `json:"applicationKeyData,omitempty"`
}
func (a *AnalysisProviderDatadogConfig) Validate() error {
if a.APIKeyFile == "" && a.APIKeyData == "" {
return fmt.Errorf("either datadog APIKeyFile or APIKeyData must be set")
}
if a.ApplicationKeyFile == "" && a.ApplicationKeyData == "" {
return fmt.Errorf("either datadog ApplicationKeyFile or ApplicationKeyData must be set")
}
if a.APIKeyData != "" && a.APIKeyFile != "" {
return fmt.Errorf("only datadog APIKeyFile or APIKeyData can be set")
}
if a.ApplicationKeyData != "" && a.ApplicationKeyFile != "" {
return fmt.Errorf("only datadog ApplicationKeyFile or ApplicationKeyData can be set")
}
return nil
}
func (a *AnalysisProviderDatadogConfig) Mask() {
if len(a.APIKeyFile) != 0 {
a.APIKeyFile = maskString
}
if len(a.ApplicationKeyFile) != 0 {
a.ApplicationKeyFile = maskString
}
if len(a.APIKeyData) != 0 {
a.APIKeyData = maskString
}
if len(a.ApplicationKeyData) != 0 {
a.ApplicationKeyData = maskString
}
}
// func(a *AnalysisProviderDatadogConfig)
type AnalysisProviderStackdriverConfig struct {
// The path to the service account file.
ServiceAccountFile string `json:"serviceAccountFile"`
}
func (a *AnalysisProviderStackdriverConfig) Mask() {
if len(a.ServiceAccountFile) != 0 {
a.ServiceAccountFile = maskString
}
}
func (a *AnalysisProviderStackdriverConfig) Validate() error {
return nil
}
type Notifications struct {
// List of notification routes.
Routes []NotificationRoute `json:"routes,omitempty"`
// List of notification receivers.
Receivers []NotificationReceiver `json:"receivers,omitempty"`
}
func (n *Notifications) Mask() {
for _, r := range n.Receivers {
r.Mask()
}
}
type NotificationRoute struct {
Name string `json:"name"`
Receiver string `json:"receiver"`
Events []string `json:"events,omitempty"`
IgnoreEvents []string `json:"ignoreEvents,omitempty"`
Groups []string `json:"groups,omitempty"`
IgnoreGroups []string `json:"ignoreGroups,omitempty"`
Apps []string `json:"apps,omitempty"`
IgnoreApps []string `json:"ignoreApps,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
IgnoreLabels map[string]string `json:"ignoreLabels,omitempty"`
}
type NotificationReceiver struct {
Name string `json:"name"`
Slack *NotificationReceiverSlack `json:"slack,omitempty"`
Webhook *NotificationReceiverWebhook `json:"webhook,omitempty"`
}
func (n *NotificationReceiver) Mask() {
if n.Slack != nil {
n.Slack.Mask()
}
if n.Webhook != nil {
n.Webhook.Mask()
}
}
type NotificationReceiverSlack struct {
HookURL string `json:"hookURL"`
OAuthToken string `json:"oauthToken"` // Deprecated: use OAuthTokenData instead.
OAuthTokenData string `json:"oauthTokenData"`
OAuthTokenFile string `json:"oauthTokenFile"`
ChannelID string `json:"channelID"`
MentionedAccounts []string `json:"mentionedAccounts,omitempty"`
}
func (n *NotificationReceiverSlack) Mask() {
if len(n.HookURL) != 0 {
n.HookURL = maskString
}
if len(n.OAuthToken) != 0 {
n.OAuthToken = maskString
}
if len(n.OAuthTokenData) != 0 {
n.OAuthTokenData = maskString
}
}
func (n *NotificationReceiverSlack) Validate() error {
mentionedAccounts := make([]string, 0, len(n.MentionedAccounts))
for _, mentionedAccount := range n.MentionedAccounts {
formatMentionedAccount := strings.TrimPrefix(mentionedAccount, "@")
mentionedAccounts = append(mentionedAccounts, formatMentionedAccount)
}
if len(mentionedAccounts) > 0 {
n.MentionedAccounts = mentionedAccounts
}
if n.HookURL != "" && (n.OAuthToken != "" || n.OAuthTokenFile != "" || n.OAuthTokenData != "" || n.ChannelID != "") {
return errors.New("only one of sending via hook URL or API should be used")
}
if n.HookURL != "" {
return nil
}
if n.ChannelID == "" || (n.OAuthToken == "" && n.OAuthTokenFile == "" && n.OAuthTokenData == "") {
return errors.New("missing channelID or OAuth token configuration")
}
if (n.OAuthToken != "" && n.OAuthTokenFile != "") || (n.OAuthToken != "" && n.OAuthTokenData != "") || (n.OAuthTokenFile != "" && n.OAuthTokenData != "") {
return errors.New("only one of OAuthToken, OAuthTokenData and OAuthTokenFile should be set")
}
return nil
}
type NotificationReceiverWebhook struct {
URL string `json:"url"`
SignatureKey string `json:"signatureKey,omitempty" default:"PipeCD-Signature"`
SignatureValue string `json:"signatureValue,omitempty"`
SignatureValueFile string `json:"signatureValueFile,omitempty"`
}
func (n *NotificationReceiverWebhook) Mask() {
if len(n.URL) != 0 {