structs

Documentation

Overview

Package structs contains structs that are reused in multiple locations.

Index

• type DeployEventData
• type DeploymentInfo
• type Environment
• type ErrorMatcherDescriptor
• type PrecheckerEventData
• type PushEventData
• type StopEventData

Types

type DeployEventData

type DeployEventData struct {
	// Writer is being deprecated in favor of using Response as a ReadWriter. 01/03/2017
	Writer io.Writer

	Response       io.ReadWriter
	DeploymentInfo *DeploymentInfo
	RequestBody    io.Reader
}

DeployEventData has a RequestBody and DeploymentInfo.

type DeploymentInfo

type DeploymentInfo struct {
	ArtifactURL          string `json:"artifact_url"`
	Manifest             string `json:"manifest"`
	Username             string
	Password             string
	Environment          string
	Org                  string
	Space                string
	AppName              string
	UUID                 string
	SkipSSL              bool
	Instances            uint16
	Domain               string
	AppPath              string
	ContentType          string
	Body                 io.Reader
	EnvironmentVariables map[string]string `json:"environment_variables"`
	HealthCheckEndpoint  string            `json:"health_check_endpoint"`
	CustomParams         map[string]interface{}

	// Generic map used for users to provide their own deployment properties in JSON format.
	Data map[string]interface{} `json:"data"`
}

DeploymentInfo is a collection of properties necessary for a deployment.

type Environment

type Environment struct {
	Name           string
	Domain         string
	Foundations    []string `yaml:",flow"`
	Authenticate   bool
	SkipSSL        bool `yaml:"skip_ssl"`
	Instances      uint16
	EnableRollback bool                   `yaml:"rollback_enabled"`
	CustomParams   map[string]interface{} `yaml:"custom_params"`
}

Environment is representation of a single environment configuration.

type ErrorMatcherDescriptor

type ErrorMatcherDescriptor struct {
	Description string `yaml:"description"`
	Pattern     string `yaml:"pattern"`
	Solution    string `yaml:"solution"`
	Code        string `yaml:"code"`
}

type PrecheckerEventData

type PrecheckerEventData struct {
	Environment Environment
	Description string
}

PrecheckerEventData has Environment variables and a description.

type PushEventData

type PushEventData struct {
	AppPath         string
	FoundationURL   string
	TempAppWithUUID string

	DeploymentInfo *DeploymentInfo
	Courier        interface{}
	Response       io.ReadWriter
}

PushEventData has a RequestBody and DeploymentInfo.

type StopEventData

type StopEventData struct {
	Response       io.ReadWriter
	DeploymentInfo *DeploymentInfo
}