deployment

Documentation

Index

• Constants
• func DryRun(ctx context.Context, azureDeployment *AzureDeployment) (*sdk.DryRunResult, error)
• type ArmDeployer
  • func (deployer *ArmDeployer) Begin(ctx context.Context, azureDeployment AzureDeployment) (*BeginAzureDeploymentResult, error)
  • func (deployer *ArmDeployer) Cancel(ctx context.Context, acd AzureCancelDeployment) (*AzureCancelDeploymentResult, error)
  • func (deployer *ArmDeployer) Redeploy(ctx context.Context, ad AzureRedeployment) (*AzureDeploymentResult, error)
  • func (deployer *ArmDeployer) Type() DeploymentType
  • func (deployer *ArmDeployer) Wait(ctx context.Context, resumeToken *ResumeToken) (*AzureDeploymentResult, error)
• type AzureCancelDeployment
• type AzureCancelDeploymentResult
• type AzureDeployment
  • func (ad *AzureDeployment) GetDeploymentType() DeploymentType
  • func (ad *AzureDeployment) GetParameters() map[string]interface{}
  • func (ad *AzureDeployment) GetParametersFromTemplate() map[string]interface{}
• type AzureDeploymentResult
• type AzureRedeployment
• type AzureTemplate
• type AzureTemplateParameters
• type BeginAzureDeploymentResult
• type Deployer
  • func NewDeployer(deploymentType DeploymentType, subscriptionId string) (Deployer, error)
• type DeploymentType
• type DryRunValidationInput
  • func (i DryRunValidationInput) GetParams() map[string]interface{}
  • func (i DryRunValidationInput) GetTemplateParams() map[string]interface{}
• type DryRunValidator
• type ExecutionStatus
• type LookupTag
• type LookupTagKey
• type LookupTags
• type ResumeToken
• type ValidatorFunc
  • func (f ValidatorFunc) Validate(input DryRunValidationInput) (*sdk.DryRunError, error)

Constants

const LookupPrefix = "modm."

const LookupTagKeyPublisherPrefix = "publisher."

Functions

func DryRun

func DryRun(ctx context.Context, azureDeployment *AzureDeployment) (*sdk.DryRunResult, error)

Types

type ArmDeployer

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

func (*ArmDeployer) Begin

func (deployer *ArmDeployer) Begin(ctx context.Context, azureDeployment AzureDeployment) (*BeginAzureDeploymentResult, error)

func (*ArmDeployer) Cancel

func (deployer *ArmDeployer) Cancel(ctx context.Context, acd AzureCancelDeployment) (*AzureCancelDeploymentResult, error)

func (*ArmDeployer) Redeploy

func (deployer *ArmDeployer) Redeploy(ctx context.Context, ad AzureRedeployment) (*AzureDeploymentResult, error)

func (*ArmDeployer) Type

func (deployer *ArmDeployer) Type() DeploymentType

func (*ArmDeployer) Wait

func (deployer *ArmDeployer) Wait(ctx context.Context, resumeToken *ResumeToken) (*AzureDeploymentResult, error)

type AzureCancelDeployment

type AzureCancelDeployment struct {
	SubscriptionId    string `json:"subscriptionId"`
	Location          string `json:"location"`
	ResourceGroupName string `json:"resourceGroupName"`
	DeploymentName    string `json:"deploymentName"`
}

type AzureCancelDeploymentResult

type AzureCancelDeploymentResult struct {
	CancelSubmitted bool `json:"cancelSubmitted"`
}

type AzureDeployment

type AzureDeployment struct {
	SubscriptionId    string                  `json:"subscriptionId"`
	Location          string                  `json:"location"`
	ResourceGroupName string                  `json:"resourceGroupName"`
	DeploymentName    string                  `json:"deploymentName"`
	DeploymentType    DeploymentType          `json:"deploymentType"`
	Template          AzureTemplate           `json:"template"`
	Params            AzureTemplateParameters `json:"templateParams"`
	Tags              map[string]*string      `json:"tags"`
	ResumeToken       string                  `json:"resumeToken"`
	OperationId       uuid.UUID               `json:"operationId"` //the modm operationId that triggered the deployment
}

func (*AzureDeployment) GetDeploymentType

func (ad *AzureDeployment) GetDeploymentType() DeploymentType

func (*AzureDeployment) GetParameters

func (ad *AzureDeployment) GetParameters() map[string]interface{}

func (*AzureDeployment) GetParametersFromTemplate

func (ad *AzureDeployment) GetParametersFromTemplate() map[string]interface{}

type AzureDeploymentResult

type AzureDeploymentResult struct {
	ID                string                 `json:"id"`
	CorrelationID     string                 `json:"correlationId"`
	Duration          string                 `json:"duration"`
	Timestamp         time.Time              `json:"timestamp"`
	ProvisioningState string                 `json:"provisioningState"`
	Outputs           map[string]interface{} `json:"outputs"`
	Status            ExecutionStatus
}

