sfn 3.0.32 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/bin/command-config-generator +34 -14
- data/docs/command-config.md +338 -1
- data/docs/commands.md +56 -10
- data/docs/usage.md +1 -0
- data/lib/sfn.rb +1 -0
- data/lib/sfn/command.rb +1 -0
- data/lib/sfn/command/import.rb +8 -1
- data/lib/sfn/command/plan.rb +8 -51
- data/lib/sfn/command/realize.rb +82 -0
- data/lib/sfn/command/update.rb +1 -1
- data/lib/sfn/command_module/planning.rb +6 -2
- data/lib/sfn/command_module/stack.rb +11 -3
- data/lib/sfn/command_module/template.rb +5 -1
- data/lib/sfn/config.rb +9 -1
- data/lib/sfn/config/plan.rb +18 -0
- data/lib/sfn/config/realize.rb +13 -0
- data/lib/sfn/config/validate.rb +8 -1
- data/lib/sfn/error.rb +61 -0
- data/lib/sfn/version.rb +1 -1
- metadata +5 -3
- data/lib/chef/knife/knife_plugin_seed.rb +0 -117
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 61e1f8b5f3368c544eb62deddf53125068fb58da22d78e0314149017fc525876
|
|
4
|
+
data.tar.gz: 30f8e10f6b1fe2364ce1eab3ba6a5b8fabd37386f0dcda8ae10bf4b81ff80789
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2a723ade4a10648cef17999848c8b41e3b6867c29611bd0b0c4530e30d447b939590153cdc1946a113cc43625b10ac8f42ddfb3d11f200d4ccccfd447ed59cfc
|
|
7
|
+
data.tar.gz: '013810809d502b67e8d7257cda9cf37b438bd1d3a5e3ced5fd5fb49e1d4917533024bf46031ae54187b0d1e150ed827ab0e363b888ebbda7f0512f5f4479b449'
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
# v3.1.0
|
|
2
|
+
* [enhancement] Split `plan` command into `plan` and `realize` (#285)
|
|
3
|
+
* [deprecation] Remove sfn command mapping knife integration (#286)
|
|
4
|
+
* [fix] Properly handle multiple type compile parameters (#287)
|
|
5
|
+
|
|
1
6
|
# v3.0.32
|
|
2
7
|
* [enhancement] Store AWS STS information on failure
|
|
3
8
|
* [enhancement] Show parameter name when validation fails (#273)
|
|
@@ -1,44 +1,64 @@
|
|
|
1
1
|
#!/usr/bin/env ruby
|
|
2
2
|
|
|
3
|
-
require
|
|
3
|
+
require "sfn"
|
|
4
4
|
|
|
5
|
-
print
|
|
5
|
+
print "Generating command and configuration page..."
|
|
6
6
|
|
|
7
7
|
klasses = Sfn::Config.constants.sort.map do |const|
|
|
8
8
|
klass = Sfn::Config.const_get(const)
|
|
9
9
|
klass if klass.is_a?(Class) && klass.respond_to?(:attributes)
|
|
10
10
|
end.compact
|
|
11
11
|
|
|
12
|
-
file = File.open(File.join(File.dirname(__FILE__),
|
|
12
|
+
file = File.open(File.join(File.dirname(__FILE__), "..", "docs", "command-config.md"), "w")
|
|
13
13
|
|
|
14
14
|
file.puts <<-EOS
|
|
15
15
|
---
|
|
16
|
-
title: "
|
|
16
|
+
title: "Configuration"
|
|
17
17
|
weight: 6
|
|
18
18
|
anchors:
|
|
19
19
|
EOS
|
|
20
20
|
|
|
21
21
|
klasses.each do |klass|
|
|
22
|
-
file.puts " - title: \"#{klass.name.split(
|
|
23
|
-
file.puts " url: \"##{klass.name.split(
|
|
22
|
+
file.puts " - title: \"#{klass.name.split("::").last} Command\""
|
|
23
|
+
file.puts " url: \"##{klass.name.split("::").last.downcase}-command\""
|
|
24
24
|
end
|
|
25
|
-
file.puts
|
|
25
|
+
file.puts "---"
|
|
26
|
+
file.puts <<-EOS
|
|
27
|
+
|
|
28
|
+
# Command configurations
|
|
29
|
+
|
|
30
|
+
This lists commands and the options which the commands accept. It also
|
|
31
|
+
includes the valid types which the options will accept. Options can be
|
|
32
|
+
set with the `.sfn` configuration file to apply default values which
|
|
33
|
+
can be overridden on the CLI. Options defined within the `.sfn` configuration
|
|
34
|
+
file are the option name with `-` characters replaced with `_`.
|
|
35
|
+
|
|
36
|
+
For example, the option `--apply-mapping` can be defined in the `.sfn`
|
|
37
|
+
configuration file as:
|
|
38
|
+
|
|
39
|
+
~~~ruby
|
|
40
|
+
Configuration.new do
|
|
41
|
+
apply_mapping true
|
|
42
|
+
end
|
|
43
|
+
~~~
|
|
44
|
+
|
|
45
|
+
EOS
|
|
26
46
|
|
|
27
47
|
klasses.each do |klass|
|
|
28
|
-
file.puts "## #{klass.name.split(
|
|
48
|
+
file.puts "## #{klass.name.split("::").last} Command"
|
|
29
49
|
file.puts
|
|
30
|
-
file.puts
|
|
31
|
-
file.puts "$ sfn #{klass.name.split(
|
|
32
|
-
file.puts
|
|
50
|
+
file.puts "~~~"
|
|
51
|
+
file.puts "$ sfn #{klass.name.split("::").last.downcase}"
|
|
52
|
+
file.puts "~~~"
|
|
33
53
|
file.puts "\n"
|
|
34
54
|
file.puts "| Option | Attribute | Value"
|
|
35
55
|
file.puts "|--------|-----------|------"
|
|
36
56
|
klass.attributes.sort_by(&:first).map do |name, value|
|
|
37
|
-
file.puts "| `--#{name.to_s.tr(
|
|
38
|
-
file.puts "| | Valid | `#{[value[:type]].flatten.compact.join(
|
|
57
|
+
file.puts "| `--#{name.to_s.tr("_", "-")}` | Description | #{value[:description]} |"
|
|
58
|
+
file.puts "| | Valid | `#{[value[:type]].flatten.compact.join("`, `")}` |"
|
|
39
59
|
file.puts "| | Default | #{value[:default].inspect unless value[:default].nil?}|\n"
|
|
40
60
|
end
|
|
41
61
|
file.puts
|
|
42
62
|
end
|
|
43
63
|
|
|
44
|
-
puts
|
|
64
|
+
puts "done"
|
data/docs/command-config.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Configuration"
|
|
3
3
|
weight: 6
|
|
4
4
|
anchors:
|
|
5
5
|
- title: "Conf Command"
|
|
@@ -28,15 +28,37 @@ anchors:
|
|
|
28
28
|
url: "#lint-command"
|
|
29
29
|
- title: "List Command"
|
|
30
30
|
url: "#list-command"
|
|
31
|
+
- title: "Plan Command"
|
|
32
|
+
url: "#plan-command"
|
|
31
33
|
- title: "Print Command"
|
|
32
34
|
url: "#print-command"
|
|
33
35
|
- title: "Promote Command"
|
|
34
36
|
url: "#promote-command"
|
|
37
|
+
- title: "Realize Command"
|
|
38
|
+
url: "#realize-command"
|
|
35
39
|
- title: "Update Command"
|
|
36
40
|
url: "#update-command"
|
|
37
41
|
- title: "Validate Command"
|
|
38
42
|
url: "#validate-command"
|
|
39
43
|
---
|
|
44
|
+
|
|
45
|
+
# Command configurations
|
|
46
|
+
|
|
47
|
+
This lists commands and the options which the commands accept. It also
|
|
48
|
+
includes the valid types which the options will accept. Options can be
|
|
49
|
+
set with the `.sfn` configuration file to apply default values which
|
|
50
|
+
can be overridden on the CLI. Options defined within the `.sfn` configuration
|
|
51
|
+
file are the option name with `-` characters replaced with `_`.
|
|
52
|
+
|
|
53
|
+
For example, the option `--apply-mapping` can be defined in the `.sfn`
|
|
54
|
+
configuration file as:
|
|
55
|
+
|
|
56
|
+
~~~ruby
|
|
57
|
+
Configuration.new do
|
|
58
|
+
apply_mapping true
|
|
59
|
+
end
|
|
60
|
+
~~~
|
|
61
|
+
|
|
40
62
|
## Conf Command
|
|
41
63
|
|
|
42
64
|
~~~
|
|
@@ -57,6 +79,9 @@ $ sfn conf
|
|
|
57
79
|
| `--base-directory` | Description | Path to root of of templates directory |
|
|
58
80
|
| | Valid | `String` |
|
|
59
81
|
| | Default | |
|
|
82
|
+
| `--colors` | Description | Enable colorized output |
|
|
83
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
84
|
+
| | Default | true|
|
|
60
85
|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
61
86
|
| | Valid | `Bogo::Smash` |
|
|
62
87
|
| | Default | |
|
|
@@ -90,6 +115,9 @@ $ sfn conf
|
|
|
90
115
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
91
116
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
92
117
|
| | Default | true|
|
|
118
|
+
| `--log` | Description | Enable logging with given level |
|
|
119
|
+
| | Valid | `String` |
|
|
120
|
+
| | Default | |
|
|
93
121
|
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
94
122
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
95
123
|
| | Default | false|
|
|
@@ -174,6 +202,9 @@ $ sfn create
|
|
|
174
202
|
| `--base-directory` | Description | Path to root of of templates directory |
|
|
175
203
|
| | Valid | `String` |
|
|
176
204
|
| | Default | |
|
|
205
|
+
| `--colors` | Description | Enable colorized output |
|
|
206
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
207
|
+
| | Default | true|
|
|
177
208
|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
178
209
|
| | Valid | `Bogo::Smash` |
|
|
179
210
|
| | Default | |
|
|
@@ -204,6 +235,9 @@ $ sfn create
|
|
|
204
235
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
205
236
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
206
237
|
| | Default | true|
|
|
238
|
+
| `--log` | Description | Enable logging with given level |
|
|
239
|
+
| | Valid | `String` |
|
|
240
|
+
| | Default | |
|
|
207
241
|
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
208
242
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
209
243
|
| | Default | false|
|
|
@@ -276,6 +310,9 @@ $ sfn describe
|
|
|
276
310
|
|
|
277
311
|
| Option | Attribute | Value
|
|
278
312
|
|--------|-----------|------
|
|
313
|
+
| `--colors` | Description | Enable colorized output |
|
|
314
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
315
|
+
| | Default | true|
|
|
279
316
|
| `--conf` | Description | |
|
|
280
317
|
| | Valid | `Sfn::Config::Conf` |
|
|
281
318
|
| | Default | |
|
|
@@ -315,6 +352,9 @@ $ sfn describe
|
|
|
315
352
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
316
353
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
317
354
|
| | Default | true|
|
|
355
|
+
| `--log` | Description | Enable logging with given level |
|
|
356
|
+
| | Valid | `String` |
|
|
357
|
+
| | Default | |
|
|
318
358
|
| `--outputs` | Description | Display stack outputs |
|
|
319
359
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
320
360
|
| | Default | |
|
|
@@ -342,6 +382,9 @@ $ sfn destroy
|
|
|
342
382
|
|
|
343
383
|
| Option | Attribute | Value
|
|
344
384
|
|--------|-----------|------
|
|
385
|
+
| `--colors` | Description | Enable colorized output |
|
|
386
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
387
|
+
| | Default | true|
|
|
345
388
|
| `--conf` | Description | |
|
|
346
389
|
| | Valid | `Sfn::Config::Conf` |
|
|
347
390
|
| | Default | |
|
|
@@ -366,6 +409,9 @@ $ sfn destroy
|
|
|
366
409
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
367
410
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
368
411
|
| | Default | true|
|
|
412
|
+
| `--log` | Description | Enable logging with given level |
|
|
413
|
+
| | Valid | `String` |
|
|
414
|
+
| | Default | |
|
|
369
415
|
| `--poll` | Description | Poll stack events on modification actions |
|
|
370
416
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
371
417
|
| | Default | true|
|
|
@@ -396,6 +442,9 @@ $ sfn diff
|
|
|
396
442
|
| `--base-directory` | Description | Path to root of of templates directory |
|
|
397
443
|
| | Valid | `String` |
|
|
398
444
|
| | Default | |
|
|
445
|
+
| `--colors` | Description | Enable colorized output |
|
|
446
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
447
|
+
| | Default | true|
|
|
399
448
|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
400
449
|
| | Valid | `Bogo::Smash` |
|
|
401
450
|
| | Default | |
|
|
@@ -426,6 +475,9 @@ $ sfn diff
|
|
|
426
475
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
427
476
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
428
477
|
| | Default | true|
|
|
478
|
+
| `--log` | Description | Enable logging with given level |
|
|
479
|
+
| | Valid | `String` |
|
|
480
|
+
| | Default | |
|
|
429
481
|
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
430
482
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
431
483
|
| | Default | false|
|
|
@@ -498,6 +550,9 @@ $ sfn events
|
|
|
498
550
|
| `--attribute` | Description | Event attribute to display |
|
|
499
551
|
| | Valid | `String` |
|
|
500
552
|
| | Default | |
|
|
553
|
+
| `--colors` | Description | Enable colorized output |
|
|
554
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
555
|
+
| | Default | true|
|
|
501
556
|
| `--conf` | Description | |
|
|
502
557
|
| | Valid | `Sfn::Config::Conf` |
|
|
503
558
|
| | Default | |
|
|
@@ -525,6 +580,9 @@ $ sfn events
|
|
|
525
580
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
526
581
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
527
582
|
| | Default | true|
|
|
583
|
+
| `--log` | Description | Enable logging with given level |
|
|
584
|
+
| | Valid | `String` |
|
|
585
|
+
| | Default | |
|
|
528
586
|
| `--poll` | Description | Poll stack events on modification actions |
|
|
529
587
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
530
588
|
| | Default | true|
|
|
@@ -552,6 +610,9 @@ $ sfn export
|
|
|
552
610
|
| `--bucket-prefix` | Description | Remote key prefix within bucket for dump file |
|
|
553
611
|
| | Valid | `String` |
|
|
554
612
|
| | Default | |
|
|
613
|
+
| `--colors` | Description | Enable colorized output |
|
|
614
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
615
|
+
| | Default | true|
|
|
555
616
|
| `--conf` | Description | |
|
|
556
617
|
| | Valid | `Sfn::Config::Conf` |
|
|
557
618
|
| | Default | |
|
|
@@ -582,6 +643,9 @@ $ sfn export
|
|
|
582
643
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
583
644
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
584
645
|
| | Default | true|
|
|
646
|
+
| `--log` | Description | Enable logging with given level |
|
|
647
|
+
| | Valid | `String` |
|
|
648
|
+
| | Default | |
|
|
585
649
|
| `--name` | Description | Export file base name |
|
|
586
650
|
| | Valid | `String` |
|
|
587
651
|
| | Default | |
|
|
@@ -612,6 +676,9 @@ $ sfn graph
|
|
|
612
676
|
| `--base-directory` | Description | Path to root of of templates directory |
|
|
613
677
|
| | Valid | `String` |
|
|
614
678
|
| | Default | |
|
|
679
|
+
| `--colors` | Description | Enable colorized output |
|
|
680
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
681
|
+
| | Default | true|
|
|
615
682
|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
616
683
|
| | Valid | `Bogo::Smash` |
|
|
617
684
|
| | Default | |
|
|
@@ -642,6 +709,9 @@ $ sfn graph
|
|
|
642
709
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
643
710
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
644
711
|
| | Default | true|
|
|
712
|
+
| `--log` | Description | Enable logging with given level |
|
|
713
|
+
| | Valid | `String` |
|
|
714
|
+
| | Default | |
|
|
645
715
|
| `--luckymike` | Description | Force `dependency` style graph |
|
|
646
716
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
647
717
|
| | Default | false|
|
|
@@ -699,6 +769,9 @@ $ sfn import
|
|
|
699
769
|
| `--bucket-prefix` | Description | Remote key prefix within bucket for dump file |
|
|
700
770
|
| | Valid | `String` |
|
|
701
771
|
| | Default | |
|
|
772
|
+
| `--colors` | Description | Enable colorized output |
|
|
773
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
774
|
+
| | Default | true|
|
|
702
775
|
| `--conf` | Description | |
|
|
703
776
|
| | Valid | `Sfn::Config::Conf` |
|
|
704
777
|
| | Default | |
|
|
@@ -732,6 +805,9 @@ $ sfn import
|
|
|
732
805
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
733
806
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
734
807
|
| | Default | true|
|
|
808
|
+
| `--log` | Description | Enable logging with given level |
|
|
809
|
+
| | Valid | `String` |
|
|
810
|
+
| | Default | |
|
|
735
811
|
| `--path` | Description | Directory path JSON export files are located |
|
|
736
812
|
| | Valid | `String` |
|
|
737
813
|
| | Default | |
|
|
@@ -753,6 +829,9 @@ $ sfn init
|
|
|
753
829
|
|
|
754
830
|
| Option | Attribute | Value
|
|
755
831
|
|--------|-----------|------
|
|
832
|
+
| `--colors` | Description | Enable colorized output |
|
|
833
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
834
|
+
| | Default | true|
|
|
756
835
|
| `--conf` | Description | |
|
|
757
836
|
| | Valid | `Sfn::Config::Conf` |
|
|
758
837
|
| | Default | |
|
|
@@ -798,6 +877,9 @@ $ sfn init
|
|
|
798
877
|
| `--list` | Description | |
|
|
799
878
|
| | Valid | `Sfn::Config::List` |
|
|
800
879
|
| | Default | |
|
|
880
|
+
| `--log` | Description | Enable logging with given level |
|
|
881
|
+
| | Valid | `String` |
|
|
882
|
+
| | Default | |
|
|
801
883
|
| `--poll` | Description | Poll stack events on modification actions |
|
|
802
884
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
803
885
|
| | Default | true|
|
|
@@ -825,6 +907,9 @@ $ sfn inspect
|
|
|
825
907
|
| `--attribute` | Description | Dot delimited attribute to view |
|
|
826
908
|
| | Valid | `String` |
|
|
827
909
|
| | Default | |
|
|
910
|
+
| `--colors` | Description | Enable colorized output |
|
|
911
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
912
|
+
| | Default | true|
|
|
828
913
|
| `--conf` | Description | |
|
|
829
914
|
| | Valid | `Sfn::Config::Conf` |
|
|
830
915
|
| | Default | |
|
|
@@ -873,6 +958,9 @@ $ sfn inspect
|
|
|
873
958
|
| `--load-balancers` | Description | Locate all load balancers, display addresses and server states |
|
|
874
959
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
875
960
|
| | Default | |
|
|
961
|
+
| `--log` | Description | Enable logging with given level |
|
|
962
|
+
| | Valid | `String` |
|
|
963
|
+
| | Default | |
|
|
876
964
|
| `--nodes` | Description | Locate all instances and display addresses |
|
|
877
965
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
878
966
|
| | Default | |
|
|
@@ -903,6 +991,9 @@ $ sfn lint
|
|
|
903
991
|
| `--base-directory` | Description | Path to root of of templates directory |
|
|
904
992
|
| | Valid | `String` |
|
|
905
993
|
| | Default | |
|
|
994
|
+
| `--colors` | Description | Enable colorized output |
|
|
995
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
996
|
+
| | Default | true|
|
|
906
997
|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
907
998
|
| | Valid | `Bogo::Smash` |
|
|
908
999
|
| | Default | |
|
|
@@ -942,6 +1033,9 @@ $ sfn lint
|
|
|
942
1033
|
| `--local-rule-sets-only` | Description | Only apply rule sets provided by lint directory |
|
|
943
1034
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
944
1035
|
| | Default | false|
|
|
1036
|
+
| `--log` | Description | Enable logging with given level |
|
|
1037
|
+
| | Valid | `String` |
|
|
1038
|
+
| | Default | |
|
|
945
1039
|
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
946
1040
|
| | Valid | `String` |
|
|
947
1041
|
| | Default | |
|
|
@@ -990,6 +1084,9 @@ $ sfn list
|
|
|
990
1084
|
| `--attribute` | Description | Attribute of stack to print |
|
|
991
1085
|
| | Valid | `String` |
|
|
992
1086
|
| | Default | |
|
|
1087
|
+
| `--colors` | Description | Enable colorized output |
|
|
1088
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1089
|
+
| | Default | true|
|
|
993
1090
|
| `--conf` | Description | |
|
|
994
1091
|
| | Valid | `Sfn::Config::Conf` |
|
|
995
1092
|
| | Default | |
|
|
@@ -1032,6 +1129,9 @@ $ sfn list
|
|
|
1032
1129
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1033
1130
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1034
1131
|
| | Default | true|
|
|
1132
|
+
| `--log` | Description | Enable logging with given level |
|
|
1133
|
+
| | Valid | `String` |
|
|
1134
|
+
| | Default | |
|
|
1035
1135
|
| `--poll` | Description | Poll stack events on modification actions |
|
|
1036
1136
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1037
1137
|
| | Default | true|
|
|
@@ -1045,6 +1145,138 @@ $ sfn list
|
|
|
1045
1145
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1046
1146
|
| | Default | |
|
|
1047
1147
|
|
|
1148
|
+
## Plan Command
|
|
1149
|
+
|
|
1150
|
+
~~~
|
|
1151
|
+
$ sfn plan
|
|
1152
|
+
~~~
|
|
1153
|
+
|
|
1154
|
+
| Option | Attribute | Value
|
|
1155
|
+
|--------|-----------|------
|
|
1156
|
+
| `--apply-mapping` | Description | Customize apply stack mapping as [StackName__]OutputName:ParameterName (Key:Value[,Key:Value,...]) |
|
|
1157
|
+
| | Valid | `Bogo::Smash` |
|
|
1158
|
+
| | Default | |
|
|
1159
|
+
| `--apply-nesting` | Description | Apply stack nesting |
|
|
1160
|
+
| | Valid | `String`, `Symbol` |
|
|
1161
|
+
| | Default | "deep"|
|
|
1162
|
+
| `--apply-stack` | Description | Apply outputs from stack to input parameters |
|
|
1163
|
+
| | Valid | `String` |
|
|
1164
|
+
| | Default | |
|
|
1165
|
+
| `--auto-destroy-plan` | Description | Automatically destroy generated plan |
|
|
1166
|
+
| | Valid | `TrueClass`, `FalseClass`, `NilClass` |
|
|
1167
|
+
| | Default | |
|
|
1168
|
+
| `--auto-destroy-stack` | Description | Automatically destroy empty stack |
|
|
1169
|
+
| | Valid | `TrueClass`, `FalseClass`, `NilClass` |
|
|
1170
|
+
| | Default | |
|
|
1171
|
+
| `--base-directory` | Description | Path to root of of templates directory |
|
|
1172
|
+
| | Valid | `String` |
|
|
1173
|
+
| | Default | |
|
|
1174
|
+
| `--colors` | Description | Enable colorized output |
|
|
1175
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1176
|
+
| | Default | true|
|
|
1177
|
+
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
1178
|
+
| | Valid | `Bogo::Smash` |
|
|
1179
|
+
| | Default | |
|
|
1180
|
+
| `--config` | Description | Configuration file path |
|
|
1181
|
+
| | Valid | `String` |
|
|
1182
|
+
| | Default | |
|
|
1183
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
1184
|
+
| | Valid | `Bogo::Smash` |
|
|
1185
|
+
| | Default | |
|
|
1186
|
+
| `--debug` | Description | Enable debug output |
|
|
1187
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1188
|
+
| | Default | |
|
|
1189
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
1190
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1191
|
+
| | Default | |
|
|
1192
|
+
| `--diffs` | Description | Show planner content diff |
|
|
1193
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1194
|
+
| | Default | true|
|
|
1195
|
+
| `--file` | Description | Path to template file |
|
|
1196
|
+
| | Valid | `String` |
|
|
1197
|
+
| | Default | |
|
|
1198
|
+
| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
|
|
1199
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1200
|
+
| | Default | true|
|
|
1201
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
1202
|
+
| | Valid | `String` |
|
|
1203
|
+
| | Default | |
|
|
1204
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1205
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1206
|
+
| | Default | true|
|
|
1207
|
+
| `--list` | Description | List all available plans for stack |
|
|
1208
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1209
|
+
| | Default | false|
|
|
1210
|
+
| `--load-existing` | Description | Load existing plan if exists |
|
|
1211
|
+
| | Valid | `TrueClass`, `FalseClass`, `NilClass` |
|
|
1212
|
+
| | Default | |
|
|
1213
|
+
| `--log` | Description | Enable logging with given level |
|
|
1214
|
+
| | Valid | `String` |
|
|
1215
|
+
| | Default | |
|
|
1216
|
+
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
1217
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1218
|
+
| | Default | false|
|
|
1219
|
+
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
1220
|
+
| | Valid | `String` |
|
|
1221
|
+
| | Default | |
|
|
1222
|
+
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
|
|
1223
|
+
| | Valid | `String` |
|
|
1224
|
+
| | Default | |
|
|
1225
|
+
| `--no-base-directory` | Description | Unset any value used for the template root directory path |
|
|
1226
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1227
|
+
| | Default | |
|
|
1228
|
+
| `--notification-topics` | Description | Notification endpoints for stack events |
|
|
1229
|
+
| | Valid | `String` |
|
|
1230
|
+
| | Default | |
|
|
1231
|
+
| `--options` | Description | Extra options to apply to the API call (Key:Value[,Key:Value,...]) |
|
|
1232
|
+
| | Valid | `Bogo::Smash` |
|
|
1233
|
+
| | Default | |
|
|
1234
|
+
| `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
|
|
1235
|
+
| | Valid | `Bogo::Smash` |
|
|
1236
|
+
| | Default | |
|
|
1237
|
+
| `--parameter-validation` | Description | Stack parameter validation behavior |
|
|
1238
|
+
| | Valid | `String` |
|
|
1239
|
+
| | Default | "default"|
|
|
1240
|
+
| `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
|
|
1241
|
+
| | Valid | `Bogo::Smash` |
|
|
1242
|
+
| | Default | |
|
|
1243
|
+
| `--plan-name` | Description | Custom plan name or ID (not applicable to all providers) |
|
|
1244
|
+
| | Valid | `String` |
|
|
1245
|
+
| | Default | |
|
|
1246
|
+
| `--plan-only` | Description | Exit after plan display |
|
|
1247
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1248
|
+
| | Default | false|
|
|
1249
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
1250
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1251
|
+
| | Default | true|
|
|
1252
|
+
| `--print-only` | Description | Print the resulting stack template |
|
|
1253
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1254
|
+
| | Default | |
|
|
1255
|
+
| `--processing` | Description | Call the unicorns and explode the glitter bombs |
|
|
1256
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1257
|
+
| | Default | true|
|
|
1258
|
+
| `--rollback` | Description | Rollback stack on failure |
|
|
1259
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1260
|
+
| | Default | |
|
|
1261
|
+
| `--sparkle-pack` | Description | Load SparklePack gem |
|
|
1262
|
+
| | Valid | `String` |
|
|
1263
|
+
| | Default | |
|
|
1264
|
+
| `--timeout` | Description | Seconds to wait for stack to complete |
|
|
1265
|
+
| | Valid | `Integer` |
|
|
1266
|
+
| | Default | |
|
|
1267
|
+
| `--translate` | Description | Translate generated template to given provider |
|
|
1268
|
+
| | Valid | `String` |
|
|
1269
|
+
| | Default | |
|
|
1270
|
+
| `--translate-chunk` | Description | Chunk length for serialization |
|
|
1271
|
+
| | Valid | `Integer` |
|
|
1272
|
+
| | Default | |
|
|
1273
|
+
| `--upload-root-template` | Description | Upload root template to storage bucket |
|
|
1274
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1275
|
+
| | Default | |
|
|
1276
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
1277
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1278
|
+
| | Default | |
|
|
1279
|
+
|
|
1048
1280
|
## Print Command
|
|
1049
1281
|
|
|
1050
1282
|
~~~
|
|
@@ -1059,6 +1291,9 @@ $ sfn print
|
|
|
1059
1291
|
| `--base-directory` | Description | Path to root of of templates directory |
|
|
1060
1292
|
| | Valid | `String` |
|
|
1061
1293
|
| | Default | |
|
|
1294
|
+
| `--colors` | Description | Enable colorized output |
|
|
1295
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1296
|
+
| | Default | true|
|
|
1062
1297
|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
1063
1298
|
| | Valid | `Bogo::Smash` |
|
|
1064
1299
|
| | Default | |
|
|
@@ -1086,6 +1321,9 @@ $ sfn print
|
|
|
1086
1321
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1087
1322
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1088
1323
|
| | Default | true|
|
|
1324
|
+
| `--log` | Description | Enable logging with given level |
|
|
1325
|
+
| | Valid | `String` |
|
|
1326
|
+
| | Default | |
|
|
1089
1327
|
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
1090
1328
|
| | Valid | `String` |
|
|
1091
1329
|
| | Default | |
|
|
@@ -1122,6 +1360,9 @@ $ sfn print
|
|
|
1122
1360
|
| `--write-to-file` | Description | Write compiled SparkleFormation template to path provided |
|
|
1123
1361
|
| | Valid | `String` |
|
|
1124
1362
|
| | Default | |
|
|
1363
|
+
| `--yaml` | Description | Output template content in YAML format |
|
|
1364
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1365
|
+
| | Default | |
|
|
1125
1366
|
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
1126
1367
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1127
1368
|
| | Default | |
|
|
@@ -1143,6 +1384,78 @@ $ sfn promote
|
|
|
1143
1384
|
| `--bucket-prefix` | Description | Key prefix within remote bucket |
|
|
1144
1385
|
| | Valid | `String` |
|
|
1145
1386
|
| | Default | |
|
|
1387
|
+
| `--colors` | Description | Enable colorized output |
|
|
1388
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1389
|
+
| | Default | true|
|
|
1390
|
+
| `--conf` | Description | |
|
|
1391
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
1392
|
+
| | Default | |
|
|
1393
|
+
| `--config` | Description | Configuration file path |
|
|
1394
|
+
| | Valid | `String` |
|
|
1395
|
+
| | Default | |
|
|
1396
|
+
| `--create` | Description | |
|
|
1397
|
+
| | Valid | `Sfn::Config::Create` |
|
|
1398
|
+
| | Default | |
|
|
1399
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
1400
|
+
| | Valid | `Bogo::Smash` |
|
|
1401
|
+
| | Default | |
|
|
1402
|
+
| `--debug` | Description | Enable debug output |
|
|
1403
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1404
|
+
| | Default | |
|
|
1405
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
1406
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1407
|
+
| | Default | |
|
|
1408
|
+
| `--describe` | Description | |
|
|
1409
|
+
| | Valid | `Sfn::Config::Describe` |
|
|
1410
|
+
| | Default | |
|
|
1411
|
+
| `--destroy` | Description | |
|
|
1412
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
1413
|
+
| | Default | |
|
|
1414
|
+
| `--events` | Description | |
|
|
1415
|
+
| | Valid | `Sfn::Config::Events` |
|
|
1416
|
+
| | Default | |
|
|
1417
|
+
| `--export` | Description | |
|
|
1418
|
+
| | Valid | `Sfn::Config::Export` |
|
|
1419
|
+
| | Default | |
|
|
1420
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
1421
|
+
| | Valid | `String` |
|
|
1422
|
+
| | Default | |
|
|
1423
|
+
| `--import` | Description | |
|
|
1424
|
+
| | Valid | `Sfn::Config::Import` |
|
|
1425
|
+
| | Default | |
|
|
1426
|
+
| `--inspect` | Description | |
|
|
1427
|
+
| | Valid | `Sfn::Config::Inspect` |
|
|
1428
|
+
| | Default | |
|
|
1429
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1430
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1431
|
+
| | Default | true|
|
|
1432
|
+
| `--list` | Description | |
|
|
1433
|
+
| | Valid | `Sfn::Config::List` |
|
|
1434
|
+
| | Default | |
|
|
1435
|
+
| `--log` | Description | Enable logging with given level |
|
|
1436
|
+
| | Valid | `String` |
|
|
1437
|
+
| | Default | |
|
|
1438
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
1439
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1440
|
+
| | Default | true|
|
|
1441
|
+
| `--update` | Description | |
|
|
1442
|
+
| | Valid | `Sfn::Config::Update` |
|
|
1443
|
+
| | Default | |
|
|
1444
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
1445
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1446
|
+
| | Default | |
|
|
1447
|
+
|
|
1448
|
+
## Realize Command
|
|
1449
|
+
|
|
1450
|
+
~~~
|
|
1451
|
+
$ sfn realize
|
|
1452
|
+
~~~
|
|
1453
|
+
|
|
1454
|
+
| Option | Attribute | Value
|
|
1455
|
+
|--------|-----------|------
|
|
1456
|
+
| `--colors` | Description | Enable colorized output |
|
|
1457
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1458
|
+
| | Default | true|
|
|
1146
1459
|
| `--conf` | Description | |
|
|
1147
1460
|
| | Valid | `Sfn::Config::Conf` |
|
|
1148
1461
|
| | Default | |
|
|
@@ -1188,12 +1501,24 @@ $ sfn promote
|
|
|
1188
1501
|
| `--list` | Description | |
|
|
1189
1502
|
| | Valid | `Sfn::Config::List` |
|
|
1190
1503
|
| | Default | |
|
|
1504
|
+
| `--log` | Description | Enable logging with given level |
|
|
1505
|
+
| | Valid | `String` |
|
|
1506
|
+
| | Default | |
|
|
1507
|
+
| `--plan-name` | Description | Custom plan name or ID |
|
|
1508
|
+
| | Valid | `String` |
|
|
1509
|
+
| | Default | |
|
|
1191
1510
|
| `--poll` | Description | Poll stack events on modification actions |
|
|
1192
1511
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1193
1512
|
| | Default | true|
|
|
1513
|
+
| `--promote` | Description | |
|
|
1514
|
+
| | Valid | `Sfn::Config::Promote` |
|
|
1515
|
+
| | Default | |
|
|
1194
1516
|
| `--update` | Description | |
|
|
1195
1517
|
| | Valid | `Sfn::Config::Update` |
|
|
1196
1518
|
| | Default | |
|
|
1519
|
+
| `--validate` | Description | |
|
|
1520
|
+
| | Valid | `Sfn::Config::Validate` |
|
|
1521
|
+
| | Default | |
|
|
1197
1522
|
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
1198
1523
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1199
1524
|
| | Default | |
|
|
@@ -1218,6 +1543,9 @@ $ sfn update
|
|
|
1218
1543
|
| `--base-directory` | Description | Path to root of of templates directory |
|
|
1219
1544
|
| | Valid | `String` |
|
|
1220
1545
|
| | Default | |
|
|
1546
|
+
| `--colors` | Description | Enable colorized output |
|
|
1547
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1548
|
+
| | Default | true|
|
|
1221
1549
|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
1222
1550
|
| | Valid | `Bogo::Smash` |
|
|
1223
1551
|
| | Default | |
|
|
@@ -1248,6 +1576,9 @@ $ sfn update
|
|
|
1248
1576
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1249
1577
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1250
1578
|
| | Default | true|
|
|
1579
|
+
| `--log` | Description | Enable logging with given level |
|
|
1580
|
+
| | Valid | `String` |
|
|
1581
|
+
| | Default | |
|
|
1251
1582
|
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
1252
1583
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1253
1584
|
| | Default | false|
|
|
@@ -1314,6 +1645,9 @@ $ sfn validate
|
|
|
1314
1645
|
| `--base-directory` | Description | Path to root of of templates directory |
|
|
1315
1646
|
| | Valid | `String` |
|
|
1316
1647
|
| | Default | |
|
|
1648
|
+
| `--colors` | Description | Enable colorized output |
|
|
1649
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1650
|
+
| | Default | true|
|
|
1317
1651
|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
1318
1652
|
| | Valid | `Bogo::Smash` |
|
|
1319
1653
|
| | Default | |
|
|
@@ -1341,6 +1675,9 @@ $ sfn validate
|
|
|
1341
1675
|
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1342
1676
|
| | Valid | `TrueClass`, `FalseClass` |
|
|
1343
1677
|
| | Default | true|
|
|
1678
|
+
| `--log` | Description | Enable logging with given level |
|
|
1679
|
+
| | Valid | `String` |
|
|
1680
|
+
| | Default | |
|
|
1344
1681
|
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
1345
1682
|
| | Valid | `String` |
|
|
1346
1683
|
| | Default | |
|