environments

Documentation

Index

• Constants
• func AttachResourceURIsToAzureStatus(status *AzureDeploymentStatus, resourceGroupName string, environment string)
• func GetAzureStatus(status AzureDeploymentStatus, environment string) string
• func IsAzureEnvironment(environment string) bool
• func IsValidEnvironment(environment string) bool
• func ReportAzureStatus(status AzureDeploymentStatus, environment string)
• type AzureCodeBlock
• type AzureDeploymentStatus
  • func NewAzureDeploymentStatus() AzureDeploymentStatus
  • func (status *AzureDeploymentStatus) AddResourceURI(uri string)
  • func (status *AzureDeploymentStatus) AddStep(step string, codeBlocks []AzureCodeBlock)
  • func (status *AzureDeploymentStatus) AsJsonString() (string, error)
  • func (status *AzureDeploymentStatus) SetError(err error)
• type AzureStep

Constants

const (
	EnvironmentsLocal = "local"
	EnvironmentsCI    = "ci"
	EnvironmentsOCD   = "ocd"
	EnvironmentsAzure = "azure"
)

Functions

func AttachResourceURIsToAzureStatus

func AttachResourceURIsToAzureStatus(
	status *AzureDeploymentStatus,
	resourceGroupName string,
	environment string,
)

Attach deployed resource URIs to the one click deployment status if we're in the correct environment & we have a resource group name.

func GetAzureStatus

func GetAzureStatus(status AzureDeploymentStatus, environment string) string

Same as ReportAzureStatus, but returns the status string instead of printing it.

func IsAzureEnvironment

func IsAzureEnvironment(environment string) bool

func IsValidEnvironment

func IsValidEnvironment(environment string) bool

Check if the environment is valid.

func ReportAzureStatus

func ReportAzureStatus(status AzureDeploymentStatus, environment string)

Print out the status JSON for azure/cloudshell if in the correct environment.

Types

type AzureCodeBlock

type AzureCodeBlock struct {
	Description string `json:"description"`
	Command     string `json:"command"`
}

codeblock metadata needed for learn mode deployments.

type AzureDeploymentStatus

type AzureDeploymentStatus struct {
	Steps        []AzureStep `json:"steps"`
	CurrentStep  int         `json:"currentStep"`
	Status       string      `json:"status"`
	ResourceURIs []string    `json:"resourceURIs"`
	Error        string      `json:"error"`
}

The status of a one-click deployment or learn mode deployment.

func NewAzureDeploymentStatus

func NewAzureDeploymentStatus() AzureDeploymentStatus

func (*AzureDeploymentStatus) AddResourceURI

func (status *AzureDeploymentStatus) AddResourceURI(uri string)

func (*AzureDeploymentStatus) AddStep

func (status *AzureDeploymentStatus) AddStep(step string, codeBlocks []AzureCodeBlock)

func (*AzureDeploymentStatus) AsJsonString

func (status *AzureDeploymentStatus) AsJsonString() (string, error)

Get the status as a JSON string.

func (*AzureDeploymentStatus) SetError

func (status *AzureDeploymentStatus) SetError(err error)

type AzureStep

type AzureStep struct {
	Name       string           `json:"name"`
	CodeBlocks []AzureCodeBlock `json:"codeblocks"`
}

Step metadata needed for learn mode deployments.