migration_163

Documentation

Index

• type AggregatePlan
  • func (plan AggregatePlan) Public() *json.RawMessage
• type DependentGetPlan
  • func (plan DependentGetPlan) Public() *json.RawMessage
• type DoPlan
  • func (plan DoPlan) Public() *json.RawMessage
• type EnsurePlan
  • func (plan EnsurePlan) Public() *json.RawMessage
• type GetPlan
  • func (plan GetPlan) Public() *json.RawMessage
• type ImageResource
• type LoadConfig
• type LoadTaskConfig
• type MetadataField
• type OnFailurePlan
  • func (plan OnFailurePlan) Public() *json.RawMessage
• type OnSuccessPlan
  • func (plan OnSuccessPlan) Public() *json.RawMessage
• type Params
• type Plan
  • func (plan Plan) Public() *json.RawMessage
• type PlanID
• type PutPlan
  • func (plan PutPlan) Public() *json.RawMessage
• type ResourceType
• type RetryPlan
  • func (plan RetryPlan) Public() *json.RawMessage
• type Source
• type Tags
• type TaskConfig
• type TaskInputConfig
• type TaskOutputConfig
• type TaskPlan
  • func (plan TaskPlan) Public() *json.RawMessage
• type TaskRunConfig
• type TimeoutPlan
  • func (plan TimeoutPlan) Public() *json.RawMessage
• type TryPlan
  • func (plan TryPlan) Public() *json.RawMessage
• type Version
• type VersionedResourceType
• type VersionedResourceTypes

Types

type AggregatePlan

type AggregatePlan []Plan

func (AggregatePlan) Public

func (plan AggregatePlan) Public() *json.RawMessage

type DependentGetPlan

type DependentGetPlan struct {
	Type     string `json:"type"`
	Name     string `json:"name,omitempty"`
	Resource string `json:"resource"`
}

func (DependentGetPlan) Public

func (plan DependentGetPlan) Public() *json.RawMessage

type DoPlan

type DoPlan []Plan

func (DoPlan) Public

func (plan DoPlan) Public() *json.RawMessage

type EnsurePlan

type EnsurePlan struct {
	Step Plan `json:"step"`
	Next Plan `json:"ensure"`
}

func (EnsurePlan) Public

func (plan EnsurePlan) Public() *json.RawMessage

type GetPlan

type GetPlan struct {
	Type        string   `json:"type"`
	Name        string   `json:"name,omitempty"`
	Resource    string   `json:"resource"`
	Source      Source   `json:"source"`
	Params      Params   `json:"params,omitempty"`
	Version     *Version `json:"version,omitempty"`
	VersionFrom *PlanID  `json:"version_from,omitempty"`
	Tags        Tags     `json:"tags,omitempty"`

	VersionedResourceTypes VersionedResourceTypes `json:"resource_types,omitempty"`
}

func (GetPlan) Public

func (plan GetPlan) Public() *json.RawMessage

type ImageResource

type ImageResource struct {
	Type   string `yaml:"type" json:"type" mapstructure:"type"`
	Source Source `yaml:"source" json:"source" mapstructure:"source"`
}

type LoadConfig

type LoadConfig struct {
	Path string `yaml:"load,omitempty" json:"load,omitempty" mapstructure:"load"`
}

type LoadTaskConfig

type LoadTaskConfig struct {
	*LoadConfig
	*TaskConfig
}

type MetadataField

type MetadataField struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type OnFailurePlan

type OnFailurePlan struct {
	Step Plan `json:"step"`
	Next Plan `json:"on_failure"`
}

func (OnFailurePlan) Public

func (plan OnFailurePlan) Public() *json.RawMessage

type OnSuccessPlan

type OnSuccessPlan struct {
	Step Plan `json:"step"`
	Next Plan `json:"on_success"`
}

func (OnSuccessPlan) Public

func (plan OnSuccessPlan) Public() *json.RawMessage

type Params

type Params map[string]interface{}

type Plan

type Plan struct {
	ID       PlanID `json:"id"`
	Attempts []int  `json:"attempts,omitempty"`

	Aggregate *AggregatePlan `json:"aggregate,omitempty"`
	Do        *DoPlan        `json:"do,omitempty"`
	Get       *GetPlan       `json:"get,omitempty"`
	Put       *PutPlan       `json:"put,omitempty"`
	Task      *TaskPlan      `json:"task,omitempty"`
	Ensure    *EnsurePlan    `json:"ensure,omitempty"`
	OnSuccess *OnSuccessPlan `json:"on_success,omitempty"`
	OnFailure *OnFailurePlan `json:"on_failure,omitempty"`
	Try       *TryPlan       `json:"try,omitempty"`
	Timeout   *TimeoutPlan   `json:"timeout,omitempty"`
	Retry     *RetryPlan     `json:"retry,omitempty"`

	// deprecated, kept for backwards compatibility to be able to show old builds
	DependentGet *DependentGetPlan `json:"dependent_get,omitempty"`
}

