forked from hashicorp/terraform-provider-google
-
Notifications
You must be signed in to change notification settings - Fork 0
/
resource_cloudbuild_trigger.go
4783 lines (4345 loc) · 184 KB
/
resource_cloudbuild_trigger.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
// ----------------------------------------------------------------------------
//
// *** AUTO GENERATED CODE *** Type: MMv1 ***
//
// ----------------------------------------------------------------------------
//
// This file is automatically generated by Magic Modules and manual
// changes will be clobbered when the file is regenerated.
//
// Please read more about how to change this file in
// .github/CONTRIBUTING.md.
//
// ----------------------------------------------------------------------------
package google
import (
"context"
"fmt"
"log"
"reflect"
"strings"
"time"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)
func stepTimeoutCustomizeDiff(_ context.Context, diff *schema.ResourceDiff, v interface{}) error {
buildList := diff.Get("build").([]interface{})
if len(buildList) == 0 || buildList[0] == nil {
return nil
}
build := buildList[0].(map[string]interface{})
buildTimeoutString := build["timeout"].(string)
buildTimeout, err := time.ParseDuration(buildTimeoutString)
if err != nil {
return fmt.Errorf("Error parsing build timeout : %s", err)
}
var stepTimeoutSum time.Duration = 0
steps := build["step"].([]interface{})
for _, rawstep := range steps {
if rawstep == nil {
continue
}
step := rawstep.(map[string]interface{})
timeoutString := step["timeout"].(string)
if len(timeoutString) == 0 {
continue
}
timeout, err := time.ParseDuration(timeoutString)
if err != nil {
return fmt.Errorf("Error parsing build step timeout: %s", err)
}
stepTimeoutSum += timeout
}
if stepTimeoutSum > buildTimeout {
return fmt.Errorf("Step timeout sum (%v) cannot be greater than build timeout (%v)", stepTimeoutSum, buildTimeout)
}
return nil
}
func resourceCloudBuildTrigger() *schema.Resource {
return &schema.Resource{
Create: resourceCloudBuildTriggerCreate,
Read: resourceCloudBuildTriggerRead,
Update: resourceCloudBuildTriggerUpdate,
Delete: resourceCloudBuildTriggerDelete,
Importer: &schema.ResourceImporter{
State: resourceCloudBuildTriggerImport,
},
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(20 * time.Minute),
Update: schema.DefaultTimeout(20 * time.Minute),
Delete: schema.DefaultTimeout(20 * time.Minute),
},
SchemaVersion: 2,
StateUpgraders: []schema.StateUpgrader{
{
Type: resourceCloudBuildTriggerResourceV0().CoreConfigSchema().ImpliedType(),
Upgrade: resourceCloudBuildTriggerUpgradeV0,
Version: 0,
},
{
Type: resourceCloudBuildTriggerResourceV1().CoreConfigSchema().ImpliedType(),
Upgrade: resourceCloudBuildTriggerUpgradeV1,
Version: 1,
},
},
CustomizeDiff: stepTimeoutCustomizeDiff,
Schema: map[string]*schema.Schema{
"approval_config": {
Type: schema.TypeList,
Computed: true,
Optional: true,
Description: `Configuration for manual approval to start a build invocation of this BuildTrigger.
Builds created by this trigger will require approval before they execute.
Any user with a Cloud Build Approver role for the project can approve a build.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"approval_required": {
Type: schema.TypeBool,
Optional: true,
Description: `Whether or not approval is needed. If this is set on a build, it will become pending when run,
and will need to be explicitly approved to start.`,
Default: false,
},
},
},
},
"build": {
Type: schema.TypeList,
Optional: true,
Description: `Contents of the build template. Either a filename or build template must be provided.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"step": {
Type: schema.TypeList,
Required: true,
Description: `The operations to be performed on the workspace.`,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Required: true,
Description: `The name of the container image that will run this particular build step.
If the image is available in the host's Docker daemon's cache, it will be
run directly. If not, the host will attempt to pull the image first, using
the builder service account's credentials if necessary.
The Docker daemon's cache will already have the latest versions of all of
the officially supported build steps (see https://github.com/GoogleCloudPlatform/cloud-builders
for images and examples).
The Docker daemon will also have cached many of the layers for some popular
images, like "ubuntu", "debian", but they will be refreshed at the time
you attempt to use them.
If you built an image in a previous build step, it will be stored in the
host's Docker daemon's cache and is available to use as the name for a
later build step.`,
},
"args": {
Type: schema.TypeList,
Optional: true,
Description: `A list of arguments that will be presented to the step when it is started.
If the image used to run the step's container has an entrypoint, the args
are used as arguments to that entrypoint. If the image does not define an
entrypoint, the first element in args is used as the entrypoint, and the
remainder will be used as arguments.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"dir": {
Type: schema.TypeString,
Optional: true,
Description: `Working directory to use when running this step's container.
If this value is a relative path, it is relative to the build's working
directory. If this value is absolute, it may be outside the build's working
directory, in which case the contents of the path may not be persisted
across build step executions, unless a 'volume' for that path is specified.
If the build specifies a 'RepoSource' with 'dir' and a step with a
'dir',
which specifies an absolute path, the 'RepoSource' 'dir' is ignored
for the step's execution.`,
},
"entrypoint": {
Type: schema.TypeString,
Optional: true,
Description: `Entrypoint to be used instead of the build step image's
default entrypoint.
If unset, the image's default entrypoint is used`,
},
"env": {
Type: schema.TypeList,
Optional: true,
Description: `A list of environment variable definitions to be used when
running a step.
The elements are of the form "KEY=VALUE" for the environment variable
"KEY" being given the value "VALUE".`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"id": {
Type: schema.TypeString,
Optional: true,
Description: `Unique identifier for this build step, used in 'wait_for' to
reference this build step as a dependency.`,
},
"script": {
Type: schema.TypeString,
Optional: true,
Description: `A shell script to be executed in the step.
When script is provided, the user cannot specify the entrypoint or args.`,
},
"secret_env": {
Type: schema.TypeList,
Optional: true,
Description: `A list of environment variables which are encrypted using
a Cloud Key
Management Service crypto key. These values must be specified in
the build's 'Secret'.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"timeout": {
Type: schema.TypeString,
Optional: true,
Description: `Time limit for executing this build step. If not defined,
the step has no
time limit and will be allowed to continue to run until either it
completes or the build itself times out.`,
},
"timing": {
Type: schema.TypeString,
Optional: true,
Description: `Output only. Stores timing information for executing this
build step.`,
},
"volumes": {
Type: schema.TypeList,
Optional: true,
Description: `List of volumes to mount into the build step.
Each volume is created as an empty volume prior to execution of the
build step. Upon completion of the build, volumes and their contents
are discarded.
Using a named volume in only one step is not valid as it is
indicative of a build request with an incorrect configuration.`,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Required: true,
Description: `Name of the volume to mount.
Volume names must be unique per build step and must be valid names for
Docker volumes. Each named volume must be used by at least two build steps.`,
},
"path": {
Type: schema.TypeString,
Required: true,
Description: `Path at which to mount the volume.
Paths must be absolute and cannot conflict with other volume paths on
the same build step or with certain reserved volume paths.`,
},
},
},
},
"wait_for": {
Type: schema.TypeList,
Optional: true,
Description: `The ID(s) of the step(s) that this build step depends on.
This build step will not start until all the build steps in 'wait_for'
have completed successfully. If 'wait_for' is empty, this build step
will start when all previous build steps in the 'Build.Steps' list
have completed successfully.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
},
},
},
"artifacts": {
Type: schema.TypeList,
Optional: true,
Description: `Artifacts produced by the build that should be uploaded upon successful completion of all build steps.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"images": {
Type: schema.TypeList,
Optional: true,
Description: `A list of images to be pushed upon the successful completion of all build steps.
The images will be pushed using the builder service account's credentials.
The digests of the pushed images will be stored in the Build resource's results field.
If any of the images fail to be pushed, the build is marked FAILURE.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"objects": {
Type: schema.TypeList,
Optional: true,
Description: `A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps.
Files in the workspace matching specified paths globs will be uploaded to the
Cloud Storage location using the builder service account's credentials.
The location and generation of the uploaded objects will be stored in the Build resource's results field.
If any objects fail to be pushed, the build is marked FAILURE.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"location": {
Type: schema.TypeString,
Optional: true,
Description: `Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/".
Files in the workspace matching any path pattern will be uploaded to Cloud Storage with
this location as a prefix.`,
},
"paths": {
Type: schema.TypeList,
Optional: true,
Description: `Path globs used to match files in the build's workspace.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"timing": {
Type: schema.TypeList,
Computed: true,
Description: `Output only. Stores timing information for pushing all artifact objects.`,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"end_time": {
Type: schema.TypeString,
Optional: true,
Description: `End of time span.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to
nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".`,
},
"start_time": {
Type: schema.TypeString,
Optional: true,
Description: `Start of time span.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to
nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".`,
},
},
},
},
},
},
},
},
},
},
"available_secrets": {
Type: schema.TypeList,
Optional: true,
Description: `Secrets and secret environment variables.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"secret_manager": {
Type: schema.TypeList,
Required: true,
Description: `Pairs a secret environment variable with a SecretVersion in Secret Manager.`,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"env": {
Type: schema.TypeString,
Required: true,
Description: `Environment variable name to associate with the secret. Secret environment
variables must be unique across all of a build's secrets, and must be used
by at least one build step.`,
},
"version_name": {
Type: schema.TypeString,
Required: true,
Description: `Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*`,
},
},
},
},
},
},
},
"images": {
Type: schema.TypeList,
Optional: true,
Description: `A list of images to be pushed upon the successful completion of all build steps.
The images are pushed using the builder service account's credentials.
The digests of the pushed images will be stored in the Build resource's results field.
If any of the images fail to be pushed, the build status is marked FAILURE.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"logs_bucket": {
Type: schema.TypeString,
Optional: true,
Description: `Google Cloud Storage bucket where logs should be written.
Logs file names will be of the format ${logsBucket}/log-${build_id}.txt.`,
},
"options": {
Type: schema.TypeList,
Optional: true,
Description: `Special options for this build.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"disk_size_gb": {
Type: schema.TypeInt,
Optional: true,
Description: `Requested disk size for the VM that runs the build. Note that this is NOT "disk free";
some of the space will be used by the operating system and build utilities.
Also note that this is the minimum disk size that will be allocated for the build --
the build may run with a larger disk than requested. At present, the maximum disk size
is 1000GB; builds that request more than the maximum are rejected with an error.`,
},
"dynamic_substitutions": {
Type: schema.TypeBool,
Optional: true,
Description: `Option to specify whether or not to apply bash style string operations to the substitutions.
NOTE this is always enabled for triggered builds and cannot be overridden in the build configuration file.`,
},
"env": {
Type: schema.TypeList,
Optional: true,
Description: `A list of global environment variable definitions that will exist for all build steps
in this build. If a variable is defined in both globally and in a build step,
the variable will use the build step value.
The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"log_streaming_option": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateEnum([]string{"STREAM_DEFAULT", "STREAM_ON", "STREAM_OFF", ""}),
Description: `Option to define build log streaming behavior to Google Cloud Storage. Possible values: ["STREAM_DEFAULT", "STREAM_ON", "STREAM_OFF"]`,
},
"logging": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateEnum([]string{"LOGGING_UNSPECIFIED", "LEGACY", "GCS_ONLY", "STACKDRIVER_ONLY", "CLOUD_LOGGING_ONLY", "NONE", ""}),
Description: `Option to specify the logging mode, which determines if and where build logs are stored. Possible values: ["LOGGING_UNSPECIFIED", "LEGACY", "GCS_ONLY", "STACKDRIVER_ONLY", "CLOUD_LOGGING_ONLY", "NONE"]`,
},
"machine_type": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateEnum([]string{"UNSPECIFIED", "N1_HIGHCPU_8", "N1_HIGHCPU_32", "E2_HIGHCPU_8", "E2_HIGHCPU_32", ""}),
Description: `Compute Engine machine type on which to run the build. Possible values: ["UNSPECIFIED", "N1_HIGHCPU_8", "N1_HIGHCPU_32", "E2_HIGHCPU_8", "E2_HIGHCPU_32"]`,
},
"requested_verify_option": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateEnum([]string{"NOT_VERIFIED", "VERIFIED", ""}),
Description: `Requested verifiability options. Possible values: ["NOT_VERIFIED", "VERIFIED"]`,
},
"secret_env": {
Type: schema.TypeList,
Optional: true,
Description: `A list of global environment variables, which are encrypted using a Cloud Key Management
Service crypto key. These values must be specified in the build's Secret. These variables
will be available to all build steps in this build.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"source_provenance_hash": {
Type: schema.TypeList,
Optional: true,
Description: `Requested hash for SourceProvenance. Possible values: ["NONE", "SHA256", "MD5"]`,
Elem: &schema.Schema{
Type: schema.TypeString,
ValidateFunc: validateEnum([]string{"NONE", "SHA256", "MD5"}),
},
},
"substitution_option": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateEnum([]string{"MUST_MATCH", "ALLOW_LOOSE", ""}),
Description: `Option to specify behavior when there is an error in the substitution checks.
NOTE this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden
in the build configuration file. Possible values: ["MUST_MATCH", "ALLOW_LOOSE"]`,
},
"volumes": {
Type: schema.TypeList,
Optional: true,
Description: `Global list of volumes to mount for ALL build steps
Each volume is created as an empty volume prior to starting the build process.
Upon completion of the build, volumes and their contents are discarded. Global
volume names and paths cannot conflict with the volumes defined a build step.
Using a global volume in a build with only one step is not valid as it is indicative
of a build request with an incorrect configuration.`,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Optional: true,
Description: `Name of the volume to mount.
Volume names must be unique per build step and must be valid names for Docker volumes.
Each named volume must be used by at least two build steps.`,
},
"path": {
Type: schema.TypeString,
Optional: true,
Description: `Path at which to mount the volume.
Paths must be absolute and cannot conflict with other volume paths on the same
build step or with certain reserved volume paths.`,
},
},
},
},
"worker_pool": {
Type: schema.TypeString,
Optional: true,
Description: `Option to specify a WorkerPool for the build. Format projects/{project}/workerPools/{workerPool}
This field is experimental.`,
},
},
},
},
"queue_ttl": {
Type: schema.TypeString,
Optional: true,
Description: `TTL in queue for this build. If provided and the build is enqueued longer than this value,
the build will expire and the build status will be EXPIRED.
The TTL starts ticking from createTime.
A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".`,
},
"secret": {
Type: schema.TypeList,
Optional: true,
Description: `Secrets to decrypt using Cloud Key Management Service.`,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"kms_key_name": {
Type: schema.TypeString,
Required: true,
Description: `Cloud KMS key name to use to decrypt these envs.`,
},
"secret_env": {
Type: schema.TypeMap,
Optional: true,
Description: `Map of environment variable name to its encrypted value.
Secret environment variables must be unique across all of a build's secrets,
and must be used by at least one build step. Values can be at most 64 KB in size.
There can be at most 100 secret values across all of a build's secrets.`,
Elem: &schema.Schema{Type: schema.TypeString},
},
},
},
},
"source": {
Type: schema.TypeList,
Optional: true,
Description: `The location of the source files to build.
One of 'storageSource' or 'repoSource' must be provided.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"repo_source": {
Type: schema.TypeList,
Optional: true,
Description: `Location of the source in a Google Cloud Source Repository.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"repo_name": {
Type: schema.TypeString,
Required: true,
Description: `Name of the Cloud Source Repository.`,
},
"branch_name": {
Type: schema.TypeString,
Optional: true,
Description: `Regex matching branches to build. Exactly one a of branch name, tag, or commit SHA must be provided.
The syntax of the regular expressions accepted is the syntax accepted by RE2 and
described at https://github.com/google/re2/wiki/Syntax`,
ExactlyOneOf: []string{"build.0.source.0.repo_source.0.branch_name", "build.0.source.0.repo_source.0.commit_sha", "build.0.source.0.repo_source.0.tag_name"},
},
"commit_sha": {
Type: schema.TypeString,
Optional: true,
Description: `Explicit commit SHA to build. Exactly one a of branch name, tag, or commit SHA must be provided.`,
ExactlyOneOf: []string{"build.0.source.0.repo_source.0.branch_name", "build.0.source.0.repo_source.0.commit_sha", "build.0.source.0.repo_source.0.tag_name"},
},
"dir": {
Type: schema.TypeString,
Optional: true,
Description: `Directory, relative to the source root, in which to run the build.
This must be a relative path. If a step's dir is specified and is an absolute path,
this value is ignored for that step's execution.`,
},
"invert_regex": {
Type: schema.TypeBool,
Optional: true,
Description: `Only trigger a build if the revision regex does NOT match the revision regex.`,
},
"project_id": {
Type: schema.TypeString,
Optional: true,
Description: `ID of the project that owns the Cloud Source Repository.
If omitted, the project ID requesting the build is assumed.`,
},
"substitutions": {
Type: schema.TypeMap,
Optional: true,
Description: `Substitutions to use in a triggered build. Should only be used with triggers.run`,
Elem: &schema.Schema{Type: schema.TypeString},
},
"tag_name": {
Type: schema.TypeString,
Optional: true,
Description: `Regex matching tags to build. Exactly one a of branch name, tag, or commit SHA must be provided.
The syntax of the regular expressions accepted is the syntax accepted by RE2 and
described at https://github.com/google/re2/wiki/Syntax`,
ExactlyOneOf: []string{"build.0.source.0.repo_source.0.branch_name", "build.0.source.0.repo_source.0.commit_sha", "build.0.source.0.repo_source.0.tag_name"},
},
},
},
},
"storage_source": {
Type: schema.TypeList,
Optional: true,
Description: `Location of the source in an archive file in Google Cloud Storage.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"bucket": {
Type: schema.TypeString,
Required: true,
Description: `Google Cloud Storage bucket containing the source.`,
},
"object": {
Type: schema.TypeString,
Required: true,
Description: `Google Cloud Storage object containing the source.
This object must be a gzipped archive file (.tar.gz) containing source to build.`,
},
"generation": {
Type: schema.TypeString,
Optional: true,
Description: `Google Cloud Storage generation for the object.
If the generation is omitted, the latest generation will be used`,
},
},
},
},
},
},
},
"substitutions": {
Type: schema.TypeMap,
Optional: true,
Description: `Substitutions data for Build resource.`,
Elem: &schema.Schema{Type: schema.TypeString},
},
"tags": {
Type: schema.TypeList,
Optional: true,
Description: `Tags for annotation of a Build. These are not docker tags.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"timeout": {
Type: schema.TypeString,
Optional: true,
Description: `Amount of time that this build should be allowed to run, to second granularity.
If this amount of time elapses, work on the build will cease and the build status will be TIMEOUT.
This timeout must be equal to or greater than the sum of the timeouts for build steps within the build.
The expected format is the number of seconds followed by s.
Default time is ten minutes (600s).`,
Default: "600s",
},
},
},
ExactlyOneOf: []string{"filename", "build", "git_file_source"},
},
"description": {
Type: schema.TypeString,
Optional: true,
Description: `Human-readable description of the trigger.`,
},
"disabled": {
Type: schema.TypeBool,
Optional: true,
Description: `Whether the trigger is disabled or not. If true, the trigger will never result in a build.`,
},
"filename": {
Type: schema.TypeString,
Optional: true,
Description: `Path, from the source root, to a file whose contents is used for the template.
Either a filename or build template must be provided. Set this only when using trigger_template or github.
When using Pub/Sub, Webhook or Manual set the file name using git_file_source instead.`,
ExactlyOneOf: []string{"filename", "build", "git_file_source"},
},
"filter": {
Type: schema.TypeString,
Optional: true,
Description: `A Common Expression Language string. Used only with Pub/Sub and Webhook.`,
},
"git_file_source": {
Type: schema.TypeList,
Optional: true,
Description: `The file source describing the local or remote Build template.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"path": {
Type: schema.TypeString,
Required: true,
Description: `The path of the file, with the repo root as the root of the path.`,
},
"repo_type": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validateEnum([]string{"UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET"}),
Description: `The type of the repo, since it may not be explicit from the repo field (e.g from a URL).
Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET Possible values: ["UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET"]`,
},
"revision": {
Type: schema.TypeString,
Optional: true,
Description: `The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the
filename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions
If unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path.`,
},
"uri": {
Type: schema.TypeString,
Optional: true,
Description: `The URI of the repo (optional). If unspecified, the repo from which the trigger
invocation originated is assumed to be the repo from which to read the specified path.`,
},
},
},
ExactlyOneOf: []string{"filename", "git_file_source", "build"},
},
"github": {
Type: schema.TypeList,
Optional: true,
Description: `Describes the configuration of a trigger that creates a build whenever a GitHub event is received.
One of 'trigger_template', 'github', 'pubsub_config' or 'webhook_config' must be provided.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Optional: true,
Description: `Name of the repository. For example: The name for
https://github.com/googlecloudplatform/cloud-builders is "cloud-builders".`,
},
"owner": {
Type: schema.TypeString,
Optional: true,
Description: `Owner of the repository. For example: The owner for
https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform".`,
},
"pull_request": {
Type: schema.TypeList,
Optional: true,
Description: `filter to match changes in pull requests. Specify only one of 'pull_request' or 'push'.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"branch": {
Type: schema.TypeString,
Required: true,
Description: `Regex of branches to match.`,
},
"comment_control": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateEnum([]string{"COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY", ""}),
Description: `Whether to block builds on a "/gcbrun" comment from a repository owner or collaborator. Possible values: ["COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"]`,
},
"invert_regex": {
Type: schema.TypeBool,
Optional: true,
Description: `If true, branches that do NOT match the git_ref will trigger a build.`,
},
},
},
ExactlyOneOf: []string{"github.0.pull_request", "github.0.push"},
},
"push": {
Type: schema.TypeList,
Optional: true,
Description: `filter to match changes in refs, like branches or tags. Specify only one of 'pull_request' or 'push'.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"branch": {
Type: schema.TypeString,
Optional: true,
Description: `Regex of branches to match. Specify only one of branch or tag.`,
ExactlyOneOf: []string{"github.0.push.0.branch", "github.0.push.0.tag"},
},
"invert_regex": {
Type: schema.TypeBool,
Optional: true,
Description: `When true, only trigger a build if the revision regex does NOT match the git_ref regex.`,
},
"tag": {
Type: schema.TypeString,
Optional: true,
Description: `Regex of tags to match. Specify only one of branch or tag.`,
ExactlyOneOf: []string{"github.0.push.0.branch", "github.0.push.0.tag"},
},
},
},
ExactlyOneOf: []string{"github.0.pull_request", "github.0.push"},
},
},
},
AtLeastOneOf: []string{"trigger_template", "github", "pubsub_config", "webhook_config", "source_to_build"},
},
"ignored_files": {
Type: schema.TypeList,
Optional: true,
Description: `ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match
extended with support for '**'.
If ignoredFiles and changed files are both empty, then they are not
used to determine whether or not to trigger a build.
If ignoredFiles is not empty, then we ignore any files that match any
of the ignored_file globs. If the change has no files that are outside
of the ignoredFiles globs, then we do not trigger a build.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"include_build_logs": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validateEnum([]string{"INCLUDE_BUILD_LOGS_UNSPECIFIED", "INCLUDE_BUILD_LOGS_WITH_STATUS", ""}),
Description: `Build logs will be sent back to GitHub as part of the checkrun
result. Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or
INCLUDE_BUILD_LOGS_WITH_STATUS Possible values: ["INCLUDE_BUILD_LOGS_UNSPECIFIED", "INCLUDE_BUILD_LOGS_WITH_STATUS"]`,
},
"included_files": {
Type: schema.TypeList,
Optional: true,
Description: `ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match
extended with support for '**'.
If any of the files altered in the commit pass the ignoredFiles filter
and includedFiles is empty, then as far as this filter is concerned, we
should trigger the build.
If any of the files altered in the commit pass the ignoredFiles filter
and includedFiles is not empty, then we make sure that at least one of
those files matches a includedFiles glob. If not, then we do not trigger
a build.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"location": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `The [Cloud Build location](https://cloud.google.com/build/docs/locations) for the trigger.
If not specified, "global" is used.`,
Default: "global",
},
"name": {
Type: schema.TypeString,
Computed: true,
Optional: true,
Description: `Name of the trigger. Must be unique within the project.`,
},
"pubsub_config": {
Type: schema.TypeList,
Optional: true,
Description: `PubsubConfig describes the configuration of a trigger that creates
a build whenever a Pub/Sub message is published.
One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"topic": {
Type: schema.TypeString,
Required: true,
Description: `The name of the topic from which this subscription is receiving messages.`,
},
"service_account_email": {
Type: schema.TypeString,
Optional: true,
Description: `Service account that will make the push request.`,
},
"state": {
Type: schema.TypeString,
Computed: true,
Description: `Potential issues with the underlying Pub/Sub subscription configuration.
Only populated on get requests.`,
},
"subscription": {
Type: schema.TypeString,
Computed: true,
Description: `Output only. Name of the subscription.`,
},
},
},
AtLeastOneOf: []string{"trigger_template", "github", "pubsub_config", "webhook_config", "source_to_build"},
},
"service_account": {
Type: schema.TypeString,
Optional: true,
Description: `The service account used for all user-controlled operations including
triggers.patch, triggers.run, builds.create, and builds.cancel.
If no service account is set, then the standard Cloud Build service account
([PROJECT_NUM]@system.gserviceaccount.com) will be used instead.
Format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`,
},
"source_to_build": {
Type: schema.TypeList,
Optional: true,
Description: `The repo and ref of the repository from which to build.
This field is used only for those triggers that do not respond to SCM events.
Triggers that respond to such events build source at whatever commit caused the event.
This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.
One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"ref": {
Type: schema.TypeString,
Required: true,
Description: `The branch or tag to use. Must start with "refs/" (required).`,
},
"repo_type": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validateEnum([]string{"UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET"}),
Description: `The type of the repo, since it may not be explicit from the repo field (e.g from a URL).
Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET Possible values: ["UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET"]`,
},
"uri": {
Type: schema.TypeString,
Required: true,
Description: `The URI of the repo (required).`,
},
},
},
AtLeastOneOf: []string{"trigger_template", "github", "pubsub_config", "webhook_config", "source_to_build"},
},
"substitutions": {
Type: schema.TypeMap,
Optional: true,
Description: `Substitutions data for Build resource.`,
Elem: &schema.Schema{Type: schema.TypeString},
},
"tags": {
Type: schema.TypeList,
Optional: true,
Description: `Tags for annotation of a BuildTrigger`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"trigger_template": {
Type: schema.TypeList,
Optional: true,
Description: `Template describing the types of source changes to trigger a build.
Branch and tag names in trigger templates are interpreted as regular
expressions. Any branch or tag change that matches that regular
expression will trigger a build.
One of 'trigger_template', 'github', 'pubsub_config', 'webhook_config' or 'source_to_build' must be provided.`,
MaxItems: 1,