Documentation
¶
Index ¶
- Constants
- Variables
- func DeleteBackendWithParams(params *DeleteBackendParams) error
- func DescribeBackend(atmosConfig *schema.AtmosConfiguration, component string, opts interface{}) error
- func ExecuteProvisioners(ctx context.Context, event HookEvent, atmosConfig *schema.AtmosConfiguration, ...) error
- func ListBackends(atmosConfig *schema.AtmosConfiguration, opts interface{}) error
- func ProvisionWithParams(params *ProvisionParams) error
- func RegisterProvisioner(p Provisioner) error
- type DeleteBackendParams
- type ExecuteDescribeComponentFunc
- type HookEvent
- type ProvisionParams
- type Provisioner
- type ProvisionerFunc
Constants ¶
const HookEventBeforeTerraformInit = HookEvent("before.terraform.init")
HookEventBeforeTerraformInit is the hook event for before terraform init.
Variables ¶
var ErrUnsupportedProvisionerType = errors.New("unsupported provisioner type")
Error types for provisioning operations.
Functions ¶
func DeleteBackendWithParams ¶
func DeleteBackendWithParams(params *DeleteBackendParams) error
DeleteBackendWithParams deletes a backend using a params struct.
func DescribeBackend ¶
func DescribeBackend(atmosConfig *schema.AtmosConfiguration, component string, opts interface{}) error
DescribeBackend returns the backend configuration from stack.
func ExecuteProvisioners ¶
func ExecuteProvisioners( ctx context.Context, event HookEvent, atmosConfig *schema.AtmosConfiguration, componentConfig map[string]any, authContext *schema.AuthContext, ) error
ExecuteProvisioners executes all provisioners registered for a specific hook event. Returns an error if any provisioner fails (fail-fast behavior).
func ListBackends ¶
func ListBackends(atmosConfig *schema.AtmosConfiguration, opts interface{}) error
ListBackends lists all backends in a stack.
func ProvisionWithParams ¶
func ProvisionWithParams(params *ProvisionParams) error
Provision provisions infrastructure resources using a params struct. It validates the provisioner type, loads component configuration, and executes the provisioner.
func RegisterProvisioner ¶
func RegisterProvisioner(p Provisioner) error
RegisterProvisioner registers a provisioner for a specific hook event. Provisioners self-declare when they should run by specifying a hook event. Returns an error if Func is nil or HookEvent is empty.
Types ¶
type DeleteBackendParams ¶
type DeleteBackendParams struct {
AtmosConfig *schema.AtmosConfiguration
Component string
Stack string
Force bool
DescribeComponent ExecuteDescribeComponentFunc
AuthContext *schema.AuthContext
}
DeleteBackendParams contains parameters for the DeleteBackend function.
type ExecuteDescribeComponentFunc ¶
ExecuteDescribeComponentFunc is a function that describes a component from a stack. This allows us to inject the describe component logic without circular dependencies.
type HookEvent ¶
type HookEvent string
HookEvent represents when a provisioner should run. This is a string type alias compatible with pkg/hooks.HookEvent to avoid circular dependencies. Use pkg/hooks.HookEvent constants (e.g., hooks.BeforeTerraformInit) when registering provisioners.
type ProvisionParams ¶
type ProvisionParams struct {
AtmosConfig *schema.AtmosConfiguration
ProvisionerType string
Component string
Stack string
DescribeComponent ExecuteDescribeComponentFunc
AuthContext *schema.AuthContext
}
ProvisionParams contains parameters for the Provision function.
type Provisioner ¶
type Provisioner struct {
// Type is the provisioner type (e.g., "backend", "component").
Type string
// HookEvent declares when this provisioner should run.
// Must not be empty; use pkg/hooks.HookEvent constants.
HookEvent HookEvent
// Func is the provisioning function to execute.
// Must not be nil.
Func ProvisionerFunc
}
Provisioner represents a self-registering provisioner. All fields are validated at registration time by RegisterProvisioner.
func GetProvisionersForEvent ¶
func GetProvisionersForEvent(event HookEvent) []Provisioner
GetProvisionersForEvent returns all provisioners registered for a specific hook event.
type ProvisionerFunc ¶
type ProvisionerFunc func( ctx context.Context, atmosConfig *schema.AtmosConfiguration, componentConfig map[string]any, authContext *schema.AuthContext, ) error
ProvisionerFunc is a function that provisions infrastructure. It receives the Atmos configuration, component configuration, and auth context. Returns an error if provisioning fails.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package source provides just-in-time (JIT) vendoring of component sources from source configuration in stack manifests.
|
Package source provides just-in-time (JIT) vendoring of component sources from source configuration in stack manifests. |
|
cmd
Package cmd provides reusable CLI command builders for source provisioning.
|
Package cmd provides reusable CLI command builders for source provisioning. |