rc

Documentation

Index

• Variables
• func DeleteTarget(targetName TargetName) error
• func LoadTargets() (*targetDetailsYAML, error)
• func SaveTarget(targetName TargetName, api string, insecure bool, teamName string, ...) error
• type ErrVersionMismatch
  • func NewErrVersionMismatch(flyVersion string, atcVersion string, targetName TargetName) ErrVersionMismatch
  • func (e ErrVersionMismatch) Error() string
• type Target
  • func LoadTarget(selectedTarget TargetName) (Target, error)
  • func LoadTargetWithInsecure(selectedTarget TargetName, teamName string, commandInsecure bool, ...) (Target, error)
  • func NewBasicAuthTarget(name TargetName, url string, teamName string, insecure bool, username string, ...) (Target, error)
  • func NewNoAuthTarget(name TargetName, url string, teamName string, insecure bool, caCert string) (Target, error)
  • func NewUnauthenticatedTarget(name TargetName, url string, teamName string, insecure bool, caCert string) (Target, error)
• type TargetName
  • func (name *TargetName) Complete(match string) []flags.Completion
  • func (name *TargetName) UnmarshalFlag(value string) error
• type TargetProps
• type TargetToken
• type UnknownTargetError
  • func (err UnknownTargetError) Error() string

Variables

var ErrNoTargetSpecified = errors.New("no target specified")

Functions

func DeleteTarget

func DeleteTarget(targetName TargetName) error

func LoadTargets

func LoadTargets() (*targetDetailsYAML, error)

func SaveTarget

func SaveTarget(
	targetName TargetName,
	api string,
	insecure bool,
	teamName string,
	token *TargetToken,
	caCert string,
) error

Types

type ErrVersionMismatch

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

func NewErrVersionMismatch

func NewErrVersionMismatch(flyVersion string, atcVersion string, targetName TargetName) ErrVersionMismatch

func (ErrVersionMismatch) Error

func (e ErrVersionMismatch) Error() string

type Target

type Target interface {
	Client() concourse.Client
	Team() concourse.Team
	CACert() string
	Validate() error
	ValidateWithWarningOnly() error
	TLSConfig() *tls.Config
	URL() string
	WorkerVersion() (string, error)
	IsWorkerVersionCompatible(string) (bool, error)
	Token() *TargetToken
	TokenAuthorization() (string, bool)
}

func LoadTarget

func LoadTarget(selectedTarget TargetName) (Target, error)

func LoadTargetWithInsecure

func LoadTargetWithInsecure(
	selectedTarget TargetName,
	teamName string,
	commandInsecure bool,
	caCert string,
) (Target, error)

func NewBasicAuthTarget

func NewBasicAuthTarget(
	name TargetName,
	url string,
	teamName string,
	insecure bool,
	username string,
	password string,
	caCert string,
) (Target, error)

func NewNoAuthTarget

func NewNoAuthTarget(
	name TargetName,
	url string,
	teamName string,
	insecure bool,
	caCert string,
) (Target, error)

func NewUnauthenticatedTarget

func NewUnauthenticatedTarget(
	name TargetName,
	url string,
	teamName string,
	insecure bool,
	caCert string,
) (Target, error)

type TargetName

type TargetName string

func (*TargetName) Complete

func (name *TargetName) Complete(match string) []flags.Completion

func (*TargetName) UnmarshalFlag

func (name *TargetName) UnmarshalFlag(value string) error

type TargetProps

type TargetProps struct {
	API      string       `yaml:"api"`
	TeamName string       `yaml:"team"`
	Insecure bool         `yaml:"insecure,omitempty"`
	Token    *TargetToken `yaml:"token,omitempty"`
	CACert   string       `yaml:"ca_cert,omitempty"`
}

type TargetToken

type TargetToken struct {
	Type  string `yaml:"type"`
	Value string `yaml:"value"`
}

type UnknownTargetError

type UnknownTargetError struct {
	TargetName TargetName
}

func (UnknownTargetError) Error

func (err UnknownTargetError) Error() string