fly

Documentation

Index

• Variables
• type AWSPipeline
  • func (a AWSPipeline) BuildPipelineParams(deployment, namespace, region, domain, allowIps, iaas string) (Pipeline, error)
  • func (a AWSPipeline) GetConfigTemplate() string
• type Client
  • func (client *Client) CanConnect() (bool, error)
  • func (client *Client) Cleanup() error
  • func (client *Client) SetDefaultPipeline(config config.ConfigView, allowFlyVersionDiscrepancy bool) error
• type Credentials
• type GCPPipeline
  • func (a GCPPipeline) BuildPipelineParams(deployment, namespace, region, domain, allowIps, iaas string) (Pipeline, error)
  • func (a GCPPipeline) GetConfigTemplate() string
• type IClient
  • func New(provider iaas.Provider, creds Credentials, stdout, stderr io.Writer, ...) (IClient, error)
• type Pipeline
  • func NewAWSPipeline() Pipeline
  • func NewGCPPipeline() Pipeline
• type PipelineTemplateParams

Variables

var ControlTowerVersion = "COMPILE_TIME_VARIABLE_fly_control_tower_version"

ControlTowerVersion is a compile-time variable set with -ldflags

Types

type AWSPipeline

type AWSPipeline struct {
	PipelineTemplateParams
}

AWSPipeline is AWS specific implementation of Pipeline interface

func (AWSPipeline) BuildPipelineParams

func (a AWSPipeline) BuildPipelineParams(deployment, namespace, region, domain, allowIps, iaas string) (Pipeline, error)

BuildPipelineParams builds params for AWS control-tower self update pipeline

func (AWSPipeline) GetConfigTemplate

func (a AWSPipeline) GetConfigTemplate() string

GetConfigTemplate returns template for AWS Control-Tower self update pipeline

type Client

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

Client represents a low-level wrapper for fly

func (*Client) CanConnect

func (client *Client) CanConnect() (bool, error)

CanConnect returns true if it can connect to the concourse

func (*Client) Cleanup

func (client *Client) Cleanup() error

Cleanup removes tempfiles

func (*Client) SetDefaultPipeline

func (client *Client) SetDefaultPipeline(config config.ConfigView, allowFlyVersionDiscrepancy bool) error

SetDefaultPipeline sets the default pipeline against a given concourse

type Credentials

type Credentials struct {
	Target   string
	API      string
	Username string
	Password string
	CACert   string
}

Credentials represents credentials needed to connect to concourse

type GCPPipeline

type GCPPipeline struct {
	PipelineTemplateParams
	GCPCreds string
}

GCPPipeline is GCP specific implementation of Pipeline interface

func (GCPPipeline) BuildPipelineParams

func (a GCPPipeline) BuildPipelineParams(deployment, namespace, region, domain, allowIps, iaas string) (Pipeline, error)

BuildPipelineParams builds params for AWS control-tower self update pipeline

func (GCPPipeline) GetConfigTemplate

func (a GCPPipeline) GetConfigTemplate() string

GetConfigTemplate returns template for AWS Control-Tower self update pipeline

type IClient

type IClient interface {
	CanConnect() (bool, error)
	SetDefaultPipeline(config config.ConfigView, allowFlyVersionDiscrepancy bool) error
	Cleanup() error
}

func New

func New(provider iaas.Provider, creds Credentials, stdout, stderr io.Writer, versionFile []byte) (IClient, error)

New returns a new fly client

type Pipeline

type Pipeline interface {
	BuildPipelineParams(deployment, namespace, region, domain, allowIps, iaas string) (Pipeline, error)
	GetConfigTemplate() string
}

Pipeline is interface for self update pipeline

func NewAWSPipeline

func NewAWSPipeline() Pipeline

NewAWSPipeline return AWSPipeline

func NewGCPPipeline

func NewGCPPipeline() Pipeline

NewGCPPipeline return GCPPipeline

type PipelineTemplateParams

type PipelineTemplateParams struct {
	ControlTowerVersion string
	Deployment          string
	Domain              string
	AllowIPs            string
	Namespace           string
	Region              string
	IaaS                string
}