Update Atmos stack manifest JSON schema. Fix docs (#842)

* updates * updates * updates * updates
cloudposse · Dec 10, 2024 · 1bf5dc2 · 1bf5dc2
1 parent 36a595e
commit 1bf5dc2
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 22 deletions.
diff --git a/examples/demo-context/schemas/atmos-manifest.json b/examples/demo-context/schemas/atmos-manifest.json
@@ -320,21 +320,29 @@
             "real"
           ]
         },
+        "enabled": {
+          "type": "boolean",
+          "description": "Flag to enable or disable the component"
+        },
         "component": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform/OpenTofu/Helmfile component"
         },
         "inherits": {
           "type": "array",
+          "description": "A list of Atmos components that the current component inherits from",
           "uniqueItems": true,
           "items": {
             "type": "string"
           }
         },
         "terraform_workspace": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace"
         },
         "terraform_workspace_pattern": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace pattern"
         },
         "custom": {
           "type": "object",

diff --git a/examples/demo-helmfile/schemas/atmos-manifest.json b/examples/demo-helmfile/schemas/atmos-manifest.json
@@ -320,21 +320,29 @@
             "real"
           ]
         },
+        "enabled": {
+          "type": "boolean",
+          "description": "Flag to enable or disable the component"
+        },
         "component": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform/OpenTofu/Helmfile component"
         },
         "inherits": {
           "type": "array",
+          "description": "A list of Atmos components that the current component inherits from",
           "uniqueItems": true,
           "items": {
             "type": "string"
           }
         },
         "terraform_workspace": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace"
         },
         "terraform_workspace_pattern": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace pattern"
         },
         "custom": {
           "type": "object",

diff --git a/examples/demo-localstack/schemas/atmos-manifest.json b/examples/demo-localstack/schemas/atmos-manifest.json
@@ -320,21 +320,29 @@
             "real"
           ]
         },
+        "enabled": {
+          "type": "boolean",
+          "description": "Flag to enable or disable the component"
+        },
         "component": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform/OpenTofu/Helmfile component"
         },
         "inherits": {
           "type": "array",
+          "description": "A list of Atmos components that the current component inherits from",
           "uniqueItems": true,
           "items": {
             "type": "string"
           }
         },
         "terraform_workspace": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace"
         },
         "terraform_workspace_pattern": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace pattern"
         },
         "custom": {
           "type": "object",

diff --git a/examples/quick-start-advanced/Dockerfile b/examples/quick-start-advanced/Dockerfile
@@ -6,7 +6,7 @@ ARG GEODESIC_OS=debian
 # https://atmos.tools/
 # https://github.com/cloudposse/atmos
 # https://github.com/cloudposse/atmos/releases
-ARG ATMOS_VERSION=1.121.0
+ARG ATMOS_VERSION=1.122.0
 
 # Terraform: https://github.com/hashicorp/terraform/releases
 ARG TF_VERSION=1.5.7

diff --git a/examples/quick-start-advanced/stacks/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json b/examples/quick-start-advanced/stacks/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json
@@ -320,21 +320,29 @@
             "real"
           ]
         },
+        "enabled": {
+          "type": "boolean",
+          "description": "Flag to enable or disable the component"
+        },
         "component": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform/OpenTofu/Helmfile component"
         },
         "inherits": {
           "type": "array",
+          "description": "A list of Atmos components that the current component inherits from",
           "uniqueItems": true,
           "items": {
             "type": "string"
           }
         },
         "terraform_workspace": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace"
         },
         "terraform_workspace_pattern": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace pattern"
         },
         "custom": {
           "type": "object",

diff --git a/website/docs/core-concepts/components/terraform/backends.mdx b/website/docs/core-concepts/components/terraform/backends.mdx
@@ -102,8 +102,8 @@ Configuring Terraform S3 backend with Atmos consists of three steps:
 ```yaml
 components:
   terraform:
-  # Can also be set using 'ATMOS_COMPONENTS_TERRAFORM_AUTO_GENERATE_BACKEND_FILE' ENV var, or '--auto-generate-backend-file' command-line argument
-  auto_generate_backend_file: true
+    # Can also be set using 'ATMOS_COMPONENTS_TERRAFORM_AUTO_GENERATE_BACKEND_FILE' ENV var, or '--auto-generate-backend-file' command-line argument
+    auto_generate_backend_file: true
 ```
 </Terminal>
 

diff --git a/website/docs/core-concepts/stacks/overrides.mdx b/website/docs/core-concepts/stacks/overrides.mdx
@@ -362,5 +362,5 @@ terraform:
 :::
 
 :::tip
-Refer to [`atmosxw describe component`](/cli/commands/describe/component) CLI command for more details
+Refer to [`atmos describe component`](/cli/commands/describe/component) CLI command for more details
 :::
diff --git a/website/docs/integrations/atlantis.mdx b/website/docs/integrations/atlantis.mdx
@@ -673,7 +673,7 @@ on:
     branches: [ main ]
 
 env:
-  ATMOS_VERSION: 1.121.0
+  ATMOS_VERSION: 1.122.0
   ATMOS_CLI_CONFIG_PATH: ./
 
 jobs:

diff --git a/website/docs/quick-start/advanced/configure-terraform-backend.mdx b/website/docs/quick-start/advanced/configure-terraform-backend.mdx
@@ -155,8 +155,8 @@ Configuring Terraform S3 backend with Atmos consists of the three steps:
   ```yaml
   components:
     terraform:
-    # Can also be set using 'ATMOS_COMPONENTS_TERRAFORM_AUTO_GENERATE_BACKEND_FILE' ENV var, or '--auto-generate-backend-file' command-line argument
-    auto_generate_backend_file: true
+      # Can also be set using 'ATMOS_COMPONENTS_TERRAFORM_AUTO_GENERATE_BACKEND_FILE' ENV var, or '--auto-generate-backend-file' command-line argument
+      auto_generate_backend_file: true
   ```
   </File>
 

diff --git a/website/static/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json b/website/static/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json
@@ -320,21 +320,29 @@
             "real"
           ]
         },
+        "enabled": {
+          "type": "boolean",
+          "description": "Flag to enable or disable the component"
+        },
         "component": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform/OpenTofu/Helmfile component"
         },
         "inherits": {
           "type": "array",
+          "description": "A list of Atmos components that the current component inherits from",
           "uniqueItems": true,
           "items": {
             "type": "string"
           }
         },
         "terraform_workspace": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace"
         },
         "terraform_workspace_pattern": {
-          "type": "string"
+          "type": "string",
+          "description": "Terraform workspace pattern"
         },
         "custom": {
           "type": "object",
-Original file line number
+Diff line change
@@ Expand Up / @@ -362,5 +362,5 @@ terraform: @@
     :::
     :::tip
-    Refer to [`atmosxw describe component`](/cli/commands/describe/component) CLI command for more details
+    Refer to [`atmos describe component`](/cli/commands/describe/component) CLI command for more details
     :::