Merge branch 'DEV-2537/redirects' of github.com:cloudposse/docs into …

…DEV-2537/redirects
cloudposse · Sep 12, 2024 · eee18d0 · eee18d0
2 parents a9d8268 + 18385ec
commit eee18d0
Show file tree

Hide file tree

Showing 5 changed files with 537 additions and 554 deletions.
diff --git a/docs/layers/software-delivery/ecs-ecspresso/ecs-ecspresso.mdx b/docs/layers/software-delivery/ecs-ecspresso/ecs-ecspresso.mdx
@@ -7,6 +7,7 @@ import Intro from '@site/src/components/Intro';
 import KeyPoints from '@site/src/components/KeyPoints';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import CollapsibleText from '@site/src/components/CollapsibleText';
 
 <Intro>
   We use the [`ecspresso`](https://github.com/kayac/ecspresso) deployment tool for Amazon ECS to manage ECS services using a code-driven approach, alongside reusable GitHub Action workflows. This setup allows tasks to be defined with Terraform within the infrastructure repository, and task definitions to reside alongside the application code. Ecspresso provides extensive configuration options via YAML, JSON, and Jsonnet, and includes plugins for enhanced functionality such as Terraform state lookups.
@@ -57,192 +58,192 @@ sequenceDiagram
 
 ### Github Action Workflows
 
-The basic deployment flow is for feature branches. You can use the following
-sample workflow to add pull request deploys to your application repository:
+The basic deployment flow is for feature branches. You can use the following sample workflow to add pull request deploys to your application repository:
 
-<details>
-<summary>Deploy</summary>
+:::tip Latest Examples
 
-<Tabs queryString="workflow">
-
-<TabItem value="feature" label="Feature">
-
-```yaml
-name: Feature Branch
-on:
-  pull_request:
-    branches: [ 'main' ]
-    types: [opened, synchronize, reopened, closed, labeled, unlabeled]
-
-permissions:
-  pull-requests: write
-  deployments: write
-  id-token: write
-  contents: read
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: false
-
-jobs:
-  monorepo:
-    uses:  cloudposse/github-actions-workflows/.github/workflows/controller-monorepo.yml@main
-    with:
-      file: ./deploy/config.yaml
-
-  ci:
-    uses: cloudposse/github-actions-workflows/.github/workflows/ci-dockerized-app-build.yml@main
-    needs: [ monorepo ]
-    with:
-      organization: "cloudposse"
-      repository: ${{ github.event.repository.name }}
-    secrets:
-      ecr-region: ${{ secrets.ECR_REGION }}
-      ecr-iam-role: ${{ secrets.ECR_IAM_ROLE }}
-      registry: ${{ secrets.ECR_REGISTRY }}
-      secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
-
-  cd:
-    uses: cloudposse/github-actions-workflows/.github/workflows/cd-preview-ecspresso.yml@main
-    needs: [ ci, monorepo ]
-    if: ${{ always() && needs.monorepo.outputs.apps != '[]' }}
-    strategy:
-      matrix:
-        app: ${{ fromJson(needs.monorepo.outputs.apps) }}
-    with:
-      image: ${{ needs.ci.outputs.image }}
-      tag: ${{ needs.ci.outputs.tag }}
-      repository: ${{ github.event.repository.name }}
-      app: ${{ matrix.app }}
-      open: ${{ github.event.pull_request.state == 'open' }}
-      labels: ${{ toJSON(github.event.pull_request.labels.*.name) }}
-      ref: ${{ github.event.pull_request.head.ref }}
-      exclusive: true
-      enable-migration: ${{ contains(fromJSON(needs.monorepo.outputs.migrations), matrix.app) }}
-      settings: ${{ needs.monorepo.outputs.settings }}
-      env-label: |
-        qa1: deploy/qa1
-    secrets:
-      secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
-```
+Check out our [example app-on-ecs](https://github.com/cloudposse-examples/app-on-ecs) for the latest example of how to use `ecspresso` with GitHub Actions.
 
-</TabItem>
-
-<TabItem value="main" label="Main">
-
-```yaml
-name: 2 - Main Branch
-on:
-  push:
-    branches: [ main ]
-
-permissions:
-  contents: write
-  id-token: write
-  pull-requests: read
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: false
-
-jobs:
-  monorepo:
-    uses:  cloudposse/github-actions-workflows/.github/workflows/controller-monorepo.yml@main
-    with:
-      file: ./deploy/config.yaml
-
-  ci:
-    uses: cloudposse/github-actions-workflows/.github/workflows/ci-dockerized-app-build.yml@main
-    needs: [ monorepo ]
-    with:
-      organization: "cloudposse"
-      repository: ${{ github.event.repository.name }}
-    secrets:
-      ecr-region: ${{ secrets.ECR_REGION }}
-      ecr-iam-role: ${{ secrets.ECR_IAM_ROLE }}
-      registry: ${{ secrets.ECR_REGISTRY }}
-      secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
-
-  cd:
-    uses: cloudposse/github-actions-workflows/.github/workflows/cd-ecspresso.yml@main
-    needs: [ ci, monorepo ]
-    strategy:
-      matrix:
-        app: ${{ fromJson(needs.monorepo.outputs.apps) }}
-    with:
-      image: ${{ needs.ci.outputs.image }}
-      tag: ${{ needs.ci.outputs.tag }}
-      repository: ${{ github.event.repository.name }}
-      app: ${{ matrix.app }}
-      environment: dev
-      enable-migration: ${{ contains(fromJSON(needs.monorepo.outputs.migrations), matrix.app) }}
-      settings: ${{ needs.monorepo.outputs.settings }}
-    secrets:
-      secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
-
-  release:
-    uses:  cloudposse/github-actions-workflows/.github/workflows/controller-draft-release.yml@main
-    needs: [ cd ]
-```
+:::
 
-</TabItem>
-
-<TabItem value="release" label="Release">
-
-```yaml
-name: 3 - Release
-on:
-  release:
-    types: [published]
-
-permissions:
-  id-token: write
-  contents: write
-
-concurrency:
-  group: ${{ github.workflow }}
-  cancel-in-progress: false
-
-jobs:
-  monorepo:
-    uses:  cloudposse/github-actions-workflows/.github/workflows/controller-monorepo.yml@main
-    with:
-      file: ./deploy/config.yaml
-
-  ci:
-    uses: cloudposse/github-actions-workflows/.github/workflows/ci-dockerized-app-promote.yml@main
-    needs: [ monorepo ]
-    with:
-      organization: "cloudposse"
-      repository: ${{ github.event.repository.name }}
-      version: ${{ github.event.release.tag_name }}
-    secrets:
-      ecr-region: ${{ secrets.ECR_REGION }}
-      ecr-iam-role: ${{ secrets.ECR_IAM_ROLE }}
-      registry: ${{ secrets.ECR_REGISTRY }}
-      secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
-
-  cd:
-    uses: cloudposse/github-actions-workflows/.github/workflows/cd-ecspresso.yml@main
-    needs: [ ci, monorepo ]
-    strategy:
-      matrix:
-        app: ${{ fromJson(needs.monorepo.outputs.apps) }}
-    with:
-      image: ${{ needs.ci.outputs.image }}
-      tag: ${{ needs.ci.outputs.tag }}
-      repository: ${{ github.event.repository.name }}
-      app: ${{ matrix.app }}
-      environment: "staging"
-      enable-migration: ${{ contains(fromJSON(needs.monorepo.outputs.migrations), matrix.app) }}
-      settings: ${{ needs.monorepo.outputs.settings }}
-    secrets:
-      secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
-```
-
-</TabItem>
+<Tabs queryString="workflow">
+  <TabItem value="feature" label="Feature">
+    <CollapsibleText type="medium">
+      ```yaml title=".github/workflows/feature-branch.yaml"
+      name: 1 - Feature Branch
+      on:
+        pull_request:
+          branches: [ main ]
+          types: [opened, synchronize, reopened, closed, labeled, unlabeled]
+
+      permissions:
+        pull-requests: write
+        deployments: write
+        id-token: write
+        contents: read
+
+      concurrency:
+        group: ${{ github.workflow }}-${{ github.ref }}
+        cancel-in-progress: false
+
+      jobs:
+        monorepo:
+          uses:  cloudposse/github-actions-workflows/.github/workflows/controller-monorepo.yml@main
+          with:
+            file: ./deploy/config.yaml
+
+        ci:
+          uses: cloudposse/github-actions-workflows/.github/workflows/ci-dockerized-app-build.yml@main
+          needs: [ monorepo ]
+          with:
+            organization: "cloudposse"
+            repository: ${{ github.event.repository.name }}
+          secrets:
+            ecr-region: ${{ secrets.ECR_REGION }}
+            ecr-iam-role: ${{ secrets.ECR_IAM_ROLE }}
+            registry: ${{ secrets.ECR_REGISTRY }}
+            secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
+
+        cd:
+          uses: cloudposse/github-actions-workflows/.github/workflows/cd-preview-ecspresso.yml@main
+          needs: [ ci, monorepo ]
+          if: ${{ always() && needs.monorepo.outputs.apps != '[]' }}
+          strategy:
+            matrix:
+              app: ${{ fromJson(needs.monorepo.outputs.apps) }}
+          with:
+            image: ${{ needs.ci.outputs.image }}
+            tag: ${{ needs.ci.outputs.tag }}
+            repository: ${{ github.event.repository.name }}
+            app: ${{ matrix.app }}
+            open: ${{ github.event.pull_request.state == 'open' }}
+            labels: ${{ toJSON(github.event.pull_request.labels.*.name) }}
+            ref: ${{ github.event.pull_request.head.ref }}
+            exclusive: true
+            enable-migration: ${{ contains(fromJSON(needs.monorepo.outputs.migrations), matrix.app) }}
+            settings: ${{ needs.monorepo.outputs.settings }}
+            env-label: |
+              qa1: deploy/qa1
+          secrets:
+            secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
+      ```
+    </CollapsibleText>
+  </TabItem>
+
+  <TabItem value="main" label="Main">
+    <CollapsibleText type="medium">
+      ```yaml title=".github/workflows/main-branch.yaml"
+      name: 2 - Main Branch
+      on:
+        push:
+          branches: [ main ]
+
+      permissions:
+        contents: write
+        id-token: write
+        pull-requests: read
+
+      concurrency:
+        group: ${{ github.workflow }}-${{ github.ref }}
+        cancel-in-progress: false
+
+      jobs:
+        monorepo:
+          uses:  cloudposse/github-actions-workflows/.github/workflows/controller-monorepo.yml@main
+          with:
+            file: ./deploy/config.yaml
+
+        ci:
+          uses: cloudposse/github-actions-workflows/.github/workflows/ci-dockerized-app-build.yml@main
+          needs: [ monorepo ]
+          with:
+            organization: "cloudposse"
+            repository: ${{ github.event.repository.name }}
+          secrets:
+            ecr-region: ${{ secrets.ECR_REGION }}
+            ecr-iam-role: ${{ secrets.ECR_IAM_ROLE }}
+            registry: ${{ secrets.ECR_REGISTRY }}
+            secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
+
+        cd:
+          uses: cloudposse/github-actions-workflows/.github/workflows/cd-ecspresso.yml@main
+          needs: [ ci, monorepo ]
+          strategy:
+            matrix:
+              app: ${{ fromJson(needs.monorepo.outputs.apps) }}
+          with:
+            image: ${{ needs.ci.outputs.image }}
+            tag: ${{ needs.ci.outputs.tag }}
+            repository: ${{ github.event.repository.name }}
+            app: ${{ matrix.app }}
+            environment: dev
+            enable-migration: ${{ contains(fromJSON(needs.monorepo.outputs.migrations), matrix.app) }}
+            settings: ${{ needs.monorepo.outputs.settings }}
+          secrets:
+            secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
+
+        release:
+          uses:  cloudposse/github-actions-workflows/.github/workflows/controller-draft-release.yml@main
+          needs: [ cd ]
+      ```
+    </CollapsibleText>
+  </TabItem>
+
+  <TabItem value="release" label="Release">
+    <CollapsibleText type="medium">
+      ```yaml title=".github/workflows/release.yaml"
+      name: 3 - Release
+      on:
+        release:
+          types: [published]
+
+      permissions:
+        id-token: write
+        contents: write
+
+      concurrency:
+        group: ${{ github.workflow }}
+        cancel-in-progress: false
+
+      jobs:
+        monorepo:
+          uses:  cloudposse/github-actions-workflows/.github/workflows/controller-monorepo.yml@main
+          with:
+            file: ./deploy/config.yaml
+
+        ci:
+          uses: cloudposse/github-actions-workflows/.github/workflows/ci-dockerized-app-promote.yml@main
+          needs: [ monorepo ]
+          with:
+            organization: "cloudposse"
+            repository: ${{ github.event.repository.name }}
+            version: ${{ github.event.release.tag_name }}
+          secrets:
+            ecr-region: ${{ secrets.ECR_REGION }}
+            ecr-iam-role: ${{ secrets.ECR_IAM_ROLE }}
+            registry: ${{ secrets.ECR_REGISTRY }}
+            secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
+
+        cd:
+          uses: cloudposse/github-actions-workflows/.github/workflows/cd-ecspresso.yml@main
+          needs: [ ci, monorepo ]
+          strategy:
+            matrix:
+              app: ${{ fromJson(needs.monorepo.outputs.apps) }}
+          with:
+            image: ${{ needs.ci.outputs.image }}
+            tag: ${{ needs.ci.outputs.tag }}
+            repository: ${{ github.event.repository.name }}
+            app: ${{ matrix.app }}
+            environment: "staging"
+            enable-migration: ${{ contains(fromJSON(needs.monorepo.outputs.migrations), matrix.app) }}
+            settings: ${{ needs.monorepo.outputs.settings }}
+          secrets:
+            secret-outputs-passphrase: ${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}
+      ```
+    </CollapsibleText>
+  </TabItem>
 </Tabs>
-</details>
 
 ## References
 - [Ecspresso](https://github.com/kayac/ecspresso) : Tool repo