seeker

Documentation

Index

• type AppInstance
• type AppMeta
• type Output
• type Seeker
  • func NewSeeker(conf *config.Config) (ret *Seeker, err error)
  • func (s *Seeker) BOSHConfigured() bool
  • func (s *Seeker) ByGUID(appGUID string) (string, error)
  • func (s *Seeker) ByOrgSpaceAndName(org, space, app string) (retGUID string, err error)
  • func (s *Seeker) FindInstances(guid string, inputErr error) (meta *AppMeta, inst []AppInstance, err error)
  • func (s *Seeker) GetVMWithIP(ip string) (vm *VMInfo, err error)
  • func (s *Seeker) InvalidateAll()
  • func (s *Seeker) SetTTL(ttl time.Duration)
• type VMCache
• type VMInfo

Types

type AppInstance

type AppInstance struct {
	Host string
	Port int
}

AppInstance has information from the CF API about an application

type AppMeta

type AppMeta struct {
	Name string
	GUID string
}

AppMeta has information about the pushed application itself, universal to all its instances

type Output

type Output interface {
	ReceiveJSON([]byte) error
}

Output is an output struct that knows how to take json and turn it into the fields of itself

type Seeker

type Seeker struct {
	CF *cfclient.Client
	// contains filtered or unexported fields
}

Seeker has constructs and functions necessary to find app locations in Cloud Foundry

func NewSeeker

func NewSeeker(conf *config.Config) (ret *Seeker, err error)

NewSeeker returns a NewSeeker with a client configured with the information in the given Config object

func (*Seeker) BOSHConfigured

func (s *Seeker) BOSHConfigured() bool

BOSHConfigured returns true if the attached configuration has all the keys required to attempt a connection to BOSH. False otherwise.

func (*Seeker) ByGUID

func (s *Seeker) ByGUID(appGUID string) (string, error)

ByGUID checks that the given appGUID is set, returning an error if not, and then passes through the given GUID, dereferenced.

func (*Seeker) ByOrgSpaceAndName

func (s *Seeker) ByOrgSpaceAndName(org, space, app string) (retGUID string, err error)

ByOrgSpaceAndName checks that the given variables are set, erroring if any of them are not, and then looks up the GUID of the app using the CF API.

func (*Seeker) FindInstances

func (s *Seeker) FindInstances(guid string, inputErr error) (meta *AppMeta, inst []AppInstance, err error)

FindInstances takes the App GUID given and queries the CF API to get the IP addresses of the VMs and listening ports on which the instances of the application are located and returns those. If inputErr is non-nil, the function will bail early with the given error.

func (*Seeker) GetVMWithIP

func (s *Seeker) GetVMWithIP(ip string) (vm *VMInfo, err error)

GetVMWithIP searches the BOSH director for the VM with the IP you've given An error is returned if a problem is encountered while contacting the BOSH director. If the VM simply could not be found in the configured deployments, no error is returned, but vm will be nil.

func (*Seeker) InvalidateAll

func (s *Seeker) InvalidateAll()

InvalidateAll wipes the entire cache

func (*Seeker) SetTTL

func (s *Seeker) SetTTL(ttl time.Duration)

SetTTL sets how long (in seconds) before cache entries are wiped.

type VMCache

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

VMCache contains the fields needed for caching VM information

type VMInfo

type VMInfo struct {
	JobName        string
	DeploymentName string
	IP             string
	Index          int
}

VMInfo contains information about a VM...