internal

Documentation

Index

• func NewAWSPlugin() schema.MachComposerPlugin
• func StripProtocol(value string) string
• func TerraformRenderComponentProviders(cfg *SiteConfig) []string
• func ZoneFromURL(value string) string
• type AWSProvider
• type AWSTFState
• type ComponentConfig
• type EndpointConfig
  • func (e *EndpointConfig) SetDefaults()
• type Plugin
  • func (p *Plugin) Configure(environment string, provider string) error
  • func (p *Plugin) GetValidationSchema() (*schema.ValidationSchema, error)
  • func (p *Plugin) Identifier() string
  • func (p *Plugin) IsEnabled() bool
  • func (p *Plugin) RenderTerraformComponent(site string, component string) (*schema.ComponentSchema, error)
  • func (p *Plugin) SetComponentEndpointsConfig(component string, endpoints map[string]string) error
  • func (p *Plugin) SetRemoteStateBackend(data map[string]any) error
  • func (p *Plugin) SetSiteConfig(site string, data map[string]any) error
  • func (p *Plugin) SetSiteEndpointConfig(site string, name string, data map[string]any) error
  • func (p *Plugin) TerraformRenderProviders(site string) (string, error)
  • func (p *Plugin) TerraformRenderResources(site string) (string, error)
  • func (p *Plugin) TerraformRenderStateBackend(site string) (string, error)
• type SiteConfig

Functions

func NewAWSPlugin

func NewAWSPlugin() schema.MachComposerPlugin

func StripProtocol

func StripProtocol(value string) string

func TerraformRenderComponentProviders

func TerraformRenderComponentProviders(cfg *SiteConfig) []string

func ZoneFromURL

func ZoneFromURL(value string) string

Types

type AWSProvider

type AWSProvider struct {
	Name        string
	Region      string
	DefaultTags map[string]string `mapstructure:"default_tags"`
}

type AWSTFState

type AWSTFState struct {
	Bucket    string `mapstructure:"bucket"`
	KeyPrefix string `mapstructure:"key_prefix"`
	Region    string `mapstructure:"region"`
	RoleARN   string `mapstructure:"role_arn"`
	LockTable string `mapstructure:"lock_table"`
	Encrypt   bool   `mapstructure:"encrypt" default:"true"`
}

AWSTFState AWS S3 bucket state backend configuration.

type ComponentConfig

type ComponentConfig struct {
	Endpoints map[string]string
}

type EndpointConfig

type EndpointConfig struct {
	// Key is the id of the endpoint (.e.g internal)
	Key string `mapstructure:"key"`

	URL                  string `mapstructure:"url"`
	ThrottlingBurstLimit *int   `mapstructure:"throttling_burst_limit"`
	ThrottlingRateLimit  *int   `mapstructure:"throttling_rate_limit"`
	EnableCDN            bool   `mapstructure:"enable_cdn"`

	AssociatedComponents []string `mapstructure:"-"`

	// Zone is the route53 DNS Zone
	Zone string `mapstructure:"zone"`
}

func (*EndpointConfig) SetDefaults

func (e *EndpointConfig) SetDefaults()

type Plugin

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

func (*Plugin) Configure

func (p *Plugin) Configure(environment string, provider string) error

func (*Plugin) GetValidationSchema

func (p *Plugin) GetValidationSchema() (*schema.ValidationSchema, error)

func (*Plugin) Identifier

func (p *Plugin) Identifier() string

func (*Plugin) IsEnabled

func (p *Plugin) IsEnabled() bool

func (*Plugin) RenderTerraformComponent

func (p *Plugin) RenderTerraformComponent(site string, component string) (*schema.ComponentSchema, error)

func (*Plugin) SetComponentEndpointsConfig

func (p *Plugin) SetComponentEndpointsConfig(component string, endpoints map[string]string) error

func (*Plugin) SetRemoteStateBackend

func (p *Plugin) SetRemoteStateBackend(data map[string]any) error

func (*Plugin) SetSiteConfig

func (p *Plugin) SetSiteConfig(site string, data map[string]any) error

func (*Plugin) SetSiteEndpointConfig

func (p *Plugin) SetSiteEndpointConfig(site string, name string, data map[string]any) error

func (*Plugin) TerraformRenderProviders

func (p *Plugin) TerraformRenderProviders(site string) (string, error)

func (*Plugin) TerraformRenderResources

func (p *Plugin) TerraformRenderResources(site string) (string, error)

func (*Plugin) TerraformRenderStateBackend

func (p *Plugin) TerraformRenderStateBackend(site string) (string, error)

type SiteConfig

type SiteConfig struct {
	AccountID string `mapstructure:"account_id"`
	Region    string `mapstructure:"region"`

	DeployRoleName string            `mapstructure:"deploy_role_name"`
	ExtraProviders []AWSProvider     `mapstructure:"extra_providers"`
	DefaultTags    map[string]string `mapstructure:"default_tags"`
}