account

Documentation

Index

• type Account
• type AccountValidator
• type BaseAccount
  • func (b *BaseAccount) BaseToSpinnakerSettings(a Account) map[string]interface{}
  • func (b *BaseAccount) GetHash() (string, error)
• type SpinnakerAccountType

Types

type Account

type Account interface {
	// GetName returns the name of the account
	GetName() string
	GetType() interfaces.AccountType
	NewValidator() AccountValidator
	// Output the account definition in Spinnaker terms
	ToSpinnakerSettings(context.Context) (map[string]interface{}, error)
	GetSettings() *interfaces.FreeForm
	GetHash() (string, error)
}

Accounts represents a single account of a certain type. It must contain a FreeForm (aka a map) of settings. These settings hold additional settings when parsed from a SpinnakerAccount as well as all settings when parsed from Spinnaker settings.

type AccountValidator

type AccountValidator interface {
	Validate(interfaces.SpinnakerService, client.Client, context.Context, logr.Logger) error
}

type BaseAccount

type BaseAccount struct{}

func (*BaseAccount) BaseToSpinnakerSettings

func (b *BaseAccount) BaseToSpinnakerSettings(a Account) map[string]interface{}

func (*BaseAccount) GetHash

func (b *BaseAccount) GetHash() (string, error)

type SpinnakerAccountType

type SpinnakerAccountType interface {
	GetType() interfaces.AccountType
	// Create account from CRD
	FromCRD(account interfaces.SpinnakerAccount) (Account, error)
	// Create account from Spinnaker config
	FromSpinnakerConfig(ctx context.Context, config map[string]interface{}) (Account, error)
	// Affected services
	GetServices() []string
	// Key under which accounts are stored in service
	GetAccountsKey() string
	// Key under which accounts are stored in profile/config
	GetConfigAccountsKey() string
	// GetValidationSettings returns validation settings if validation must happen
	GetValidationSettings(spinsvc interfaces.SpinnakerService) *interfaces.ValidationSetting
	// Key under which primary account is stored in service
	GetPrimaryAccountsKey() string
}

SpinnakerAccountType implements the logic for parsing SpinnakerAccount (CRD) objects. Accounts are the intermediary struct on which we'll perform validation and transformation. Each account type should be able to parse from SpinnakerAccount or from Spinnaker settings (map[string]interface{}). The account type also holds the information where to parse accounts from, where to save settings to (when serialized to Spinnaker settings), and how to get validation settings from a SpinnakerService.