fly

Documentation

Index

• Variables
• type Client
  • func (client *Client) CanConnect() (bool, error)
  • func (client *Client) Cleanup() error
  • func (client *Client) SetDefaultPipeline(deployArgs *config.DeployArgs, config *config.Config, ...) error
• type Credentials
• type IClient
  • func New(creds Credentials, stdout, stderr io.Writer) (IClient, error)

Variables

var DarwinBinaryURL = "COMPILE_TIME_VARIABLE_fly_darwin_binary_url"

DarwinBinaryURL is a compile-time variable set with -ldflags

var LinuxBinaryURL = "COMPILE_TIME_VARIABLE_fly_linux_binary_url"

LinuxBinaryURL is a compile-time variable set with -ldflags

var WindowsBinaryURL = "COMPILE_TIME_VARIABLE_fly_windows_binary_url"

WindowsBinaryURL is a compile-time variable set with -ldflags

Types

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(deployArgs *config.DeployArgs, config *config.Config, 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 IClient

type IClient interface {
	CanConnect() (bool, error)
	SetDefaultPipeline(deployArgs *config.DeployArgs, config *config.Config, allowFlyVersionDiscrepancy bool) error
	Cleanup() error
}

IClient represents an interface for a client

func New

func New(creds Credentials, stdout, stderr io.Writer) (IClient, error)

New returns a new fly client