Documentation
¶
Index ¶
- func ExecuteDescribeComponent(component string, stack string, processTemplates bool, ...) (map[string]any, error)
- func ExecuteDescribeStacks(atmosConfig schema.AtmosConfiguration, filterByStack string, ...) (map[string]any, error)
- func ProcessComponentFromContext(params *ComponentFromContextParams, opts ...ProcessOption) (map[string]any, error)
- func ProcessComponentInStack(component string, stack string, atmosCliConfigPath string, ...) (map[string]any, error)
- type ComponentFromContextParams
- type ProcessOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExecuteDescribeComponent ¶ added in v1.109.0
func ExecuteDescribeComponent( component string, stack string, processTemplates bool, processYamlFunctions bool, skip []string, ) (map[string]any, error)
ExecuteDescribeComponent describes component config and returns the final map of component configuration in the stack
func ExecuteDescribeStacks ¶
func ExecuteDescribeStacks( atmosConfig schema.AtmosConfiguration, filterByStack string, components []string, componentTypes []string, sections []string, ignoreMissingFiles bool, includeEmptyStacks bool, ) (map[string]any, error)
ExecuteDescribeStacks processes stack manifests and returns the final map of stacks and components.
func ProcessComponentFromContext ¶ added in v1.207.0
func ProcessComponentFromContext(params *ComponentFromContextParams, opts ...ProcessOption) (map[string]any, error)
ProcessComponentFromContext accepts context (namespace, tenant, environment, stage) and returns the component configuration in the stack.
This function is the public API used by terraform-provider-utils (data "utils_component_config"). See ProcessComponentInStack for details on why this lives in pkg/describe.
func ProcessComponentInStack ¶ added in v1.207.0
func ProcessComponentInStack( component string, stack string, atmosCliConfigPath string, atmosBasePath string, opts ...ProcessOption, ) (map[string]any, error)
ProcessComponentInStack accepts a component and a stack name and returns the component configuration in the stack.
This function is the public API used by terraform-provider-utils (data "utils_component_config"). It was originally in pkg/component/component_processor.go but was moved here because internal/exec imports pkg/component (for the registry/provider types), creating an import cycle if pkg/component imports internal/exec.
Functional options can be passed to control whether Go templates and YAML functions (e.g. !terraform.output, !terraform.state) are resolved during processing. When called from the terraform-provider-utils, both should be disabled to avoid spawning child terraform processes inside the provider plugin. When omitted, both default to true for backward compatibility.
Types ¶
type ComponentFromContextParams ¶ added in v1.207.0
type ComponentFromContextParams struct {
Component string
Namespace string
Tenant string
Environment string
Stage string
AtmosCliConfigPath string
AtmosBasePath string
}
ComponentFromContextParams contains the parameters for ProcessComponentFromContext.
type ProcessOption ¶ added in v1.209.0
type ProcessOption func(*processOptions)
ProcessOption is a functional option for ProcessComponentInStack and ProcessComponentFromContext.
func WithProcessTemplates ¶ added in v1.209.0
func WithProcessTemplates(enabled bool) ProcessOption
WithProcessTemplates controls whether Go templates are resolved during processing. When false, template expressions like {{ .settings.config.a }} are preserved as raw strings. Defaults to true when not specified.
func WithProcessYamlFunctions ¶ added in v1.209.0
func WithProcessYamlFunctions(enabled bool) ProcessOption
WithProcessYamlFunctions controls whether YAML functions (!terraform.output, !terraform.state, !template, !store, etc.) are resolved during processing. When false, YAML function tags are preserved as raw strings. Defaults to true when not specified.
Source Files