Skip to content

Commit

Permalink
update demo to add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
osterman committed Dec 23, 2024
1 parent c22cfb8 commit 62a9a70
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 18 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/demo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ jobs:
vhs:
needs: [prepare]
runs-on: ubuntu-latest
timeout-minutes: 120
strategy:
matrix:
file: ${{ fromJson(needs.prepare.outputs.matrix) }}
Expand Down Expand Up @@ -119,7 +120,8 @@ jobs:
echo "job_name=${JOB_NAME}" >> $GITHUB_OUTPUT
echo "branch_name=chore/update-${JOB_NAME}-for-${VERSION}" >> $GITHUB_OUTPUT
- uses: charmbracelet/vhs-action@v2
- name: Setup VHS
uses: charmbracelet/vhs-action@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
install-fonts: true
Expand Down
12 changes: 8 additions & 4 deletions demo/recordings/demo.tape
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Sleep 1s

Type "# We will start by installing some 3rd-party components and other artifacts..." Sleep 500ms Enter
Type "atmos vendor pull" Sleep 500ms Enter
Sleep 8s
Sleep 9s

Type "# In Atmos you can easily explore components, stacks, and run commands..." Sleep 500ms Enter
Type "atmos" Sleep 500ms Enter
Expand All @@ -41,11 +41,15 @@ Type "# Let's see what components we have available!" Sleep 500ms Enter
Type "atmos list components" Sleep 500ms Enter
Sleep 1s

Type "# Let's see where they can be deployed" Sleep 500ms Enter
Type "# Then we can learn about the VPC component" Sleep 500ms Enter
Type "atmos docs vpc" Sleep 500ms Enter
Sleep 1s

Type "# Now, let's see where they are deployed" Sleep 500ms Enter
Type "atmos list stacks" Sleep 500ms Enter
Sleep 2s

Type "# Let's validate the stack configurations" Sleep 500ms Enter
Type "# And validate the stack configurations" Sleep 500ms Enter
Type "atmos validate stacks" Sleep 500ms Enter
Sleep 2s

Expand Down Expand Up @@ -90,5 +94,5 @@ Sleep 5s
Type "# Check out the docs at https://atmos.tools/" Sleep 500ms Enter
Sleep 2s

Type "# or join us in #atmos at https://slack.cloudposse.com!" Sleep 500ms Enter
Type "# or join us in #atmos at https://cloudposse.com/slack!" Sleep 500ms Enter
Sleep 3s
Binary file modified docs/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions examples/quick-start-advanced/atmos.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
# are considered paths relative to 'base_path'.
base_path: "."

docs:
max-width: 30
pagination: true

components:
terraform:
# Optional `command` specifies the executable to be called by `atmos` when running Terraform commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@ locals {

module "utils" {
source = "cloudposse/utils/aws"
version = "1.4.0"
version = "1.3.0"
}

module "vpc" {
source = "cloudposse/vpc/aws"
version = "2.1.1"
version = "2.1.0"

ipv4_primary_cidr_block = var.ipv4_primary_cidr_block
internet_gateway_enabled = var.public_subnets_enabled
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,13 @@
module "vpc_flow_logs_bucket" {
count = local.vpc_flow_logs_enabled ? 1 : 0
count = var.vpc_flow_logs_enabled ? 1 : 0

source = "cloudposse/stack-config/yaml//modules/remote-state"
version = "1.5.0"

# Specify the Atmos component name (defined in YAML stack config files)
# for which to get the remote state outputs
component = "vpc-flow-logs-bucket"

# Override the context variables to point to a different Atmos stack if the
# `vpc-flow-logs-bucket` Atmos component is provisioned in another AWS account, OU or region
stage = try(coalesce(var.vpc_flow_logs_bucket_stage_name, module.this.stage), null)
environment = try(coalesce(var.vpc_flow_logs_bucket_environment_name, module.this.environment), null)
component = "vpc-flow-logs-bucket"
environment = var.vpc_flow_logs_bucket_environment_name
stage = var.vpc_flow_logs_bucket_stage_name
tenant = try(coalesce(var.vpc_flow_logs_bucket_tenant_name, module.this.tenant), null)

# `context` input is a way to provide the information about the stack (using the context
# variables `namespace`, `tenant`, `environment`, and `stage` defined in the stack config)
context = module.this.context
}
2 changes: 2 additions & 0 deletions examples/quick-start-advanced/vendor.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ spec:
# https://github.com/bmatcuk/doublestar#patterns
included_paths:
- "**/*.tf"
- "**/README.md"
excluded_paths:
- "**/providers.tf"
# Tags can be used to vendor component that have the specific tags
Expand All @@ -39,6 +40,7 @@ spec:
- "components/terraform/vpc-flow-logs-bucket"
included_paths:
- "**/*.tf"
- "**/README.md"
excluded_paths:
- "**/providers.tf"
# Tags can be used to vendor component that have the specific tags
Expand Down

0 comments on commit 62a9a70

Please sign in to comment.