func (Plan) Public

func (plan Plan) Public() *json.RawMessage

type PlanID

type PlanID string

type PutPlan

type PutPlan struct {
	Type     string `json:"type"`
	Name     string `json:"name,omitempty"`
	Resource string `json:"resource"`
	Source   Source `json:"source"`
	Params   Params `json:"params,omitempty"`
	Tags     Tags   `json:"tags,omitempty"`

	VersionedResourceTypes VersionedResourceTypes `json:"resource_types,omitempty"`
}

func (PutPlan) Public

func (plan PutPlan) Public() *json.RawMessage

type ResourceType

type ResourceType struct {
	Name       string `yaml:"name" json:"name" mapstructure:"name"`
	Type       string `yaml:"type" json:"type" mapstructure:"type"`
	Source     Source `yaml:"source" json:"source" mapstructure:"source"`
	Privileged bool   `yaml:"privileged,omitempty" json:"privileged" mapstructure:"privileged"`
	Tags       Tags   `yaml:"tags,omitempty" json:"tags" mapstructure:"tags"`
}

type RetryPlan

type RetryPlan []Plan

func (RetryPlan) Public

func (plan RetryPlan) Public() *json.RawMessage

type Source

type Source map[string]interface{}

type Tags

type Tags []string

type TaskConfig

type TaskConfig struct {
	// The platform the task must run on (e.g. linux, windows).
	Platform string `json:"platform,omitempty" yaml:"platform,omitempty" mapstructure:"platform"`

	// Optional string specifying an image to use for the build. Depending on the
	// platform, this may or may not be required (e.g. Windows/OS X vs. Linux).
	RootfsURI string `json:"rootfs_uri,omitempty" yaml:"rootfs_uri,omitempty" mapstructure:"rootfs_uri"`

	ImageResource *ImageResource `json:"image_resource,omitempty" yaml:"image_resource,omitempty" mapstructure:"image_resource"`

	// Parameters to pass to the task via environment variables.
	Params map[string]string `json:"params,omitempty" yaml:"params,omitempty" mapstructure:"params"`

	// Script to execute.
	Run TaskRunConfig `json:"run,omitempty" yaml:"run,omitempty" mapstructure:"run"`

	// The set of (logical, name-only) inputs required by the task.
	Inputs []TaskInputConfig `json:"inputs,omitempty" yaml:"inputs,omitempty" mapstructure:"inputs"`

	// The set of (logical, name-only) outputs provided by the task.
	Outputs []TaskOutputConfig `json:"outputs,omitempty" yaml:"outputs,omitempty" mapstructure:"outputs"`
}

type TaskInputConfig

type TaskInputConfig struct {
	Name string `json:"name" yaml:"name"`
	Path string `json:"path,omitempty" yaml:"path"`
}

type TaskOutputConfig

type TaskOutputConfig struct {
	Name string `json:"name" yaml:"name"`
	Path string `json:"path,omitempty" yaml:"path"`
}

type TaskPlan

type TaskPlan struct {
	Name string `json:"name,omitempty"`

	Privileged bool `json:"privileged"`
	Tags       Tags `json:"tags,omitempty"`

	ConfigPath string          `json:"config_path,omitempty"`
	Config     *LoadTaskConfig `json:"config,omitempty"`

	Params            Params            `json:"params,omitempty"`
	InputMapping      map[string]string `json:"input_mapping,omitempty"`
	OutputMapping     map[string]string `json:"output_mapping,omitempty"`
	ImageArtifactName string            `json:"image,omitempty"`

	VersionedResourceTypes VersionedResourceTypes `json:"resource_types,omitempty"`
}

func (TaskPlan) Public

func (plan TaskPlan) Public() *json.RawMessage

type TaskRunConfig

type TaskRunConfig struct {
	Path string   `json:"path" yaml:"path"`
	Args []string `json:"args,omitempty" yaml:"args"`
	Dir  string   `json:"dir,omitempty" yaml:"dir"`

	// The user that the task will run as (defaults to whatever the docker image specifies)
	User string `json:"user,omitempty" yaml:"user,omitempty" mapstructure:"user"`
}

type TimeoutPlan

type TimeoutPlan struct {
	Step     Plan   `json:"step"`
	Duration string `json:"duration"`
}

func (TimeoutPlan) Public

func (plan TimeoutPlan) Public() *json.RawMessage

type TryPlan

type TryPlan struct {
	Step Plan `json:"step"`
}

func (TryPlan) Public

func (plan TryPlan) Public() *json.RawMessage

type Version

type Version map[string]string

type VersionedResourceType

type VersionedResourceType struct {
	ResourceType

	Version Version `yaml:"version" json:"version" mapstructure:"version"`
}

type VersionedResourceTypes

type VersionedResourceTypes []VersionedResourceType