Documentation ¶
Index ¶
- func BuildAtlantisProjectNameFromComponentConfig(cliConfig schema.CliConfiguration, ...) (string, error)
- func BuildComponentPath(cliConfig schema.CliConfiguration, componentSectionMap map[string]any, ...) string
- func BuildDependentStackNameFromDependsOn(currentComponentName string, currentStackName string, ...) (string, error)
- func BuildDependentStackNameFromDependsOnLegacy(dependsOn string, allStackNames []string, currentStackName string, ...) (string, error)
- func BuildSpaceliftStackName(spaceliftSettings map[any]any, context schema.Context, contextPrefix string) (string, string, error)
- func BuildSpaceliftStackNameFromComponentConfig(cliConfig schema.CliConfiguration, ...) (string, error)
- func BuildSpaceliftStackNames(stacks map[string]any, stackNamePattern string) ([]string, error)
- func BuildTerraformWorkspace(cliConfig schema.CliConfiguration, ...) (string, error)
- func CreateComponentStackMap(cliConfig schema.CliConfiguration, stacksBasePath string, ...) (map[string]map[string][]string, error)
- func ExecuteAtlantisGenerateRepoConfig(cliConfig schema.CliConfiguration, outputPath string, ...) error
- func ExecuteAtlantisGenerateRepoConfigAffectedOnly(cliConfig schema.CliConfiguration, outputPath string, ...) error
- func ExecuteAtlantisGenerateRepoConfigCmd(cmd *cobra.Command, args []string) error
- func ExecuteAtmosCmd() error
- func ExecuteAtmosVendorInternal(cliConfig schema.CliConfiguration, vendorConfigFileName string, ...) error
- func ExecuteAwsEksUpdateKubeconfig(kubeconfigContext schema.AwsEksUpdateKubeconfigContext) error
- func ExecuteAwsEksUpdateKubeconfigCommand(cmd *cobra.Command, args []string) error
- func ExecuteComponentVendorInternal(cliConfig schema.CliConfiguration, ...) error
- func ExecuteDescribeAffectedCmd(cmd *cobra.Command, args []string) error
- func ExecuteDescribeAffectedWithTargetRefCheckout(cliConfig schema.CliConfiguration, ref string, sha string, verbose bool, ...) ([]schema.Affected, *plumbing.Reference, *plumbing.Reference, string, error)
- func ExecuteDescribeAffectedWithTargetRefClone(cliConfig schema.CliConfiguration, ref string, sha string, sshKeyPath string, ...) ([]schema.Affected, *plumbing.Reference, *plumbing.Reference, string, error)
- func ExecuteDescribeAffectedWithTargetRepoPath(cliConfig schema.CliConfiguration, targetRefPath string, verbose bool, ...) ([]schema.Affected, *plumbing.Reference, *plumbing.Reference, string, error)
- func ExecuteDescribeComponent(component string, stack string, processTemplates bool) (map[string]any, error)
- func ExecuteDescribeComponentCmd(cmd *cobra.Command, args []string) error
- func ExecuteDescribeConfigCmd(cmd *cobra.Command, args []string) error
- func ExecuteDescribeDependents(cliConfig schema.CliConfiguration, component string, stack string, ...) ([]schema.Dependent, error)
- func ExecuteDescribeDependentsCmd(cmd *cobra.Command, args []string) error
- func ExecuteDescribeStacks(cliConfig schema.CliConfiguration, filterByStack string, components []string, ...) (map[string]any, error)
- func ExecuteDescribeStacksCmd(cmd *cobra.Command, args []string) error
- func ExecuteDescribeWorkflows(cliConfig schema.CliConfiguration) ([]schema.DescribeWorkflowsItem, map[string][]string, ...)
- func ExecuteDescribeWorkflowsCmd(cmd *cobra.Command, args []string) error
- func ExecuteHelmfile(info schema.ConfigAndStacksInfo) error
- func ExecuteHelmfileCmd(cmd *cobra.Command, args []string, additionalArgsAndFlags []string) error
- func ExecuteHelmfileGenerateVarfileCmd(cmd *cobra.Command, args []string) error
- func ExecuteShell(cliConfig schema.CliConfiguration, command string, name string, dir string, ...) error
- func ExecuteShellAndReturnOutput(cliConfig schema.CliConfiguration, command string, name string, dir string, ...) (string, error)
- func ExecuteShellCommand(cliConfig schema.CliConfiguration, command string, args []string, dir string, ...) error
- func ExecuteStackVendorInternal(stack string, dryRun bool) error
- func ExecuteTerraform(info schema.ConfigAndStacksInfo) error
- func ExecuteTerraformCmd(cmd *cobra.Command, args []string, additionalArgsAndFlags []string) error
- func ExecuteTerraformGenerateBackendCmd(cmd *cobra.Command, args []string) error
- func ExecuteTerraformGenerateBackends(cliConfig schema.CliConfiguration, fileTemplate string, format string, ...) error
- func ExecuteTerraformGenerateBackendsCmd(cmd *cobra.Command, args []string) error
- func ExecuteTerraformGenerateVarfileCmd(cmd *cobra.Command, args []string) error
- func ExecuteTerraformGenerateVarfiles(cliConfig schema.CliConfiguration, fileTemplate string, format string, ...) error
- func ExecuteTerraformGenerateVarfilesCmd(cmd *cobra.Command, args []string) error
- func ExecuteValidateComponent(cliConfig schema.CliConfiguration, ...) (bool, error)
- func ExecuteValidateComponentCmd(cmd *cobra.Command, args []string) (string, string, error)
- func ExecuteValidateStacksCmd(cmd *cobra.Command, args []string) error
- func ExecuteVendorDiffCmd(cmd *cobra.Command, args []string) error
- func ExecuteVendorPullCmd(cmd *cobra.Command, args []string) error
- func ExecuteVendorPullCommand(cmd *cobra.Command, args []string) error
- func ExecuteWorkflow(cliConfig schema.CliConfiguration, workflow string, workflowPath string, ...) error
- func ExecuteWorkflowCmd(cmd *cobra.Command, args []string) error
- func ExecuteWorkflowUI(cliConfig schema.CliConfiguration) (string, string, string, error)
- func FindComponentDependencies(currentStack string, sources schema.ConfigSources) ([]string, []string, error)
- func FindComponentDependenciesLegacy(stack string, componentType string, component string, baseComponents []string, ...) ([]string, error)
- func FindComponentStacks(componentType string, component string, baseComponent string, ...) ([]string, error)
- func FindComponentsDerivedFromBaseComponents(stack string, allComponents map[string]any, baseComponents []string) ([]string, error)
- func FindStacksMap(cliConfig schema.CliConfiguration, ignoreMissingFiles bool) (map[string]any, map[string]map[string]any, error)
- func FindValidationSection(componentSection map[string]any) (schema.Validation, error)
- func FuncMap(cliConfig schema.CliConfiguration, ctx context.Context, ...) template.FuncMap
- func GetFileContent(filePath string) (string, error)
- func GetStackNamePattern(cliConfig schema.CliConfiguration) string
- func IsComponentAbstract(metadataSection map[any]any) bool
- func IsGolangTemplate(str string) (bool, error)
- func ProcessBaseComponentConfig(cliConfig schema.CliConfiguration, ...) error
- func ProcessComponentConfig(configAndStacksInfo *schema.ConfigAndStacksInfo, stack string, ...) error
- func ProcessComponentMetadata(component string, componentSection map[string]any) (map[any]any, string, bool)
- func ProcessConfigSources(configAndStacksInfo schema.ConfigAndStacksInfo, ...) (schema.ConfigSources, error)
- func ProcessImportSection(stackMap map[any]any, filePath string) ([]schema.StackImport, error)
- func ProcessStackConfig(cliConfig schema.CliConfiguration, stacksBasePath string, ...) (map[any]any, error)
- func ProcessStacks(cliConfig schema.CliConfiguration, ...) (schema.ConfigAndStacksInfo, error)
- func ProcessTmpl(tmplName string, tmplValue string, tmplData any, ...) (string, error)
- func ProcessTmplWithDatasources(cliConfig schema.CliConfiguration, settingsSection schema.Settings, ...) (string, error)
- func ProcessYAMLConfigFile(cliConfig schema.CliConfiguration, basePath string, filePath string, ...) (map[any]any, map[string]map[any]any, map[any]any, error)
- func ProcessYAMLConfigFiles(cliConfig schema.CliConfiguration, stacksBasePath string, ...) ([]string, map[string]any, map[string]map[string]any, error)
- func ReadAndProcessComponentVendorConfigFile(cliConfig schema.CliConfiguration, component string, componentType string) (schema.VendorComponentConfig, string, error)
- func ReadAndProcessVendorConfigFile(cliConfig schema.CliConfiguration, vendorConfigFile string) (schema.AtmosVendorConfig, bool, string, error)
- func ValidateComponent(cliConfig schema.CliConfiguration, componentName string, componentSection any, ...) (bool, error)
- func ValidateStacks(cliConfig schema.CliConfiguration) error
- func ValidateWithCue(data any, schemaName string, schemaText string) (bool, error)
- func ValidateWithJsonSchema(data any, schemaName string, schemaText string) (bool, error)
- func ValidateWithOpa(data any, schemaPath string, modulePaths []string, timeoutSeconds int) (bool, error)
- func ValidateWithOpaLegacy(data any, schemaName string, schemaText string, timeoutSeconds int) (bool, error)
- type AtmosFuncs
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildAtlantisProjectNameFromComponentConfig ¶ added in v1.31.0
func BuildAtlantisProjectNameFromComponentConfig( cliConfig schema.CliConfiguration, configAndStacksInfo schema.ConfigAndStacksInfo, ) (string, error)
BuildAtlantisProjectNameFromComponentConfig builds an Atlantis project name from the component config
func BuildComponentPath ¶ added in v1.31.0
func BuildComponentPath( cliConfig schema.CliConfiguration, componentSectionMap map[string]any, componentType string, ) string
BuildComponentPath builds component path (path to the component's physical location on disk)
func BuildDependentStackNameFromDependsOn ¶ added in v1.33.2
func BuildDependentStackNameFromDependsOn( currentComponentName string, currentStackName string, dependsOnComponentName string, dependsOnStackName string, allStackNames []string, ) (string, error)
BuildDependentStackNameFromDependsOn builds the dependent stack name from "settings.depends_on" config
func BuildDependentStackNameFromDependsOnLegacy ¶ added in v1.50.0
func BuildDependentStackNameFromDependsOnLegacy( dependsOn string, allStackNames []string, currentStackName string, componentNamesInCurrentStack []string, currentComponentName string, ) (string, error)
BuildDependentStackNameFromDependsOnLegacy builds the dependent stack name from "settings.spacelift.depends_on" config
func BuildSpaceliftStackName ¶ added in v1.24.0
func BuildSpaceliftStackName(spaceliftSettings map[any]any, context schema.Context, contextPrefix string) (string, string, error)
BuildSpaceliftStackName builds a Spacelift stack name from the provided context and stack name pattern
func BuildSpaceliftStackNameFromComponentConfig ¶ added in v1.31.0
func BuildSpaceliftStackNameFromComponentConfig( cliConfig schema.CliConfiguration, configAndStacksInfo schema.ConfigAndStacksInfo, ) (string, error)
BuildSpaceliftStackNameFromComponentConfig builds Spacelift stack name from the component config
func BuildSpaceliftStackNames ¶ added in v1.31.0
BuildSpaceliftStackNames builds Spacelift stack names
func BuildTerraformWorkspace ¶ added in v1.4.8
func BuildTerraformWorkspace(cliConfig schema.CliConfiguration, configAndStacksInfo schema.ConfigAndStacksInfo) (string, error)
BuildTerraformWorkspace builds Terraform workspace
func CreateComponentStackMap ¶ added in v1.81.0
func CreateComponentStackMap( cliConfig schema.CliConfiguration, stacksBasePath string, terraformComponentsBasePath string, helmfileComponentsBasePath string, filePath string, ) (map[string]map[string][]string, error)
CreateComponentStackMap accepts a config file and creates a map of component-stack dependencies
func ExecuteAtlantisGenerateRepoConfig ¶ added in v1.5.0
func ExecuteAtlantisGenerateRepoConfig( cliConfig schema.CliConfiguration, outputPath string, configTemplateNameArg string, projectTemplateNameArg string, stacks []string, components []string, ) error
ExecuteAtlantisGenerateRepoConfig generates repository configuration for Atlantis
func ExecuteAtlantisGenerateRepoConfigAffectedOnly ¶ added in v1.30.0
func ExecuteAtlantisGenerateRepoConfigAffectedOnly( cliConfig schema.CliConfiguration, outputPath string, configTemplateName string, projectTemplateName string, ref string, sha string, repoPath string, sshKeyPath string, sshKeyPassword string, verbose bool, cloneTargetRef bool, ) error
ExecuteAtlantisGenerateRepoConfigAffectedOnly generates repository configuration for Atlantis only for the affected compoenents and stacks
func ExecuteAtlantisGenerateRepoConfigCmd ¶ added in v1.5.0
ExecuteAtlantisGenerateRepoConfigCmd executes 'atlantis generate repo-config' command
func ExecuteAtmosCmd ¶ added in v1.54.0
func ExecuteAtmosCmd() error
ExecuteAtmosCmd executes `atmos` command
func ExecuteAtmosVendorInternal ¶ added in v1.47.0
func ExecuteAtmosVendorInternal( cliConfig schema.CliConfiguration, vendorConfigFileName string, atmosVendorSpec schema.AtmosVendorSpec, component string, tags []string, dryRun bool, ) error
ExecuteAtmosVendorInternal downloads the artifacts from the sources and writes them to the targets
func ExecuteAwsEksUpdateKubeconfig ¶ added in v1.4.9
func ExecuteAwsEksUpdateKubeconfig(kubeconfigContext schema.AwsEksUpdateKubeconfigContext) error
ExecuteAwsEksUpdateKubeconfig executes 'aws eks update-kubeconfig' https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html
func ExecuteAwsEksUpdateKubeconfigCommand ¶ added in v1.4.9
func ExecuteComponentVendorInternal ¶ added in v1.47.0
func ExecuteComponentVendorInternal( cliConfig schema.CliConfiguration, vendorComponentSpec schema.VendorComponentSpec, component string, componentPath string, dryRun bool, ) error
ExecuteComponentVendorInternal executes the 'atmos vendor pull' command for a component Supports all protocols (local files, Git, Mercurial, HTTP, HTTPS, Amazon S3, Google GCP), URL and archive formats described in https://github.com/hashicorp/go-getter https://www.allee.xyz/en/posts/getting-started-with-go-getter https://github.com/otiai10/copy https://opencontainers.org/ https://github.com/google/go-containerregistry https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html
func ExecuteDescribeAffectedCmd ¶ added in v1.17.0
ExecuteDescribeAffectedCmd executes `describe affected` command
func ExecuteDescribeAffectedWithTargetRefCheckout ¶ added in v1.71.0
func ExecuteDescribeAffectedWithTargetRefCheckout( cliConfig schema.CliConfiguration, ref string, sha string, verbose bool, includeSpaceliftAdminStacks bool, includeSettings bool, ) ([]schema.Affected, *plumbing.Reference, *plumbing.Reference, string, error)
ExecuteDescribeAffectedWithTargetRefCheckout checks out the target reference, processes stack configs, and returns a list of the affected Atmos components and stacks given two Git commits
func ExecuteDescribeAffectedWithTargetRefClone ¶ added in v1.71.0
func ExecuteDescribeAffectedWithTargetRefClone( cliConfig schema.CliConfiguration, ref string, sha string, sshKeyPath string, sshKeyPassword string, verbose bool, includeSpaceliftAdminStacks bool, includeSettings bool, ) ([]schema.Affected, *plumbing.Reference, *plumbing.Reference, string, error)
ExecuteDescribeAffectedWithTargetRefClone clones the remote reference, processes stack configs, and returns a list of the affected Atmos components and stacks given two Git commits
func ExecuteDescribeAffectedWithTargetRepoPath ¶ added in v1.26.0
func ExecuteDescribeAffectedWithTargetRepoPath( cliConfig schema.CliConfiguration, targetRefPath string, verbose bool, includeSpaceliftAdminStacks bool, includeSettings bool, ) ([]schema.Affected, *plumbing.Reference, *plumbing.Reference, string, error)
ExecuteDescribeAffectedWithTargetRepoPath uses `repo-path` to access the target repo, and processes stack configs and returns a list of the affected Atmos components and stacks given two Git commits
func ExecuteDescribeComponent ¶
func ExecuteDescribeComponent( component string, stack string, processTemplates bool, ) (map[string]any, error)
ExecuteDescribeComponent describes component config
func ExecuteDescribeComponentCmd ¶ added in v1.11.0
ExecuteDescribeComponentCmd executes `describe component` command
func ExecuteDescribeConfigCmd ¶ added in v1.11.0
ExecuteDescribeConfigCmd executes `describe config` command
func ExecuteDescribeDependents ¶ added in v1.33.2
func ExecuteDescribeDependents( cliConfig schema.CliConfiguration, component string, stack string, includeSettings bool, ) ([]schema.Dependent, error)
ExecuteDescribeDependents produces a list of Atmos components in Atmos stacks that depend on the provided Atmos component
func ExecuteDescribeDependentsCmd ¶ added in v1.33.2
ExecuteDescribeDependentsCmd executes `describe dependents` command
func ExecuteDescribeStacks ¶ added in v1.4.4
func ExecuteDescribeStacks( cliConfig schema.CliConfiguration, filterByStack string, components []string, componentTypes []string, sections []string, ignoreMissingFiles bool, processTemplates bool, ) (map[string]any, error)
ExecuteDescribeStacks processes stack manifests and returns the final map of stacks and components
func ExecuteDescribeStacksCmd ¶ added in v1.11.0
ExecuteDescribeStacksCmd executes `describe stacks` command
func ExecuteDescribeWorkflows ¶ added in v1.55.0
func ExecuteDescribeWorkflows( cliConfig schema.CliConfiguration, ) ([]schema.DescribeWorkflowsItem, map[string][]string, map[string]schema.WorkflowManifest, error)
ExecuteDescribeWorkflows executes `atmos describe workflows` command
func ExecuteDescribeWorkflowsCmd ¶ added in v1.55.0
ExecuteDescribeWorkflowsCmd executes `atmos describe workflows` CLI command
func ExecuteHelmfile ¶
func ExecuteHelmfile(info schema.ConfigAndStacksInfo) error
ExecuteHelmfile executes helmfile commands
func ExecuteHelmfileCmd ¶ added in v1.11.0
ExecuteHelmfileCmd parses the provided arguments and flags and executes helmfile commands
func ExecuteHelmfileGenerateVarfileCmd ¶ added in v1.11.0
ExecuteHelmfileGenerateVarfileCmd executes `helmfile generate varfile` command
func ExecuteShell ¶ added in v1.16.0
func ExecuteShell( cliConfig schema.CliConfiguration, command string, name string, dir string, env []string, dryRun bool, ) error
ExecuteShell runs a shell script
func ExecuteShellAndReturnOutput ¶ added in v1.16.0
func ExecuteShellAndReturnOutput( cliConfig schema.CliConfiguration, command string, name string, dir string, env []string, dryRun bool, ) (string, error)
ExecuteShellAndReturnOutput runs a shell script and capture its standard output
func ExecuteShellCommand ¶ added in v1.4.9
func ExecuteShellCommand( cliConfig schema.CliConfiguration, command string, args []string, dir string, env []string, dryRun bool, redirectStdError string, ) error
ExecuteShellCommand prints and executes the provided command with args and flags
func ExecuteStackVendorInternal ¶ added in v1.47.0
ExecuteStackVendorInternal executes the command to vendor an Atmos stack TODO: implement this
func ExecuteTerraform ¶
func ExecuteTerraform(info schema.ConfigAndStacksInfo) error
ExecuteTerraform executes terraform commands
func ExecuteTerraformCmd ¶ added in v1.11.0
ExecuteTerraformCmd parses the provided arguments and flags and executes terraform commands
func ExecuteTerraformGenerateBackendCmd ¶ added in v1.11.0
ExecuteTerraformGenerateBackendCmd executes `terraform generate backend` command
func ExecuteTerraformGenerateBackends ¶
func ExecuteTerraformGenerateBackends( cliConfig schema.CliConfiguration, fileTemplate string, format string, stacks []string, components []string, ) error
ExecuteTerraformGenerateBackends generates backend configs for all terraform components
func ExecuteTerraformGenerateBackendsCmd ¶ added in v1.7.0
ExecuteTerraformGenerateBackendsCmd executes `terraform generate backends` command
func ExecuteTerraformGenerateVarfileCmd ¶ added in v1.11.0
ExecuteTerraformGenerateVarfileCmd executes `terraform generate varfile` command
func ExecuteTerraformGenerateVarfiles ¶ added in v1.5.0
func ExecuteTerraformGenerateVarfiles( cliConfig schema.CliConfiguration, fileTemplate string, format string, stacks []string, components []string, ) error
ExecuteTerraformGenerateVarfiles generates varfiles for all terraform components in all stacks
func ExecuteTerraformGenerateVarfilesCmd ¶ added in v1.5.0
ExecuteTerraformGenerateVarfilesCmd executes `terraform generate varfiles` command
func ExecuteValidateComponent ¶ added in v1.9.0
func ExecuteValidateComponent( cliConfig schema.CliConfiguration, configAndStacksInfo schema.ConfigAndStacksInfo, componentName string, stack string, schemaPath string, schemaType string, modulePaths []string, timeoutSeconds int, ) (bool, error)
ExecuteValidateComponent validates a component in a stack using JsonSchema, OPA or CUE schema documents
func ExecuteValidateComponentCmd ¶ added in v1.9.0
ExecuteValidateComponentCmd executes `validate component` command
func ExecuteValidateStacksCmd ¶ added in v1.11.0
ExecuteValidateStacksCmd executes `validate stacks` command
func ExecuteVendorDiffCmd ¶ added in v1.11.0
ExecuteVendorDiffCmd executes `vendor diff` commands
func ExecuteVendorPullCmd ¶ added in v1.11.0
ExecuteVendorPullCmd executes `vendor pull` commands
func ExecuteVendorPullCommand ¶ added in v1.47.0
ExecuteVendorPullCommand executes `atmos vendor` commands
func ExecuteWorkflow ¶ added in v1.4.0
func ExecuteWorkflow( cliConfig schema.CliConfiguration, workflow string, workflowPath string, workflowDefinition *schema.WorkflowDefinition, dryRun bool, commandLineStack string, fromStep string, ) error
ExecuteWorkflow executes an Atmos workflow
func ExecuteWorkflowCmd ¶ added in v1.11.0
ExecuteWorkflowCmd executes an Atmos workflow
func ExecuteWorkflowUI ¶ added in v1.81.0
func FindComponentDependencies ¶ added in v1.42.0
func FindComponentDependencies(currentStack string, sources schema.ConfigSources) ([]string, []string, error)
FindComponentDependencies finds all imports that the component depends on, and all imports that the component has any sections defind in
func FindComponentDependenciesLegacy ¶ added in v1.81.0
func FindComponentDependenciesLegacy( stack string, componentType string, component string, baseComponents []string, stackImports map[string]map[any]any) ([]string, error)
FindComponentDependenciesLegacy finds all imports where the component or the base component(s) are defined Component depends on the imported config file if any of the following conditions is true:
- The imported config file has any of the global `backend`, `backend_type`, `env`, `remote_state_backend`, `remote_state_backend_type`, `settings` or `vars` sections which are not empty.
- The imported config file has the component type section, which has any of the `backend`, `backend_type`, `env`, `remote_state_backend`, `remote_state_backend_type`, `settings` or `vars` sections which are not empty.
- The imported config file has the "components" section, which has the component type section, which has the component section.
- The imported config file has the "components" section, which has the component type section, which has the base component(s) section, and the base component section is defined inline (not imported).
func FindComponentStacks ¶ added in v1.81.0
func FindComponentStacks( componentType string, component string, baseComponent string, componentStackMap map[string]map[string][]string) ([]string, error)
FindComponentStacks finds all infrastructure stack manifests where the component or the base component is defined
func FindComponentsDerivedFromBaseComponents ¶ added in v1.81.0
func FindComponentsDerivedFromBaseComponents( stack string, allComponents map[string]any, baseComponents []string, ) ([]string, error)
FindComponentsDerivedFromBaseComponents finds all components that derive from the given base components
func FindStacksMap ¶ added in v1.4.4
func FindStacksMap(cliConfig schema.CliConfiguration, ignoreMissingFiles bool) ( map[string]any, map[string]map[string]any, error, )
FindStacksMap processes stack config and returns a map of all stacks
func FindValidationSection ¶ added in v1.9.0
func FindValidationSection(componentSection map[string]any) (schema.Validation, error)
FindValidationSection finds 'validation' section in the component config
func FuncMap ¶ added in v1.81.0
func FuncMap(cliConfig schema.CliConfiguration, ctx context.Context, gomplateData *data.Data) template.FuncMap
FuncMap creates and returns a map of template functions
func GetFileContent ¶ added in v1.81.0
GetFileContent tries to read and return the file content from the sync map if it exists in the map, otherwise it reads the file, stores its content in the map and returns the content
func GetStackNamePattern ¶ added in v1.66.0
func GetStackNamePattern(cliConfig schema.CliConfiguration) string
GetStackNamePattern returns stack name pattern
func IsComponentAbstract ¶ added in v1.78.0
IsComponentAbstract returns 'true' if the component is abstract
func IsGolangTemplate ¶ added in v1.81.0
IsGolangTemplate checks if the provided string is a Go template
func ProcessBaseComponentConfig ¶ added in v1.81.0
func ProcessBaseComponentConfig( cliConfig schema.CliConfiguration, baseComponentConfig *schema.BaseComponentConfig, allComponentsMap map[any]any, component string, stack string, baseComponent string, componentBasePath string, checkBaseComponentExists bool, baseComponents *[]string, ) error
ProcessBaseComponentConfig processes base component(s) config
func ProcessComponentConfig ¶ added in v1.66.0
func ProcessComponentConfig( configAndStacksInfo *schema.ConfigAndStacksInfo, stack string, stacksMap map[string]any, componentType string, component string, ) error
ProcessComponentConfig processes component config sections
func ProcessComponentMetadata ¶ added in v1.8.0
func ProcessComponentMetadata( component string, componentSection map[string]any, ) (map[any]any, string, bool)
ProcessComponentMetadata processes component metadata and returns a base component (if any) and whether the component is real or abstract
func ProcessConfigSources ¶ added in v1.42.0
func ProcessConfigSources( configAndStacksInfo schema.ConfigAndStacksInfo, rawStackConfigs map[string]map[string]any, ) (schema.ConfigSources, error)
ProcessConfigSources processes the sources (files) for all sections for a component in a stack
func ProcessImportSection ¶ added in v1.81.0
ProcessImportSection processes the `import` section in stack manifests The `import` section` can be of the following types: 1. list of `StackImport` structs 2. list of strings 3. List of strings and `StackImport` structs in the same file
func ProcessStackConfig ¶ added in v1.81.0
func ProcessStackConfig( cliConfig schema.CliConfiguration, stacksBasePath string, terraformComponentsBasePath string, helmfileComponentsBasePath string, stack string, config map[any]any, processStackDeps bool, processComponentDeps bool, componentTypeFilter string, componentStackMap map[string]map[string][]string, importsConfig map[string]map[any]any, checkBaseComponentExists bool, ) (map[any]any, error)
ProcessStackConfig takes a stack manifest, deep-merges all variables, settings, environments and backends, and returns the final stack configuration for all Terraform and helmfile components
func ProcessStacks ¶ added in v1.3.28
func ProcessStacks( cliConfig schema.CliConfiguration, configAndStacksInfo schema.ConfigAndStacksInfo, checkStack bool, processTemplates bool, ) (schema.ConfigAndStacksInfo, error)
ProcessStacks processes stack config
func ProcessTmpl ¶ added in v1.81.0
func ProcessTmpl( tmplName string, tmplValue string, tmplData any, ignoreMissingTemplateValues bool, ) (string, error)
ProcessTmpl parses and executes Go templates
func ProcessTmplWithDatasources ¶ added in v1.81.0
func ProcessTmplWithDatasources( cliConfig schema.CliConfiguration, settingsSection schema.Settings, tmplName string, tmplValue string, tmplData any, ignoreMissingTemplateValues bool, ) (string, error)
ProcessTmplWithDatasources parses and executes Go templates with datasources
func ProcessYAMLConfigFile ¶ added in v1.81.0
func ProcessYAMLConfigFile( cliConfig schema.CliConfiguration, basePath string, filePath string, importsConfig map[string]map[any]any, context map[string]any, ignoreMissingFiles bool, skipTemplatesProcessingInImports bool, ignoreMissingTemplateValues bool, skipIfMissing bool, parentTerraformOverrides map[any]any, parentHelmfileOverrides map[any]any, atmosManifestJsonSchemaFilePath string, ) ( map[any]any, map[string]map[any]any, map[any]any, error, )
ProcessYAMLConfigFile takes a path to a YAML stack manifest, recursively processes and deep-merges all imports, and returns the final stack config
func ProcessYAMLConfigFiles ¶ added in v1.81.0
func ProcessYAMLConfigFiles( cliConfig schema.CliConfiguration, stacksBasePath string, terraformComponentsBasePath string, helmfileComponentsBasePath string, filePaths []string, processStackDeps bool, processComponentDeps bool, ignoreMissingFiles bool, ) ( []string, map[string]any, map[string]map[string]any, error, )
ProcessYAMLConfigFiles takes a list of paths to stack manifests, processes and deep-merges all imports, and returns a list of stack configs
func ReadAndProcessComponentVendorConfigFile ¶ added in v1.47.0
func ReadAndProcessComponentVendorConfigFile( cliConfig schema.CliConfiguration, component string, componentType string, ) (schema.VendorComponentConfig, string, error)
ReadAndProcessComponentVendorConfigFile reads and processes the component vendoring config file `component.yaml`
func ReadAndProcessVendorConfigFile ¶ added in v1.47.0
func ReadAndProcessVendorConfigFile(cliConfig schema.CliConfiguration, vendorConfigFile string) ( schema.AtmosVendorConfig, bool, string, error, )
ReadAndProcessVendorConfigFile reads and processes the Atmos vendoring config file `vendor.yaml`
func ValidateComponent ¶ added in v1.9.0
func ValidateComponent( cliConfig schema.CliConfiguration, componentName string, componentSection any, schemaPath string, schemaType string, modulePaths []string, timeoutSeconds int, ) (bool, error)
ValidateComponent validates the component config using JsonSchema, OPA or CUE schema documents
func ValidateStacks ¶ added in v1.75.0
func ValidateStacks(cliConfig schema.CliConfiguration) error
ValidateStacks validates Atmos stack configuration
func ValidateWithCue ¶ added in v1.9.0
ValidateWithCue validates the data structure using the provided CUE document https://cuelang.org/docs/integrations/go/#processing-cue-in-go
func ValidateWithJsonSchema ¶ added in v1.9.0
ValidateWithJsonSchema validates the data structure using the provided JSON Schema document https://github.com/santhosh-tekuri/jsonschema https://go.dev/play/p/Hhax3MrtD8r
func ValidateWithOpa ¶ added in v1.9.0
func ValidateWithOpa( data any, schemaPath string, modulePaths []string, timeoutSeconds int, ) (bool, error)
ValidateWithOpa validates the data structure using the provided OPA document https://github.com/open-policy-agent/opa/blob/main/rego/example_test.go https://github.com/open-policy-agent/opa/blob/main/rego/rego_test.go https://www.openpolicyagent.org/docs/latest/integration/#sdk
func ValidateWithOpaLegacy ¶ added in v1.38.0
func ValidateWithOpaLegacy( data any, schemaName string, schemaText string, timeoutSeconds int, ) (bool, error)
ValidateWithOpaLegacy validates the data structure using the provided OPA document https://www.openpolicyagent.org/docs/latest/integration/#sdk
Types ¶
type AtmosFuncs ¶ added in v1.81.0
type AtmosFuncs struct {
// contains filtered or unexported fields
}
func (AtmosFuncs) Component ¶ added in v1.81.0
func (f AtmosFuncs) Component(component string, stack string) (any, error)
func (AtmosFuncs) GomplateDatasource ¶ added in v1.84.0
func (f AtmosFuncs) GomplateDatasource(alias string, args ...string) (any, error)
Source Files ¶
- atlantis_generate_repo_config.go
- atlantis_utils.go
- atmos.go
- aws_eks_update_kubeconfig.go
- config_sources_utils.go
- describe_affected.go
- describe_affected_utils.go
- describe_component.go
- describe_config.go
- describe_dependents.go
- describe_stacks.go
- describe_workflows.go
- file_utils.go
- helmfile.go
- helmfile_generate_varfile.go
- help.go
- oci_utils.go
- path_utils.go
- shell_utils.go
- spacelift_utils.go
- stack_processor_utils.go
- stack_utils.go
- tar_utils.go
- template_funcs.go
- template_funcs_component.go
- template_funcs_gomplate_datasource.go
- template_utils.go
- terraform.go
- terraform_generate_backend.go
- terraform_generate_backends.go
- terraform_generate_varfile.go
- terraform_generate_varfiles.go
- terraform_utils.go
- utils.go
- validate_component.go
- validate_stacks.go
- validate_utils.go
- vendor.go
- vendor_component_utils.go
- vendor_utils.go
- worflow.go
- worflow_utils.go