exec

package
v1.32.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 25, 2023 License: Apache-2.0 Imports: 36 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildAtlantisProjectName added in v1.30.0

func BuildAtlantisProjectName(context cfg.Context, projectNameTemplate string) string

BuildAtlantisProjectName builds an Atlantis project name from the provided context and project name pattern

func BuildAtlantisProjectNameFromComponentConfig added in v1.31.0

func BuildAtlantisProjectNameFromComponentConfig(
	cliConfig cfg.CliConfiguration,
	componentName string,
	componentSettingsSection map[any]any,
	componentVarsSection map[any]any,
) (string, error)

BuildAtlantisProjectNameFromComponentConfig builds an Atlantis project name from from the component config

func BuildComponentPath added in v1.31.0

func BuildComponentPath(
	cliConfig cfg.CliConfiguration,
	componentSectionMap map[string]any,
	componentType string,
) string

BuildComponentPath builds component path (path to the component's physical location on disk)

func BuildDependantStackNameFromDependsOn added in v1.31.0

func BuildDependantStackNameFromDependsOn(
	dependsOn string,
	allStackNames []string,
	currentStackName string,
	componentNamesInCurrentStack []string,
	currentComponentName string,
) (string, error)

BuildDependantStackNameFromDependsOn builds the dependant stack name from "depends_on" attribute

func BuildSpaceliftStackName added in v1.24.0

func BuildSpaceliftStackName(spaceliftSettings map[any]any, context cfg.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 cfg.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

func BuildSpaceliftStackNames(stacks map[string]any, stackNamePattern string) ([]string, error)

BuildSpaceliftStackNames builds Spacelift stack names

func BuildTerraformWorkspace added in v1.4.8

func BuildTerraformWorkspace(
	stack string,
	stackNamePattern string,
	componentMetadata map[any]any,
	context cfg.Context,
) (string, error)

BuildTerraformWorkspace builds Terraform workspace

func ExecuteAtlantisGenerateRepoConfig added in v1.5.0

func ExecuteAtlantisGenerateRepoConfig(
	cliConfig cfg.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 cfg.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

func ExecuteAtlantisGenerateRepoConfigCmd(cmd *cobra.Command, args []string) error

ExecuteAtlantisGenerateRepoConfigCmd executes 'atlantis generate repo-config' command

func ExecuteAwsEksUpdateKubeconfig added in v1.4.9

func ExecuteAwsEksUpdateKubeconfig(kubeconfigContext cfg.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 ExecuteAwsEksUpdateKubeconfigCommand(cmd *cobra.Command, args []string) error

func ExecuteComponentVendorCommandInternal added in v1.4.12

func ExecuteComponentVendorCommandInternal(
	vendorComponentSpec cfg.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

func ExecuteDescribeAffectedCmd(cmd *cobra.Command, args []string) error

ExecuteDescribeAffectedCmd executes `describe affected` command

func ExecuteDescribeAffectedWithTargetRepoClone added in v1.26.0

func ExecuteDescribeAffectedWithTargetRepoClone(
	cliConfig cfg.CliConfiguration,
	ref string,
	sha string,
	sshKeyPath string,
	sshKeyPassword string,
	verbose bool,
) ([]cfg.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 cfg.CliConfiguration,
	repoPath string,
	verbose bool,
) ([]cfg.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

func ExecuteDescribeComponent(component string, stack string) (map[string]any, error)

ExecuteDescribeComponent describes component config

func ExecuteDescribeComponentCmd added in v1.11.0

func ExecuteDescribeComponentCmd(cmd *cobra.Command, args []string) error

ExecuteDescribeComponentCmd executes `describe component` command

func ExecuteDescribeConfigCmd added in v1.11.0

func ExecuteDescribeConfigCmd(cmd *cobra.Command, args []string) error

ExecuteDescribeConfigCmd executes `describe config` command

func ExecuteDescribeDependants added in v1.31.0

func ExecuteDescribeDependants(
	cliConfig cfg.CliConfiguration,
	component string,
	stack string,
) ([]cfg.Dependant, error)

ExecuteDescribeDependants produces a list of Atmos components in Atmos stacks that depend on the provided Atmos component

func ExecuteDescribeDependantsCmd added in v1.31.0

func ExecuteDescribeDependantsCmd(cmd *cobra.Command, args []string) error

ExecuteDescribeDependantsCmd executes `describe dependants` command

func ExecuteDescribeStacks added in v1.4.4

func ExecuteDescribeStacks(
	cliConfig cfg.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

func ExecuteDescribeStacksCmd(cmd *cobra.Command, args []string) error

ExecuteDescribeStacksCmd executes `describe stacks` command

func ExecuteHelmfile

func ExecuteHelmfile(info cfg.ConfigAndStacksInfo) error

ExecuteHelmfile executes helmfile commands

func ExecuteHelmfileCmd added in v1.11.0

func ExecuteHelmfileCmd(cmd *cobra.Command, args []string) error

ExecuteHelmfileCmd parses the provided arguments and flags and executes helmfile commands

func ExecuteHelmfileGenerateVarfileCmd added in v1.11.0

func ExecuteHelmfileGenerateVarfileCmd(cmd *cobra.Command, args []string) error

ExecuteHelmfileGenerateVarfileCmd executes `helmfile generate varfile` command

func ExecuteShell added in v1.16.0

func ExecuteShell(command string, name string, dir string, env []string, dryRun bool, verbose bool) error

ExecuteShell runs a shell script

func ExecuteShellAndReturnOutput added in v1.16.0

func ExecuteShellAndReturnOutput(command string, name string, dir string, env []string, dryRun bool, verbose bool) (string, error)

ExecuteShellAndReturnOutput runs a shell script and capture its standard output

func ExecuteShellCommand added in v1.4.9

func ExecuteShellCommand(
	command string,
	args []string,
	dir string,
	env []string,
	dryRun bool,
	verbose bool,
	redirectStdError string,
) error

ExecuteShellCommand prints and executes the provided command with args and flags

func ExecuteShellCommandAndReturnOutput added in v1.4.22

func ExecuteShellCommandAndReturnOutput(
	command string,
	args []string,
	dir string,
	env []string,
	dryRun bool,
	verbose bool,
	redirectStdError string,
) (string, error)

ExecuteShellCommandAndReturnOutput prints and executes the provided command with args and flags and returns the command output

func ExecuteShellCommands added in v1.4.22

func ExecuteShellCommands(
	commands []string,
	dir string,
	env []string,
	dryRun bool,
	verbose bool,
	redirectStdError string,
) error

ExecuteShellCommands sequentially executes the provided list of commands

func ExecuteStackVendorCommandInternal added in v1.4.12

func ExecuteStackVendorCommandInternal(
	stack string,
	dryRun bool,
	vendorCommand string,
) error

ExecuteStackVendorCommandInternal executes a stack vendor command TODO: implement this

func ExecuteTerraform

func ExecuteTerraform(info cfg.ConfigAndStacksInfo) error

ExecuteTerraform executes terraform commands

func ExecuteTerraformCmd added in v1.11.0

func ExecuteTerraformCmd(cmd *cobra.Command, args []string) error

ExecuteTerraformCmd parses the provided arguments and flags and executes terraform commands

func ExecuteTerraformGenerateBackendCmd added in v1.11.0

func ExecuteTerraformGenerateBackendCmd(cmd *cobra.Command, args []string) error

ExecuteTerraformGenerateBackendCmd executes `terraform generate backend` command

func ExecuteTerraformGenerateBackends

func ExecuteTerraformGenerateBackends(cliConfig cfg.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

func ExecuteTerraformGenerateBackendsCmd(cmd *cobra.Command, args []string) error

ExecuteTerraformGenerateBackendsCmd executes `terraform generate backends` command

func ExecuteTerraformGenerateVarfileCmd added in v1.11.0

func ExecuteTerraformGenerateVarfileCmd(cmd *cobra.Command, args []string) error

ExecuteTerraformGenerateVarfileCmd executes `terraform generate varfile` command

func ExecuteTerraformGenerateVarfiles added in v1.5.0

func ExecuteTerraformGenerateVarfiles(cliConfig cfg.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

func ExecuteTerraformGenerateVarfilesCmd(cmd *cobra.Command, args []string) error

ExecuteTerraformGenerateVarfilesCmd executes `terraform generate varfiles` command

func ExecuteValidateComponent added in v1.9.0

func ExecuteValidateComponent(cliConfig cfg.CliConfiguration, configAndStacksInfo cfg.ConfigAndStacksInfo, componentName string, stack string, schemaPath string, schemaType string) (bool, error)

ExecuteValidateComponent validates a component in a stack using JsonSchema, OPA or CUE schema documents

func ExecuteValidateComponentCmd added in v1.9.0

func ExecuteValidateComponentCmd(cmd *cobra.Command, args []string) error

ExecuteValidateComponentCmd executes `validate component` command

func ExecuteValidateStacksCmd added in v1.11.0

func ExecuteValidateStacksCmd(cmd *cobra.Command, args []string) error

ExecuteValidateStacksCmd executes `validate stacks` command

func ExecuteVendorCommand added in v1.4.12

func ExecuteVendorCommand(cmd *cobra.Command, args []string, vendorCommand string) error

ExecuteVendorCommand executes `atmos vendor` commands

func ExecuteVendorDiffCmd added in v1.11.0

func ExecuteVendorDiffCmd(cmd *cobra.Command, args []string) error

ExecuteVendorDiffCmd executes `vendor diff` commands

func ExecuteVendorPullCmd added in v1.11.0

func ExecuteVendorPullCmd(cmd *cobra.Command, args []string) error

ExecuteVendorPullCmd executes `vendor pull` commands

func ExecuteWorkflow added in v1.4.0

func ExecuteWorkflow(
	workflow string,
	workflowPath string,
	workflowDefinition *cfg.WorkflowDefinition,
	dryRun bool,
	commandLineStack string,
	fromStep string,
) error

ExecuteWorkflow executes an Atmos workflow

func ExecuteWorkflowCmd added in v1.11.0

func ExecuteWorkflowCmd(cmd *cobra.Command, args []string) error

ExecuteWorkflowCmd executes a workflow

func FindComponentConfig added in v1.3.28

func FindComponentConfig(
	stack string,
	stacksMap map[string]any,
	componentType string,
	component string,
) (map[string]any,
	map[any]any,
	map[any]any,
	map[any]any,
	string,
	string,
	string,
	[]string,
	bool,
	map[any]any,
	error,
)

FindComponentConfig finds component config sections

func FindStacksMap added in v1.4.4

func FindStacksMap(cliConfig cfg.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) (cfg.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 ProcessStacks added in v1.3.28

func ProcessStacks(
	cliConfig cfg.CliConfiguration,
	configAndStacksInfo cfg.ConfigAndStacksInfo,
	checkStack bool,
) (
	cfg.ConfigAndStacksInfo,
	error,
)

ProcessStacks processes stack config

func ReadAndProcessComponentConfigFile added in v1.4.12

func ReadAndProcessComponentConfigFile(cliConfig cfg.CliConfiguration, component string, componentType string) (cfg.VendorComponentConfig, string, error)

ReadAndProcessComponentConfigFile reads and processes `component.yaml` vendor config file

func ValidateComponent added in v1.9.0

func ValidateComponent(cliConfig cfg.CliConfiguration, componentName string, componentSection any, schemaPath string, schemaType string) (bool, error)

ValidateComponent validates the component config using JsonSchema, OPA or CUE schema documents

func ValidateWithCue added in v1.9.0

func ValidateWithCue(data any, schemaName string, schemaText string) (bool, error)

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

func ValidateWithJsonSchema(data any, schemaName string, schemaText string) (bool, error)

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, schemaName string, schemaText string) (bool, error)

ValidateWithOpa validates the data structure using the provided OPA document https://www.openpolicyagent.org/docs/latest/integration/#sdk

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL