Documentation
¶
Index ¶
- Constants
- func AppUUID(name string) string
- func AssertAppIsDeleted(appName string)
- func BindAppToService(appName string, instance string)
- func BindAppToServiceWithUsername(appName, instance, username string)
- func BoundAppGUIDs(instanceGUID string) []string
- func CheckAppInfo(skipSSLValidation bool, appURI string, instance string)
- func CheckForRequiredEnvVars(envs []string)
- func CreateAndBindServiceToApp(serviceName, planName, appName, appPath, instanceName string)
- func CreateInstanceAndWait(args ...string) string
- func CreateService(serviceName string, planName string, name string, args ...string)
- func CreateServiceKey(instanceName, keyName string)
- func DeleteApp(appName string)
- func DeleteAppAndService(appName, instance string)
- func DeleteInstanceAndWait(instanceName string)
- func DeleteService(name string)
- func DeleteServiceKey(instanceName, keyName string)
- func DeployApp(appName string)
- func DownloadManifest(deploymentName string) string
- func ExecuteBosh(args []string, timeout time.Duration) *gexec.Session
- func ExecuteBoshNoOutput(args []string, timeout time.Duration) *gexec.Session
- func ExecuteCfCmd(args ...string) string
- func ExecuteMysqlQuery(deploymentName, instanceIndex, userName, password, sqlQuery string) *gexec.Session
- func ExecuteMysqlQueryAsAdmin(deploymentName, instanceIndex, sqlQuery string) string
- func GetDeploymentName(instanceName string) string
- func GetManifestValue(deploymentName, xPath string) string
- func InstanceDeploymentName(instanceUUID string) string
- func InstanceUUID(name string) string
- func Interpolate(manifestPath string, selector string) string
- func ManageInstanceProcesses(deploymentName, task, instance string)
- func MustSucceed(session *gexec.Session) *gexec.Session
- func OpenDatabaseTunnelToApp(port int, appName string, serviceKey ServiceKey) context.CancelFunc
- func ProperYaml(improperYaml string) []byte
- func PushApp(appName, appCodePath string)
- func ReadData(skipSSLValidation bool, appURI string, id string) string
- func ResourceExists(resourceType string, resourceName string) bool
- func StartApp(appName string)
- func UnbindAppFromService(appName string, instance string)
- func WaitForService(name string, success string)
- func WriteData(skipSSLValidation bool, appURI string, value string) string
- type BindingResult
- type Entity
- type Instance
- type Resource
- type ServiceKey
Constants ¶
const (
BoshPath = "/usr/local/bin/bosh"
)
Variables ¶
This section is empty.
Functions ¶
func AssertAppIsDeleted ¶
func AssertAppIsDeleted(appName string)
func BindAppToService ¶
func BindAppToServiceWithUsername ¶
func BindAppToServiceWithUsername(appName, instance, username string)
func BoundAppGUIDs ¶
func CheckAppInfo ¶
func CheckForRequiredEnvVars ¶
func CheckForRequiredEnvVars(envs []string)
CheckForRequiredEnvVars asserts that environment variables in envs must be set to a non-empty string. If any environment variable in the slice is not set, an error will be returned denoting which variable is unset.
func CreateAndBindServiceToApp ¶
func CreateAndBindServiceToApp(serviceName, planName, appName, appPath, instanceName string)
func CreateInstanceAndWait ¶
func CreateService ¶
func CreateServiceKey ¶
func CreateServiceKey(instanceName, keyName string)
func DeleteAppAndService ¶
func DeleteAppAndService(appName, instance string)
func DeleteInstanceAndWait ¶
func DeleteInstanceAndWait(instanceName string)
func DeleteService ¶
func DeleteService(name string)
func DeleteServiceKey ¶
func DeleteServiceKey(instanceName, keyName string)
func DownloadManifest ¶
DownloadManifest downloads the manifest for deployment deploymentName into a temporary file. It returns the filename path as a string. It is up to the caller to delete this file when they are done with the manifest.
func ExecuteBoshNoOutput ¶
func ExecuteCfCmd ¶
func ExecuteMysqlQuery ¶
func ExecuteMysqlQuery(deploymentName, instanceIndex, userName, password, sqlQuery string) *gexec.Session
ExecuteMysqlQuery executes sqlQuery against the MySQL deployment denoted by deploymentName and instance instanceIndex, using credentials in userName and password. It returns a pointer to a gexec.Session to be consumed.
func ExecuteMysqlQueryAsAdmin ¶
ExecuteMysqlQueryAsAdmin is a convenience function for calling ExecuteMysqlQuery as the admin user, asserting that the mysql command exits cleanly and returns the output as a string
func GetDeploymentName ¶
func GetManifestValue ¶
GetManifestValue fetches a value from deploymentName's manifest at the path xPath
func InstanceDeploymentName ¶
func InstanceUUID ¶
func Interpolate ¶
Interpolate interpolates the xPath selector against the manifest file at manifestPath and returns the resulting YAML as a string.
func ManageInstanceProcesses ¶
func ManageInstanceProcesses(deploymentName, task, instance string)
func OpenDatabaseTunnelToApp ¶
func OpenDatabaseTunnelToApp(port int, appName string, serviceKey ServiceKey) context.CancelFunc
func ProperYaml ¶
func ResourceExists ¶
func UnbindAppFromService ¶
func WaitForService ¶
Types ¶
type BindingResult ¶
type BindingResult struct {
Resources []Resource `json:"resources"`
}
type Instance ¶
func FindFollower ¶
FindFollower find a follower VM in deploymentName
func FindLeader ¶
FindLeader find a leader VM in deploymentName
type ServiceKey ¶
type ServiceKey struct {
Hostname string `json:"hostname"`
JbdcUrl string `json:"jbdcUrl"`
Name string `json:"name"`
Password string `json:"password"`
Port int `json:"port"`
Uri string `json:"uri"`
Username string `json:"username"`
TLS struct {
Cert struct {
CA string
}
}
}
func GetServiceKey ¶
func GetServiceKey(serviceInstanceName, serviceKeyName string) ServiceKey