Documentation
¶
Index ¶
- Variables
- func AppNameFromDirName(dir string) (string, error)
- func AppNameFromFilename(file string) (string, error)
- func FilenameFromAppName(appName string) string
- func Parse(parseCfg ParseConfig) (*config.AppConfig, error)
- func ParseAppBranchConfig(r io.Reader) (*config.AppBranchConfig, error)
- func ParseAppBranchConfigFile(path string) (*config.AppBranchConfig, error)
- func ParseDir(ctx context.Context, parseCfg ParseConfig) (*config.AppConfig, error)
- func ParseInstallConfig(r io.Reader, v *validator.Validate) (*config.Install, error)
- func ReadFile(filename string) ([]byte, error)
- func Template(byts []byte) ([]byte, error)
- type AppBranchConfigFile
- type BaseConfig
- type ConfigDir
- type File
- type FileProcessor
- type ParseConfig
- type ParseErr
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidFilename error = fmt.Errorf("invalid filename")
Functions ¶
func AppNameFromDirName ¶
func AppNameFromFilename ¶
func FilenameFromAppName ¶
func ParseAppBranchConfig ¶ added in v0.19.1164
func ParseAppBranchConfig(r io.Reader) (*config.AppBranchConfig, error)
ParseAppBranchConfig reads a single standalone app branch config from a TOML document. Unlike the app config directory parser, the document is the branch itself rather than a `[branch]` section of a larger config.
func ParseAppBranchConfigFile ¶ added in v0.19.1164
func ParseAppBranchConfigFile(path string) (*config.AppBranchConfig, error)
ParseAppBranchConfigFile parses one branch config file.
func ParseInstallConfig ¶ added in v0.19.1091
Types ¶
type AppBranchConfigFile ¶ added in v0.19.1164
type AppBranchConfigFile struct {
Path string
Config *config.AppBranchConfig
}
AppBranchConfigFile pairs a parsed branch config with the file it came from, so callers can point at the offending file when two files declare the same branch name.
func LoadAppBranchConfigs ¶ added in v0.19.1164
func LoadAppBranchConfigs(path string) ([]AppBranchConfigFile, bool, error)
LoadAppBranchConfigs loads a single TOML file or a directory of them.
func ParseAppBranchConfigDir ¶ added in v0.19.1164
func ParseAppBranchConfigDir(dir string) ([]AppBranchConfigFile, error)
ParseAppBranchConfigDir recursively parses every *.toml file under dir. Files are visited in sorted path order so the resulting plan is deterministic, and two files declaring the same branch name are rejected.
type BaseConfig ¶
type BaseConfig struct {
ConfigVars map[string]interface{} `toml:"config_vars"`
}
type ConfigDir ¶
type ConfigDir struct {
Branch *config.AppBranchConfig `name:"branch"`
Branches []*config.AppBranchConfig `name:"branches"`
Components []*config.Component `name:"components"`
Actions []*config.ActionConfig `name:"actions"`
Runbooks []*config.RunbookConfig `name:"runbooks"`
Installs []*config.Install `name:"installs"`
InstallsConfig *config.InstallsConfig `name:"installs"`
Triggers *config.TriggersConfig `name:"triggers"`
Policies *config.PoliciesConfig `name:"policies"`
PoliciesDir []config.AppPolicy `name:"policies"`
Secrets *config.SecretsConfig `name:"secrets"`
SecretsDir []*config.AppSecret `name:"secrets"`
Inputs *config.AppInputConfig `name:"inputs"`
InputsDir []config.AppInput `name:"inputs"`
InputGroupsDir []config.AppInputGroup `name:"input_groups"`
Permissions *config.PermissionsConfig `name:"permissions"`
PermissionsDir []*config.AppAWSIAMRole `name:"permissions"`
OperationRolesConfig *config.OperationRolesConfig `name:"operation_roles"`
KubernetesContexts *config.KubernetesContextsConfig `name:"kubernetes_contexts"`
KubernetesContextsDir []*config.KubernetesContext `name:"kubernetes_contexts"`
BreakGlass *config.BreakGlass `name:"break_glass"`
BreakGlassDir []*config.AppAWSIAMRole `name:"break_glass"`
Stack *config.StackConfig `name:"stack"`
Sandbox *config.AppSandboxConfig `name:"sandbox"`
Runner *config.AppRunnerConfig `name:"runner"`
Metadata *config.MetadataConfig `name:"metadata,required"`
Installer *config.InstallerConfig `name:"installer"`
}
NOTE(jm): this is only required as a temporary migration path, while the old config syncing exists.
This will be removed and we will pass the `config.AppConfig` into the directory parser once we have time to remove the old version.
type File ¶
func FindConfigFiles ¶
type FileProcessor ¶
FileProcessor is a function to process config files before they're marshalled into a config struct and synced to the api.
Source Files
Directories