-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update
atmos, rebuild provider docs (#102)
* Update `atmos`, rebuild provider docs * Update `atmos`, rebuild provider docs
- Loading branch information
Showing
9 changed files
with
185 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "utils_component_config Data Source - terraform-provider-utils" | ||
| subcategory: "" | ||
| description: |- | ||
| The component_config data source accepts a component and a stack name and returns the component configuration in the stack | ||
| --- | ||
|
|
||
| # utils_component_config (Data Source) | ||
|
|
||
| The `component_config` data source accepts a component and a stack name and returns the component configuration in the stack | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| locals { | ||
| component = "test/test-component-override" | ||
| stack = "tenant1-ue2-dev" | ||
| tenant = "tenant1" | ||
| environment = "ue2" | ||
| stage = "dev" | ||
| result1 = yamldecode(data.utils_component_config.example1.output) | ||
| result2 = yamldecode(data.utils_component_config.example2.output) | ||
| } | ||
| data "utils_component_config" "example1" { | ||
| component = local.component | ||
| stack = local.stack | ||
| } | ||
| data "utils_component_config" "example2" { | ||
| component = local.component | ||
| tenant = local.tenant | ||
| environment = local.environment | ||
| stage = local.stage | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **component** (String) Component name. | ||
|
|
||
| ### Optional | ||
|
|
||
| - **environment** (String) Environment. | ||
| - **id** (String) The ID of this resource. | ||
| - **stack** (String) Stack name. | ||
| - **stage** (String) Stage. | ||
| - **tenant** (String) Tenant. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - **output** (String) Component configuration. | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "utils_spacelift_stack_config Data Source - terraform-provider-utils" | ||
| subcategory: "" | ||
| description: |- | ||
| The spacelift_stack_config data source accepts a list of stack config file names and returns a map of Spacelift stack configurations. | ||
| --- | ||
|
|
||
| # utils_spacelift_stack_config (Data Source) | ||
|
|
||
| The `spacelift_stack_config` data source accepts a list of stack config file names and returns a map of Spacelift stack configurations. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| locals { | ||
| result = yamldecode(data.utils_spacelift_stack_config.example.output) | ||
| } | ||
| data "utils_spacelift_stack_config" "example" { | ||
| process_component_deps = true | ||
| process_stack_deps = true | ||
| process_imports = true | ||
| stack_config_path_template = "stacks/%s.yaml" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **stack_config_path_template** (String) Stack config path template. | ||
|
|
||
| ### Optional | ||
|
|
||
| - **base_path** (String) Stack config base path. | ||
| - **id** (String) The ID of this resource. | ||
| - **input** (List of String) A list of stack config file names. | ||
| - **process_component_deps** (Boolean) A boolean flag to enable/disable processing config dependencies for the components. | ||
| - **process_imports** (Boolean) A boolean flag to enable/disable processing stack imports. | ||
| - **process_stack_deps** (Boolean) A boolean flag to enable/disable processing all stack dependencies for the components. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - **output** (String) A map of Spacelift stack configurations. | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "utils_stack_config_yaml Data Source - terraform-provider-utils" | ||
| subcategory: "" | ||
| description: |- | ||
| The stack_config_yaml data source accepts a list of stack config file names and returns a list of stack configurations. | ||
| --- | ||
|
|
||
| # utils_stack_config_yaml (Data Source) | ||
|
|
||
| The `stack_config_yaml` data source accepts a list of stack config file names and returns a list of stack configurations. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| locals { | ||
| base_path = "../../config/stacks" | ||
| stack_config_files = [ | ||
| "${local.base_path}/tenant1/ue2/dev.yaml", | ||
| "${local.base_path}/tenant1/ue2/prod.yaml", | ||
| "${local.base_path}/tenant1/ue2/staging.yaml", | ||
| "${local.base_path}/tenant2/ue2/dev.yaml", | ||
| "${local.base_path}/tenant2/ue2/prod.yaml", | ||
| "${local.base_path}/tenant2/ue2/staging.yaml", | ||
| ] | ||
| result = [for i in data.utils_stack_config_yaml.example.output : yamldecode(i)] | ||
| } | ||
| data "utils_stack_config_yaml" "example" { | ||
| base_path = local.base_path | ||
| input = local.stack_config_files | ||
| process_component_deps = true | ||
| process_stack_deps = false | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **input** (List of String) A list of stack config file names. | ||
|
|
||
| ### Optional | ||
|
|
||
| - **base_path** (String) Stack config base path. | ||
| - **id** (String) The ID of this resource. | ||
| - **process_component_deps** (Boolean) A boolean flag to enable/disable processing config dependencies for the components. | ||
| - **process_stack_deps** (Boolean) A boolean flag to enable/disable processing all stack dependencies for the components. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - **output** (List of String) A list of stack configurations. | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,4 +18,4 @@ provider "utils" { | |
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
| ## Schema | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters