Archive Tool Improvements

[TotalDwarf03]

Overview

This PR improves a few areas of the Archive Tool. Improvements include:

• Allowing Markdown files to be used as exemption files.
• Add manual archive instructions within the notification issue.
• Allow the use of a config file within S3 to save the need for redeployment if the config changes.
• Logging Improvements.
• MkDocs setup + FAQs

Testing + Documentation

• Automated Tests have been updated.
• Documentation has been created.

How to Test

Cloud Configuration

1. Follow the instructions in the README to run the tool outside of a container.
2. Set show_log_locally to true.
3. In config/config.json, toggle use_local_config.

When using the cloud configuration, a debug.log file shouldn't get created. When using the local configuration, debug.log should get created.

MkDocs

• Follow the documentation section of the README to serve MkDocs locally.
• Check for typos etc.

[github-actions]

🦙 MegaLinter status: ⚠️ WARNING

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
⚠️ BASH	bash-exec	4		2	0.03s
✅ BASH	shellcheck	4		0	0.1s
✅ BASH	shfmt	4		0	0.01s
✅ DOCKERFILE	hadolint	1		0	0.07s
✅ JSON	jsonlint	1		0	0.23s
✅ JSON	prettier	1		0	0.47s
✅ JSON	v8r	1		0	2.22s
✅ MARKDOWN	markdownlint	11		0	0.78s
✅ MARKDOWN	markdown-table-formatter	11		0	0.36s
✅ REPOSITORY	checkov	yes		no	19.77s
✅ REPOSITORY	dustilock	yes		no	0.0s
✅ REPOSITORY	gitleaks	yes		no	3.42s
✅ REPOSITORY	grype	yes		no	20.9s
✅ REPOSITORY	kics	yes		no	41.05s
✅ REPOSITORY	secretlint	yes		no	0.84s
✅ REPOSITORY	syft	yes		no	2.79s
✅ REPOSITORY	trivy	yes		no	16.52s
✅ REPOSITORY	trivy-sbom	yes		no	0.2s
✅ TERRAFORM	terraform-fmt	6		0	0.54s
✅ YAML	prettier	8		0	0.83s
✅ YAML	v8r	8		0	8.94s
✅ YAML	yamllint	8		0	0.51s

See detailed report in MegaLinter reports

You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:

• oxsecurity/megalinter/flavors/terraform@v8.3.0 (54 linters)
• oxsecurity/megalinter/flavors/cupcake@v8.3.0 (83 linters)

MegaLinter is graciously provided by OX Security

[sebtheo]

LGTM

[sebtheo]

Can you install poetry directly instead of Pip aswell