DEV-2485: AtmosWorkflow Component (#660)

Author: milldr

.github/actions/build-website/action.yml

@@ -93,7 +93,6 @@ runs:
     - name: "Render Documentation for Terraform Components"
       shell: bash
       run: |
-        rm -rf tmp/components/terraform-aws-components
         ./scripts/render-docs-for-components.sh
 
     - name: "Render Documentation for Terraform Modules"

docs/layers/accounts/account-baseline.mdx

@@ -8,6 +8,7 @@ import KeyPoints from '@site/src/components/KeyPoints';
 import Steps from '@site/src/components/Steps';
 import Step from '@site/src/components/Step';
 import StepNumber from '@site/src/components/StepNumber';
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 <Intro>
 Now that all the accounts have been deployed, we need to finalize the setup of the accounts. This includes deploying CloudTrail and ECR. These foundational components will be necessary to move forward with the rest of the deployment.
@@ -23,8 +24,6 @@ Now that all the accounts have been deployed, we need to finalize the setup of t
 
   Deploy CloudTrail and ECR with the following workflow:
 
-  ```bash
-  atmos workflow deploy -f baseline
-  ```
+  <AtmosWorkflow workflow="deploy" fileName="baseline" />
   </Step>
 </Steps>

docs/layers/accounts/deploy-accounts.mdx

@@ -10,6 +10,7 @@ import Steps from '@site/src/components/Steps';
 import Step from '@site/src/components/Step';
 import StepNumber from '@site/src/components/StepNumber';
 import Note from '@site/src/components/Note';
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 <Intro>
 This step-by-step process outlines how to deploy AWS accounts using `atmos` workflows and ClickOps steps. It covers necessary preparations, such as configuring the AWS Organization, increasing account quotas, and verifying account configurations. The guide details the deployment processes and post-deployment configurations, including setting up account settings, enabling AWS RAM for Organizations, and performing certain manual configurations via ClickOps.
@@ -42,9 +43,8 @@ This step-by-step process outlines how to deploy AWS accounts using `atmos` work
   <Step>
     ## <StepNumber/> Deploy the AWS Organization:
 
-    ```bash
-    atmos workflow deploy/organization -f accounts
-    ```
+    <AtmosWorkflow workflow="deploy/organization" fileName="accounts" />
+
   </Step>
 
   <Step>
@@ -78,9 +78,7 @@ This step-by-step process outlines how to deploy AWS accounts using `atmos` work
 
     Once confident, begin the accounts deployment:
 
-    ```bash
-    atmos workflow deploy/accounts -f accounts
-    ```
+    <AtmosWorkflow workflow="deploy/accounts" fileName="accounts" />
 
     These deployments will create all AWS member accounts and store relevant account metadata as "mappings" in the Terraform
     outputs of the `account-map` component. Rather than querying this `account` component each time we need an Account ID or
@@ -90,8 +88,9 @@ This step-by-step process outlines how to deploy AWS accounts using `atmos` work
     Always run `atmos terraform apply account-map -s core-gbl-root` after provisioning accounts.
     </Note>
 
-    Once you've created the accounts, you'll need to provision the baseline configuration within the accounts themselves.
-    This is accomplished by running `atmos workflow deploy/account-settings -f accounts`.
+    Once you've created the accounts, you'll need to provision the baseline configuration within the accounts themselves. Run the following:
+
+    <AtmosWorkflow workflow="deploy/account-settings" fileName="accounts" />
 
     The workflows will kick off several sequential Terraform runs to provision all the AWS member account settings for
     member accounts in the Organization.

docs/layers/accounts/initialize-tfstate.mdx

@@ -7,6 +7,9 @@ import Intro from '@site/src/components/Intro';
 import KeyPoints from '@site/src/components/KeyPoints';
 import Note from '@site/src/components/Note';
 import Steps from '@site/src/components/Steps';
+import Step from '@site/src/components/Step';
+import StepNumber from '@site/src/components/StepNumber';
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 <Intro>
 Follow these steps to configure and initialize the Terraform state backend using Atmos, ensuring proper setup of the infrastructure components and state management.
@@ -27,20 +30,32 @@ If you're unfamiliar with atmos, you can read more about it [here](https://atmos
 If you look at `components/terraform/`, you'll see a bunch of directories. These contain Terraform "root modules" that are provisioned with Atmos. At first they'll only have their vendor files, such as `components/terraform/tfstate-backend/component.yaml`.
 
 <Steps>
-1. You can use `atmos workflow vendor -f baseline` to vendor all the `baseline` modules, if the Terraform files are not
-present. You'll want to at least see Terraform files in `tfstate-backend` and `account-map`.
+  <Step>
+    ## <StepNumber/> Vendor the Terraform State Backend component
 
-2. Once you've done that, you can run `atmos workflow init/tfstate -f baseline` to deploy the Terraform Backend.
-   <Note>it can take a minute for the S3 buckets you created to become available. The workflow will attempt to wait until the bucket is created and available, with a 5-second delay between each check.</Note>
+    Vendor the Terraform State Backend component by running the following command. The steps here require the `tfstate-backend` and `account-map` components.
 
-3. Wait until you see the following prompt
+    <AtmosWorkflow workflow="vendor" fileName="baseline" />
+
+  </Step>
+  <Step>
+    ## <StepNumber/> Initialize the Terraform State Backend
+
+    Initialize the Terraform State Backend by running the following command:
+
+    <AtmosWorkflow workflow="init/tfstate" fileName="baseline" />
+  </Step>
+
+  <Step>
+    ## <StepNumber/> Migrate all workspaces to S3
+
+    When prompted, type `yes` to migrate all workspaces to S3.
 
     ```shell
     Initializing the backend...
     Do you want to migrate all workspaces to "s3"?
     ```
-
-4. Type `yes` to continue. This will migrate the state from the local backend to the s3 backend.
+  </Step>
 </Steps>
 
 :::info Granting SuperAdmin Access to Terraform State

docs/layers/alerting/setup.mdx

@@ -5,6 +5,7 @@ sidebar_position: 2
 ---
 import Intro from '@site/src/components/Intro';
 import KeyPoints from '@site/src/components/KeyPoints';
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 ## Quick Start
 
@@ -16,9 +17,9 @@ Please follow the sign up steps in [How to Sign Up for OpsGenie](/layers/alertin
 
 ### Vendor
 
-Like most other components we need to vendor in the component. This can be done with
+Like most other components we need to vendor in the component. This can be done with the following:
 
-`atmos workflow vendor -f alerting` or `atmos vendor pull --component opsgenie-team`.
+<AtmosWorkflow workflow="vendor" fileName="alerting" />
 
 ### Deploy
 

docs/layers/data/setup.mdx

@@ -8,6 +8,7 @@ import Intro from '@site/src/components/Intro';
 import KeyPoints from '@site/src/components/KeyPoints';
 import Steps from '@site/src/components/Steps'
 import Note from '@site/src/components/Note'
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 ## Quick Start
 
@@ -49,9 +50,7 @@ At the moment we have support for:
 
 Vendor all data components with the following workflow:
 
-```bash
-atmos workflow vendor -f data
-```
+<AtmosWorkflow workflow="vendor" fileName="data" />
 
 These run several vendor commands for each included component. You can always run these commands individually to update
 any single component. For example:
@@ -67,6 +66,4 @@ atmos vendor pull -c aurora-postgres
 In order to deploy database, deploy both the cluster and the resources component (if applicable). Applying changes to
 the resources component requires a VPN connection. For example,
 
-```bash
-atmos workflow deploy/all -f data
-```
+<AtmosWorkflow workflow="deploy/all" fileName="data" />

docs/layers/ecs/deploy-clusters.mdx

@@ -8,6 +8,7 @@ import KeyPoints from '@site/src/components/KeyPoints';
 import Steps from '@site/src/components/Steps'
 import Step from '@site/src/components/Step'
 import StepNumber from '@site/src/components/StepNumber'
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 ## Quick Start
 
@@ -38,16 +39,7 @@ All deployment steps below assume that the environment has been successfully set
 
     Vendor these components with the included Atmos Workflows.
 
-    ```bash
-    atmos workflow vendor -f ecs
-    ```
-
-    or for each component:
-
-    ```bash
-    atmos vendor pull --component ecs
-    atmos vendor pull --component ecs-service
-    ```
+    <AtmosWorkflow workflow="vendor" fileName="ecs" />
 
   </Step>
 
@@ -66,11 +58,9 @@ All deployment steps below assume that the environment has been successfully set
 
     First deploy all required ACM certificates for each ECS cluster. These certificates validate the given service domain. You can deploy these certificates before associating the given Route 53 Hosted Zone with the purchased domain in your chosen Domain Registrar, but the certificate will not be ISSUED until the registered domain and Hosted Zone are connected.
 
-    Run the following Atmos Workflow to deploy every required ACM certificate for ECS.
+    Run the following to deploy every required ACM certificate for ECS.
 
-    ```bash
-    atmos workflow deploy/ecs-acm -f ecs
-    ```
+    <AtmosWorkflow workflow="deploy/ecs-acm" fileName="ecs" />
 
   </Step>
 
@@ -91,11 +81,9 @@ All deployment steps below assume that the environment has been successfully set
   <Step>
     ## <StepNumber/> Deploy All Clusters
 
-    Run the following Atmos Workflow to deploy every ECS cluster. This workflow will deploy every required platform cluster.
+    Run the following to deploy every ECS cluster. This workflow will deploy every required platform cluster.
 
-    ```bash
-    atmos workflow deploy/clusters -f ecs
-    ```
+    <AtmosWorkflow workflow="deploy/clusters" fileName="ecs" />
 
   </Step>
 </Steps>

docs/layers/ecs/provision-services.mdx

@@ -8,6 +8,7 @@ import KeyPoints from '@site/src/components/KeyPoints';
 import Steps from '@site/src/components/Steps'
 import Step from '@site/src/components/Step'
 import StepNumber from '@site/src/components/StepNumber'
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 <Intro>
   Provision an example service like the Echo server to test your cluster’s functionality. This will ensure you can access the service remotely via the load balancer, both publicly and privately through the VPN.
@@ -25,12 +26,10 @@ Once the cluster is up and running, continue with the first ECS service deployme
   <Step>
     ## <StepNumber/> Deploy Echo Server
 
-    Run the following Atmos Workflow to deploy `ecs/platform/service/echo-server` and
+    Run the following to deploy `ecs/platform/service/echo-server` and
     `ecs/platform/service/echo-server-private` to every cluster.
 
-    ```bash
-    atmos workflow deploy/echo-server -f ecs
-    ```
+    <AtmosWorkflow workflow="deploy/echo-server" fileName="ecs" />
 
   </Step>
 

docs/layers/eks/deploy-clusters.mdx

@@ -9,6 +9,7 @@ import Steps from '@site/src/components/Steps'
 import Step from '@site/src/components/Step'
 import StepNumber from '@site/src/components/StepNumber'
 import Note from '@site/src/components/Note'
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 ## Quick Start
 
@@ -48,15 +49,7 @@ All deployment steps below assume that the environment has been successfully set
 
     Vendor these components with the included Atmos Workflows.
 
-    ```bash
-    atmos workflow vendor -f eks
-    ```
-
-    or for each component. See `stacks/workflows/eks.yaml` for a complete list.
-
-    ```bash
-    atmos vendor pull --component eks/cluster
-    ```
+    <AtmosWorkflow workflow="vendor" fileName="eks" />
   </Step>
 
   <Step>
@@ -79,9 +72,7 @@ All deployment steps below assume that the environment has been successfully set
     In order for Karpenter to reserve Spot Instances, the cluster needs to have a Service-Linked Role. Deploy these to all
     cluster accounts with `iam-service-linked-roles`
 
-    ```bash
-    atmos workflow deploy/iam-service-linked-roles -f eks
-    ```
+    <AtmosWorkflow workflow="deploy/iam-service-linked-roles" fileName="eks" />
   </Step>
 
   <Step>
@@ -90,9 +81,7 @@ All deployment steps below assume that the environment has been successfully set
     First deploy the cluster and AWS EFS. Since Karpenter will be used in the following steps, the initial cluster is
     deployed without Nodes.
 
-    ```bash
-    atmos workflow deploy/cluster -s plat-use1-dev -f eks
-    ```
+    <AtmosWorkflow workflow="deploy/cluster" fileName="eks" stack="plat-use1-dev"/>
   </Step>
 
   <Step>
@@ -104,9 +93,7 @@ All deployment steps below assume that the environment has been successfully set
 
     Run the Atmos Workflow to deploy all required `plat` components.
 
-    ```bash
-    atmos workflow deploy/resources -s plat-use1-dev -f eks
-    ```
+    <AtmosWorkflow workflow="deploy/resources" fileName="eks" stack="plat-use1-dev"/>
 
     Validate the cluster deployment with `eks/echo-server` and the targeted service domain. The following URL should return
     a success message for `dev`:
@@ -121,10 +108,8 @@ All deployment steps below assume that the environment has been successfully set
 
     Repeat the same deployment steps in `staging`
 
-    ```bash
-    atmos workflow deploy/cluster -s plat-use1-staging -f eks
-    atmos workflow deploy/resources -s plat-use1-staging -f eks
-    ```
+    <AtmosWorkflow workflow="deploy/cluster" fileName="eks" stack="plat-use1-staging"/>
+    <AtmosWorkflow workflow="deploy/resources" fileName="eks" stack="plat-use1-staging"/>
 
     Validate `staging`: https://echo.use1.staging.plat.acme-svc.com/
   </Step>
@@ -134,10 +119,8 @@ All deployment steps below assume that the environment has been successfully set
 
     Then deploy `prod`
 
-    ```bash
-    atmos workflow deploy/cluster -s plat-use1-prod -f eks
-    atmos workflow deploy/resources -s plat-use1-prod -f eks
-    ```
+    <AtmosWorkflow workflow="deploy/cluster" fileName="eks" stack="plat-use1-prod"/>
+    <AtmosWorkflow workflow="deploy/resources" fileName="eks" stack="plat-use1-prod"/>
 
     Validate `prod`: https://echo.use1.prod.plat.acme-svc.com/
   </Step>

docs/layers/github-actions/eks-github-actions-controller.mdx

@@ -7,6 +7,7 @@ import KeyPoints from '@site/src/components/KeyPoints';
 import Note from '@site/src/components/Note';
 import Step from '@site/src/components/Step';
 import StepNumber from '@site/src/components/StepNumber';
+import AtmosWorkflow from '@site/src/components/AtmosWorkflow';
 
 <Intro>
 The GitHub Action Runner Controller (ARC) is a Kubernetes operator that automates the management of self-hosted GitHub Actions runners in a Kubernetes cluster, that works very well together with Karpenter for EKS.
@@ -120,9 +121,7 @@ GitHub Repository or Organization
 <Note title="Tip">
   The first three steps before are all included in the following workflow:
 
-  ```bash
-  atmos workflow deploy/github-runners -f github
-  ```
+  <AtmosWorkflow workflow="deploy/github-runners" fileName="github" />
 </Note>
 
 <Step>
@@ -141,10 +140,8 @@ GitHub Repository or Organization
 
   Deploy the cluster with the same commands as `plat` cluster deployments:
 
-  ```bash
-  atmos workflow deploy/cluster -f eks -s core-use1-auto
-  atmos workflow deploy/resources -f eks -s core-use1-auto
-  ```
+  <AtmosWorkflow workflow="deploy/cluster" fileName="eks" stack="core-use1-auto"/>
+  <AtmosWorkflow workflow="deploy/resources" fileName="eks" stack="core-use1-auto"/>
 
   Validate the `core-auto` deployment using Echo Server. For example: https://echo.use1.auto.core.acme-svc.com/
 </Step>