arm

Documentation

Index

• type AzureOutput
• type Config
  • func GetConfigFromEnvironment() (Config, error)
  • func NewConfigWithDefaults() Config
• type InstallAction
• type InstallArguments
• type InstallStep
• type Mixin
  • func New() *Mixin
  • func (m *Mixin) Build(ctx context.Context) error
  • func (m *Mixin) GetSchema() (string, error)
  • func (m *Mixin) Install(ctx context.Context) error
  • func (m *Mixin) LoadConfigFromEnvironment() error
  • func (m *Mixin) PrintSchema() error
  • func (m *Mixin) PrintVersion(opts version.Options) error
  • func (m *Mixin) Uninstall(ctx context.Context) error
• type Step
• type TestMixin
  • func NewTestMixin(t *testing.T) *TestMixin

Types

type AzureOutput

type AzureOutput struct {
	Name string `yaml:"name"`
	Key  string `yaml:"key"`
}

type Config

type Config struct {
	Environment    azure.Environment
	SubscriptionID string `envconfig:"SUBSCRIPTION_ID" required:"true"`
	TenantID       string `envconfig:"TENANT_ID" required:"true"`
	ClientID       string `envconfig:"CLIENT_ID" required:"true"`
	ClientSecret   string `envconfig:"CLIENT_SECRET" required:"true"`
}

Config represents details necessary for the broker to interact with an Azure subscription

func GetConfigFromEnvironment

func GetConfigFromEnvironment() (Config, error)

GetConfigFromEnvironment returns Azure-related configuration derived from environment variables

func NewConfigWithDefaults

func NewConfigWithDefaults() Config

NewConfigWithDefaults returns a Config object with default values already applied. Callers are then free to set custom values for the remaining fields and/or override default values.

type InstallAction

type InstallAction struct {
	Steps []InstallStep `yaml:"install"`
}

type InstallArguments

type InstallArguments struct {
	Step `yaml:",inline"`

	Template      string                 `yaml:"template"`
	Name          string                 `yaml:"name"`
	ResourceGroup string                 `yaml:"resourceGroup"`
	Parameters    map[string]interface{} `yaml:"parameters"`
}

type InstallStep

type InstallStep struct {
	InstallArguments `yaml:"arm"`
}

type Mixin

type Mixin struct {
	runtime.RuntimeConfig
	// contains filtered or unexported fields
}

func New

func New() *Mixin

New arm mixin client, initialized with useful defaults.

func (*Mixin) Build

func (m *Mixin) Build(ctx context.Context) error

Build will generate the necessary Dockerfile lines for an invocation image using this mixin

func (*Mixin) GetSchema

func (m *Mixin) GetSchema() (string, error)

func (*Mixin) Install

func (m *Mixin) Install(ctx context.Context) error

func (*Mixin) LoadConfigFromEnvironment

func (m *Mixin) LoadConfigFromEnvironment() error

func (*Mixin) PrintSchema

func (m *Mixin) PrintSchema() error

func (*Mixin) PrintVersion

func (m *Mixin) PrintVersion(opts version.Options) error

func (*Mixin) Uninstall

func (m *Mixin) Uninstall(ctx context.Context) error

type Step

type Step struct {
	Description string        `yaml:"description"`
	Outputs     []AzureOutput `yaml:"outputs"`
}

type TestMixin

type TestMixin struct {
	*Mixin
	TestContext *portercontext.TestContext
}

func NewTestMixin

func NewTestMixin(t *testing.T) *TestMixin

NewTestMixin initializes a mixin test client, with the output buffered, and an in-memory file system.