-
Notifications
You must be signed in to change notification settings - Fork 0
/
aws-services-snapshot.sh
19678 lines (19650 loc) · 899 KB
/
aws-services-snapshot.sh
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
#! /bin/bash
#
#
##########################################
#
# begin bash shell script
#
##########################################
#
###############################################################################
#
# >>>> begin documentation <<<<
#
###############################################################################
#
#
##########################################################################################################
#
# Structure:
# A) documentation (this section)
# B) initialize (initializes variables and tables)
# C) functionDefinition (defines functions)
# D) setup (loads files, tables, and variables )
# E) main (creates program output)
#
# For quick access, search for 'begin' or 'end' and the section name
# Example: 'begin setup'
#
##########################################################################################################
#
# ------------------------------------------------------------------------------------
#
# MIT License
#
# Copyright (c) 2018 Enterprise Group, Ltd.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# ------------------------------------------------------------------------------------
#
# File: aws-services-snapshot.sh
# Source: https://github.com/Enterprise-Group-Ltd/aws-services-snapshot
#
script_version=2.1.38
#
# Dependencies:
# - postgresql instance running on EC2 (setup steps here: https://github.com/Enterprise-Group-Ltd/aws-services-snapshot/blob/master/docs/postgresql-install.md )
# - Microsoft Excel file: driver_aws_cli_commands-X-X-X.xlsx (this file is used to create the contents of the
# postgresql tables '_driver_aws_cli_commands' and '_driver_aws_cli_commands_recursive' )
# - bash shell
# - jq - JSON wrangler https://stedolan.github.io/jq/
# - AWS CLI tools (pre-installed on AWS AMIs)
# - AWS CLI profile with IAM permissions for the AWS CLI command:
# - aws ec2 describe-instances (used to test for valid -r region )
# - aws sts get-caller-identity (used to pull account number )
# - aws iam list-account-aliases (used to pull account alias )
# - AWS CLI profile with IAM permissions for the AWS CLI 'service describe', 'service get', and
# 'service list' commands included in the postgresql tables '_driver_aws_cli_commands' and '_driver_aws_cli_commands_recursive'
#
#
# Sample IAM policy JSON for "sts:GetCallerIdentity"
#
# {
# "Version": "2012-10-17",
# "Statement":
# {
# "Effect": "Allow",
# "Action": "sts:GetCallerIdentity",
# "Resource": "*"
# }
# }
#
#
# Sample IAM policy JSON for "iam:ListAccountAliases"
#
# {
# "Version": "2012-10-17",
# "Statement":
# {
# "Effect": "Allow",
# "Action": "iam:ListAccountAliases",
# "Resource": "*"
# }
# }
#
#
# Tested on:
# Windows Subsystem for Linux (WSL)
# Windows 10 Enterprise: 1709
# Build: 16299.248
# OS: Ubuntu 16.04 xenial
# Kernel: x86_64 Linux 4.4.0-43-Microsoft
# Shell: bash 4.3.48
# jq 1.5-1-a5b5cbe
# aws-cli/1.14.36 Python/2.7.12 Linux/4.4.0-43-Microsoft botocore/1.8.40
#
# AWS EC2
# OS: Amazon Linux
# AMI: amzn-ami-hvm-2017.09.1.20180115-x86_64-gp2 (ami-97785bed)
# Kernel: x86_64 Linux 4.9.77-31.58.amzn1.x86_64
# Shell: bash 4.2.46
# jq: 1.5
# aws-cli/1.14.32 Python/2.7.13 Linux/4.9.77-31.58.amzn1.x86_64 botocore/1.8.36
#
#
# By: Douglas Hackney
# https://github.com/dhackney
#
# Type: AWS utility
# Description:
# This shell script snapshots the current state of AWS resources and writes it to JSON files and PostgreSQL tables
#
#
# Roadmap:
# - additional AWS command types:
# * recursive-multi
# * recursive-multi-dependent
# * hardcoded parameter value
#
# - test for table source JSON file > 1GB (too big for PostgreSQL JSONB load single field )
# - summary report: add list of commands with no response values
# - auto-support --account-id qualifier
# - service attribute "$" to tag services with fixed/regular costs, e.g. load balancers
#
# - additional tested AWS services in command XLS
# * Route53
# * DynamoDB
# * SQS
# * SNS
# * EC2-VPC
# * EC2-autoscaling
# * EC2
# * Cloudwatch
# * RDS
# * Redshift
# * Glacier
# * AWS Glue
#
#
##########################################################################################################
#
# Overview:
# This utility executes a series of shell, AWS CLI, jq, and psql commands that create local JSON files and
# postgresql JSON tables populated with snapshots of AWS services.
#
# The process to execute the utility is:
# 1) create an EC2 instance (setup steps here: https://github.com/Enterprise-Group-Ltd/aws-services-snapshot/blob/master/docs/postgresql-install.md )
# 2) install postgresql 9.6 (setup steps here: https://github.com/Enterprise-Group-Ltd/aws-services-snapshot/blob/master/docs/postgresql-install.md )
# 3) edit or populate the Microsoft Excel file: 'driver_aws_cli_commands-X-X-X.xlsx' to set which services and AWS CLI commands are snapshotted
# 4) copy the contents of the Excel workbook 'driver-aws-services-X-X-X.xlsx' tab 'aws_services' into the empty postgresql table 'aws_snapshot.aws_sps__commands._driver_aws_services' and commit the transactions
# 5) copy the contents of the Excel workbook 'driver_aws_cli_commands-X-X-X.xlsx' tab 'aws_cli_commands' into the empty postgresql table 'aws_snapshot.aws_sps__commands._driver_aws_cli_commands' and commit the transactions
# 6) copy the contents of the Excel workbook 'driver_aws_cli_commands-X-X-X.xlsx' tab 'aws_cli_commands_recursive' into the empty postgresql table 'aws_snapshot.aws_sps__commands._driver_aws_cli_commands_recursive' and commit the transactions
# 7) create AWS CLI profiles with required AWS IAM permissions for each AWS account that you want to snapshot
# 8) copy this script to the AWS EC2 instance running the PostgreSQL database
# 9) execute this script: bash ./aws-services-snapshot.sh -p AWS_CLI_profile -r AWS_region
# 10) download the summary report and JSON files from the EC2 instance if desired
# 11) use the PostgreSQL database tables as a snapshot resource as desired
#
# Detailed instructions are here: https://github.com/Enterprise-Group-Ltd/aws-services-snapshot/blob/master/docs/postgresql-install.md
#
#
##########################################################################################################
#
# Definitions:
# * Snapshot types
# - non-recursive: stand-alone AWS CLI list, describe, or get command that requires no parameter values from prior snapshot results
# - recursive-single: AWS CLI list, describe, or get command that requires a single parameter's values from prior non-recursive snapshot results
# - recursive-multi: AWS CLI list, describe, or get command that requires multiple parameters' values from multiple prior non-recursive snapshot results
# - recursive-single-dependent: AWS CLI list, describe, or get command that requires a single parameter's values from prior recursive snapshot results
# - recursive-multi-dependent: AWS CLI list, describe, or get command that requires multiple parameters' values from multiple prior recursive snapshot results
# - recursive-hardcoded: AWS CLI list, describe, or get command that includes a parameter value that is hardcoded
#
#
###############################################################################
#
#
# reference list of functions used in this script
#
# fnAwsPullSnapshots()
# fnAwsPullSnapshotsLoop()
# fnAwsPullSnapshotsNonRecursive()
# fnAwsPullSnapshotsRecursiveHardcoded()
# fnAwsPullSnapshotsRecursiveLoop()
# fnAwsPullSnapshotsRecursiveLoopTail()
# fnAwsPullSnapshotsRecursiveSingle()
# fnAwsPullSnapshotsRecursiveSingleDependent()
# fnAwsServiceTestValid()
# fnCommandCount()
# fnCommandListBuild()
# fnCommandNonRecursiveListBuild()
# fnCommandRecursiveSingleDependentListBuild()
# fnCommandRecursiveSingleListBuild()
# fnCommandUnderscore()
# fnCountDriverServices()
# fnCounterIncrementAwsSnapshotCommands()
# fnCounterIncrementRegions()
# fnCounterIncrementSnapshots()
# fnCounterIncrementTask()
# fnCountGlobalServicesNames()
# fnDbLoadSnapshotFile()
# fnDbQueryCommandNonRecursiveList()
# fnDbQueryCommandRecursiveSingleDependentList()
# fnDbQueryCommandRecursiveSingleList()
# fnDbQueryCommandRecursiveSourceTables()
# fnDbQueryNonRecursiveCommandTest()
# fnDbQueryRecursiveCommandTest()
# fnDbQueryReservedWords()
# fnDbQueryServiceGlobalList()
# fnDbQueryServiceList()
# fnDbQueryTestTableExists()
# fnDbQueryTestTablePopulate()
# fnDbReservedWordsTest()
# fnDbSchemaCreate()
# fnDbSchemaDrop()
# fnDbTableCreate()
# fnDisplayHeader()
# fnDisplayOutputConsole()
# fnDisplayProgressBar()
# fnDisplayProgressBarTask()
# fnDisplayProgressBarTaskSub()
# fnDisplayProgressBarTaskSubUpdate()
# fnDisplayProgressBarTaskUpdate()
# fnDisplayTaskSubText()
# fnDisplayVariableNamesCommand()
# fnEcho()
# fnErrorAws()
# fnErrorJq()
# fnErrorLog()
# fnErrorPipeline()
# fnErrorPsql()
# fnFileAppendLog()
# fnFileAppendLogTemp()
# fnFileCreateMergedServicesAllJsonFile()
# fnFileCreateMergedServicesJsonFile()
# fnFileCreateStrippedDriverFile()
# fnFileCreateWriteDirectory()
# fnFileDeDuplicateSnapshottedServices()
# fnFileDeleteSnapshotUnneeded()
# fnFileDeleteWorkFiles()
# fnFileInitializeWriteFileBuild()
# fnFileInitializeWriteFileBuildPattern()
# fnFileMergeArraysServicesJson()
# fnFileMergeArraysServicesRecursiveJson()
# fnFileWriteCommandFileRecursive()
# fnUsage()
# fnVariableAppendLog()
# fnVariableLoadCommandFileSource()
# fnVariableLoadCommandFromBackup()
# fnVariableLoadCommandFromPrior()
# fnVariableLoadCommandPriorFromCommand()
# fnVariableLoadNamesCommand()
# fnVariableLoadNamesCommandRecursive()
# fnVariableLoadServiceSnapshot()
# fnVariableLoadSnapshotName()
# fnVariablePatternLoad()
# fnVariableWriteFileSet()
###############################################################################
#
# >>>> end documentation <<<<
#
###############################################################################
#
###############################################################################
#
# >>>> begin initialize <<<<
#
###############################################################################
#
# set the environmental variables
#
# set to catch errors in a pipeling
set -o pipefail
#
# set to suppress NOTICE console output from psql
PGOPTIONS='--client-min-messages=warning'
export PGOPTIONS
#
###############################################################################
#
#
# initialize the script variables
#
aws_account=""
aws_account_alias=""
aws_command=""
aws_command_line=""
aws_command_line_service=""
aws_command_parameter_01=""
aws_command_parameter_02=""
aws_command_parameter_03=""
aws_command_parameter_04=""
aws_command_parameter_05=""
aws_command_parameter_06=""
aws_command_parameter_07=""
aws_command_parameter_08=""
aws_command_parameter_01_value=""
aws_command_parameter_02_value=""
aws_command_parameter_03_value=""
aws_command_parameter_04_value=""
aws_command_parameter_05_value=""
aws_command_parameter_06_value=""
aws_command_parameter_07_value=""
aws_command_parameter_08_value=""
aws_command_parameter_string=""
aws_command_parameter_string_build=""
aws_command_prior=""
aws_command_recursive=""
aws_command_underscore=""
aws_command_parameter_01_supplemental_01=""
aws_command_parameter_01_supplemental_01_value=""
aws_region=""
aws_region_backup=""
aws_region_fn_create_merged_services_json_file=""
aws_region_list=""
aws_region_list_line_parameter=""
aws_region_list_line_parameter_temp=""
aws_service=""
aws_service_underscore=""
parameter_01_source_key_colon=""
parameter_01_source_key_list=""
parameter_01_source_key_list_sort=""
aws_service_snapshot_name=""
aws_service_snapshot_name_table_underscore=""
aws_service_snapshot_name_table_underscore_backup=""
aws_service_snapshot_name_table_underscore_prior=""
aws_service_snapshot_name_table_underscore_load=""
aws_service_snapshot_name_table_underscore_load_backup=""
aws_service_snapshot_name_table_underscore_load_prior=""
aws_service_snapshot_name_table_underscore_load_long=""
aws_service_snapshot_name_underscore=""
aws_service_strip=""
aws_snapshot_commands_recursive_single_dedupe=""
aws_snapshot_name=""
break_global=""
choices=""
cli_profile=""
continue_global=""
count_aws_command_parameter_string=0
count_aws_snapshot_commands=0
count_aws_snapshot_commands_non_recursive=0
count_aws_snapshot_commands_recursive_single_dependent=0
count_aws_snapshot_commands_recursive_single=0
count_aws_snapshot_commands_recursive_multi=0
count_array_service_snapshot_recursive=0
count_aws_region_check=0
count_aws_region_list=0
count_aws_snapshot_commands=0
count_cli_profile=0
count_cli_profile_regions=0
count_db_snapshot_list_key=0
count_db_table_name=0
count_driver_services=0
count_error_aws_no_endpoint=0
count_error_lines=0
count_file_snapshot_driver_file_name_aws_cli_commands_all=0
count_file_snapshot_driver_file_name_aws_cli_commands_non_recursive_source=0
count_files_snapshots=0
count_files_snapshots_all=0
count_global_services_names=0
count_global_services_names_check=0
count_global_services_names_file=0
count_lines_service_snapshot_recursive=0
count_not_found_error=0
count_query_test_table_populate=0
count_services_driver_list=0
count_script_version_length=0
count_text_header_length=0
count_text_block_length=0
count_text_width_menu=0
count_text_width_header=0
count_text_side_length_menu=0
count_text_side_length_header=0
count_text_bar_menu=0
count_text_bar_header=0
count_this_file_tasks=0
counter_aws_region_list=0
counter_aws_snapshot_commands=0
counter_aws_region_set=0
counter_aws_snapshot_commands=0
counter_db_table_name=0
counter_driver_services=0
counter_files_snapshots=0
counter_files_snapshots_all=0
counter_snapshots=0
counter_this_file_tasks=0
count_this_file_tasks_end=0
count_this_file_tasks_increment=0
date_file="$(date +"%Y-%m-%d-%H%M%S")"
date_now="$(date +"%Y-%m-%d-%H%M%S")"
db_command=""
db_file_output=""
db_host=""
db_name=""
db_port=""
db_query_sql=""
db_schema=""
db_table_baseline_non_recursive_key_match=""
db_type=""
db_user=""
_empty=""
_empty_task=""
_empty_task_sub=""
error_line_aws=""
error_line_jq=""
error_line_pipeline=""
error_line_psql=""
execute_direct=""
feed_write_log=""
file_snapshot_driver_file_name=""
file_snapshot_driver_aws_cli_commands_all_file_name=""
file_snapshot_driver_aws_cli_commands_all_file_name_raw=""
file_snapshot_driver_aws_cli_commands_global_file_name=""
file_snapshot_driver_aws_cli_commands_global_file_name_raw=""
file_snapshot_driver_aws_cli_commands_non_global_file_name=""
file_snapshot_driver_aws_cli_commands_non_global_file_name_raw=""
file_snapshot_driver_aws_cli_commands_non_recursive_file_name=""
file_snapshot_driver_aws_cli_commands_non_recursive_file_name_raw=""
file_snapshot_driver_file_name_global=""
file_snapshot_driver_file_name_global_line=""
file_snapshot_driver_stripped_file_name=""
file_target_initialize_region=""
file_target_initialize_file=""
files_snapshots=""
files_snapshots_source=""
files_snapshots_source_merge=""
files_snapshots_target=""
files_snapshots_all=""
files_snapshots_all_source=""
files_snapshots_all_source_merge=""
files_snapshots_all_target=""
_fill=""
_fill_task=""
_fill_task_sub=""
find_name=""
find_name_fn_create_merged_services_json_file=""
flag_recursive_command=""
full_path=""
let_done=""
let_done_task=""
let_done_task_sub=""
let_left=""
let_left_task=""
let_left_task_sub=""
let_progress=""
let_progress_task=""
let_progress_task_sub=""
logging=""
log_suffix=""
merge_service_recursive_files_snapshots_source=""
merge_service_recursive_files_snapshots_target=""
merge_service_recursive=""
merge_service_recursive_key_name=""
parameter1=""
paramter2=""
parameter_01_source_key=""
parameter_02_source_key=""
parameter_03_source_key=""
parameter_04_source_key=""
parameter_05_source_key=""
parameter_06_source_key=""
parameter_07_source_key=""
parameter_08_source_key=""
parameter_01_source_table=""
parameter_02_source_table=""
parameter_03_source_table=""
parameter_04_source_table=""
parameter_05_source_table=""
parameter_06_source_table=""
parameter_07_source_table=""
parameter_08_source_table=""
pattern_load_feed=""
pattern_load_value=""
query_array_length=""
query_command_list=""
query_command_list_create=""
query_count_services="0"
query_extract_load_contents=""
query_list_recursive_single_dependent=""
query_list_recursive_single=""
query_load_snapshot_file=""
query_non_recursive_command_test=""
query_non_recursive_command_test_sql=""
query_recursive_command_test=""
query_recursive_command_test_sql=""
query_schema_drop=""
query_schema_create=""
query_service_list=""
query_service_list_create=""
query_service_global_list=""
query_service_global_list_create=""
query_table_create=""
query_test_table_populate=""
recursive_single_dependent_yn=""
recursive_multi_yn=""
recursive_single_yn=""
recursive_source=""
region_global_list_raw=""
service_snapshot=""
service_snapshot_build_01=""
service_snapshot_build_02=""
service_snapshot_build_03=""
service_snapshot_command=""
service_snapshot_recursive=""
service_snapshot_recursive_object_key=""
service_snapshot_recursive_service_key=""
services_driver_list=""
snapshot_source_recursive_command=""
snapshot_target_recursive_command=""
snapshot_type=""
string_replace=""
string_search=""
text_bar_menu_build=""
text_bar_header_build=""
text_side_menu=""
text_side_header=""
text_menu=""
text_menu_bar=""
text_header=""
text_header_bar=""
this_file=""
this_file_account_services_all=""
this_file_account_region_services_all=""
this_file_account_region_services_all_global=""
this_file_account_region_services_all_target=""
this_log=""
thislogdate=""
this_log_file=""
this_log_file_errors=""
this_log_file_errors_full_path=""
this_log_file_full_path=""
this_log_temp_file_full_path=""
this_path=""
this_path_temp=""
this_summary_report=""
this_summary_report_full_path=""
this_user=""
this_utility_acronym=""
this_utility_filename_plug=""
verbose=""
write_file=""
write_file_clean=""
write_file_full_path=""
write_file_raw=""
write_file_service_names=""
write_file_service_names_unique=""
write_path=""
write_path_snapshots=""
#
###############################################################################
#
#
# initialize the baseline variables
#
this_utility_acronym="sps"
this_utility_filename_plug="snapshot"
date_file="$(date +"%Y-%m-%d-%H%M%S")"
date_file_underscore="$(date +"%Y_%m_%d_%H%M%S")"
this_path="$(pwd)"
this_file="$(basename "$0")"
full_path="${this_path}"/"$this_file"
this_log_temp_file_full_path="$this_path"/"$this_utility_filename_plug"-log-temp.log
this_user="$(whoami)"
count_this_file_tasks="$(cat "$full_path" | grep -c "\-\-\- begin\: " 2>&1)"
count_this_file_tasks_end="$(cat "$full_path" | grep -c "\-\-\- end\: " 2>&1)"
count_this_file_tasks_increment="$(cat "$full_path" | grep -c "# increment the task counter" 2>&1)"
count_this_file_tasks_increment=$((count_this_file_tasks_increment-3))
counter_this_file_tasks=0
logging="x"
counter_snapshots=0
db_host="localhost"
db_name="aws_snapshot"
db_port="5432"
db_type="postresql"
db_user="ec2-user"
#
###############################################################################
#
# initialize the temp log file
#
echo "" > "$this_log_temp_file_full_path"
#
#
###############################################################################
#
# >>>> end initialize <<<<
#
###############################################################################
#
#
###############################################################################
#
# >>>> begin functionDefinition <<<<
#
###############################################################################
#
#######################################################################
#
#
# function to display the Usage
#
#
function fnUsage()
{
echo ""
echo " ---------------------------------------- AWS Service Snapshot utility usage -----------------------------------------"
echo ""
echo " This utility snapshots the current state of AWS Services "
echo ""
echo " This script will: "
echo " * Capture the current state of AWS Services "
echo " * Write the current state to JSON files and PostgreSQL tables "
echo ""
echo "----------------------------------------------------------------------------------------------------------------------"
echo ""
echo " Usage:"
echo " aws-services-snapshot.sh -p AWS_CLI_profile "
echo ""
echo " Optional parameters: -r AWS_region -b y -g y -x y"
echo ""
echo " Where: "
echo " -p - Name of the AWS CLI cli_profile (i.e. what you would pass to the --profile parameter in an AWS CLI command)"
echo " Example: -p myAWSCLIprofile "
echo ""
echo " -r - AWS region to snapshot. Default is the AWS CLI profile's region. Enter 'all' for all regions. "
echo " A list of available AWS regions is here: "
echo " http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions"
echo " Example: -r us-east-2 "
echo " Example: -r all "
echo ""
echo " -b - Verbose console output. Set to 'y' for verbose console output. Temp files are not deleted. "
echo " Example: -b y "
echo ""
echo " -g - Logging on / off. Default is off. Set to 'y' to create an info log. Set to 'z' to create a debug log. "
echo " Note: logging mode is slower and debug log mode will be very slow and resource intensive on large jobs. "
echo " Example: -g y "
echo ""
echo " -x - Execute with no operator prompt on / off. Default is off. Set to 'y' to automate, schedule, etc. "
echo " Example: -x y "
echo ""
echo " -h - Display this message"
echo " Example: -h "
echo ""
echo " ---version - Display the script version"
echo " Example: --version "
echo ""
echo ""
exit 1
}
#
#######################################################################
#
#
# function to echo the progress bar to the console
#
# source: https://stackoverflow.com/questions/238073/how-to-add-a-progress-bar-to-a-shell-script
#
# 1. Create ProgressBar function
# 1.1 Input is currentState($1) and totalState($2)
function fnDisplayProgressBar()
{
#
# Process data
let _progress=(${1}*100/"${2}"*100)/100
let _done=(${_progress}*4)/10
let _left=40-"$_done"
# Build progressbar string lengths
_fill="$(printf "%${_done}s")"
_empty="$(printf "%${_left}s")"
#
# 1.2 Build progressbar strings and print the ProgressBar line
# 1.2.1 Output example:
# 1.2.1.1 Progress : [########################################] 100%
printf "\r Overall Progress : [${_fill// /#}${_empty// /-}] ${_progress}%%"
}
#
#######################################################################
#
#
# function to update the task progress bar
#
# source: https://stackoverflow.com/questions/238073/how-to-add-a-progress-bar-to-a-shell-script
#
# 1. Create ProgressBar function
# 1.1 Input is currentState($1) and totalState($2)
function fnDisplayProgressBarTaskUpdate()
{
#
# Process data
let _progress_task=(${1}*100/"${2}"*100)/100
let _done_task=(${_progress_task}*4)/10
let _left_task=40-"$_done_task"
# Build progressbar string lengths
_fill_task="$(printf "%${_done_task}s")"
_empty_task="$(printf "%${_left_task}s")"
#
# 1.2 Build progressbar strings and print the ProgressBar line
# 1.2.1 Output example:
# 1.2.1.1 Progress : [########################################] 100%
printf "\r Region Progress : [${_fill_task// /#}${_empty_task// /-}] ${_progress_task}%%"
}
#
#######################################################################
#
#
# function to update the subtask progress bar
#
# source: https://stackoverflow.com/questions/238073/how-to-add-a-progress-bar-to-a-shell-script
#
# 1. Create ProgressBar function
# 1.1 Input is currentState($1) and totalState($2)
function fnDisplayProgressBarTaskSubUpdate()
{
#
# Process data
let _progress_task_sub=(${1}*100/"${2}"*100)/100
let _done_task_sub=(${_progress_task_sub}*4)/10
let _left_task_sub=40-"$_done_task_sub"
# Build progressbar string lengths
_fill_task_sub="$(printf "%${_done_task_sub}s")"
_empty_task_sub="$(printf "%${_left_task_sub}s")"
#
# 1.2 Build progressbar strings and print the ProgressBar line
# 1.2.1 Output example:
# 1.2.1.1 Progress : [########################################] 100%
printf "\r Snapshot Progress : [${_fill_task_sub// /#}${_empty_task_sub// /-}] ${_progress_task_sub}%%"
}
#
#######################################################################
#
#
# function to display the subtask text
#
function fnDisplayTaskSubText()
{
#
fnEcho ${LINENO} ""
fnEcho ${LINENO} "value of variable: 'counter_aws_snapshot_commands': "$counter_aws_snapshot_commands" "
fnEcho ${LINENO} ""
fnEcho ${LINENO} "value of variable: 'count_aws_snapshot_commands': "$count_aws_snapshot_commands" "
fnEcho ${LINENO} ""
#
fnEcho ${LINENO} ""
fnEcho ${LINENO} "value of variable: 'counter_aws_region_list': "$counter_aws_region_list" "
fnEcho ${LINENO} ""
fnEcho ${LINENO} "value of variable: 'count_aws_region_list': "$count_aws_region_list" "
fnEcho ${LINENO} ""
#
#
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 "This job takes a while. Please wait..."
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 ""
#
#
fnEcho ${LINENO} ""
fnEcho ${LINENO} "value of variable: 'snapshot_type': "$snapshot_type" "
fnEcho ${LINENO} ""
#
if [[ "$snapshot_type" != 'source-recursive' ]]
then
#
fnEcho ${LINENO} ""
fnEcho ${LINENO} ""$snapshot_type" != source-recursive "
fnEcho ${LINENO} ""
#
fnEcho ${LINENO} level_0 "Snapshotting the AWS Services for region: "$aws_region_list_line_parameter" "
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 "Region "$counter_aws_region_list" of "$count_aws_region_list" "
fnEcho ${LINENO} level_0 "Note that the global region is included in the count"
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 "Snapshot type "$snapshot_type": "$counter_aws_snapshot_commands" of "$count_aws_snapshot_commands" "
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 "Pulling a snapshot for: "$aws_service" "$aws_command" "$aws_command_parameter_01" "$aws_command_parameter_01_value" "
fnEcho ${LINENO} level_0""
fnEcho ${LINENO} ""
fnEcho ${LINENO} ""
else
#
fnEcho ${LINENO} ""
fnEcho ${LINENO} ""$snapshot_type" = 'source-recursive' "
fnEcho ${LINENO} ""
#
fnEcho ${LINENO} level_0 "Creating and loading the source database tables for the recursive commands "
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 "Snapshot type: "$snapshot_type" "
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 "Pulling a snapshot for: "$aws_service" "$aws_command" "$aws_command_parameter_01" "$aws_command_parameter_01_value" "
fnEcho ${LINENO} level_0""
fnEcho ${LINENO} ""
fnEcho ${LINENO} ""
fi # end test for recursive source table run
#
}
#
#######################################################################
#
#
# function to display the task progress bar on the console
#
# parameter 1 = counter
# paramter 2 = count
#
function fnDisplayProgressBarTask()
{
#
fnEcho ${LINENO} ""
fnEcho ${LINENO} "in function: 'fnDisplayProgressBarTask' "
fnEcho ${LINENO} ""
#
fnEcho ${LINENO} level_0 " ---------------------------------------------------------------------------------"
fnEcho ${LINENO} level_0 ""
fnDisplayProgressBarTaskUpdate "$1" "$2"
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 " ---------------------------------------------------------------------------------"
fnEcho ${LINENO} level_0 ""
}
#
#######################################################################
#
#
# function to display the subtask progress bar on the console
#
# parameter 1 = counter
# paramter 2 = count
#
function fnDisplayProgressBarTaskSub()
{
#
fnEcho ${LINENO} ""
fnEcho ${LINENO} "in function: 'fnDisplayProgressBarTaskSub' "
fnEcho ${LINENO} ""
#
fnEcho ${LINENO} level_0 " ---------------------------------------------------------------------------------"
fnEcho ${LINENO} level_0 ""
fnDisplayProgressBarTaskSubUpdate "$1" "$2"
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 " ---------------------------------------------------------------------------------"
fnEcho ${LINENO} level_0 ""
}
#
#######################################################################
#
#
# function to echo the header to the console
#
function fnDisplayHeader()
{
#
fnEcho ${LINENO} ""
fnEcho ${LINENO} "in function: 'fnDisplayHeader' "
fnEcho ${LINENO} ""
#
clear
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} "--------------------------------------------------------------------------------------------------------------------"
fnEcho ${LINENO} "--------------------------------------------------------------------------------------------------------------------"
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 "$text_header"
fnEcho ${LINENO} level_0 ""
fnDisplayProgressBar ${counter_this_file_tasks} ${count_this_file_tasks}
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 ""
fnEcho ${LINENO} level_0 "$text_header_bar"
fnEcho ${LINENO} level_0 ""
}
#
#######################################################################
#
#
# function to echo to the console and write to the log file
#
function fnEcho()
{
# clear IFS parser
IFS=
# write the output to the console
fnDisplayOutputConsole "$1" "$2" "$3" "$4" "$5" "$6" "$7" "$8" "$9"
# if logging is enabled, then write to the log
if [[ ("$logging" = "y") || ("$logging" = "z") || ("$logging" = "x") ]]
then
# write the output to the log
fnVariableAppendLog "$1" "$2" "$3" "$4" "$5" "$6" "$7" "$8" "$9"
fi
# reset IFS parser to default values
unset IFS
}
#
#######################################################################
#
#
# function to echo to the console
#
function fnDisplayOutputConsole()
{
#
# console output section
#
# test for verbose
if [ "$verbose" = "y" ] ;
then
# if verbose console output then
# echo everything to the console
#
# strip the leading 'level_0'
if [ "$2" = "level_0" ] ;
then
# if the line is tagged for display in non-verbose mode
# then echo the line to the console without the leading 'level_0'
echo " Line: "$1" "$3" "$4" "$5" "$6" "$7" "$8" "$9""
else
# if a normal line echo all to the console
echo " Line: "$1" "$2" "$3" "$4" "$5" "$6" "$7" "$8" "$9""
fi
else
# test for minimum console output
if [ "$2" = "level_0" ] ;
then
# echo ""
# echo "console output no -v: the logic test for level_0 was true"
# echo ""
# if the line is tagged for display in non-verbose mode
# then echo the line to the console without the leading 'level_0'
echo " "$3" "$4" "$5" "$6" "$7" "$8" "$9""
fi
fi
#
#
}
#
#######################################################################
#
#
# function to write to the log file
#
function fnVariableAppendLog()
{
# log output section
#
# load the timestamp
thislogdate="$(date +"%Y-%m-%d-%H:%M:%S")"
#
# ----------------------------------------------------------
#
# normal logging
#
# append the line to the log variable
# the variable is written to the log file on exit by function fnFileAppendLog
#
#
if [ "$2" = "level_0" ] ;
then
# if the line is tagged for logging in non-verbose mode
# then write the line to the log without the leading 'level_0'
this_log+="$(echo "${thislogdate} Line: "$1" "$3" "$4" "$5" "$6" "$7" "$8" "$9"" 2>&1)"
else
# if a normal line write the entire set to the log
this_log+="$(echo "${thislogdate} Line: "$1" "$2" "$3" "$4" "$5" "$6" "$7" "$8" "$9"" 2>&1)"
fi
#
# append the new line
# do not quote this variable
this_log+=$'\n'
#
#
# ---------------------------------------------------------
#
# 'use this for debugging' - debug logging
#
# if the script is crashing and you cannot debug it from the 'info' mode log produced by -g y,
# then enable 'verbose' console output and 'debug' logging mode
#
# note that the 'debug' form of logging is VERY slow on big jobs
#
# use parameters: -b y -g z
#
# if the script crashes before writing out the log you can scroll back in the console to
# identify the line number where the problem is located