Documentation ¶
Index ¶
- func BuildAtlantisProjectName(context schema.Context, projectNameTemplate string) string
- func BuildAtlantisProjectNameFromComponentConfig(cliConfig schema.CliConfiguration, componentName string, ...) (string, error)
- func BuildComponentPath(cliConfig schema.CliConfiguration, componentSectionMap map[string]any, ...) string
- func BuildDependentStackNameFromDependsOn(dependsOn string, allStackNames []string, currentStackName string, ...) (string, error)
- func BuildSpaceliftStackName(spaceliftSettings map[any]any, context schema.Context, contextPrefix string) (string, string)
- func BuildSpaceliftStackNameFromComponentConfig(cliConfig schema.CliConfiguration, componentName string, stackName string, ...) (string, error)
- func BuildSpaceliftStackNames(stacks map[string]any, stackNamePattern string) ([]string, error)
- func BuildTerraformWorkspace(stack string, stackNamePattern string, componentMetadata map[any]any, ...) (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 ExecuteAwsEksUpdateKubeconfig(kubeconfigContext schema.AwsEksUpdateKubeconfigContext) error
- func ExecuteAwsEksUpdateKubeconfigCommand(cmd *cobra.Command, args []string) error
- func ExecuteComponentVendorCommandInternal(cliConfig schema.CliConfiguration, ...) error
- func ExecuteDescribeAffectedCmd(cmd *cobra.Command, args []string) error
- func ExecuteDescribeAffectedWithTargetRepoClone(cliConfig schema.CliConfiguration, ref string, sha string, sshKeyPath string, ...) ([]schema.Affected, error)
- func ExecuteDescribeAffectedWithTargetRepoPath(cliConfig schema.CliConfiguration, repoPath string, verbose bool, ...) ([]schema.Affected, error)
- func ExecuteDescribeComponent(component string, stack string) (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 ExecuteHelmfile(info schema.ConfigAndStacksInfo) error
- func ExecuteHelmfileCmd(cmd *cobra.Command, args []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 ExecuteStackVendorCommandInternal(stack string, dryRun bool, vendorCommand string) error
- func ExecuteTerraform(info schema.ConfigAndStacksInfo) error
- func ExecuteTerraformCmd(cmd *cobra.Command, args []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) error
- func ExecuteValidateStacksCmd(cmd *cobra.Command, args []string) error
- func ExecuteVendorCommand(cmd *cobra.Command, args []string, vendorCommand string) error
- func ExecuteVendorDiffCmd(cmd *cobra.Command, args []string) error
- func ExecuteVendorPullCmd(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 FindComponentConfig(configAndStacksInfo *schema.ConfigAndStacksInfo, stack string, ...) error
- func FindComponentDependencies(currentStack string, sources schema.ConfigSources) ([]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 ProcessComponentMetadata(component string, componentSection map[string]any) (map[any]any, string, bool)
- func ProcessConfigSources(configAndStacksInfo schema.ConfigAndStacksInfo, ...) (schema.ConfigSources, error)
- func ProcessStacks(cliConfig schema.CliConfiguration, ...) (schema.ConfigAndStacksInfo, error)
- func ReadAndProcessComponentConfigFile(cliConfig schema.CliConfiguration, component string, componentType string) (schema.VendorComponentConfig, string, error)
- func ValidateComponent(cliConfig schema.CliConfiguration, componentName string, componentSection any, ...) (bool, 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)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildAtlantisProjectName ¶ added in v1.30.0
BuildAtlantisProjectName builds an Atlantis project name from the provided context and project name pattern
func BuildAtlantisProjectNameFromComponentConfig ¶ added in v1.31.0
func BuildAtlantisProjectNameFromComponentConfig( cliConfig schema.CliConfiguration, componentName string, componentSettingsSection map[any]any, componentVarsSection map[any]any, ) (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( dependsOn string, allStackNames []string, currentStackName string, componentNamesInCurrentStack []string, currentComponentName string, ) (string, error)
BuildDependentStackNameFromDependsOn builds the dependent stack name from "depends_on" attribute
func BuildSpaceliftStackName ¶ added in v1.24.0
func BuildSpaceliftStackName(spaceliftSettings map[any]any, context schema.Context, contextPrefix string) (string, string)
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, componentName string, stackName string, componentSettingsSection map[any]any, componentVarsSection map[any]any, ) (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( stack string, stackNamePattern string, componentMetadata map[any]any, context schema.Context, ) (string, error)
BuildTerraformWorkspace builds Terraform workspace
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, ) 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 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 ExecuteComponentVendorCommandInternal ¶ added in v1.4.12
func ExecuteComponentVendorCommandInternal( cliConfig schema.CliConfiguration, vendorComponentSpec schema.VendorComponentSpec, component string, componentPath string, dryRun bool, vendorCommand string, ) error
ExecuteComponentVendorCommandInternal executes a component vendor command 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
func ExecuteDescribeAffectedCmd ¶ added in v1.17.0
ExecuteDescribeAffectedCmd executes `describe affected` command
func ExecuteDescribeAffectedWithTargetRepoClone ¶ added in v1.26.0
func ExecuteDescribeAffectedWithTargetRepoClone( cliConfig schema.CliConfiguration, ref string, sha string, sshKeyPath string, sshKeyPassword string, verbose bool, includeSpaceliftAdminStacks bool, ) ([]schema.Affected, error)
ExecuteDescribeAffectedWithTargetRepoClone clones the remote repo using `ref` or `sha`, 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, repoPath string, verbose bool, includeSpaceliftAdminStacks bool, ) ([]schema.Affected, error)
ExecuteDescribeAffectedWithTargetRepoPath uses `repo-path` to access the target repo, processes stack configs and returns a list of the affected Atmos components and stacks given two Git commits
func ExecuteDescribeComponent ¶
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, ) ([]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, ) (map[string]any, error)
ExecuteDescribeStacks processes stack configs and returns the final map of stacks and components
func ExecuteDescribeStacksCmd ¶ added in v1.11.0
ExecuteDescribeStacksCmd executes `describe stacks` 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 ExecuteStackVendorCommandInternal ¶ added in v1.4.12
ExecuteStackVendorCommandInternal executes a stack vendor command 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 ExecuteVendorCommand ¶ added in v1.4.12
ExecuteVendorCommand executes `atmos vendor` commands
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 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 a workflow
func FindComponentConfig ¶ added in v1.3.28
func FindComponentConfig( configAndStacksInfo *schema.ConfigAndStacksInfo, stack string, stacksMap map[string]any, componentType string, component string, ) error
FindComponentConfig finds component config sections
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 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 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 ProcessStacks ¶ added in v1.3.28
func ProcessStacks( cliConfig schema.CliConfiguration, configAndStacksInfo schema.ConfigAndStacksInfo, checkStack bool, ) (schema.ConfigAndStacksInfo, error)
ProcessStacks processes stack config
func ReadAndProcessComponentConfigFile ¶ added in v1.4.12
func ReadAndProcessComponentConfigFile(cliConfig schema.CliConfiguration, component string, componentType string) (schema.VendorComponentConfig, string, error)
ReadAndProcessComponentConfigFile reads and processes `component.yaml` vendor config file
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 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 ¶
This section is empty.
Source Files ¶
- atlantis_generate_repo_config.go
- atlantis_utils.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
- helmfile.go
- helmfile_generate_varfile.go
- help.go
- path_utils.go
- shell_utils.go
- spacelift_utils.go
- stack_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_utils.go
- worflow.go
- worflow_utils.go