type AzureRedeployment

type AzureRedeployment struct {
	SubscriptionId    string             `json:"subscriptionId"`
	Location          string             `json:"location"`
	ResourceGroupName string             `json:"resourceGroupName"`
	DeploymentName    string             `json:"deploymentName"`
	Tags              map[string]*string `json:"tags"`
	OperationId       uuid.UUID          `json:"operationId"` //the modm operationId that triggered the deployment
}

type AzureTemplate

type AzureTemplate map[string]interface{}

type AzureTemplateParameters

type AzureTemplateParameters map[string]interface{}

type BeginAzureDeploymentResult

type BeginAzureDeploymentResult struct {
	CorrelationID *string     `json:"correlationId" mapstructure:"correlationId"`
	ResumeToken   ResumeToken `json:"resumeToken" mapstructure:"resumeToken"`
}

type Deployer

type Deployer interface {
	Begin(ctx context.Context, azureDeployment AzureDeployment) (*BeginAzureDeploymentResult, error)
	Wait(ctx context.Context, resumeToken *ResumeToken) (*AzureDeploymentResult, error)

	Redeploy(ctx context.Context, d AzureRedeployment) (*AzureDeploymentResult, error)
	Cancel(ctx context.Context, d AzureCancelDeployment) (*AzureCancelDeploymentResult, error)

	// gets the template type the deployer is set to
	Type() DeploymentType
}

deploys templates to Azure

func NewDeployer

func NewDeployer(deploymentType DeploymentType, subscriptionId string) (Deployer, error)

type DeploymentType

type DeploymentType int64

const (
	DeploymentTypeARM DeploymentType = iota
	// terraform not supported yet. stubbed only
	DeploymentTypeTerraform
)

type DryRunValidationInput

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

func (DryRunValidationInput) GetParams

func (i DryRunValidationInput) GetParams() map[string]interface{}

func (DryRunValidationInput) GetTemplateParams

func (i DryRunValidationInput) GetTemplateParams() map[string]interface{}

type DryRunValidator

type DryRunValidator interface {
	// Validates dry run input
	//	returns:
	//		- dryRunError: error that will be returned if there were no runtime errors, AND the validator failed. If there were no errors
	//			and the validator passed, then this will be nil
	//		- error: runtime error, so there won't be a dry run error returned by the validator
	//
	Validate(input DryRunValidationInput) (*sdk.DryRunError, error)
}

type ExecutionStatus

type ExecutionStatus string

const (
	Started           ExecutionStatus = "Started"
	Failed            ExecutionStatus = "Failed"
	PermanentlyFailed ExecutionStatus = "PermanentlyFailed"
	Succeeded         ExecutionStatus = "Succeeded"
	Restart           ExecutionStatus = "Restart"
	Restarted         ExecutionStatus = "Restarted"
	RestartTimedOut   ExecutionStatus = "RestartTimedOut"
	Canceled          ExecutionStatus = "Canceled"
)

type LookupTag

type LookupTag struct {
	Key   LookupTagKey
	Value *string
}

type LookupTagKey

type LookupTagKey string

const (

	// The unique id for modm to identify something
	LookupTagKeyId LookupTagKey = "modm.id"

	// the unique id for an instance of any operation executed by modm against one or more resources
	LookupTagKeyOperationId LookupTagKey = "modm.operation.id"

	// the unique id for an instance of any operation executed by modm against one or more resources
	LookupTagKeyDeploymentId LookupTagKey = "modm.deployment.id"

	// whether or not to send events, if this is not set to true, then the event will not be sent
	LookupTagKeyEvents LookupTagKey = "modm.events"

	// the friendly name of the resource used for logging
	LookupTagKeyName LookupTagKey = "modm.name"

	// the stage id reference. Use is on a resource that's a child of a 1-level parent deployment
	LookupTagKeyStageId LookupTagKey = "modm.stage.id"

	// the stage id reference. Use is on a resource that's a child of a 1-level parent deployment
	LookupTagKeyRetry LookupTagKey = "modm.retry"
)

type LookupTags

type LookupTags map[LookupTagKey]*string

type ResumeToken

type ResumeToken struct {
	SubscriptionId string `json:"subscriptionId" mapstructure:"subscriptionId"`
	Value          string `json:"value" mapstructure:"value"`
}

the resume token to resume waiting for an azure operation

type ValidatorFunc

type ValidatorFunc func(input DryRunValidationInput) (*sdk.DryRunError, error)

func (ValidatorFunc) Validate

func (f ValidatorFunc) Validate(input DryRunValidationInput) (*sdk.DryRunError, error)