Skip to content

docs: add aws ami build & deploy workflow guide#67

Merged
l50 merged 3 commits into
mainfrom
docs/aws-ami-workflow
Apr 4, 2026
Merged

docs: add aws ami build & deploy workflow guide#67
l50 merged 3 commits into
mainfrom
docs/aws-ami-workflow

Conversation

@l50
Copy link
Copy Markdown
Contributor

@l50 l50 commented Apr 3, 2026

Key Changes:

  • Added comprehensive guide for AWS AMI build and deployment workflow
  • Linked new guide in both the main README and mkdocs navigation
  • Clarified documentation on pre-baked vs. runtime configuration for AWS
  • Improved discoverability of AWS provider documentation

Added:

  • AWS AMI build & deploy workflow documentation, detailing end-to-end process
    using warpgate, Terragrunt, and Ansible - added
    docs/mkdocs/docs/providers/aws-ami-workflow.md
  • Step-by-step instructions for building golden AMIs, configuring Terragrunt,
    deploying infrastructure, and provisioning with Ansible
  • Troubleshooting section and host mapping reference for AWS deployments

Changed:

  • Updated README to reference the new AWS AMI workflow guide for improved
    visibility of AWS deployment instructions
  • Extended mkdocs navigation to include the AWS AMI Workflow guide, making the
    documentation easier to access from the sidebar

Removed:

  • No documentation or configuration was removed in this update

**Added:**

- Introduced a comprehensive AWS AMI build & deploy workflow guide detailing
  warpgate AMI creation, Terragrunt configuration, infrastructure deployment,
  and Ansible provisioning in `docs/mkdocs/docs/providers/aws-ami-workflow.md`

**Changed:**

- Updated main `README.md` to reference the new AWS AMI workflow guide for
  easier discoverability
- Added the AWS AMI Workflow page to the MkDocs navigation in
  `docs/mkdocs/mkdocs.yml` for better documentation structure and access
@dreadnode-renovate-bot dreadnode-renovate-bot Bot added area/readme Changes made to README.md file area/docs Changes made to documentation labels Apr 3, 2026
l50 added 2 commits April 3, 2026 11:13
**Added:**

- Detailed explanation of `--env` and `--region` flags, including their mapping
  to Terragrunt directories and Ansible inventories, with usage table and config
  options
- Guidance on duplicating environment directory trees and editing `env.hcl` for
  new environments
- Example CLI commands showing how to specify `--env` and `--region` for
  provisioning, health checks, and validation
- Tips on using persistent config defaults to simplify CLI usage

**Changed:**

- Updated CLI command examples throughout to explicitly include `--env` and
  `--region` flags for clarity and to match new documentation sections
- Clarified workflow steps to emphasize the importance of consistent environment
  and region selection across provisioning and validation tasks
**Added:**

- Documented the recommended workflow for stopping, fixing, and resuming
  provisioning in `provisioning.md`, including usage of `--from` and retry
  strategies
- Described how to resume failed provisioning runs and clarified CLI behavior in
  `aws-ami-workflow.md`
- Added `network_setup.yml` as the initial playbook in the default playbook
  sequence to ensure network setup precedes other provisioning steps

**Changed:**

- Improved SSM session management by cleaning up stale sessions before and
  between playbook runs, and waiting for SSM agent reconnection after reboots in
  `provision.go`
- Refactored SSM session cleanup to a public `CleanupSSMSessions` function in
  `retry.go` and updated all internal calls accordingly
- Enhanced instance-to-IP mapping generation to always run before provisioning to
  avoid slow Ansible runtime detection in AWS environments
- Updated `dev-inventory` with explicit `dc_ipv4` and `host_ipv4` mappings for
  all domain controllers and servers, and added a flag to indicate AWS instances
  use a single network adapter
- Refined documentation in `GOAD-vulnerabilities-comprehensive.md` for clarity,
  conciseness, and up-to-date coverage information
- Improved related documentation references and removed outdated support info in
  `validation.md`
- Updated `.gitignore` to exclude Ansible artifact files matching `*AnsiballZ*`
- Set `fact_caching_connection` in `ansible.cfg` to ensure consistent fact
  caching location

**Removed:**

- Removed the unused `lab` variable from the `ad-trusts.yml` playbook to clean
  up inputs
- Removed repetitive and obsolete conclusion and support sections from
  documentation files
@dreadnode-renovate-bot dreadnode-renovate-bot Bot added the area/playbooks Changes made to playbooks directory label Apr 3, 2026
@l50 l50 merged commit 7939f47 into main Apr 4, 2026
6 checks passed
@l50 l50 deleted the docs/aws-ami-workflow branch April 4, 2026 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Changes made to documentation area/playbooks Changes made to playbooks directory area/readme Changes made to README.md file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant