Documentation
¶
Index ¶
- type Affected
- type ArgsAndFlagsInfo
- type Atlantis
- type AtlantisConfigOutput
- type AtlantisProjectAutoplanConfig
- type AtlantisProjectConfig
- type AtlantisRepoConfig
- type AtmosConfiguration
- type AtmosSectionMapType
- type AtmosSettings
- type AtmosVendorConfig
- type AtmosVendorMetadata
- type AtmosVendorSource
- type AtmosVendorSpec
- type AwsEksUpdateKubeconfigContext
- type BaseComponentConfig
- type ChromaStyle
- type Command
- type CommandAliases
- type CommandArgument
- type CommandComponentConfig
- type CommandEnv
- type CommandFlag
- type Components
- type ConfigAndStacksInfo
- type ConfigSources
- type ConfigSourcesItem
- type ConfigSourcesStackDependencies
- type ConfigSourcesStackDependency
- type Context
- type Dependent
- type DependsOn
- type DescribeWorkflowsItem
- type Docs
- type DocsGenerate
- type EditorConfig
- type Helmfile
- type Integrations
- type ListColumnConfig
- type ListConfig
- type Logs
- type MarkdownSettings
- type MarkdownStyle
- type ResourcePath
- type SchemaRegistry
- type Settings
- type SettingsSpacelift
- type ShellConfig
- type StackImport
- type Stacks
- type SyntaxHighlighting
- type Templates
- type TemplatesSettings
- type TemplatesSettingsGomplate
- type TemplatesSettingsGomplateDatasource
- type TemplatesSettingsSprig
- type Terminal
- type Terraform
- type TerraformDocsReadmeSettings
- type TerraformInit
- type Validate
- type Validation
- type ValidationItem
- type Vendor
- type VendorComponentConfig
- type VendorComponentMetadata
- type VendorComponentMixins
- type VendorComponentSource
- type VendorComponentSpec
- type Version
- type VersionCheck
- type WorkflowConfig
- type WorkflowDefinition
- type WorkflowManifest
- type WorkflowStep
- type Workflows
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Affected ¶
type Affected struct {
Component string `yaml:"component" json:"component" mapstructure:"component"`
ComponentType string `yaml:"component_type" json:"component_type" mapstructure:"component_type"`
ComponentPath string `yaml:"component_path" json:"component_path" mapstructure:"component_path"`
Namespace string `yaml:"namespace,omitempty" json:"namespace,omitempty" mapstructure:"namespace"`
Tenant string `yaml:"tenant,omitempty" json:"tenant,omitempty" mapstructure:"tenant"`
Environment string `yaml:"environment,omitempty" json:"environment,omitempty" mapstructure:"environment"`
Stage string `yaml:"stage,omitempty" json:"stage,omitempty" mapstructure:"stage"`
Stack string `yaml:"stack" json:"stack" mapstructure:"stack"`
StackSlug string `yaml:"stack_slug" json:"stack_slug" mapstructure:"stack_slug"`
SpaceliftStack string `yaml:"spacelift_stack,omitempty" json:"spacelift_stack,omitempty" mapstructure:"spacelift_stack"`
AtlantisProject string `yaml:"atlantis_project,omitempty" json:"atlantis_project,omitempty" mapstructure:"atlantis_project"`
Affected string `yaml:"affected" json:"affected" mapstructure:"affected"`
File string `yaml:"file,omitempty" json:"file,omitempty" mapstructure:"file"`
Folder string `yaml:"folder,omitempty" json:"folder,omitempty" mapstructure:"folder"`
Dependents []Dependent `yaml:"dependents" json:"dependents" mapstructure:"dependents"`
IncludedInDependents bool `yaml:"included_in_dependents" json:"included_in_dependents" mapstructure:"included_in_dependents"`
Settings AtmosSectionMapType `yaml:"settings" json:"settings" mapstructure:"settings"`
}
type ArgsAndFlagsInfo ¶
type ArgsAndFlagsInfo struct {
AdditionalArgsAndFlags []string
SubCommand string
SubCommand2 string
ComponentFromArg string
GlobalOptions []string
TerraformCommand string
TerraformDir string
HelmfileCommand string
HelmfileDir string
ConfigDir string
StacksDir string
WorkflowsDir string
BasePath string
VendorBasePath string
DeployRunInit string
InitRunReconfigure string
InitPassVars string
AutoGenerateBackendFile string
AppendUserAgent string
UseTerraformPlan bool
PlanFile string
DryRun bool
SkipInit bool
NeedHelp bool
JsonSchemaDir string
OpaDir string
CueDir string
AtmosManifestJsonSchema string
RedirectStdErr string
LogsLevel string
LogsFile string
SettingsListMergeStrategy string
Query string
}
type Atlantis ¶
type Atlantis struct {
Path string `yaml:"path,omitempty" json:"path,omitempty" mapstructure:"path"`
ConfigTemplates map[string]AtlantisRepoConfig `yaml:"config_templates,omitempty" json:"config_templates,omitempty" mapstructure:"config_templates"`
ProjectTemplates map[string]AtlantisProjectConfig `yaml:"project_templates,omitempty" json:"project_templates,omitempty" mapstructure:"project_templates"`
WorkflowTemplates AtmosSectionMapType `yaml:"workflow_templates,omitempty" json:"workflow_templates,omitempty" mapstructure:"workflow_templates"`
}
type AtlantisConfigOutput ¶
type AtlantisConfigOutput struct {
Version int `yaml:"version" json:"version" mapstructure:"version"`
Automerge bool `yaml:"automerge" json:"automerge" mapstructure:"automerge"`
DeleteSourceBranchOnMerge bool `yaml:"delete_source_branch_on_merge" json:"delete_source_branch_on_merge" mapstructure:"delete_source_branch_on_merge"`
ParallelPlan bool `yaml:"parallel_plan" json:"parallel_plan" mapstructure:"parallel_plan"`
ParallelApply bool `yaml:"parallel_apply" json:"parallel_apply" mapstructure:"parallel_apply"`
AllowedRegexpPrefixes []string `yaml:"allowed_regexp_prefixes" json:"allowed_regexp_prefixes" mapstructure:"allowed_regexp_prefixes"`
Projects []AtlantisProjectConfig `yaml:"projects" json:"projects" mapstructure:"projects"`
Workflows AtmosSectionMapType `yaml:"workflows,omitempty" json:"workflows,omitempty" mapstructure:"workflows"`
}
type AtlantisProjectConfig ¶
type AtlantisProjectConfig struct {
Name string `yaml:"name" json:"name" mapstructure:"name"`
Workspace string `yaml:"workspace" json:"workspace" mapstructure:"workspace"`
Workflow string `yaml:"workflow,omitempty" json:"workflow,omitempty" mapstructure:"workflow"`
Dir string `yaml:"dir" json:"dir" mapstructure:"dir"`
TerraformVersion string `yaml:"terraform_version" json:"terraform_version" mapstructure:"terraform_version"`
DeleteSourceBranchOnMerge bool `yaml:"delete_source_branch_on_merge" json:"delete_source_branch_on_merge" mapstructure:"delete_source_branch_on_merge"`
Autoplan AtlantisProjectAutoplanConfig `yaml:"autoplan" json:"autoplan" mapstructure:"autoplan"`
ApplyRequirements []string `yaml:"apply_requirements" json:"apply_requirements" mapstructure:"apply_requirements"`
}
type AtlantisRepoConfig ¶
type AtlantisRepoConfig struct {
Version int `yaml:"version" json:"version" mapstructure:"version"`
Automerge bool `yaml:"automerge" json:"automerge" mapstructure:"automerge"`
DeleteSourceBranchOnMerge bool `yaml:"delete_source_branch_on_merge" json:"delete_source_branch_on_merge" mapstructure:"delete_source_branch_on_merge"`
ParallelPlan bool `yaml:"parallel_plan" json:"parallel_plan" mapstructure:"parallel_plan"`
ParallelApply bool `yaml:"parallel_apply" json:"parallel_apply" mapstructure:"parallel_apply"`
AllowedRegexpPrefixes []string `yaml:"allowed_regexp_prefixes" json:"allowed_regexp_prefixes" mapstructure:"allowed_regexp_prefixes"`
}
type AtmosConfiguration ¶ added in v1.131.0
type AtmosConfiguration struct {
BasePath string `yaml:"base_path" json:"base_path" mapstructure:"base_path"`
Components Components `yaml:"components" json:"components" mapstructure:"components"`
Stacks Stacks `yaml:"stacks" json:"stacks" mapstructure:"stacks"`
Workflows Workflows `yaml:"workflows,omitempty" json:"workflows,omitempty" mapstructure:"workflows"`
Logs Logs `yaml:"logs,omitempty" json:"logs,omitempty" mapstructure:"logs"`
Commands []Command `yaml:"commands,omitempty" json:"commands,omitempty" mapstructure:"commands"`
CommandAliases CommandAliases `yaml:"aliases,omitempty" json:"aliases,omitempty" mapstructure:"aliases"`
Integrations Integrations `yaml:"integrations,omitempty" json:"integrations,omitempty" mapstructure:"integrations"`
Schemas map[string]interface{} `yaml:"schemas,omitempty" json:"schemas,omitempty" mapstructure:"schemas"`
Templates Templates `yaml:"templates,omitempty" json:"templates,omitempty" mapstructure:"templates"`
Settings AtmosSettings `yaml:"settings,omitempty" json:"settings,omitempty" mapstructure:"settings"`
StoresConfig store.StoresConfig `yaml:"stores,omitempty" json:"stores,omitempty" mapstructure:"stores"`
Vendor Vendor `yaml:"vendor,omitempty" json:"vendor,omitempty" mapstructure:"vendor"`
Initialized bool `yaml:"initialized" json:"initialized" mapstructure:"initialized"`
StacksBaseAbsolutePath string `yaml:"stacksBaseAbsolutePath,omitempty" json:"stacksBaseAbsolutePath,omitempty" mapstructure:"stacksBaseAbsolutePath"`
IncludeStackAbsolutePaths []string `` /* 126-byte string literal not displayed */
ExcludeStackAbsolutePaths []string `` /* 126-byte string literal not displayed */
TerraformDirAbsolutePath string `yaml:"terraformDirAbsolutePath,omitempty" json:"terraformDirAbsolutePath,omitempty" mapstructure:"terraformDirAbsolutePath"`
HelmfileDirAbsolutePath string `yaml:"helmfileDirAbsolutePath,omitempty" json:"helmfileDirAbsolutePath,omitempty" mapstructure:"helmfileDirAbsolutePath"`
StackConfigFilesRelativePaths []string `` /* 138-byte string literal not displayed */
StackConfigFilesAbsolutePaths []string `` /* 138-byte string literal not displayed */
StackType string `yaml:"stackType,omitempty" json:"StackType,omitempty" mapstructure:"stackType"`
Default bool `yaml:"default" json:"default" mapstructure:"default"`
Version Version `yaml:"version,omitempty" json:"version,omitempty" mapstructure:"version"`
Validate Validate `yaml:"validate,omitempty" json:"validate,omitempty" mapstructure:"validate"`
// Stores is never read from yaml, it is populated in processStoreConfig and it's used to pass to the populated store
// registry through to the yaml parsing functions when !store is run and to pass the registry to the hooks
// functions to be able to call stores from within hooks.
Stores store.StoreRegistry `yaml:"stores_registry,omitempty" json:"stores_registry,omitempty" mapstructure:"stores_registry"`
CliConfigPath string `yaml:"cli_config_path" json:"cli_config_path,omitempty" mapstructure:"cli_config_path"`
Import []string `yaml:"import" json:"import" mapstructure:"import"`
Docs Docs `yaml:"docs,omitempty" json:"docs,omitempty" mapstructure:"docs"`
}
AtmosConfiguration structure represents schema for `atmos.yaml` CLI config.
func (*AtmosConfiguration) GetResourcePath ¶ added in v1.166.0
func (m *AtmosConfiguration) GetResourcePath(key string) ResourcePath
func (*AtmosConfiguration) GetSchemaRegistry ¶ added in v1.166.0
func (m *AtmosConfiguration) GetSchemaRegistry(key string) SchemaRegistry
func (*AtmosConfiguration) ProcessSchemas ¶ added in v1.166.0
func (a *AtmosConfiguration) ProcessSchemas()
func (*AtmosConfiguration) UnmarshalYAML ¶ added in v1.166.0
func (m *AtmosConfiguration) UnmarshalYAML(value *yaml.Node) error
Custom YAML unmarshaler for `Schemas`.
type AtmosSectionMapType ¶ added in v1.88.0
type AtmosSettings ¶ added in v1.131.0
type AtmosSettings struct {
ListMergeStrategy string `yaml:"list_merge_strategy" json:"list_merge_strategy" mapstructure:"list_merge_strategy"`
Terminal Terminal `yaml:"terminal,omitempty" json:"terminal,omitempty" mapstructure:"terminal"`
// Deprecated: this was moved to top-level Atmos config
Docs Docs `yaml:"docs,omitempty" json:"docs,omitempty" mapstructure:"docs"`
Markdown MarkdownSettings `yaml:"markdown,omitempty" json:"markdown,omitempty" mapstructure:"markdown"`
InjectGithubToken bool `yaml:"inject_github_token,omitempty" mapstructure:"inject_github_token"`
GithubToken string `yaml:"github_token,omitempty" mapstructure:"github_token"`
AtmosGithubToken string `yaml:"atmos_github_token,omitempty" mapstructure:"atmos_github_token"`
InjectBitbucketToken bool `yaml:"inject_bitbucket_token,omitempty" mapstructure:"inject_bitbucket_token"`
BitbucketToken string `yaml:"bitbucket_token,omitempty" mapstructure:"bitbucket_token"`
AtmosBitbucketToken string `yaml:"atmos_bitbucket_token,omitempty" mapstructure:"atmos_bitbucket_token"`
BitbucketUsername string `yaml:"bitbucket_username,omitempty" mapstructure:"bitbucket_username"`
InjectGitlabToken bool `yaml:"inject_gitlab_token,omitempty" mapstructure:"inject_gitlab_token"`
AtmosGitlabToken string `yaml:"atmos_gitlab_token,omitempty" mapstructure:"atmos_gitlab_token"`
GitlabToken string `yaml:"gitlab_token,omitempty" mapstructure:"gitlab_token"`
}
type AtmosVendorConfig ¶ added in v1.47.0
type AtmosVendorConfig struct {
ApiVersion string `yaml:"apiVersion" json:"apiVersion" mapstructure:"apiVersion"`
Kind string `yaml:"kind" json:"kind" mapstructure:"kind"`
Metadata AtmosVendorMetadata
Spec AtmosVendorSpec `yaml:"spec" json:"spec" mapstructure:"spec"`
}
type AtmosVendorMetadata ¶ added in v1.47.0
type AtmosVendorSource ¶ added in v1.47.0
type AtmosVendorSource struct {
Component string `yaml:"component" json:"component" mapstructure:"component"`
Source string `yaml:"source" json:"source" mapstructure:"source"`
Version string `yaml:"version" json:"version" mapstructure:"version"`
File string `yaml:"file" json:"file" mapstructure:"file"`
Targets []string `yaml:"targets" json:"targets" mapstructure:"targets"`
IncludedPaths []string `yaml:"included_paths,omitempty" json:"included_paths,omitempty" mapstructure:"included_paths"`
ExcludedPaths []string `yaml:"excluded_paths,omitempty" json:"excluded_paths,omitempty" mapstructure:"excluded_paths"`
Tags []string `yaml:"tags" json:"tags" mapstructure:"tags"`
}
type AtmosVendorSpec ¶ added in v1.47.0
type AtmosVendorSpec struct {
Imports []string `yaml:"imports,omitempty" json:"imports,omitempty" mapstructure:"imports"`
Sources []AtmosVendorSource `yaml:"sources" json:"sources" mapstructure:"sources"`
}
type BaseComponentConfig ¶
type BaseComponentConfig struct {
BaseComponentVars AtmosSectionMapType
BaseComponentSettings AtmosSectionMapType
BaseComponentEnv AtmosSectionMapType
BaseComponentProviders AtmosSectionMapType
BaseComponentHooks AtmosSectionMapType
FinalBaseComponentName string
BaseComponentCommand string
BaseComponentBackendType string
BaseComponentBackendSection AtmosSectionMapType
BaseComponentRemoteStateBackendType string
BaseComponentRemoteStateBackendSection AtmosSectionMapType
ComponentInheritanceChain []string
}
type ChromaStyle ¶ added in v1.135.0
type ChromaStyle struct {
Color string `yaml:"color,omitempty" json:"color,omitempty" mapstructure:"color"`
}
type Command ¶
type Command struct {
Name string `yaml:"name" json:"name" mapstructure:"name"`
Description string `yaml:"description" json:"description" mapstructure:"description"`
Env []CommandEnv `yaml:"env" json:"env" mapstructure:"env"`
Arguments []CommandArgument `yaml:"arguments" json:"arguments" mapstructure:"arguments"`
Flags []CommandFlag `yaml:"flags" json:"flags" mapstructure:"flags"`
ComponentConfig CommandComponentConfig `yaml:"component_config" json:"component_config" mapstructure:"component_config"`
Steps []string `yaml:"steps" json:"steps" mapstructure:"steps"`
Commands []Command `yaml:"commands" json:"commands" mapstructure:"commands"`
Verbose bool `yaml:"verbose" json:"verbose" mapstructure:"verbose"`
}
type CommandAliases ¶ added in v1.64.2
type CommandArgument ¶
type CommandArgument struct {
Name string `yaml:"name" json:"name" mapstructure:"name"`
Description string `yaml:"description" json:"description" mapstructure:"description"`
Required bool `yaml:"required" json:"required" mapstructure:"required"`
Default string `yaml:"default" json:"default" mapstructure:"default"`
}
type CommandComponentConfig ¶
type CommandEnv ¶
type CommandFlag ¶
type CommandFlag struct {
Name string `yaml:"name" json:"name" mapstructure:"name"`
Shorthand string `yaml:"shorthand" json:"shorthand" mapstructure:"shorthand"`
Type string `yaml:"type" json:"type" mapstructure:"type"`
Description string `yaml:"description" json:"description" mapstructure:"description"`
Usage string `yaml:"usage" json:"usage" mapstructure:"usage"`
Required bool `yaml:"required" json:"required" mapstructure:"required"`
}
type Components ¶
type ConfigAndStacksInfo ¶
type ConfigAndStacksInfo struct {
StackFromArg string
Stack string
StackFile string
ComponentType string
ComponentFromArg string
Component string
ComponentFolderPrefix string
ComponentFolderPrefixReplaced string
BaseComponentPath string
BaseComponent string
FinalComponent string
Command string
SubCommand string
SubCommand2 string
ComponentSection AtmosSectionMapType
ComponentVarsSection AtmosSectionMapType
ComponentSettingsSection AtmosSectionMapType
ComponentOverridesSection AtmosSectionMapType
ComponentProvidersSection AtmosSectionMapType
ComponentHooksSection AtmosSectionMapType
ComponentEnvSection AtmosSectionMapType
ComponentEnvList []string
ComponentBackendSection AtmosSectionMapType
ComponentBackendType string
AdditionalArgsAndFlags []string
GlobalOptions []string
BasePath string
VendorBasePathFlag string
TerraformCommand string
TerraformDir string
HelmfileCommand string
HelmfileDir string
ConfigDir string
StacksDir string
WorkflowsDir string
Context Context
ContextPrefix string
DeployRunInit string
InitRunReconfigure string
InitPassVars string
AutoGenerateBackendFile string
UseTerraformPlan bool
PlanFile string
DryRun bool
SkipInit bool
ComponentInheritanceChain []string
ComponentImportsSection []string
NeedHelp bool
ComponentIsAbstract bool
ComponentIsEnabled bool
ComponentIsLocked bool
ComponentMetadataSection AtmosSectionMapType
TerraformWorkspace string
JsonSchemaDir string
OpaDir string
CueDir string
AtmosManifestJsonSchema string
AtmosCliConfigPath string
AtmosBasePath string
RedirectStdErr string
LogsLevel string
LogsFile string
SettingsListMergeStrategy string
Query string
AtmosConfigFilesFromArg []string
AtmosConfigDirsFromArg []string
ProcessTemplates bool
ProcessFunctions bool
Skip []string
}
type ConfigSources ¶ added in v1.42.0
type ConfigSources map[string]map[string]ConfigSourcesItem
type ConfigSourcesItem ¶ added in v1.42.0
type ConfigSourcesItem struct {
FinalValue any `yaml:"final_value" json:"final_value" mapstructure:"final_value"`
Name string `yaml:"name" json:"name" mapstructure:"name"`
StackDependencies ConfigSourcesStackDependencies `yaml:"stack_dependencies" json:"stack_dependencies" mapstructure:"stack_dependencies"`
}
type ConfigSourcesStackDependencies ¶ added in v1.42.0
type ConfigSourcesStackDependencies []ConfigSourcesStackDependency
type ConfigSourcesStackDependency ¶ added in v1.42.0
type ConfigSourcesStackDependency struct {
StackFile string `yaml:"stack_file" json:"stack_file" mapstructure:"stack_file"`
StackFileSection string `yaml:"stack_file_section" json:"stack_file_section" mapstructure:"stack_file_section"`
DependencyType string `yaml:"dependency_type" json:"dependency_type" mapstructure:"dependency_type"`
VariableValue any `yaml:"variable_value" json:"variable_value" mapstructure:"variable_value"`
}
ConfigSourcesStackDependency defines schema for sources of config sections
type Context ¶
type Context struct {
Namespace string `yaml:"namespace" json:"namespace" mapstructure:"namespace"`
Tenant string `yaml:"tenant" json:"tenant" mapstructure:"tenant"`
Environment string `yaml:"environment" json:"environment" mapstructure:"environment"`
Stage string `yaml:"stage" json:"stage" mapstructure:"stage"`
Region string `yaml:"region" json:"region" mapstructure:"region"`
Component string `yaml:"component" json:"component" mapstructure:"component"`
BaseComponent string `yaml:"base_component" json:"base_component" mapstructure:"base_component"`
ComponentPath string `yaml:"component_path" json:"component_path" mapstructure:"component_path"`
Workspace string `yaml:"workspace" json:"workspace" mapstructure:"workspace"`
Attributes []any `yaml:"attributes" json:"attributes" mapstructure:"attributes"`
File string `yaml:"file" json:"file" mapstructure:"file"`
Folder string `yaml:"folder" json:"folder" mapstructure:"folder"`
TerraformWorkspace string `yaml:"terraform_workspace" json:"terraform_workspace" mapstructure:"terraform_workspace"`
}
type Dependent ¶ added in v1.33.2
type Dependent struct {
Component string `yaml:"component" json:"component" mapstructure:"component"`
ComponentType string `yaml:"component_type" json:"component_type" mapstructure:"component_type"`
ComponentPath string `yaml:"component_path" json:"component_path" mapstructure:"component_path"`
Namespace string `yaml:"namespace,omitempty" json:"namespace,omitempty" mapstructure:"namespace"`
Tenant string `yaml:"tenant,omitempty" json:"tenant,omitempty" mapstructure:"tenant"`
Environment string `yaml:"environment,omitempty" json:"environment,omitempty" mapstructure:"environment"`
Stage string `yaml:"stage,omitempty" json:"stage,omitempty" mapstructure:"stage"`
Stack string `yaml:"stack" json:"stack" mapstructure:"stack"`
StackSlug string `yaml:"stack_slug" json:"stack_slug" mapstructure:"stack_slug"`
SpaceliftStack string `yaml:"spacelift_stack,omitempty" json:"spacelift_stack,omitempty" mapstructure:"spacelift_stack"`
AtlantisProject string `yaml:"atlantis_project,omitempty" json:"atlantis_project,omitempty" mapstructure:"atlantis_project"`
Dependents []Dependent `yaml:"dependents" json:"dependents" mapstructure:"dependents"`
Settings AtmosSectionMapType `yaml:"settings" json:"settings" mapstructure:"settings"`
}
type DescribeWorkflowsItem ¶ added in v1.55.0
type Docs ¶ added in v1.103.0
type Docs struct {
// Deprecated: this has moved to `settings.terminal.max-width`
MaxWidth int `yaml:"max-width" json:"max_width" mapstructure:"max-width"`
// Deprecated: this has moved to `settings.terminal.pagination`
Pagination bool `yaml:"pagination" json:"pagination" mapstructure:"pagination"`
Generate map[string]DocsGenerate `yaml:"generate,omitempty" json:"generate,omitempty" mapstructure:"generate"`
}
type DocsGenerate ¶ added in v1.175.0
type DocsGenerate struct {
BaseDir string `yaml:"base-dir,omitempty" json:"base-dir,omitempty" mapstructure:"base-dir"`
Input []any `yaml:"input,omitempty" json:"input,omitempty" mapstructure:"input"`
Template string `yaml:"template,omitempty" json:"template,omitempty" mapstructure:"template"`
Output string `yaml:"output,omitempty" json:"output,omitempty" mapstructure:"output"`
Terraform TerraformDocsReadmeSettings `yaml:"terraform,omitempty" json:"terraform,omitempty" mapstructure:"terraform"`
}
type EditorConfig ¶ added in v1.151.0
type EditorConfig struct {
IgnoreDefaults bool `yaml:"ignore_defaults,omitempty" json:"ignore_defaults,omitempty" mapstructure:"ignore_defaults"`
DryRun bool `yaml:"dry_run,omitempty" json:"dry_run,omitempty" mapstructure:"dry_run"`
Format string `yaml:"format,omitempty" json:"format,omitempty" mapstructure:"format"`
ConfigFilePaths []string `yaml:"config_file_paths,omitempty" json:"config_file_paths,omitempty" mapstructure:"config_file_paths"`
Exclude []string `yaml:"exclude,omitempty" json:"exclude,omitempty" mapstructure:"exclude"`
Init bool `yaml:"init,omitempty" json:"init,omitempty" mapstructure:"init"`
DisableEndOfLine bool `yaml:"disable_end_of_line,omitempty" json:"disable_end_of_line,omitempty" mapstructure:"disable_end_of_line"`
DisableInsertFinalNewline bool `` /* 135-byte string literal not displayed */
DisableIndentation bool `yaml:"disable_indentation,omitempty" json:"disable_indentation,omitempty" mapstructure:"disable_indentation"`
DisableIndentSize bool `yaml:"disable_indent_size,omitempty" json:"disable_indent_size,omitempty" mapstructure:"disable_indent_size"`
DisableMaxLineLength bool `yaml:"disable_max_line_length,omitempty" json:"disable_max_line_length,omitempty" mapstructure:"disable_max_line_length"`
DisableTrimTrailingWhitespace bool `` /* 147-byte string literal not displayed */
}
type Helmfile ¶
type Helmfile struct {
BasePath string `yaml:"base_path" json:"base_path" mapstructure:"base_path"`
UseEKS bool `yaml:"use_eks" json:"use_eks" mapstructure:"use_eks"`
KubeconfigPath string `yaml:"kubeconfig_path" json:"kubeconfig_path" mapstructure:"kubeconfig_path"`
HelmAwsProfilePattern string `yaml:"helm_aws_profile_pattern" json:"helm_aws_profile_pattern" mapstructure:"helm_aws_profile_pattern"`
ClusterNamePattern string `yaml:"cluster_name_pattern" json:"cluster_name_pattern" mapstructure:"cluster_name_pattern"`
Command string `yaml:"command" json:"command" mapstructure:"command"`
}
type Integrations ¶
type Integrations struct {
Atlantis Atlantis `yaml:"atlantis,omitempty" json:"atlantis,omitempty" mapstructure:"atlantis"`
GitHub AtmosSectionMapType `yaml:"github,omitempty" json:"github,omitempty" mapstructure:"github"`
Pro AtmosSectionMapType `yaml:"pro,omitempty" json:"pro,omitempty" mapstructure:"pro"`
}
type ListColumnConfig ¶ added in v1.155.0
type ListConfig ¶ added in v1.155.0
type ListConfig struct {
// Format specifies the output format (table, json, csv)
// If empty, defaults to table format
Format string `yaml:"format" json:"format" mapstructure:"format" validate:"omitempty,oneof=table json csv"`
Columns []ListColumnConfig `yaml:"columns" json:"columns" mapstructure:"columns"`
}
type MarkdownSettings ¶ added in v1.135.0
type MarkdownSettings struct {
Document MarkdownStyle `yaml:"document,omitempty" json:"document,omitempty" mapstructure:"document"`
BlockQuote MarkdownStyle `yaml:"block_quote,omitempty" json:"block_quote,omitempty" mapstructure:"block_quote"`
Paragraph MarkdownStyle `yaml:"paragraph,omitempty" json:"paragraph,omitempty" mapstructure:"paragraph"`
List MarkdownStyle `yaml:"list,omitempty" json:"list,omitempty" mapstructure:"list"`
ListItem MarkdownStyle `yaml:"list_item,omitempty" json:"list_item,omitempty" mapstructure:"list_item"`
Heading MarkdownStyle `yaml:"heading,omitempty" json:"heading,omitempty" mapstructure:"heading"`
H1 MarkdownStyle `yaml:"h1,omitempty" json:"h1,omitempty" mapstructure:"h1"`
H2 MarkdownStyle `yaml:"h2,omitempty" json:"h2,omitempty" mapstructure:"h2"`
H3 MarkdownStyle `yaml:"h3,omitempty" json:"h3,omitempty" mapstructure:"h3"`
H4 MarkdownStyle `yaml:"h4,omitempty" json:"h4,omitempty" mapstructure:"h4"`
H5 MarkdownStyle `yaml:"h5,omitempty" json:"h5,omitempty" mapstructure:"h5"`
H6 MarkdownStyle `yaml:"h6,omitempty" json:"h6,omitempty" mapstructure:"h6"`
Text MarkdownStyle `yaml:"text,omitempty" json:"text,omitempty" mapstructure:"text"`
Strong MarkdownStyle `yaml:"strong,omitempty" json:"strong,omitempty" mapstructure:"strong"`
Emph MarkdownStyle `yaml:"emph,omitempty" json:"emph,omitempty" mapstructure:"emph"`
Hr MarkdownStyle `yaml:"hr,omitempty" json:"hr,omitempty" mapstructure:"hr"`
Item MarkdownStyle `yaml:"item,omitempty" json:"item,omitempty" mapstructure:"item"`
Enumeration MarkdownStyle `yaml:"enumeration,omitempty" json:"enumeration,omitempty" mapstructure:"enumeration"`
Code MarkdownStyle `yaml:"code,omitempty" json:"code,omitempty" mapstructure:"code"`
CodeBlock MarkdownStyle `yaml:"code_block,omitempty" json:"code_block,omitempty" mapstructure:"code_block"`
Table MarkdownStyle `yaml:"table,omitempty" json:"table,omitempty" mapstructure:"table"`
DefinitionList MarkdownStyle `yaml:"definition_list,omitempty" json:"definition_list,omitempty" mapstructure:"definition_list"`
DefinitionTerm MarkdownStyle `yaml:"definition_term,omitempty" json:"definition_term,omitempty" mapstructure:"definition_term"`
DefinitionDescription MarkdownStyle `yaml:"definition_description,omitempty" json:"definition_description,omitempty" mapstructure:"definition_description"`
HtmlBlock MarkdownStyle `yaml:"html_block,omitempty" json:"html_block,omitempty" mapstructure:"html_block"`
HtmlSpan MarkdownStyle `yaml:"html_span,omitempty" json:"html_span,omitempty" mapstructure:"html_span"`
Link MarkdownStyle `yaml:"link,omitempty" json:"link,omitempty" mapstructure:"link"`
LinkText MarkdownStyle `yaml:"link_text,omitempty" json:"link_text,omitempty" mapstructure:"link_text"`
}
type MarkdownStyle ¶ added in v1.135.0
type MarkdownStyle struct {
BlockPrefix string `yaml:"block_prefix,omitempty" json:"block_prefix,omitempty" mapstructure:"block_prefix"`
BlockSuffix string `yaml:"block_suffix,omitempty" json:"block_suffix,omitempty" mapstructure:"block_suffix"`
Color string `yaml:"color,omitempty" json:"color,omitempty" mapstructure:"color"`
BackgroundColor string `yaml:"background_color,omitempty" json:"background_color,omitempty" mapstructure:"background_color"`
Bold bool `yaml:"bold,omitempty" json:"bold,omitempty" mapstructure:"bold"`
Italic bool `yaml:"italic,omitempty" json:"italic,omitempty" mapstructure:"italic"`
Underline bool `yaml:"underline,omitempty" json:"underline,omitempty" mapstructure:"underline"`
Margin int `yaml:"margin,omitempty" json:"margin,omitempty" mapstructure:"margin"`
Padding int `yaml:"padding,omitempty" json:"padding,omitempty" mapstructure:"padding"`
Indent int `yaml:"indent,omitempty" json:"indent,omitempty" mapstructure:"indent"`
IndentToken string `yaml:"indent_token,omitempty" json:"indent_token,omitempty" mapstructure:"indent_token"`
LevelIndent int `yaml:"level_indent,omitempty" json:"level_indent,omitempty" mapstructure:"level_indent"`
Format string `yaml:"format,omitempty" json:"format,omitempty" mapstructure:"format"`
Prefix string `yaml:"prefix,omitempty" json:"prefix,omitempty" mapstructure:"prefix"`
StyleOverride bool `yaml:"style_override,omitempty" json:"style_override,omitempty" mapstructure:"style_override"`
Chroma map[string]ChromaStyle `yaml:"chroma,omitempty" json:"chroma,omitempty" mapstructure:"chroma"`
}
type ResourcePath ¶ added in v1.166.0
type ResourcePath struct {
BasePath string `yaml:"base_path,omitempty" json:"base_path,omitempty" mapstructure:"base_path"`
}
type SchemaRegistry ¶ added in v1.166.0
type SchemaRegistry struct {
Manifest string `yaml:"manifest,omitempty" json:"manifest,omitempty" mapstructure:"manifest"`
Schema string `yaml:"schema,omitempty" json:"schema,omitempty" mapstructure:"schema"`
Matches []string `yaml:"matches,omitempty" json:"matches,omitempty" mapstructure:"matches"`
}
type Settings ¶
type Settings struct {
DependsOn DependsOn `yaml:"depends_on,omitempty" json:"depends_on,omitempty" mapstructure:"depends_on"`
Spacelift SettingsSpacelift `yaml:"spacelift,omitempty" json:"spacelift,omitempty" mapstructure:"spacelift"`
Templates Templates `yaml:"templates,omitempty" json:"templates,omitempty" mapstructure:"templates"`
}
type SettingsSpacelift ¶ added in v1.37.0
type SettingsSpacelift AtmosSectionMapType
type ShellConfig ¶ added in v1.107.0
type ShellConfig struct {
Prompt string `yaml:"prompt" json:"prompt" mapstructure:"prompt"`
}
type StackImport ¶
type StackImport struct {
Path string `yaml:"path" json:"path" mapstructure:"path"`
Context AtmosSectionMapType `yaml:"context" json:"context" mapstructure:"context"`
SkipTemplatesProcessing bool `` /* 126-byte string literal not displayed */
IgnoreMissingTemplateValues bool `` /* 141-byte string literal not displayed */
SkipIfMissing bool `yaml:"skip_if_missing,omitempty" json:"skip_if_missing,omitempty" mapstructure:"skip_if_missing"`
}
type Stacks ¶
type Stacks struct {
BasePath string `yaml:"base_path" json:"base_path" mapstructure:"base_path"`
IncludedPaths []string `yaml:"included_paths" json:"included_paths" mapstructure:"included_paths"`
ExcludedPaths []string `yaml:"excluded_paths" json:"excluded_paths" mapstructure:"excluded_paths"`
NamePattern string `yaml:"name_pattern" json:"name_pattern" mapstructure:"name_pattern"`
NameTemplate string `yaml:"name_template" json:"name_template" mapstructure:"name_template"`
}
type SyntaxHighlighting ¶ added in v1.148.0
type SyntaxHighlighting struct {
Enabled bool `yaml:"enabled" json:"enabled" mapstructure:"enabled"`
Lexer string `yaml:"lexer" json:"lexer" mapstructure:"lexer"`
Formatter string `yaml:"formatter" json:"formatter" mapstructure:"formatter"`
Theme string `yaml:"theme" json:"theme" mapstructure:"theme"`
HighlightedOutputPager bool `yaml:"pager" json:"pager" mapstructure:"pager"`
LineNumbers bool `yaml:"line_numbers" json:"line_numbers" mapstructure:"line_numbers"`
Wrap bool `yaml:"wrap" json:"wrap" mapstructure:"wrap"`
}
type Templates ¶ added in v1.68.0
type Templates struct {
Settings TemplatesSettings `yaml:"settings" json:"settings" mapstructure:"settings"`
}
type TemplatesSettings ¶ added in v1.68.0
type TemplatesSettings struct {
Enabled bool `yaml:"enabled" json:"enabled" mapstructure:"enabled"`
Sprig TemplatesSettingsSprig `yaml:"sprig" json:"sprig" mapstructure:"sprig"`
Gomplate TemplatesSettingsGomplate `yaml:"gomplate" json:"gomplate" mapstructure:"gomplate"`
Delimiters []string `yaml:"delimiters,omitempty" json:"delimiters,omitempty" mapstructure:"delimiters"`
Evaluations int `yaml:"evaluations,omitempty" json:"evaluations,omitempty" mapstructure:"evaluations"`
Env map[string]string `yaml:"env,omitempty" json:"env,omitempty" mapstructure:"env"`
}
type TemplatesSettingsGomplate ¶ added in v1.68.0
type TemplatesSettingsGomplate struct {
Enabled bool `yaml:"enabled" json:"enabled" mapstructure:"enabled"`
Timeout int `yaml:"timeout" json:"timeout" mapstructure:"timeout"`
Datasources map[string]TemplatesSettingsGomplateDatasource `yaml:"datasources" json:"datasources" mapstructure:"datasources"`
}
type TemplatesSettingsGomplateDatasource ¶ added in v1.70.0
type TemplatesSettingsSprig ¶ added in v1.68.0
type TemplatesSettingsSprig struct {
Enabled bool `yaml:"enabled" json:"enabled" mapstructure:"enabled"`
}
type Terminal ¶ added in v1.135.0
type Terminal struct {
MaxWidth int `yaml:"max_width" json:"max_width" mapstructure:"max_width"`
Pager string `yaml:"pager" json:"pager" mapstructure:"pager"`
Unicode bool `yaml:"unicode" json:"unicode" mapstructure:"unicode"`
SyntaxHighlighting SyntaxHighlighting `yaml:"syntax_highlighting" json:"syntax_highlighting" mapstructure:"syntax_highlighting"`
NoColor bool `yaml:"no_color" json:"no_color" mapstructure:"no_color"`
}
func (*Terminal) IsPagerEnabled ¶ added in v1.175.0
type Terraform ¶
type Terraform struct {
BasePath string `yaml:"base_path" json:"base_path" mapstructure:"base_path"`
ApplyAutoApprove bool `yaml:"apply_auto_approve" json:"apply_auto_approve" mapstructure:"apply_auto_approve"`
AppendUserAgent string `yaml:"append_user_agent" json:"append_user_agent" mapstructure:"append_user_agent"`
DeployRunInit bool `yaml:"deploy_run_init" json:"deploy_run_init" mapstructure:"deploy_run_init"`
InitRunReconfigure bool `yaml:"init_run_reconfigure" json:"init_run_reconfigure" mapstructure:"init_run_reconfigure"`
AutoGenerateBackendFile bool `yaml:"auto_generate_backend_file" json:"auto_generate_backend_file" mapstructure:"auto_generate_backend_file"`
WorkspacesEnabled *bool `yaml:"workspaces_enabled,omitempty" json:"workspaces_enabled,omitempty" mapstructure:"workspaces_enabled,omitempty"`
Command string `yaml:"command" json:"command" mapstructure:"command"`
Shell ShellConfig `yaml:"shell" json:"shell" mapstructure:"shell"`
Init TerraformInit `yaml:"init" json:"init" mapstructure:"init"`
}
type TerraformDocsReadmeSettings ¶ added in v1.175.0
type TerraformDocsReadmeSettings struct {
Source string `yaml:"source,omitempty" json:"source,omitempty" mapstructure:"source"`
Enabled bool `yaml:"enabled,omitempty" json:"enabled,omitempty" mapstructure:"enabled"`
Format string `yaml:"format,omitempty" json:"format,omitempty" mapstructure:"format"`
ShowProviders bool `yaml:"show_providers,omitempty" json:"show_providers,omitempty" mapstructure:"show_providers"`
ShowInputs bool `yaml:"show_inputs,omitempty" json:"show_inputs,omitempty" mapstructure:"show_inputs"`
ShowOutputs bool `yaml:"show_outputs,omitempty" json:"show_outputs,omitempty" mapstructure:"show_outputs"`
SortBy string `yaml:"sort_by,omitempty" json:"sort_by,omitempty" mapstructure:"sort_by"`
HideEmpty bool `yaml:"hide_empty,omitempty" json:"hide_empty,omitempty" mapstructure:"hide_empty"`
IndentLevel int `yaml:"indent_level,omitempty" json:"indent_level,omitempty" mapstructure:"indent_level"`
}
type TerraformInit ¶ added in v1.167.0
type TerraformInit struct {
PassVars bool `yaml:"pass_vars" json:"pass_vars" mapstructure:"pass_vars"`
}
type Validate ¶ added in v1.151.0
type Validate struct {
EditorConfig EditorConfig `yaml:"editorconfig,omitempty" json:"editorconfig,omitempty" mapstructure:"editorconfig"`
}
type Validation ¶
type Validation map[string]ValidationItem
type ValidationItem ¶
type ValidationItem struct {
SchemaType string `yaml:"schema_type" json:"schema_type" mapstructure:"schema_type"`
SchemaPath string `yaml:"schema_path" json:"schema_path" mapstructure:"schema_path"`
ModulePaths []string `yaml:"module_paths" json:"module_paths" mapstructure:"module_paths"`
Description string `yaml:"description" json:"description" mapstructure:"description"`
Disabled bool `yaml:"disabled" json:"disabled" mapstructure:"disabled"`
Timeout int `yaml:"timeout" json:"timeout" mapstructure:"timeout"`
}
type Vendor ¶ added in v1.106.0
type Vendor struct {
// Path to vendor configuration file or directory containing vendor files
// If a directory is specified, all .yaml files in the directory will be processed in lexicographical order
BasePath string `yaml:"base_path" json:"base_path" mapstructure:"base_path"`
}
type VendorComponentConfig ¶
type VendorComponentConfig struct {
ApiVersion string `yaml:"apiVersion" json:"apiVersion" mapstructure:"apiVersion"`
Kind string `yaml:"kind" json:"kind" mapstructure:"kind"`
Metadata VendorComponentMetadata `yaml:"metadata" json:"metadata" mapstructure:"metadata"`
Spec VendorComponentSpec `yaml:"spec" json:"spec" mapstructure:"spec"`
}
type VendorComponentMetadata ¶
type VendorComponentMixins ¶
type VendorComponentSource ¶
type VendorComponentSource struct {
Type string `yaml:"type" json:"type" mapstructure:"type"`
Uri string `yaml:"uri" json:"uri" mapstructure:"uri"`
Version string `yaml:"version" json:"version" mapstructure:"version"`
IncludedPaths []string `yaml:"included_paths" json:"included_paths" mapstructure:"included_paths"`
ExcludedPaths []string `yaml:"excluded_paths" json:"excluded_paths" mapstructure:"excluded_paths"`
}
type VendorComponentSpec ¶
type VendorComponentSpec struct {
Source VendorComponentSource `yaml:"source" json:"source" mapstructure:"source"`
Mixins []VendorComponentMixins `yaml:"mixins" json:"mixins" mapstructure:"mixins"`
}
type Version ¶ added in v1.127.0
type Version struct {
Check VersionCheck `yaml:"check,omitempty" mapstructure:"check"`
}
type VersionCheck ¶ added in v1.127.0
type WorkflowConfig ¶
type WorkflowConfig map[string]WorkflowDefinition
type WorkflowDefinition ¶
type WorkflowDefinition struct {
Description string `yaml:"description,omitempty" json:"description,omitempty" mapstructure:"description"`
Steps []WorkflowStep `yaml:"steps" json:"steps" mapstructure:"steps"`
Stack string `yaml:"stack,omitempty" json:"stack,omitempty" mapstructure:"stack"`
}
type WorkflowManifest ¶ added in v1.56.0
type WorkflowManifest struct {
Name string `yaml:"name,omitempty" json:"name,omitempty" mapstructure:"name"`
Description string `yaml:"description,omitempty" json:"description,omitempty" mapstructure:"description"`
Workflows WorkflowConfig `yaml:"workflows" json:"workflows" mapstructure:"workflows"`
}
type WorkflowStep ¶
type WorkflowStep struct {
Name string `yaml:"name,omitempty" json:"name,omitempty" mapstructure:"name"`
Command string `yaml:"command" json:"command" mapstructure:"command"`
Stack string `yaml:"stack,omitempty" json:"stack,omitempty" mapstructure:"stack"`
Type string `yaml:"type,omitempty" json:"type,omitempty" mapstructure:"type"`
}
type Workflows ¶
type Workflows struct {
BasePath string `yaml:"base_path" json:"base_path" mapstructure:"base_path"`
List ListConfig `yaml:"list" json:"list" mapstructure:"list"`
}
Click to show internal directories.
Click to hide internal directories.