Use CircleCI version 2.1 at the top of your .circleci/config.yml file.
1
version: 2.1
Add the orbs
stanza below your version, invoking the orb:
1
2
orbs:
terraform: circleci/terraform@3.5.0
Use terraform
elements in your existing workflows and jobs.
Deploy infrastructure leveraging a sequence of jobs and workspaces to create and persist a terraform plan. Apply will 'apply' the result of a terraform plan.
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
version: '2.1'
orbs:
terraform: circleci/terraform@3.5
workflows:
deploy_infrastructure:
jobs:
- terraform/fmt:
checkout: true
context: terraform
- terraform/validate:
checkout: true
context: terraform
requires:
- terraform/fmt
- terraform/plan:
checkout: true
context: terraform
persist-workspace: true
requires:
- terraform/validate
- terraform/apply:
attach-workspace: true
context: terraform
filters:
branches:
only: main
requires:
- terraform/plan
Deploy infrastructure by leveraging a sequence of commands to create and apply subsequent terraform plan.
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
version: '2.1'
orbs:
terraform: circleci/terraform@3.5
jobs:
single-job-lifecycle:
executor: terraform/default
steps:
- checkout
- terraform/init:
path: .
- terraform/validate:
path: .
- terraform/fmt:
path: .
- terraform/plan:
path: .
- terraform/apply:
path: .
- terraform/plan:
destroy_plan: true
path: .
- terraform/destroy:
path: .
working_directory: ~/src
workflows:
single-job-lifecycle:
jobs:
- single-job-lifecycle
Deploy infrastructure that uses a remote backend to manage state. This example uses a Terraform Cloud example and references a remote.hcl file to specify the backend config.
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
version: '2.1'
orbs:
terraform: circleci/terraform@3.5
jobs:
single-job-lifecycle:
executor: terraform/default
steps:
- checkout
- run:
command: >-
echo "credentials \"app.terraform.io\" {token =
\"$TERRAFORM_TOKEN\"}" > $HOME/.terraformrc
name: Create .terraformrc file locally
- terraform/install:
arch: amd64
os: linux
terraform_version: 0.14.2
- terraform/fmt:
path: .
- terraform/validate:
path: .
- terraform/init:
backend: true
backend_config_file: backend.hcl
path: .
- terraform/plan:
backend_config_file: backend.hcl
path: .
- terraform/apply:
backend_config_file: backend.hcl
path: .
- terraform/destroy:
path: .
working_directory: ~/src
workflows:
single-job-lifecycle:
jobs:
- single-job-lifecycle
Execute terraform plan
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
attach-workspace | Attach (CircleCI) workspace to job. | No | false | boolean |
backend_config | "Comma separated list of backend configs to set, e.g. 'foo=bar'"
| No | '' | string |
backend_config_file | Path to a backend config file | No | '' | string |
checkout | Perform checkout as first step in job. | No | false | boolean |
cli_config_file | Path to terraform cli config file | No | '' | string |
lock-timeout | Configure a custom state lock timeout | No | 30s | string |
parallelism | Limit the number of concurrent operation Terraform is running. Defaults to 10 | No | 10 | integer |
path | Path to the terraform module | No | . | string |
persist-workspace | Boolean parameter to indicate whether or not to attach to an existing workspace. | No | false | boolean |
plan | Optionally provide a plan file to supply to the 'apply' command. | No | '' | string |
resource_class | Specify the resource class for Docker Executor | No | medium | string |
tag | Specify the Terraform Docker image tag for the executor | No | 1.0.0 | string |
timeout | Configure a custom timeout limit | No | 10m | string |
var | Comma separated list of vars to set, e.g. 'foo=bar,bas=foo' | No | '' | string |
var_file | Comma separated list of var file paths | No | '' | string |
workspace | Name of the terraform workspace | No | '' | string |
workspace-path | Path of the workspace to persist to relative to workspace-root. | No | . | string |
workspace-root | Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory) | No | . | string |
Destroy current state
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
attach-workspace | Attach (CircleCI) workspace to job. | No | false | boolean |
backend_config | "Comma separated list of backend configs to set, e.g. 'foo=bar'"
| No | '' | string |
backend_config_file | Path to a backend config file | No | '' | string |
checkout | Perform checkout as first step in job. | No | false | boolean |
cli_config_file | Path to terraform cli config file | No | '' | string |
path | Path to the terraform module | No | . | string |
resource_class | Specify the resource class for Docker Executor | No | medium | string |
tag | Specify the Terraform Docker image tag for the executor | No | 1.0.0 | string |
timeout | Configure a custom timeout limit | No | 10m | string |
var | Comma separated list of vars to set, e.g. 'foo=bar,bas=foo' | No | '' | string |
var_file | Comma separated list of vars file paths | No | '' | string |
workspace | Name of the terraform workspace | No | '' | string |
workspace-root | Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory) | No | . | string |
Run terraform fmt
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
attach-workspace | Attach (CircleCI) workspace to job. | No | false | boolean |
checkout | Perform checkout as first step in job. | No | false | boolean |
path | Path to the terraform module | No | . | string |
recursive | Process files in subdirectories | No | false | boolean |
resource_class | Specify the resource class for Docker Executor | No | medium | string |
tag | Specify the Terraform Docker image tag for the executor | No | 1.0.0 | string |
timeout | Configure a custom timeout limit | No | 10m | string |
workspace-root | Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory) | No | . | string |
Inits terraform directory
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
attach-workspace | Do cool stuff with workspaces | No | false | boolean |
checkout | Perform checkout as first step in job. | No | false | boolean |
cli_config_file | Path to terraform cli config file | No | '' | string |
path | Path to the terraform module | No | . | string |
resource_class | Specify the resource class for Docker Executor | No | medium | string |
tag | Specify the Terraform Docker image tag for the executor | No | 1.0.0 | string |
timeout | Configure a custom timeout limit | No | 10m | string |
workspace-root-dir | circleci workspaces...not terraform | No | . | string |
Run Terraform plan against current state
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
attach-workspace | Do cool stuff with workspaces | No | false | boolean |
backend_config | "Comma separated list of backend configs to set, e.g. 'foo=bar'"
| No | '' | string |
backend_config_file | Path to a backend config file | No | '' | string |
checkout | Perform checkout as first step in job. | No | true | boolean |
cli_config_file | Path to terraform cli config file | No | '' | string |
destroy_plan | Run this plan as a destroy plan. | No | false | boolean |
lock-timeout | Configure a custom state lock timeout | No | 30s | string |
out | The file path to save your terraform plan to. Set this to "" if you are using terraform cloud. | No | plan.out | string |
path | Path to the terraform module | No | . | string |
persist-workspace | Persist files to (cci) workspace for use in subsequent jobs | No | false | boolean |
resource_class | Specify the resource class for Docker Executor | No | medium | string |
tag | Specify the Terraform Docker image tag for the executor | No | 1.0.0 | string |
timeout | Configure a custom timeout limit | No | 10m | string |
var | Comma separated list of vars to set, e.g. 'foo=bar,bas=foo' | No | '' | string |
var_file | Comma separated list of var file paths | No | '' | string |
workspace | Name of the terraform workspace | No | '' | string |
workspace-path | Path of the workspace to persist to relative to workspace-root. | No | . | string |
workspace-root | Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory) | No | . | string |
Validate Terraform files
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
attach-workspace | Attach (CircleCI) workspace to job. | No | false | boolean |
backend | Enable backend configuration or not | No | true | boolean |
backend_config | "Comma separated list of backend configs to set, e.g. 'foo=bar'"
| No | '' | string |
backend_config_file | Path to a backend config file | No | '' | string |
checkout | Perform checkout as first step in job. | No | false | boolean |
cli_config_file | Path to terraform cli config file | No | '' | string |
path | Path to the terraform module | No | . | string |
resource_class | Specify the resource class for Docker Executor | No | medium | string |
tag | Specify the Terraform Docker image tag for the executor | No | 1.0.0 | string |
timeout | Configure a custom timeout limit | No | 10m | string |
workspace | Name of the terraform workspace | No | '' | string |
workspace-root | Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory) | No | . | string |
Execute 'terraform apply' to apply desired configuration changes to state.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
backend_config | "Comma separated list of backend configs to set, e.g. 'foo=bar'"
| No | '' | string |
backend_config_file | Path to a backend config file | No | '' | string |
cli_config_file | Path to terraform cli config file | No | '' | string |
lock-timeout | Configure a custom state lock timeout | No | 30s | string |
parallelism | Limit the number of concurrent operation Terraform is running. Defaults to 10 | No | 10 | integer |
path | Path to the terraform module | No | . | string |
plan | Optionally provide a plan file to supply to the 'apply' command. | No | '' | string |
timeout | Configure a custom timeout limit | No | 10m | string |
var | Comma separated list of var to set, e.g. 'foo=bar,bas=foo' | No | '' | string |
var_file | Comma separated list of var file paths | No | '' | string |
workspace | Name of the terraform workspace | No | '' | string |
Execute 'terraform destroy' on current state.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
backend_config | "Comma separated list of backend configs to set, e.g. 'foo=bar'"
| No | '' | string |
backend_config_file | Path to a backend config file | No | '' | string |
cli_config_file | Path to terraform cli config file | No | '' | string |
path | Path to the terraform module | No | . | string |
timeout | Configure a custom timeout limit | No | 10m | string |
var | Comma separated list of var to set, e.g. 'foo=bar,bas=foo' | No | '' | string |
var_file | Comma separated list of var file paths | No | '' | string |
workspace | Name of the terraform workspace | No | '' | string |
Execute 'terraform fmt' in specified module path.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
path | Path to the terraform module | No | . | string |
recursive | Process files in subdirectories | No | false | boolean |
timeout | Configure a custom timeout limit | No | 10m | string |
Execute 'terraform init' in directory specified in 'path' parameter.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
backend | Enable backend configuration or not | No | true | boolean |
backend_config | "Comma separated list of backend configs to set, e.g. 'foo=bar'"
| No | '' | string |
backend_config_file | Path to a backend config file | No | '' | string |
cli_config_file | Path to terraform cli config file | No | '' | string |
path | Path to the terraform module | No | . | string |
timeout | Configure a custom timeout limit | No | 10m | string |
upgrade | Install the latest terraform module and provider versions | No | false | boolean |
Install specified version of terraform.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
arch | Specify the platform architecture to install. Must be one of these values: amd64, arm64 | No | amd64 | enum |
os | Specify the operating system version to install. Must be one of these values: linux, darwin | No | linux | enum |
terraform_version | Version of Terraform to install. Only stable versions are supported. You can specify the version in three ways:
* latest: most recent version
* full version number (1.2.3): a specific version
* anything else (1.2, 1): the most recent stable version which matches this prefix.
Defaults to latest.
| No | latest | string |
timeout | Configure a custom timeout limit | No | 10m | string |
Execute 'terraform plan' against current state.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
backend_config | "Comma separated list of backend configs to set, e.g. 'foo=bar'"
| No | '' | string |
backend_config_file | Path to a backend config file | No | '' | string |
cli_config_file | Path to terraform cli config file | No | '' | string |
destroy_plan | Run this plan as a destroy plan. | No | false | boolean |
lock | Enable the lock on the state file or not | No | true | boolean |
lock-timeout | Configure a custom state lock timeout | No | 30s | string |
out | The file path to save your terraform plan to. Set this to "" if you are using terraform cloud. | No | plan.out | string |
path | Path to the terraform module | No | . | string |
timeout | Configure a custom timeout limit | No | 10m | string |
var | Comma separated list of var to set, e.g. 'foo=bar,bas=foo' | No | '' | string |
var_file | Comma separated list of var file paths | No | '' | string |
workspace | Name of the terraform workspace | No | '' | string |
Execute 'terraform validate' against modules specified in 'path' variable.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
cli_config_file | Path to terraform cli config file | No | '' | string |
path | Path to the terraform module | No | . | string |
timeout | Configure a custom timeout limit | No | 10m | string |
workspace | Name of the terraform workspace | No | '' | string |
Simple Docker based Terraform executor.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
resource_class | Specify the resource class for Docker Executor | No | medium | string |
tag | Specify the Terraform Docker image tag for the executor. Default to latest. | No | latest | string |
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# This code is licensed from CircleCI to the user under the MIT license.
# See here for details: https://circleci.com/developer/orbs/licensing
version: 2.1
description: |
Deploy your infrastructure via a CircleCI pipeline using the Terraform orb. Integrate Infrastructure-as-Code (IaC) to help provision and manage any cloud, infrastructure, or service of your choice.
display:
home_url: https://www.terraform.io/
source_url: https://github.com/CircleCI-Public/terraform-orb
commands:
apply:
description: |
Execute 'terraform apply' to apply desired configuration changes to state.
parameters:
backend_config:
default: ""
description: |
"Comma separated list of backend configs to set, e.g. 'foo=bar'"
type: string
backend_config_file:
default: ""
description: Path to a backend config file
type: string
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
lock-timeout:
default: 30s
description: Configure a custom state lock timeout
type: string
parallelism:
default: 10
description: Limit the number of concurrent operation Terraform is running. Defaults to 10
type: integer
path:
default: .
description: Path to the terraform module
type: string
plan:
default: ""
description: Optionally provide a plan file to supply to the 'apply' command.
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
var:
default: ""
description: Comma separated list of var to set, e.g. 'foo=bar,bas=foo'
type: string
var_file:
default: ""
description: Comma separated list of var file paths
type: string
workspace:
default: ""
description: Name of the terraform workspace
type: string
steps:
- run:
command: |
#!/bin/bash
# Check CLI config file
if [[ -n "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
if [[ -f "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
export TF_CLI_CONFIG_FILE=${TF_PARAM_CLI_CONFIG_FILE}
else
echo "Terraform cli config does not exist: ${TF_PARAM_CLI_CONFIG_FILE}"
exit 1
fi
fi
# 'path' is a required parameter, save it as module_path
module_path="$(eval echo "$TF_PARAM_PATH")"
readonly module_path
path=$module_path
export path
if [[ ! -d "$module_path" ]]; then
echo "Path does not exist: $module_path"
exit 1
fi
# the following is needed to process backend configs
if [[ -n "${TF_PARAM_BACKEND_CONFIG_FILE}" ]]; then
for file in $(echo "${TF_PARAM_BACKEND_CONFIG_FILE}" | tr ',' '\n'); do
if [[ -f "$module_path/$file" ]] || [[ -f "$file" ]]; then
INIT_ARGS="$INIT_ARGS -backend-config=$file"
else
echo "Backend config '$file' wasn't found" >&2
exit 1
fi
done
fi
if [[ -n "${TF_PARAM_BACKEND_CONFIG}" ]]; then
for config in $(echo "${TF_PARAM_BACKEND_CONFIG}" | tr ',' '\n'); do
INIT_ARGS="$INIT_ARGS -backend-config=$(eval echo "$config")"
done
fi
export INIT_ARGS
workspace_parameter="$(eval echo "${TF_PARAM_WORKSPACE}")"
readonly workspace="${TF_WORKSPACE:-$workspace_parameter}"
export workspace
unset TF_WORKSPACE
if [[ -n "${TF_PARAM_VAR}" ]]; then
for var in $(echo "${TF_PARAM_VAR}" | tr ',' '\n'); do
PLAN_ARGS="$PLAN_ARGS -var $(eval echo "$var")"
done
fi
if [[ -n "${TF_PARAM_VAR_FILE}" ]]; then
for file in $(eval echo "${TF_PARAM_VAR_FILE}" | tr ',' '\n'); do
if [[ -f "$module_path/$file" ]] || [[ -f "$file" ]]; then
PLAN_ARGS="$PLAN_ARGS -var-file=$file"
else
echo "var file '$file' wasn't found" >&2
exit 1
fi
done
fi
if [[ -n "${TF_PARAM_LOCK_TIMEOUT}" ]]; then
PLAN_ARGS="$PLAN_ARGS -lock-timeout=${TF_PARAM_LOCK_TIMEOUT}"
fi
export PLAN_ARGS
# shellcheck disable=SC2086
terraform -chdir="$module_path" init -input=false $INIT_ARGS
# Test for saving state locally vs a remote state backend storage
if [[ -n "$workspace_parameter" ]]; then
echo "[INFO] Provisioning local workspace: $workspace"
terraform -chdir="$module_path" workspace select "$workspace" || terraform -chdir="$module_path" workspace new "$workspace"
else
echo "[INFO] Remote State Backend Enabled"
fi
# shellcheck disable=SC2086
terraform -chdir="$module_path" apply -auto-approve -parallelism=${TF_PARAM_PARALLELISM} $PLAN_ARGS ${TF_PARAM_PLAN}
environment:
TF_PARAM_BACKEND_CONFIG: <<parameters.backend_config>>
TF_PARAM_BACKEND_CONFIG_FILE: <<parameters.backend_config_file>>
TF_PARAM_CLI_CONFIG_FILE: <<parameters.cli_config_file>>
TF_PARAM_LOCK_TIMEOUT: << parameters.lock-timeout >>
TF_PARAM_PARALLELISM: <<parameters.parallelism>>
TF_PARAM_PATH: <<parameters.path>>
TF_PARAM_PLAN: <<parameters.plan>>
TF_PARAM_VAR: <<parameters.var>>
TF_PARAM_VAR_FILE: <<parameters.var_file>>
TF_PARAM_WORKSPACE: <<parameters.workspace>>
name: terraform apply
no_output_timeout: <<parameters.timeout>>
destroy:
description: |
Execute 'terraform destroy' on current state.
parameters:
backend_config:
default: ""
description: |
"Comma separated list of backend configs to set, e.g. 'foo=bar'"
type: string
backend_config_file:
default: ""
description: Path to a backend config file
type: string
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
path:
default: .
description: Path to the terraform module
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
var:
default: ""
description: Comma separated list of var to set, e.g. 'foo=bar,bas=foo'
type: string
var_file:
default: ""
description: Comma separated list of var file paths
type: string
workspace:
default: ""
description: Name of the terraform workspace
type: string
steps:
- run:
command: |
#!/bin/bash
# Check CLI config file
if [[ -n "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
if [[ -f "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
export TF_CLI_CONFIG_FILE=${TF_PARAM_CLI_CONFIG_FILE}
else
echo "Terraform cli config does not exist: ${TF_PARAM_CLI_CONFIG_FILE}"
exit 1
fi
fi
# 'path' is a required parameter, save it as module_path
module_path="$(eval echo "$TF_PARAM_PATH")"
readonly module_path
path=$module_path
export path
if [[ ! -d "$module_path" ]]; then
echo "Path does not exist: $module_path"
exit 1
fi
# Initialize terraform
if [[ -n "${TF_PARAM_BACKEND_CONFIG_FILE}" ]]; then
for file in $(echo "${TF_PARAM_BACKEND_CONFIG_FILE}" | tr ',' '\n'); do
if [[ -f "$module_path/$file" ]] || [[ -f "$file" ]]; then
INIT_ARGS="$INIT_ARGS -backend-config=$file"
else
echo "Backend config '$file' wasn't found" >&2
exit 1
fi
done
fi
if [[ -n "${TF_PARAM_BACKEND_CONFIG}" ]]; then
for config in $(echo "${TF_PARAM_BACKEND_CONFIG}" | tr ',' '\n'); do
INIT_ARGS="$INIT_ARGS -backend-config=$(eval echo "$config")"
done
fi
export INIT_ARGS
# shellcheck disable=SC2086
terraform -chdir="$module_path" init -input=false $INIT_ARGS
# Set workspace from parameter, allowing it to be overridden by TF_WORKSPACE.
# If TF_WORKSPACE is set we don't want terraform init to use the value, in the case we are running new_workspace.sh this would cause an error
workspace_parameter="$(eval echo "${TF_PARAM_WORKSPACE}")"
readonly workspace="${TF_WORKSPACE:-$workspace_parameter}"
export workspace
unset TF_WORKSPACE
rm -rf .terraform
# The line below is the original place for the init
# terraform -chdir="$module_path" init -input=false -lock-timeout=300s $INIT_ARGS
# Test for saving state locally vs a remote state backend storage
if [[ -n "$workspace_parameter" ]]; then
echo "[INFO] Provisioning local workspace: $workspace"
terraform -chdir="$module_path" workspace select "$workspace"
else
echo "[INFO] Remote State Backend Enabled"
fi
if [[ -n "${TF_PARAM_VAR}" ]]; then
for var in $(echo "${TF_PARAM_VAR}" | tr ',' '\n'); do
PLAN_ARGS="$PLAN_ARGS -var $(eval echo "$var")"
done
fi
if [[ -n "${TF_PARAM_VAR_FILE}" ]]; then
for file in $(eval echo "${TF_PARAM_VAR_FILE}" | tr ',' '\n'); do
if [[ -f "$module_path/$file" ]] || [[ -f "$file" ]]; then
PLAN_ARGS="$PLAN_ARGS -var-file=$file"
else
echo "Var file '$file' wasn't found" >&2
exit 1
fi
done
fi
export PLAN_ARGS
# terraform -chdir="$module_path" init -input=false -lock-timeout=300s $INIT_ARGS
# shellcheck disable=SC2086
terraform -chdir="$module_path" apply -destroy -input=false -auto-approve $PLAN_ARGS
environment:
TF_PARAM_BACKEND_CONFIG: << parameters.backend_config >>
TF_PARAM_BACKEND_CONFIG_FILE: << parameters.backend_config_file >>
TF_PARAM_CLI_CONFIG_FILE: << parameters.cli_config_file >>
TF_PARAM_PATH: << parameters.path >>
TF_PARAM_VAR: << parameters.var >>
TF_PARAM_VAR_FILE: << parameters.var_file >>
TF_PARAM_WORKSPACE: << parameters.workspace >>
name: terraform destroy
no_output_timeout: <<parameters.timeout>>
fmt:
description: |
Execute 'terraform fmt' in specified module path.
parameters:
path:
default: .
description: Path to the terraform module
type: string
recursive:
default: false
description: Process files in subdirectories
type: boolean
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
steps:
- run:
command: |
#!/bin/bash
# 'path' is a required parameter, save it as module_path
readonly module_path="$TF_PARAM_MOD_PATH"
export path=$module_path
if [[ ! -d "$module_path" ]]; then
echo "Path does not exist: \"$module_path\""
exit 1
fi
if [ "$TF_PARAM_IS_RECURSIVE" = "1" ]; then
set -- "$@" -recursive
fi
terraform -chdir="$module_path" fmt -check -diff "$@"
environment:
TF_PARAM_IS_RECURSIVE: << parameters.recursive >>
TF_PARAM_MOD_PATH: << parameters.path >>
name: terraform fmt
no_output_timeout: <<parameters.timeout>>
init:
description: |
Execute 'terraform init' in directory specified in 'path' parameter.
parameters:
backend:
default: true
description: Enable backend configuration or not
type: boolean
backend_config:
default: ""
description: |
"Comma separated list of backend configs to set, e.g. 'foo=bar'"
type: string
backend_config_file:
default: ""
description: Path to a backend config file
type: string
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
path:
default: .
description: Path to the terraform module
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
upgrade:
default: false
description: Install the latest terraform module and provider versions
type: boolean
steps:
- run:
command: |
#!/bin/bash
# Check CLI config file
if [[ -n "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
if [[ -f "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
export TF_CLI_CONFIG_FILE=${TF_PARAM_CLI_CONFIG_FILE}
else
echo "Terraform cli config does not exist: ${TF_PARAM_CLI_CONFIG_FILE}"
exit 1
fi
fi
# 'path' is a required parameter, save it as module_path
module_path="$(eval echo "$TF_PARAM_PATH")"
readonly module_path
path=$module_path
export path
if [[ ! -d "$module_path" ]]; then
echo "Path does not exist: $module_path"
exit 1
fi
backend="${TF_PARAM_BACKEND}"
export backend
# Initialize terraform
if [[ -n "${TF_PARAM_BACKEND_CONFIG_FILE}" ]]; then
for file in $(echo "${TF_PARAM_BACKEND_CONFIG_FILE}" | tr ',' '\n'); do
if [[ -f "$module_path/$file" ]] || [[ -f "$file" ]]; then
INIT_ARGS="$INIT_ARGS -backend-config=$file"
else
echo "Backend config '$file' wasn't found" >&2
exit 1
fi
done
fi
if [[ -n "${TF_PARAM_BACKEND_CONFIG}" ]]; then
for config in $(echo "${TF_PARAM_BACKEND_CONFIG}" | tr ',' '\n'); do
INIT_ARGS="$INIT_ARGS -backend-config=$(eval echo "$config")"
done
fi
if [[ "${TF_PARAM_UPGRADE}" = true ]]; then
INIT_ARGS="$INIT_ARGS -upgrade"
fi
export INIT_ARGS
# shellcheck disable=SC2086
terraform -chdir="$module_path" init -input=false -backend=$backend $INIT_ARGS
environment:
TF_PARAM_BACKEND: << parameters.backend >>
TF_PARAM_BACKEND_CONFIG: << parameters.backend_config >>
TF_PARAM_BACKEND_CONFIG_FILE: << parameters.backend_config_file >>
TF_PARAM_CLI_CONFIG_FILE: << parameters.cli_config_file >>
TF_PARAM_PATH: << parameters.path >>
TF_PARAM_UPGRADE: << parameters.upgrade >>
name: terraform init
no_output_timeout: <<parameters.timeout>>
install:
description: |
Install specified version of terraform.
parameters:
arch:
default: amd64
description: 'Specify the platform architecture to install. Must be one of these values: amd64, arm64'
enum:
- amd64
- arm64
type: enum
os:
default: linux
description: 'Specify the operating system version to install. Must be one of these values: linux, darwin'
enum:
- linux
- darwin
type: enum
terraform_version:
default: latest
description: |
Version of Terraform to install. Only stable versions are supported. You can specify the version in three ways:
* latest: most recent version
* full version number (1.2.3): a specific version
* anything else (1.2, 1): the most recent stable version which matches this prefix.
Defaults to latest.
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
steps:
- run:
command: |
#!/bin/bash
download_version() {
version=$1
local base_url="https://releases.hashicorp.com/terraform/${version}/terraform_${version}"
wget -nv "${base_url}_${TF_PARAM_OS}_${TF_PARAM_ARCH}.zip"
wget -nv "${base_url}_SHA256SUMS"
}
init() {
mkdir -p /tmp/terraform-install
cd /tmp/terraform-install || exit 1
}
# Reported in #61 that recent versions of the Terraform Docker image do not contain shasum
# This is a backwards compatible fix for verifying the Terraform binary
checksumCommand() {
file=$1
if [ "$(command -v shasum)" ]; then
shasum -a 256 "$file" | cut -d' ' -f1
elif [ "$(command -v sha256sum)" ]; then
sha256sum "$file" | cut -d' ' -f1
else
echo "No checksum tools found."
exit 1
fi
}
checksum_package() {
# Validate checksum
version=$1
# shellcheck disable=SC2002
expected_sha=$(cat "terraform_${version}_SHA256SUMS" | grep "terraform_${version}_${TF_PARAM_OS}_${TF_PARAM_ARCH}.zip" | awk '{print $1}')
export -f checksumCommand
download_sha=$(checksumCommand "terraform_${version}_${TF_PARAM_OS}_${TF_PARAM_ARCH}.zip")
echo "Validating download..."
if [ "$expected_sha" != "$download_sha" ]; then
echo "Expected SHA256SUM does not match downloaded file, exiting."
exit 1
fi
}
install_terraform() {
version=$1
unzip -o "terraform_${version}_${TF_PARAM_OS}_${TF_PARAM_ARCH}.zip"
if [[ $EUID == 0 ]]; then export SUDO=""; else export SUDO="sudo"; fi
$SUDO mv terraform /usr/local/bin
}
determine_version() {
# We might have an exact version, a partial version, or "latest"
version_spec=$1
version_regex="^[0-9]+\.[0-9]+\.[0-9]+$"
# Exact version needs no further processing
if [[ $version_spec =~ $version_regex ]]; then
echo "$version_spec"
return
fi
index_json=$(curl -sf https://releases.hashicorp.com/terraform/index.json)
released_versions=$(echo "$index_json" | jq -r '.versions | keys | .[]' | grep -E "$version_regex" | sort -rV)
if [[ $version_spec = latest ]]; then
head -1 \<<< "$released_versions"
return
fi
grep -m1 -E "^$version_spec" \<<< "$released_versions" || {
echo "Couldn't find matching version for '$version_spec'"
exit 1
}
return
}
init
tf_version=$(determine_version "$TF_PARAM_VERSION")
echo "Using Terraform version '$tf_version'"
download_version "${tf_version}"
checksum_package "${tf_version}"
install_terraform "${tf_version}"
terraform version
environment:
TF_PARAM_ARCH: <<parameters.arch>>
TF_PARAM_OS: <<parameters.os>>
TF_PARAM_VERSION: <<parameters.terraform_version>>
name: Install terraform binary
no_output_timeout: <<parameters.timeout>>
plan:
description: |
Execute 'terraform plan' against current state.
parameters:
backend_config:
default: ""
description: |
"Comma separated list of backend configs to set, e.g. 'foo=bar'"
type: string
backend_config_file:
default: ""
description: Path to a backend config file
type: string
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
destroy_plan:
default: false
description: Run this plan as a destroy plan.
type: boolean
lock:
default: true
description: Enable the lock on the state file or not
type: boolean
lock-timeout:
default: 30s
description: Configure a custom state lock timeout
type: string
out:
default: plan.out
description: The file path to save your terraform plan to. Set this to "" if you are using terraform cloud.
type: string
path:
default: .
description: Path to the terraform module
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
var:
default: ""
description: Comma separated list of var to set, e.g. 'foo=bar,bas=foo'
type: string
var_file:
default: ""
description: Comma separated list of var file paths
type: string
workspace:
default: ""
description: Name of the terraform workspace
type: string
steps:
- run:
command: |-
#!/bin/bash
# Check CLI config file
if [[ -n "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
if [[ -f "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
export TF_CLI_CONFIG_FILE=${TF_PARAM_CLI_CONFIG_FILE}
else
echo "Terraform cli config does not exist: ${TF_PARAM_CLI_CONFIG_FILE}"
exit 1
fi
fi
# 'path' is a required parameter, save it as module_path
module_path="$(eval echo "$TF_PARAM_PATH")"
readonly module_path
path=$module_path
export path
if [[ ! -d "$module_path" ]]; then
echo "Path does not exist: $module_path"
exit 1
fi
# the following is needed to process backend configs
if [[ -n "${TF_PARAM_BACKEND_CONFIG_FILE}" ]]; then
for file in $(echo "${TF_PARAM_BACKEND_CONFIG_FILE}" | tr ',' '\n'); do
if [[ -f "$module_path/$file" ]] || [[ -f "$file" ]]; then
INIT_ARGS="$INIT_ARGS -backend-config=$file"
else
echo "Backend config '$file' wasn't found" >&2
exit 1
fi
done
fi
if [[ -n "${TF_PARAM_BACKEND_CONFIG}" ]]; then
for config in $(echo "${TF_PARAM_BACKEND_CONFIG}" | tr ',' '\n'); do
INIT_ARGS="$INIT_ARGS -backend-config=$(eval echo "$config")"
done
fi
export INIT_ARGS
workspace_parameter="$(eval echo "${TF_PARAM_WORKSPACE}")"
readonly workspace="${TF_WORKSPACE:-$workspace_parameter}"
export workspace
unset TF_WORKSPACE
# shellcheck disable=SC2086
terraform -chdir="$module_path" init -input=false $INIT_ARGS
# Test for saving state locally vs a remote state backend storage
if [[ -n "$workspace_parameter" ]]; then
echo "[INFO] Provisioning local workspace: $workspace"
terraform -chdir="$module_path" workspace select "$workspace" || terraform -chdir="$module_path" workspace new "$workspace"
else
echo "[INFO] Remote State Backend Enabled"
fi
if [[ -n "${TF_PARAM_VAR}" ]]; then
for var in $(echo "${TF_PARAM_VAR}" | tr ',' '\n'); do
PLAN_ARGS="$PLAN_ARGS -var $(eval echo "$var")"
done
fi
if [[ -n "${TF_PARAM_VAR_FILE}" ]]; then
for file in $(eval echo "${TF_PARAM_VAR_FILE}" | tr ',' '\n'); do
if [[ -f "$module_path/$file" ]] || [[ -f "$file" ]]; then
PLAN_ARGS="$PLAN_ARGS -var-file=$file"
else
echo "var file '$file' wasn't found" >&2
exit 1
fi
done
fi
if [ "$TF_PARAM_DESTROY" = 1 ]; then
PLAN_ARGS="$PLAN_ARGS -destroy"
fi
if [[ -n "${TF_PARAM_LOCK_TIMEOUT}" ]]; then
PLAN_ARGS="$PLAN_ARGS -lock-timeout=${TF_PARAM_LOCK_TIMEOUT}"
fi
export PLAN_ARGS
# shellcheck disable=SC2086
set -x
terraform -chdir="$module_path" plan -input=false -out=${TF_PARAM_OUT} -lock=${TF_PARAM_LOCK} $PLAN_ARGS
set +x
environment:
TF_PARAM_BACKEND_CONFIG: <<parameters.backend_config>>
TF_PARAM_BACKEND_CONFIG_FILE: <<parameters.backend_config_file>>
TF_PARAM_CLI_CONFIG_FILE: <<parameters.cli_config_file>>
TF_PARAM_DESTROY: <<parameters.destroy_plan>>
TF_PARAM_LOCK: << parameters.lock >>
TF_PARAM_LOCK_TIMEOUT: << parameters.lock-timeout >>
TF_PARAM_OUT: << parameters.out >>
TF_PARAM_PATH: <<parameters.path>>
TF_PARAM_VAR: <<parameters.var>>
TF_PARAM_VAR_FILE: <<parameters.var_file>>
TF_PARAM_WORKSPACE: <<parameters.workspace>>
name: terraform plan
no_output_timeout: <<parameters.timeout>>
validate:
description: |
Execute 'terraform validate' against modules specified in 'path' variable.
parameters:
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
path:
default: .
description: Path to the terraform module
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
workspace:
default: ""
description: Name of the terraform workspace
type: string
steps:
- run:
command: |
#!/bin/bash
# Check CLI config file
if [[ -n "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
if [[ -f "${TF_PARAM_CLI_CONFIG_FILE}" ]]; then
export TF_CLI_CONFIG_FILE=${TF_PARAM_CLI_CONFIG_FILE}
else
echo "Terraform cli config does not exist: ${TF_PARAM_CLI_CONFIG_FILE}"
exit 1
fi
fi
module_path="$(eval echo "$TF_PARAM_PATH")"
readonly module_path
path=$module_path
export path
if [[ ! -d "$module_path" ]]; then
echo "Path does not exist: $module_path"
exit 1
fi
workspace_parameter="$(eval echo "${TF_PARAM_WORKSPACE}")"
readonly workspace="${TF_WORKSPACE:-$workspace_parameter}"
export workspace
unset TF_WORKSPACE
terraform -chdir="$TF_PARAM_PATH" init -input=false -backend=false
if [[ -n "$workspace_parameter" ]]; then
echo "[INFO] Provisioning local workspace: $workspace"
terraform -chdir="${TF_PARAM_PATH}" workspace select "$workspace" || terraform -chdir="${TF_PARAM_PATH}" workspace new "$workspace"
else
echo "[INFO] Remote State Backend Enabled"
fi
terraform -chdir="$TF_PARAM_PATH" validate
environment:
TF_PARAM_CLI_CONFIG_FILE: <<parameters.cli_config_file>>
TF_PARAM_PATH: << parameters.path >>
TF_PARAM_WORKSPACE: <<parameters.workspace>>
name: terraform validate
no_output_timeout: <<parameters.timeout>>
executors:
default:
description: |
Simple Docker based Terraform executor.
docker:
- image: hashicorp/terraform:<< parameters.tag >>
parameters:
resource_class:
default: medium
description: Specify the resource class for Docker Executor
type: string
tag:
default: latest
description: Specify the Terraform Docker image tag for the executor. Default to latest.
type: string
resource_class: << parameters.resource_class >>
jobs:
apply:
description: |
Execute terraform plan
executor:
name: default
resource_class: << parameters.resource_class >>
tag: << parameters.tag >>
parameters:
attach-workspace:
default: false
description: Attach (CircleCI) workspace to job.
type: boolean
backend_config:
default: ""
description: |
"Comma separated list of backend configs to set, e.g. 'foo=bar'"
type: string
backend_config_file:
default: ""
description: Path to a backend config file
type: string
checkout:
default: false
description: Perform checkout as first step in job.
type: boolean
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
lock-timeout:
default: 30s
description: Configure a custom state lock timeout
type: string
parallelism:
default: 10
description: Limit the number of concurrent operation Terraform is running. Defaults to 10
type: integer
path:
default: .
description: Path to the terraform module
type: string
persist-workspace:
default: false
description: Boolean parameter to indicate whether or not to attach to an existing workspace.
type: boolean
plan:
default: ""
description: Optionally provide a plan file to supply to the 'apply' command.
type: string
resource_class:
default: medium
description: Specify the resource class for Docker Executor
type: string
tag:
default: 1.0.0
description: Specify the Terraform Docker image tag for the executor
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
var:
default: ""
description: Comma separated list of vars to set, e.g. 'foo=bar,bas=foo'
type: string
var_file:
default: ""
description: Comma separated list of var file paths
type: string
workspace:
default: ""
description: Name of the terraform workspace
type: string
workspace-path:
default: .
description: 'Path of the workspace to persist to relative to workspace-root. '
type: string
workspace-root:
default: .
description: Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory)
type: string
steps:
- when:
condition: << parameters.checkout >>
steps:
- checkout
- when:
condition: << parameters.attach-workspace >>
steps:
- attach_workspace:
at: << parameters.workspace-root >>
- init:
backend_config: << parameters.backend_config >>
backend_config_file: << parameters.backend_config_file >>
cli_config_file: << parameters.cli_config_file >>
path: << parameters.path >>
- apply:
backend_config: << parameters.backend_config >>
backend_config_file: << parameters.backend_config_file >>
cli_config_file: << parameters.cli_config_file >>
lock-timeout: <<parameters.lock-timeout>>
parallelism: <<parameters.parallelism>>
path: << parameters.path >>
plan: <<parameters.plan>>
timeout: <<parameters.timeout>>
var: << parameters.var >>
var_file: << parameters.var_file >>
workspace: << parameters.workspace >>
- when:
condition: << parameters.persist-workspace >>
steps:
- persist_to_workspace:
paths:
- << parameters.workspace-path >>
root: << parameters.workspace-root >>
destroy:
description: |
Destroy current state
executor:
name: default
resource_class: << parameters.resource_class >>
tag: << parameters.tag >>
parameters:
attach-workspace:
default: false
description: Attach (CircleCI) workspace to job.
type: boolean
backend_config:
default: ""
description: |
"Comma separated list of backend configs to set, e.g. 'foo=bar'"
type: string
backend_config_file:
default: ""
description: Path to a backend config file
type: string
checkout:
default: false
description: Perform checkout as first step in job.
type: boolean
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
path:
default: .
description: Path to the terraform module
type: string
resource_class:
default: medium
description: Specify the resource class for Docker Executor
type: string
tag:
default: 1.0.0
description: Specify the Terraform Docker image tag for the executor
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
var:
default: ""
description: Comma separated list of vars to set, e.g. 'foo=bar,bas=foo'
type: string
var_file:
default: ""
description: Comma separated list of vars file paths
type: string
workspace:
default: ""
description: Name of the terraform workspace
type: string
workspace-root:
default: .
description: Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory)
type: string
steps:
- when:
condition: << parameters.checkout >>
steps:
- checkout
- when:
condition: << parameters.attach-workspace >>
steps:
- attach_workspace:
at: << parameters.workspace-root >>
- init:
backend_config: << parameters.backend_config >>
backend_config_file: << parameters.backend_config_file >>
cli_config_file: << parameters.cli_config_file >>
path: << parameters.path >>
timeout: <<parameters.timeout>>
- destroy:
backend_config: << parameters.backend_config >>
backend_config_file: << parameters.backend_config_file >>
cli_config_file: << parameters.cli_config_file >>
path: << parameters.path >>
timeout: <<parameters.timeout>>
var: << parameters.var >>
var_file: << parameters.var_file >>
workspace: << parameters.workspace >>
fmt:
description: |
Run terraform fmt
executor:
name: default
resource_class: << parameters.resource_class >>
tag: << parameters.tag >>
parameters:
attach-workspace:
default: false
description: Attach (CircleCI) workspace to job.
type: boolean
checkout:
default: false
description: Perform checkout as first step in job.
type: boolean
path:
default: .
description: Path to the terraform module
type: string
recursive:
default: false
description: Process files in subdirectories
type: boolean
resource_class:
default: medium
description: Specify the resource class for Docker Executor
type: string
tag:
default: 1.0.0
description: Specify the Terraform Docker image tag for the executor
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
workspace-root:
default: .
description: Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory)
type: string
steps:
- when:
condition: << parameters.checkout >>
steps:
- checkout
- when:
condition: << parameters.attach-workspace >>
steps:
- attach_workspace:
at: << parameters.workspace-root >>
- fmt:
path: << parameters.path >>
recursive: << parameters.recursive >>
timeout: <<parameters.timeout>>
init:
description: |
Inits terraform directory
executor:
name: default
resource_class: << parameters.resource_class >>
tag: << parameters.tag >>
parameters:
attach-workspace:
default: false
description: Do cool stuff with workspaces
type: boolean
checkout:
default: false
description: Perform checkout as first step in job.
type: boolean
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
path:
default: .
description: Path to the terraform module
type: string
resource_class:
default: medium
description: Specify the resource class for Docker Executor
type: string
tag:
default: 1.0.0
description: Specify the Terraform Docker image tag for the executor
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
workspace-root-dir:
default: .
description: circleci workspaces...not terraform
type: string
steps:
- when:
condition: << parameters.checkout >>
steps:
- checkout
- when:
condition: << parameters.attach-workspace >>
steps:
- attach_workspace:
at: << parameters.workspace-root-dir >>
- init:
cli_config_file: << parameters.cli_config_file >>
path: << parameters.path >>
timeout: <<parameters.timeout>>
plan:
description: |
Run Terraform plan against current state
executor:
name: default
resource_class: << parameters.resource_class >>
tag: << parameters.tag >>
parameters:
attach-workspace:
default: false
description: Do cool stuff with workspaces
type: boolean
backend_config:
default: ""
description: |
"Comma separated list of backend configs to set, e.g. 'foo=bar'"
type: string
backend_config_file:
default: ""
description: Path to a backend config file
type: string
checkout:
default: true
description: Perform checkout as first step in job.
type: boolean
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
destroy_plan:
default: false
description: Run this plan as a destroy plan.
type: boolean
lock-timeout:
default: 30s
description: Configure a custom state lock timeout
type: string
out:
default: plan.out
description: The file path to save your terraform plan to. Set this to "" if you are using terraform cloud.
type: string
path:
default: .
description: Path to the terraform module
type: string
persist-workspace:
default: false
description: Persist files to (cci) workspace for use in subsequent jobs
type: boolean
resource_class:
default: medium
description: Specify the resource class for Docker Executor
type: string
tag:
default: 1.0.0
description: Specify the Terraform Docker image tag for the executor
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
var:
default: ""
description: Comma separated list of vars to set, e.g. 'foo=bar,bas=foo'
type: string
var_file:
default: ""
description: Comma separated list of var file paths
type: string
workspace:
default: ""
description: Name of the terraform workspace
type: string
workspace-path:
default: .
description: Path of the workspace to persist to relative to workspace-root.
type: string
workspace-root:
default: .
description: Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory)
type: string
steps:
- when:
condition: << parameters.checkout >>
steps:
- checkout
- when:
condition: << parameters.attach-workspace >>
steps:
- attach_workspace:
at: << parameters.workspace-root >>
- init:
backend_config: << parameters.backend_config >>
backend_config_file: << parameters.backend_config_file >>
cli_config_file: << parameters.cli_config_file >>
path: << parameters.path >>
timeout: <<parameters.timeout>>
- plan:
backend_config: << parameters.backend_config >>
backend_config_file: << parameters.backend_config_file >>
cli_config_file: << parameters.cli_config_file >>
destroy_plan: << parameters.destroy_plan >>
lock-timeout: <<parameters.lock-timeout>>
out: << parameters.out >>
path: << parameters.path >>
timeout: <<parameters.timeout>>
var: << parameters.var >>
var_file: << parameters.var_file >>
workspace: << parameters.workspace >>
- when:
condition: << parameters.persist-workspace >>
steps:
- persist_to_workspace:
paths:
- << parameters.workspace-path >>
root: << parameters.workspace-root >>
validate:
description: |
Validate Terraform files
executor:
name: default
resource_class: << parameters.resource_class >>
tag: << parameters.tag >>
parameters:
attach-workspace:
default: false
description: Attach (CircleCI) workspace to job.
type: boolean
backend:
default: true
description: Enable backend configuration or not
type: boolean
backend_config:
default: ""
description: |
"Comma separated list of backend configs to set, e.g. 'foo=bar'"
type: string
backend_config_file:
default: ""
description: Path to a backend config file
type: string
checkout:
default: false
description: Perform checkout as first step in job.
type: boolean
cli_config_file:
default: ""
description: Path to terraform cli config file
type: string
path:
default: .
description: Path to the terraform module
type: string
resource_class:
default: medium
description: Specify the resource class for Docker Executor
type: string
tag:
default: 1.0.0
description: Specify the Terraform Docker image tag for the executor
type: string
timeout:
default: 10m
description: Configure a custom timeout limit
type: string
workspace:
default: ""
description: Name of the terraform workspace
type: string
workspace-root:
default: .
description: Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory)
type: string
steps:
- when:
condition: << parameters.checkout >>
steps:
- checkout
- when:
condition: << parameters.attach-workspace >>
steps:
- attach_workspace:
at: << parameters.workspace-root >>
- init:
backend: << parameters.backend >>
backend_config: << parameters.backend_config >>
backend_config_file: << parameters.backend_config_file >>
cli_config_file: << parameters.cli_config_file >>
path: << parameters.path >>
timeout: <<parameters.timeout>>
- validate:
cli_config_file: << parameters.cli_config_file >>
path: << parameters.path >>
timeout: <<parameters.timeout>>
workspace: <<parameters.workspace>>
examples:
deploy_infrastructure:
description: |
Deploy infrastructure leveraging a sequence of jobs and workspaces to create and persist a terraform plan.
Apply will 'apply' the result of a terraform plan.
usage:
version: "2.1"
orbs:
terraform: circleci/terraform@3.5
workflows:
deploy_infrastructure:
jobs:
- terraform/fmt:
checkout: true
context: terraform
- terraform/validate:
checkout: true
context: terraform
requires:
- terraform/fmt
- terraform/plan:
checkout: true
context: terraform
persist-workspace: true
requires:
- terraform/validate
- terraform/apply:
attach-workspace: true
context: terraform
filters:
branches:
only: main
requires:
- terraform/plan
deploy_infrastructure_job:
description: |
Deploy infrastructure by leveraging a sequence of commands to create and apply subsequent terraform plan.
usage:
version: "2.1"
orbs:
terraform: circleci/terraform@3.5
jobs:
single-job-lifecycle:
executor: terraform/default
steps:
- checkout
- terraform/init:
path: .
- terraform/validate:
path: .
- terraform/fmt:
path: .
- terraform/plan:
path: .
- terraform/apply:
path: .
- terraform/plan:
destroy_plan: true
path: .
- terraform/destroy:
path: .
working_directory: ~/src
workflows:
single-job-lifecycle:
jobs:
- single-job-lifecycle
deploy_using_remote_backend:
description: |
Deploy infrastructure that uses a remote backend to manage state. This example uses a Terraform Cloud example and references a remote.hcl file to specify the backend config.
usage:
version: "2.1"
orbs:
terraform: circleci/terraform@3.5
jobs:
single-job-lifecycle:
executor: terraform/default
steps:
- checkout
- run:
command: echo "credentials \"app.terraform.io\" {token = \"$TERRAFORM_TOKEN\"}" > $HOME/.terraformrc
name: Create .terraformrc file locally
- terraform/install:
arch: amd64
os: linux
terraform_version: 0.14.2
- terraform/fmt:
path: .
- terraform/validate:
path: .
- terraform/init:
backend: true
backend_config_file: backend.hcl
path: .
- terraform/plan:
backend_config_file: backend.hcl
path: .
- terraform/apply:
backend_config_file: backend.hcl
path: .
- terraform/destroy:
path: .
working_directory: ~/src
workflows:
single-job-lifecycle:
jobs:
- single-job-lifecycle