cf

Documentation

Index

• Constants
• func CopyFiles(appFiles []AppFile, fromDir, toDir string) (err error)
• func Name() string
• type AppFile
  • func AppFilesInDir(dir string) (appFiles []AppFile, err error)
• type AppSummary
• type Application
• type ApplicationInstance
• type ApplicationZipper
  • func (zipper ApplicationZipper) Zip(dirOrZipFile string, targetFile *os.File) (err error)
• type Buildpack
• type Domain
• type EndpointType
• type Event
• type InstanceState
• type Organization
• type Quota
• type Route
  • func (r Route) URL() string
• type ServiceAuthToken
• type ServiceBinding
• type ServiceBroker
• type ServiceInstance
  • func (inst ServiceInstance) IsUserProvided() bool
  • func (inst ServiceInstance) ServiceOffering() ServiceOffering
• type ServiceOffering
• type ServicePlan
• type Space
  • func (space Space) String() string
• type Stack
• type User
• type Zipper

Constants

const (
	Version = "6.0.0.rc1-SHA"
	Usage   = "A command line tool to interact with Cloud Foundry"
)

const (
	InstanceStarting InstanceState = "starting"
	InstanceRunning                = "running"
	InstanceFlapping               = "flapping"
	InstanceDown                   = "down"
)

const (
	UaaEndpointKey             EndpointType = "uaa"
	LoggregatorEndpointKey                  = "loggregator"
	CloudControllerEndpointKey              = "cloud_controller"
)

const (
	USER_EXISTS                 = "20002"
	USER_NOT_FOUND              = "20003"
	ORG_EXISTS                  = "30002"
	SPACE_EXISTS                = "40002"
	SERVICE_INSTANCE_NAME_TAKEN = "60002"
	APP_NOT_STAGED              = "170002"
	APP_STOPPED                 = "220001"
	BUILDPACK_EXISTS            = "290001"
)

Functions

func CopyFiles

func CopyFiles(appFiles []AppFile, fromDir, toDir string) (err error)

func Name

func Name() string

Types

type AppFile

type AppFile struct {
	Path string
	Sha1 string
	Size int64
}

func AppFilesInDir

func AppFilesInDir(dir string) (appFiles []AppFile, err error)

type AppSummary

type AppSummary struct {
	App       Application
	Instances []ApplicationInstance
}

type Application

type Application struct {
	Name             string
	Guid             string
	State            string
	Instances        int
	RunningInstances int
	Memory           uint64 // in Megabytes
	DiskQuota        uint64 // in Megabytes
	BuildpackUrl     string
	Stack            Stack
	EnvironmentVars  map[string]string
	Command          string
	Routes           []Route
}

type ApplicationInstance

type ApplicationInstance struct {
	State     InstanceState
	Since     time.Time
	CpuUsage  float64 // percentage
	DiskQuota uint64  // in bytes
	DiskUsage uint64
	MemQuota  uint64
	MemUsage  uint64
}

type ApplicationZipper

type ApplicationZipper struct{}

func (ApplicationZipper) Zip

func (zipper ApplicationZipper) Zip(dirOrZipFile string, targetFile *os.File) (err error)

type Buildpack

type Buildpack struct {
	Guid     string
	Name     string
	Position *int
}

type Domain

type Domain struct {
	Name   string
	Guid   string
	Shared bool
	Spaces []Space
}

type EndpointType

type EndpointType string

type Event

type Event struct {
	InstanceIndex   int
	Timestamp       time.Time
	ExitDescription string
	ExitStatus      int
}

type InstanceState

type InstanceState string

type Organization

type Organization struct {
	Name    string
	Guid    string
	Spaces  []Space
	Domains []Domain
}

type Quota

type Quota struct {
	Guid        string
	Name        string
	MemoryLimit uint64 // in Megabytes
}

type Route

type Route struct {
	Host     string
	Guid     string
	Domain   Domain
	Space    Space
	AppNames []string
}

func (Route) URL

func (r Route) URL() string

type ServiceAuthToken

type ServiceAuthToken struct {
	Guid     string
	Label    string
	Provider string
	Token    string
}

type ServiceBinding

type ServiceBinding struct {
	Guid    string
	Url     string
	AppGuid string
}

type ServiceBroker

type ServiceBroker struct {
	Guid     string
	Name     string
	Username string
	Password string
	Url      string
}

type ServiceInstance

type ServiceInstance struct {
	Name             string
	Guid             string
	ServiceBindings  []ServiceBinding
	ServicePlan      ServicePlan
	ApplicationNames []string
	Params           map[string]string
	SysLogDrainUrl   string
}

func (ServiceInstance) IsUserProvided

func (inst ServiceInstance) IsUserProvided() bool

func (ServiceInstance) ServiceOffering

func (inst ServiceInstance) ServiceOffering() ServiceOffering

type ServiceOffering

type ServiceOffering struct {
	Guid             string
	Label            string
	Provider         string
	Version          string
	Description      string
	DocumentationUrl string
	Plans            []ServicePlan
}

type ServicePlan

type ServicePlan struct {
	Name            string
	Guid            string
	ServiceOffering ServiceOffering
}

type Space

type Space struct {
	Name             string
	Guid             string
	Applications     []Application
	ServiceInstances []ServiceInstance
	Organization     Organization
	Domains          []Domain
}

func (Space) String

func (space Space) String() string

type Stack

type Stack struct {
	Name        string
	Guid        string
	Description string
}

type User

type User struct {
	Guid     string
	Username string
	Password string
	IsAdmin  bool
}

type Zipper

type Zipper interface {
	Zip(dirToZip string, targetFile *os.File) (err error)
}