Documentation ¶
Index ¶
- Constants
- func NewBoshTaskOutputReporter() director.TaskReporter
- type AsyncTaskReporter
- type AuthenticationOptions
- type BOSHDeployment
- type BoshConfig
- type BoshEvent
- type BoshHTTP
- type BoshTask
- type BoshTaskOutput
- type BoshTaskOutputReporter
- type BoshTasks
- type CertAppender
- type Client
- func (c *Client) DeleteConfig(configType, configName string, logger *log.Logger) (bool, error)
- func (c *Client) DeleteConfigs(configName string, logger *log.Logger) error
- func (c *Client) DeleteDeployment(name, contextID string, force bool, taskReporter *AsyncTaskReporter, ...) (int, error)
- func (c *Client) Deploy(manifest []byte, contextID string, logger *log.Logger, ...) (int, error)
- func (c *Client) Director(taskReporter director.TaskReporter) (director.Director, error)
- func (c *Client) GetConfigs(configName string, logger *log.Logger) ([]BoshConfig, error)
- func (c *Client) GetDNSAddresses(deploymentName string, dnsRequest []config.BindingDNS) (map[string]string, error)
- func (c *Client) GetDeployment(name string, logger *log.Logger) ([]byte, bool, error)
- func (c *Client) GetDeployments(logger *log.Logger) ([]Deployment, error)
- func (c *Client) GetEvents(deploymentName string, action string, logger *log.Logger) ([]BoshEvent, error)
- func (c *Client) GetInfo(logger *log.Logger) (Info, error)
- func (c *Client) GetNormalisedTasksByContext(deploymentName, contextID string, logger *log.Logger) (BoshTasks, error)
- func (c *Client) GetTask(taskID int, logger *log.Logger) (BoshTask, error)
- func (c *Client) GetTaskOutput(taskID int, logger *log.Logger) (BoshTaskOutput, error)
- func (c *Client) GetTasksInProgress(deploymentName string, logger *log.Logger) (BoshTasks, error)
- func (c *Client) Recreate(deploymentName, contextID string, logger *log.Logger, ...) (int, error)
- func (c *Client) RunErrand(deploymentName, errandName string, errandInstances []string, contextID string, ...) (int, error)
- func (c *Client) UpdateConfig(configType, configName string, configContent []byte, logger *log.Logger) error
- func (c *Client) VMs(deploymentName string, logger *log.Logger) (bosh.BoshVMs, error)
- func (c *Client) Variables(deploymentName string, logger *log.Logger) ([]Variable, error)
- func (c *Client) VerifyAuth(logger *log.Logger) error
- type DNSRetriever
- type DNSRetrieverFactory
- type Deployment
- type DeploymentNotFoundError
- type Director
- type DirectorFactory
- type HTTP
- type HTTPFactory
- type Info
- type Instance
- type RequestError
- type Task
- type TaskStateType
- type UAA
- type UAAFactory
- type UserAuthentication
- type Variable
- type Version
- type VersionType
Constants ¶
View Source
const ( StemcellDirectorVersionType = VersionType("stemcell") SemverDirectorVersionType = VersionType("semver") )
View Source
const ( TaskQueued = "queued" TaskProcessing = "processing" TaskDone = "done" TaskError = "error" TaskCancelled = "cancelled" TaskCancelling = "cancelling" TaskTimeout = "timeout" TaskComplete TaskStateType = iota TaskIncomplete TaskFailed TaskUnknown )
Variables ¶
This section is empty.
Functions ¶
func NewBoshTaskOutputReporter ¶ added in v0.20.0
func NewBoshTaskOutputReporter() director.TaskReporter
Types ¶
type AsyncTaskReporter ¶ added in v0.20.0
func NewAsyncTaskReporter ¶ added in v0.20.0
func NewAsyncTaskReporter() *AsyncTaskReporter
func (*AsyncTaskReporter) TaskFinished ¶ added in v0.20.0
func (r *AsyncTaskReporter) TaskFinished(taskID int, state string)
func (*AsyncTaskReporter) TaskOutputChunk ¶ added in v0.20.0
func (r *AsyncTaskReporter) TaskOutputChunk(taskID int, chunk []byte)
func (*AsyncTaskReporter) TaskStarted ¶ added in v0.20.0
func (r *AsyncTaskReporter) TaskStarted(taskID int)
type AuthenticationOptions ¶ added in v0.17.2
type AuthenticationOptions struct {
URL string
}
type BOSHDeployment ¶ added in v0.20.0
type BOSHDeployment interface { director.Deployment }
type BoshConfig ¶ added in v0.26.0
type BoshHTTP ¶ added in v0.22.0
type BoshHTTP struct {
// contains filtered or unexported fields
}
type BoshTask ¶
type BoshTask struct { ID int State string Description string Result string ContextID string `json:"context_id,omitempty"` }
func (BoshTask) StateType ¶
func (t BoshTask) StateType() TaskStateType
type BoshTaskOutput ¶
type BoshTaskOutputReporter ¶ added in v0.20.0
type BoshTaskOutputReporter struct { Output BoshTaskOutput Logger *log.Logger // contains filtered or unexported fields }
func (*BoshTaskOutputReporter) TaskFinished ¶ added in v0.20.0
func (r *BoshTaskOutputReporter) TaskFinished(taskID int, state string)
func (*BoshTaskOutputReporter) TaskOutputChunk ¶ added in v0.20.0
func (r *BoshTaskOutputReporter) TaskOutputChunk(taskID int, chunk []byte)
func (*BoshTaskOutputReporter) TaskStarted ¶ added in v0.20.0
func (r *BoshTaskOutputReporter) TaskStarted(taskID int)
type BoshTasks ¶
type BoshTasks []BoshTask
func (BoshTasks) AllTasksAreDone ¶ added in v0.32.0
func (BoshTasks) FailedTasks ¶
func (BoshTasks) IncompleteTasks ¶
type CertAppender ¶ added in v0.18.0
type Client ¶
type Client struct { PollingInterval time.Duration BoshInfo Info // contains filtered or unexported fields }
func New ¶
func New(url string, trustedCertPEM []byte, certAppender CertAppender, directorFactory DirectorFactory, uaaFactory UAAFactory, boshAuth config.Authentication, dnsRetrieverFactory DNSRetrieverFactory, boshHTTPFactory HTTPFactory, logger *log.Logger) (*Client, error)
func (*Client) DeleteConfig ¶ added in v0.26.0
func (*Client) DeleteConfigs ¶ added in v0.26.0
func (*Client) DeleteDeployment ¶
func (*Client) GetConfigs ¶ added in v0.26.0
func (*Client) GetDNSAddresses ¶ added in v0.22.0
func (*Client) GetDeployment ¶
func (*Client) GetDeployments ¶
func (c *Client) GetDeployments(logger *log.Logger) ([]Deployment, error)
func (*Client) GetNormalisedTasksByContext ¶
func (*Client) GetTaskOutput ¶
func (*Client) GetTasksInProgress ¶ added in v0.38.0
func (*Client) UpdateConfig ¶ added in v0.26.0
type DNSRetriever ¶ added in v0.22.0
type DNSRetrieverFactory ¶ added in v0.22.0
type DNSRetrieverFactory func(HTTP) DNSRetriever
type Deployment ¶
type Deployment struct {
Name string
}
type DeploymentNotFoundError ¶
type DeploymentNotFoundError struct {
// contains filtered or unexported fields
}
type DirectorFactory ¶ added in v0.19.0
type DirectorFactory interface {
New(config director.FactoryConfig, taskReporter director.TaskReporter, fileReporter director.FileReporter) (director.Director, error)
}
type HTTP ¶ added in v0.22.0
type HTTP interface { RawGet(path string) (string, error) RawPost(path, data, contentType string) (string, error) RawDelete(path string) (string, error) }
func NewBoshHTTP ¶ added in v0.22.0
type HTTPFactory ¶ added in v0.22.0
type Info ¶
type Info struct { Version string UserAuthentication UserAuthentication `json:"user_authentication"` }
func (*Info) GetDirectorVersion ¶ added in v0.17.2
type RequestError ¶
type RequestError struct {
// contains filtered or unexported fields
}
func NewRequestError ¶
func NewRequestError(e error) RequestError
type TaskStateType ¶
type TaskStateType int
type UAAFactory ¶ added in v0.19.0
type UserAuthentication ¶ added in v0.17.2
type UserAuthentication struct {
Options AuthenticationOptions
}
type Version ¶
type Version struct { Version semver.Version Type VersionType }
type VersionType ¶
type VersionType string
Source Files ¶
Click to show internal directories.
Click to hide internal directories.