custom

Documentation

Index

• func EnsureRegistered(typeName, basePath string) error
• type Provider
  • func NewProvider(typeName, basePath string) *Provider
  • func (p *Provider) Execute(ctx *component.ExecutionContext) error
  • func (p *Provider) GenerateArtifacts(ctx *component.ExecutionContext) error
  • func (p *Provider) GetAvailableCommands() []string
  • func (p *Provider) GetBasePath(atmosConfig *schema.AtmosConfiguration) string
  • func (p *Provider) GetGroup() string
  • func (p *Provider) GetType() string
  • func (p *Provider) ListComponents(ctx context.Context, stack string, stackConfig map[string]any) ([]string, error)
  • func (p *Provider) ValidateComponent(config map[string]any) error

Functions

func EnsureRegistered

func EnsureRegistered(typeName, basePath string) error

EnsureRegistered registers a custom component type if not already registered. This is called during custom command execution when component.type is specified. It is idempotent - calling it multiple times with the same type is safe.

Types

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider implements ComponentProvider for custom command component types. Unlike built-in providers (terraform, helmfile, packer), custom providers are registered on-demand when a custom command with a component type is executed.

func NewProvider

func NewProvider(typeName, basePath string) *Provider

NewProvider creates a new custom component provider.

func (*Provider) Execute

func (p *Provider) Execute(ctx *component.ExecutionContext) error

Execute runs a command for this component type. For custom components, execution is handled by the custom command steps, not by the provider. This is a no-op.

func (*Provider) GenerateArtifacts

func (p *Provider) GenerateArtifacts(ctx *component.ExecutionContext) error

GenerateArtifacts creates necessary files for component execution. Custom components do not generate artifacts.

func (*Provider) GetAvailableCommands

func (p *Provider) GetAvailableCommands() []string

GetAvailableCommands returns list of commands this component type supports. Custom component commands are defined in the custom command configuration.

func (*Provider) GetBasePath

func (p *Provider) GetBasePath(atmosConfig *schema.AtmosConfiguration) string

GetBasePath returns the base directory path for this component type.

func (*Provider) GetGroup

func (p *Provider) GetGroup() string

GetGroup returns the component group for categorization.

func (*Provider) GetType

func (p *Provider) GetType() string

GetType returns the component type identifier.

func (*Provider) ListComponents

func (p *Provider) ListComponents(ctx context.Context, stack string, stackConfig map[string]any) ([]string, error)

ListComponents discovers all components of this type in a stack.

func (*Provider) ValidateComponent

func (p *Provider) ValidateComponent(config map[string]any) error

ValidateComponent validates component configuration. Custom components have no specific validation requirements.