derive

Documentation

Index

• func ProviderChoices(cfg *config.WorkflowConfig, envName string) []string
• func ResolveProvider(cfg *config.WorkflowConfig, opts Options) (string, error)
• type Diagnostic
• type ExternalProviderMapper
  • func (m ExternalProviderMapper) MapRequirements(ctx context.Context, req MapRequest) (MapResult, error)
• type GeneratedModule
• type MapRequest
• type MapResult
• type Note
• type Options
• type ProviderMapper
• type Result
  • func Derive(ctx context.Context, cfg *config.WorkflowConfig, ...) (Result, error)

Functions

func ProviderChoices

func ProviderChoices(cfg *config.WorkflowConfig, envName string) []string

func ResolveProvider

func ResolveProvider(cfg *config.WorkflowConfig, opts Options) (string, error)

Types

type Diagnostic

type Diagnostic struct {
	Key     string
	Code    string
	Message string
}

type ExternalProviderMapper

type ExternalProviderMapper struct {
	Client pb.IaCProviderRequirementMapperClient
}

func (ExternalProviderMapper) MapRequirements

func (m ExternalProviderMapper) MapRequirements(ctx context.Context, req MapRequest) (MapResult, error)

type GeneratedModule

type GeneratedModule struct {
	Name      string
	Type      string
	Satisfies []string
	Config    map[string]any
	DependsOn []string
}

type MapRequest

type MapRequest struct {
	Provider     string
	Runtime      requirements.Runtime
	Environment  string
	Requirements []requirements.Requirement
}

type MapResult

type MapResult struct {
	AcceptedKeys []string
	Modules      []GeneratedModule
	Rejected     []Diagnostic
	Notes        []Note
}

type Note

type Note struct {
	Key         string
	Message     string
	Interactive bool
}

type Options

type Options struct {
	Provider       string
	Runtime        requirements.Runtime
	Environment    string
	NonInteractive bool
}

type ProviderMapper

type ProviderMapper interface {
	MapRequirements(context.Context, MapRequest) (MapResult, error)
}

type Result

type Result struct {
	Provider     string
	Runtime      requirements.Runtime
	Requirements []requirements.Requirement
	Modules      []GeneratedModule
	Rejected     []Diagnostic
	Notes        []Note
}

func Derive

func Derive(ctx context.Context, cfg *config.WorkflowConfig, reqs []requirements.Requirement, mapper ProviderMapper, opts Options) (Result, error)