Documentation ¶
Overview ¶
Package v7action contains the business logic for the commands/v3 package
Index ¶
- Constants
- func Zipit(source, target, prefix string) error
- type Actor
- func (actor Actor) ApplyApplicationManifest(parser ManifestParser, spaceGUID string) (Warnings, error)
- func (actor Actor) AssignIsolationSegmentToSpaceByNameAndSpace(isolationSegmentName string, spaceGUID string) (Warnings, error)
- func (actor Actor) CancelDeployment(deploymentGUID string) (Warnings, error)
- func (actor Actor) CheckRoute(domainName string, hostname string, path string) (bool, Warnings, error)
- func (actor Actor) CloudControllerAPIVersion() string
- func (actor Actor) CreateAndUploadBitsPackageByApplicationNameAndSpace(appName string, spaceGUID string, bitsPath string) (Package, Warnings, error)
- func (actor Actor) CreateApplicationDroplet(appGUID string) (Droplet, Warnings, error)
- func (actor Actor) CreateApplicationInSpace(app Application, spaceGUID string) (Application, Warnings, error)
- func (actor Actor) CreateBitsPackageByApplication(appGUID string) (Package, Warnings, error)
- func (actor Actor) CreateBuildpack(buildpack Buildpack) (Buildpack, Warnings, error)
- func (actor Actor) CreateDeployment(appGUID string, dropletGUID string) (string, Warnings, error)
- func (actor Actor) CreateDockerPackageByApplication(appGUID string, dockerImageCredentials DockerImageCredentials) (Package, Warnings, error)
- func (actor Actor) CreateDockerPackageByApplicationNameAndSpace(appName string, spaceGUID string, ...) (Package, Warnings, error)
- func (actor Actor) CreateIsolationSegmentByName(isolationSegment IsolationSegment) (Warnings, error)
- func (actor Actor) CreatePrivateDomain(domainName string, orgName string) (Warnings, error)
- func (actor Actor) CreateRoute(spaceGUID, domainName, hostname, path string) (Route, Warnings, error)
- func (actor Actor) CreateServiceBroker(name, username, password, url, spaceGUID string) (Warnings, error)
- func (actor Actor) CreateSharedDomain(domainName string, internal bool) (Warnings, error)
- func (actor Actor) DeleteApplicationByNameAndSpace(name string, spaceGUID string) (Warnings, error)
- func (actor Actor) DeleteBuildpackByNameAndStack(buildpackName string, buildpackStack string) (Warnings, error)
- func (actor Actor) DeleteDomain(domain Domain) (Warnings, error)
- func (actor Actor) DeleteInstanceByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, instanceIndex int) (Warnings, error)
- func (actor Actor) DeleteIsolationSegmentByName(name string) (Warnings, error)
- func (actor Actor) DeleteIsolationSegmentOrganizationByName(isolationSegmentName string, orgName string) (Warnings, error)
- func (actor Actor) DeleteOrphanedRoutes(spaceGUID string) (Warnings, error)
- func (actor Actor) DeleteRoute(domainName, hostname, path string) (Warnings, error)
- func (actor Actor) DisableFeatureFlag(flagName string) (Warnings, error)
- func (actor Actor) EnableFeatureFlag(flagName string) (Warnings, error)
- func (actor Actor) EntitleIsolationSegmentToOrganizationByName(isolationSegmentName string, orgName string) (Warnings, error)
- func (actor Actor) GetApplicationByNameAndSpace(appName string, spaceGUID string) (Application, Warnings, error)
- func (actor Actor) GetApplicationDroplets(appName string, spaceGUID string) ([]Droplet, Warnings, error)
- func (actor *Actor) GetApplicationLabels(appName string, spaceGUID string) (map[string]types.NullString, Warnings, error)
- func (actor *Actor) GetApplicationPackages(appName string, spaceGUID string) ([]Package, Warnings, error)
- func (actor Actor) GetApplicationProcessHealthChecksByNameAndSpace(appName string, spaceGUID string) ([]ProcessHealthCheck, Warnings, error)
- func (actor Actor) GetApplicationRoutes(appGUID string) ([]Route, Warnings, error)
- func (actor Actor) GetApplicationSummaryByNameAndSpace(appName string, spaceGUID string, withObfuscatedValues bool) (ApplicationSummary, Warnings, error)
- func (actor Actor) GetApplicationTasks(appGUID string, sortOrder SortOrder) ([]Task, Warnings, error)
- func (actor Actor) GetApplicationsByGUIDs(appGUIDs []string) ([]Application, Warnings, error)
- func (actor Actor) GetApplicationsByNamesAndSpace(appNames []string, spaceGUID string) ([]Application, Warnings, error)
- func (actor Actor) GetApplicationsBySpace(spaceGUID string) ([]Application, Warnings, error)
- func (actor Actor) GetApplicationsWithProcessesBySpace(spaceGUID string) ([]ApplicationWithProcessSummary, Warnings, error)
- func (actor Actor) GetBuildpackByNameAndStack(buildpackName string, buildpackStack string) (Buildpack, Warnings, error)
- func (actor Actor) GetBuildpacks() ([]Buildpack, Warnings, error)
- func (actor Actor) GetCurrentDropletByApplication(appGUID string) (Droplet, Warnings, error)
- func (actor Actor) GetDefaultDomain(orgGUID string) (Domain, Warnings, error)
- func (actor Actor) GetDomain(domainGUID string) (Domain, Warnings, error)
- func (actor Actor) GetDomainAndOrgGUIDsByName(domainName string, orgName string) (string, string, Warnings, error)
- func (actor Actor) GetDomainByName(domainName string) (Domain, Warnings, error)
- func (actor Actor) GetEffectiveIsolationSegmentBySpace(spaceGUID string, orgDefaultIsolationSegmentGUID string) (IsolationSegment, Warnings, error)
- func (actor *Actor) GetEnvironmentVariablesByApplicationNameAndSpace(appName string, spaceGUID string) (EnvironmentVariableGroups, Warnings, error)
- func (actor Actor) GetFeatureFlagByName(featureFlagName string) (FeatureFlag, Warnings, error)
- func (actor Actor) GetFeatureFlags() ([]FeatureFlag, Warnings, error)
- func (actor Actor) GetIsolationSegmentByName(name string) (IsolationSegment, Warnings, error)
- func (actor Actor) GetIsolationSegmentSummaries() ([]IsolationSegmentSummary, Warnings, error)
- func (actor Actor) GetIsolationSegmentsByOrganization(orgGUID string) ([]IsolationSegment, Warnings, error)
- func (actor Actor) GetLatestDeploymentForApp(appGUID string) (Deployment, Warnings, error)
- func (actor Actor) GetOrganizationByName(name string) (Organization, Warnings, error)
- func (actor Actor) GetOrganizationDomains(orgGuid string) ([]Domain, Warnings, error)
- func (actor *Actor) GetOrganizationLabels(orgName string) (map[string]types.NullString, Warnings, error)
- func (actor Actor) GetOrganizationSpaces(orgGUID string) ([]Space, Warnings, error)
- func (actor Actor) GetProcess(processGUID string) (Process, Warnings, error)
- func (actor Actor) GetProcessByTypeAndApplication(processType string, appGUID string) (Process, Warnings, error)
- func (actor Actor) GetRawApplicationManifestByNameAndSpace(appName string, spaceGUID string) ([]byte, Warnings, error)
- func (actor Actor) GetRouteByAttributes(domainName string, domainGUID string, hostname string, path string) (Route, Warnings, error)
- func (actor Actor) GetRouteDestinationByAppGUID(routeGUID string, appGUID string) (RouteDestination, Warnings, error)
- func (actor Actor) GetRouteDestinations(routeGUID string) ([]RouteDestination, Warnings, error)
- func (actor Actor) GetRoutesByOrg(orgGUID string) ([]Route, Warnings, error)
- func (actor Actor) GetRoutesBySpace(spaceGUID string) ([]Route, Warnings, error)
- func (actor Actor) GetSecureShellConfigurationByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, processIndex uint) (SSHAuthentication, Warnings, error)
- func (actor Actor) GetServiceBrokers() ([]ServiceBroker, Warnings, error)
- func (actor Actor) GetServiceInstanceByNameAndSpace(serviceInstanceName string, spaceGUID string) (ServiceInstance, Warnings, error)
- func (actor Actor) GetSpaceByNameAndOrganization(spaceName string, orgGUID string) (Space, Warnings, error)
- func (actor *Actor) GetSpaceLabels(spaceName string, orgGUID string) (map[string]types.NullString, Warnings, error)
- func (actor *Actor) GetStackByName(stackName string) (Stack, Warnings, error)
- func (actor Actor) GetStacks() ([]Stack, Warnings, error)
- func (actor Actor) GetStreamingLogs(appGUID string, client NOAAClient) (<-chan *LogMessage, <-chan error)
- func (actor Actor) GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client NOAAClient) (<-chan *LogMessage, <-chan error, Warnings, error)
- func (actor Actor) GetTaskBySequenceIDAndApplication(sequenceID int, appGUID string) (Task, Warnings, error)
- func (actor Actor) MapRoute(routeGUID string, appGUID string) (Warnings, error)
- func (actor Actor) PollBuild(buildGUID string, appName string) (Droplet, Warnings, error)
- func (actor Actor) PollPackage(pkg Package) (Package, Warnings, error)
- func (actor Actor) PollProcesses(processes []ccv3.Process) (bool, Warnings, error)
- func (actor Actor) PollStart(appGUID string, noWait bool) (Warnings, error)
- func (actor Actor) PollStartForRolling(appGUID string, deploymentGUID string, noWait bool) (Warnings, error)
- func (actor Actor) PollUploadBuildpackJob(jobURL ccv3.JobURL) (Warnings, error)
- func (actor *Actor) PrepareBuildpackBits(inputPath string, tmpDirPath string, downloader Downloader) (string, error)
- func (actor Actor) ResetOrganizationDefaultIsolationSegment(orgGUID string) (Warnings, error)
- func (actor Actor) ResetSpaceIsolationSegment(orgGUID string, spaceGUID string) (string, Warnings, error)
- func (actor Actor) ResourceMatch(resources []sharedaction.V3Resource) ([]sharedaction.V3Resource, Warnings, error)
- func (actor Actor) RestartApplication(appGUID string, noWait bool) (Warnings, error)
- func (actor Actor) RunTask(appGUID string, task Task) (Task, Warnings, error)
- func (actor Actor) ScaleProcessByApplication(appGUID string, process Process) (Warnings, error)
- func (actor Actor) SetApplicationDroplet(appGUID string, dropletGUID string) (Warnings, error)
- func (actor Actor) SetApplicationDropletByApplicationNameAndSpace(appName string, spaceGUID string, dropletGUID string) (Warnings, error)
- func (actor Actor) SetApplicationManifest(appGUID string, rawManifest []byte) (Warnings, error)
- func (actor Actor) SetApplicationProcessHealthCheckTypeByNameAndSpace(appName string, spaceGUID string, healthCheckType constant.HealthCheckType, ...) (Application, Warnings, error)
- func (actor *Actor) SetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, envPair EnvironmentVariablePair) (Warnings, error)
- func (actor Actor) SetOrganizationDefaultIsolationSegment(orgGUID string, isoSegGUID string) (Warnings, error)
- func (actor Actor) SetSpaceManifest(spaceGUID string, rawManifest []byte, noRoute bool) (Warnings, error)
- func (actor Actor) SharePrivateDomain(domainName string, orgName string) (Warnings, error)
- func (actor Actor) ShareServiceInstanceToSpaces(serviceInstanceGUID string, spaceGUIDs []string) (RelationshipList, Warnings, error)
- func (actor Actor) StageApplicationPackage(packageGUID string) (Build, Warnings, error)
- func (actor Actor) StagePackage(packageGUID, appName, spaceGUID string) (<-chan Droplet, <-chan Warnings, <-chan error)
- func (actor Actor) StartApplication(appGUID string) (Warnings, error)
- func (actor Actor) StopApplication(appGUID string) (Warnings, error)
- func (actor Actor) TerminateTask(taskGUID string) (Task, Warnings, error)
- func (actor Actor) UnmapRoute(routeGUID string, destinationGUID string) (Warnings, error)
- func (actor *Actor) UnsetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, environmentVariableName string) (Warnings, error)
- func (actor Actor) UnsharePrivateDomain(domainName string, orgName string) (Warnings, error)
- func (actor Actor) UnshareServiceInstanceByServiceInstanceAndSpace(serviceInstanceGUID string, sharedToSpaceGUID string) (Warnings, error)
- func (actor Actor) UpdateApplication(app Application) (Application, Warnings, error)
- func (actor *Actor) UpdateApplicationLabelsByApplicationName(appName string, spaceGUID string, labels map[string]types.NullString) (Warnings, error)
- func (actor Actor) UpdateBuildpackByNameAndStack(buildpackName string, buildpackStack string, buildpack Buildpack) (Buildpack, Warnings, error)
- func (actor Actor) UpdateOrganization(org Organization) (Organization, Warnings, error)
- func (actor *Actor) UpdateOrganizationLabelsByOrganizationName(orgName string, labels map[string]types.NullString) (Warnings, error)
- func (actor Actor) UpdateProcessByTypeAndApplication(processType string, appGUID string, updatedProcess Process) (Warnings, error)
- func (actor *Actor) UpdateSpaceLabelsBySpaceName(spaceName string, orgGUID string, labels map[string]types.NullString) (Warnings, error)
- func (actor Actor) UploadBitsPackage(pkg Package, matchedResources []sharedaction.V3Resource, ...) (Package, Warnings, error)
- func (actor Actor) UploadBuildpack(guid string, pathToBuildpackBits string, progressBar SimpleProgressBar) (ccv3.JobURL, Warnings, error)
- func (actor Actor) UploadDroplet(dropletGUID string, dropletPath string, progressReader io.Reader, size int64) (Warnings, error)
- type Application
- type ApplicationSummary
- type ApplicationWithProcessSummary
- type Build
- type Buildpack
- type CloudControllerClient
- type Config
- type Deployment
- type DockerImageCredentials
- type Domain
- type Downloader
- type Droplet
- type DropletBuildpack
- type EnvironmentVariableGroups
- type EnvironmentVariablePair
- type FeatureFlag
- type IsolationSegment
- type IsolationSegmentSummary
- type JobURL
- type LogMessage
- type LogMessages
- type ManifestParser
- type Metadata
- type NOAAClient
- type Organization
- type Package
- type Process
- type ProcessHealthCheck
- type ProcessHealthChecks
- type ProcessInstance
- type ProcessInstances
- type ProcessSummaries
- type ProcessSummary
- type ProgressBar
- type RelationshipList
- type Route
- type RouteDestination
- type RouteDestinationApp
- type SSHActor
- type SSHAuthentication
- type ServiceBroker
- type ServiceInstance
- type SharedActor
- type SharedOrgs
- type SimpleProgressBar
- type SortOrder
- type Space
- type Stack
- type Task
- type UAAClient
- type Warnings
Constants ¶
const ( DefaultFolderPermissions = 0755 DefaultArchiveFilePermissions = 0744 )
const StagingLog = "STG"
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Actor ¶
type Actor struct { CloudControllerClient CloudControllerClient Config Config UAAClient UAAClient }
Actor represents a V3 actor.
func NewActor ¶
func NewActor(client CloudControllerClient, config Config, sharedActor SharedActor, uaaClient UAAClient) *Actor
NewActor returns a new V3 actor.
func (Actor) ApplyApplicationManifest ¶
func (actor Actor) ApplyApplicationManifest(parser ManifestParser, spaceGUID string) (Warnings, error)
ApplyApplicationManifest reads in the manifest from the path and provides it to the cloud controller.
func (Actor) AssignIsolationSegmentToSpaceByNameAndSpace ¶
func (Actor) CancelDeployment ¶
func (Actor) CheckRoute ¶
func (Actor) CloudControllerAPIVersion ¶
CloudControllerAPIVersion returns back the Cloud Controller API version.
func (Actor) CreateAndUploadBitsPackageByApplicationNameAndSpace ¶
func (Actor) CreateApplicationDroplet ¶
CreateApplicationDroplet creates a new droplet without a package for the app with guid appGUID.
func (Actor) CreateApplicationInSpace ¶
func (actor Actor) CreateApplicationInSpace(app Application, spaceGUID string) (Application, Warnings, error)
CreateApplicationInSpace creates and returns the application with the given name in the given space.
func (Actor) CreateBitsPackageByApplication ¶
func (Actor) CreateBuildpack ¶
func (Actor) CreateDeployment ¶
func (Actor) CreateDockerPackageByApplication ¶
func (Actor) CreateDockerPackageByApplicationNameAndSpace ¶
func (Actor) CreateIsolationSegmentByName ¶
func (actor Actor) CreateIsolationSegmentByName(isolationSegment IsolationSegment) (Warnings, error)
CreateIsolationSegmentByName creates a given isolation segment.
func (Actor) CreatePrivateDomain ¶
func (Actor) CreateRoute ¶
func (Actor) CreateServiceBroker ¶
func (Actor) CreateSharedDomain ¶
func (Actor) DeleteApplicationByNameAndSpace ¶
func (Actor) DeleteBuildpackByNameAndStack ¶
func (Actor) DeleteInstanceByApplicationNameSpaceProcessTypeAndIndex ¶
func (Actor) DeleteIsolationSegmentByName ¶
DeleteIsolationSegmentByName deletes the given isolation segment.
func (Actor) DeleteIsolationSegmentOrganizationByName ¶
func (Actor) DeleteOrphanedRoutes ¶
func (Actor) DeleteRoute ¶
func (Actor) DisableFeatureFlag ¶
func (Actor) EnableFeatureFlag ¶
func (Actor) EntitleIsolationSegmentToOrganizationByName ¶
func (actor Actor) EntitleIsolationSegmentToOrganizationByName(isolationSegmentName string, orgName string) (Warnings, error)
EntitleIsolationSegmentToOrganizationByName entitles the given organization to use the specified isolation segment
func (Actor) GetApplicationByNameAndSpace ¶
func (actor Actor) GetApplicationByNameAndSpace(appName string, spaceGUID string) (Application, Warnings, error)
GetApplicationByNameAndSpace returns the application with the given name in the given space.
func (Actor) GetApplicationDroplets ¶
func (actor Actor) GetApplicationDroplets(appName string, spaceGUID string) ([]Droplet, Warnings, error)
GetApplicationDroplets returns the list of droplets that belong to application.
func (*Actor) GetApplicationLabels ¶
func (*Actor) GetApplicationPackages ¶
func (actor *Actor) GetApplicationPackages(appName string, spaceGUID string) ([]Package, Warnings, error)
GetApplicationPackages returns a list of package of an app.
func (Actor) GetApplicationProcessHealthChecksByNameAndSpace ¶
func (Actor) GetApplicationRoutes ¶
func (Actor) GetApplicationSummaryByNameAndSpace ¶
func (actor Actor) GetApplicationSummaryByNameAndSpace(appName string, spaceGUID string, withObfuscatedValues bool) (ApplicationSummary, Warnings, error)
GetApplicationSummaryByNameAndSpace returns an application with process and instance stats.
func (Actor) GetApplicationTasks ¶
func (actor Actor) GetApplicationTasks(appGUID string, sortOrder SortOrder) ([]Task, Warnings, error)
GetApplicationTasks returns a list of tasks associated with the provided appplication GUID.
func (Actor) GetApplicationsByGUIDs ¶
func (actor Actor) GetApplicationsByGUIDs(appGUIDs []string) ([]Application, Warnings, error)
func (Actor) GetApplicationsByNamesAndSpace ¶
func (Actor) GetApplicationsBySpace ¶
func (actor Actor) GetApplicationsBySpace(spaceGUID string) ([]Application, Warnings, error)
GetApplicationsBySpace returns all applications in a space.
func (Actor) GetApplicationsWithProcessesBySpace ¶
func (actor Actor) GetApplicationsWithProcessesBySpace(spaceGUID string) ([]ApplicationWithProcessSummary, Warnings, error)
func (Actor) GetBuildpackByNameAndStack ¶
func (actor Actor) GetBuildpackByNameAndStack(buildpackName string, buildpackStack string) (Buildpack, Warnings, error)
GetBuildpackByNameAndStack returns a buildpack with the provided name and stack. If `buildpackStack` is not specified, and there are multiple buildpacks with the same name, it will return the one with no stack, if present.
func (Actor) GetCurrentDropletByApplication ¶
func (Actor) GetDefaultDomain ¶
func (Actor) GetDomainAndOrgGUIDsByName ¶
func (Actor) GetDomainByName ¶
func (Actor) GetEffectiveIsolationSegmentBySpace ¶
func (actor Actor) GetEffectiveIsolationSegmentBySpace(spaceGUID string, orgDefaultIsolationSegmentGUID string) (IsolationSegment, Warnings, error)
GetEffectiveIsolationSegmentBySpace returns the space's effective isolation segment.
If the space has its own isolation segment, that will be returned.
If the space does not have one, the organization's default isolation segment (GUID passed in) will be returned.
If the space does not have one and the passed in organization default isolation segment GUID is empty, a NoRelationshipError will be returned.
func (*Actor) GetEnvironmentVariablesByApplicationNameAndSpace ¶
func (actor *Actor) GetEnvironmentVariablesByApplicationNameAndSpace(appName string, spaceGUID string) (EnvironmentVariableGroups, Warnings, error)
GetEnvironmentVariablesByApplicationNameAndSpace returns the environment variables for an application.
func (Actor) GetFeatureFlagByName ¶
func (actor Actor) GetFeatureFlagByName(featureFlagName string) (FeatureFlag, Warnings, error)
GetFeatureFlagByName returns a featureFlag with the provided name.
func (Actor) GetFeatureFlags ¶
func (actor Actor) GetFeatureFlags() ([]FeatureFlag, Warnings, error)
func (Actor) GetIsolationSegmentByName ¶
func (actor Actor) GetIsolationSegmentByName(name string) (IsolationSegment, Warnings, error)
GetIsolationSegmentByName returns the requested isolation segment.
func (Actor) GetIsolationSegmentSummaries ¶
func (actor Actor) GetIsolationSegmentSummaries() ([]IsolationSegmentSummary, Warnings, error)
GetIsolationSegmentSummaries returns all isolation segments and their entitled orgs
func (Actor) GetIsolationSegmentsByOrganization ¶
func (actor Actor) GetIsolationSegmentsByOrganization(orgGUID string) ([]IsolationSegment, Warnings, error)
func (Actor) GetLatestDeploymentForApp ¶
func (actor Actor) GetLatestDeploymentForApp(appGUID string) (Deployment, Warnings, error)
func (Actor) GetOrganizationByName ¶
func (actor Actor) GetOrganizationByName(name string) (Organization, Warnings, error)
GetOrganizationByName returns the organization with the given name.
func (Actor) GetOrganizationDomains ¶
func (*Actor) GetOrganizationLabels ¶
func (Actor) GetOrganizationSpaces ¶
GetOrganizationSpaces returns a list of spaces in the specified org
func (Actor) GetProcess ¶
func (Actor) GetProcessByTypeAndApplication ¶
func (actor Actor) GetProcessByTypeAndApplication(processType string, appGUID string) (Process, Warnings, error)
GetProcessByTypeAndApplication returns a process for the given application and type.
func (Actor) GetRawApplicationManifestByNameAndSpace ¶
func (Actor) GetRouteByAttributes ¶
func (Actor) GetRouteDestinationByAppGUID ¶
func (Actor) GetRouteDestinations ¶
func (actor Actor) GetRouteDestinations(routeGUID string) ([]RouteDestination, Warnings, error)
func (Actor) GetRoutesByOrg ¶
func (Actor) GetRoutesBySpace ¶
func (Actor) GetSecureShellConfigurationByApplicationNameSpaceProcessTypeAndIndex ¶
func (actor Actor) GetSecureShellConfigurationByApplicationNameSpaceProcessTypeAndIndex( appName string, spaceGUID string, processType string, processIndex uint, ) (SSHAuthentication, Warnings, error)
GetSecureShellConfigurationByApplicationNameSpaceProcessTypeAndIndex returns back the SSH authentication information for the SSH session.
func (Actor) GetServiceBrokers ¶
func (actor Actor) GetServiceBrokers() ([]ServiceBroker, Warnings, error)
func (Actor) GetServiceInstanceByNameAndSpace ¶
func (Actor) GetSpaceByNameAndOrganization ¶
func (*Actor) GetSpaceLabels ¶
func (*Actor) GetStackByName ¶
func (Actor) GetStreamingLogs ¶
func (actor Actor) GetStreamingLogs(appGUID string, client NOAAClient) (<-chan *LogMessage, <-chan error)
func (Actor) GetStreamingLogsForApplicationByNameAndSpace ¶
func (actor Actor) GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client NOAAClient) (<-chan *LogMessage, <-chan error, Warnings, error)
func (Actor) GetTaskBySequenceIDAndApplication ¶
func (Actor) PollPackage ¶
PollPackage returns a package of an app.
func (Actor) PollProcesses ¶
PollProcesses - return true if there's no need to keep polling
func (Actor) PollStart ¶
PollStart polls an application's processes until some are started. If noWait is false, it waits for at least one instance of all processes to be running. If noWait is true, it only waits for an instance of the web process to be running.
func (Actor) PollStartForRolling ¶
func (actor Actor) PollStartForRolling(appGUID string, deploymentGUID string, noWait bool) (Warnings, error)
PollStartForRolling polls a deploying application's processes until some are started. It does the same thing as PollStart, except it accounts for rolling deployments and whether they have failed or been canceled during polling.
func (Actor) PollUploadBuildpackJob ¶
func (*Actor) PrepareBuildpackBits ¶
func (Actor) ResetOrganizationDefaultIsolationSegment ¶
ResetOrganizationDefaultIsolationSegment resets the default isolation segment fon an organization.
func (Actor) ResetSpaceIsolationSegment ¶
func (actor Actor) ResetSpaceIsolationSegment(orgGUID string, spaceGUID string) (string, Warnings, error)
ResetSpaceIsolationSegment disassociates a space from an isolation segment.
If the space's organization has a default isolation segment, return its name. Otherwise return the empty string.
func (Actor) ResourceMatch ¶
func (actor Actor) ResourceMatch(resources []sharedaction.V3Resource) ([]sharedaction.V3Resource, Warnings, error)
func (Actor) RestartApplication ¶
RestartApplication restarts an application and waits for it to start.
func (Actor) RunTask ¶
RunTask runs the provided command in the application environment associated with the provided application GUID.
func (Actor) ScaleProcessByApplication ¶
func (Actor) SetApplicationDroplet ¶
func (Actor) SetApplicationDropletByApplicationNameAndSpace ¶
func (actor Actor) SetApplicationDropletByApplicationNameAndSpace(appName string, spaceGUID string, dropletGUID string) (Warnings, error)
SetApplicationDropletByApplicationNameAndSpace sets the droplet for an application.
func (Actor) SetApplicationManifest ¶
func (Actor) SetApplicationProcessHealthCheckTypeByNameAndSpace ¶
func (actor Actor) SetApplicationProcessHealthCheckTypeByNameAndSpace( appName string, spaceGUID string, healthCheckType constant.HealthCheckType, httpEndpoint string, processType string, invocationTimeout int64, ) (Application, Warnings, error)
SetApplicationProcessHealthCheckTypeByNameAndSpace sets the health check information of the provided processType for an application with the given name and space GUID.
func (*Actor) SetEnvironmentVariableByApplicationNameAndSpace ¶
func (actor *Actor) SetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, envPair EnvironmentVariablePair) (Warnings, error)
SetEnvironmentVariableByApplicationNameAndSpace adds an EnvironmentVariablePair to an application. It must be restarted for changes to take effect.
func (Actor) SetOrganizationDefaultIsolationSegment ¶
func (actor Actor) SetOrganizationDefaultIsolationSegment(orgGUID string, isoSegGUID string) (Warnings, error)
SetOrganizationDefaultIsolationSegment sets a default isolation segment on an organization.
func (Actor) SetSpaceManifest ¶
func (Actor) SharePrivateDomain ¶
func (Actor) ShareServiceInstanceToSpaces ¶
func (Actor) StageApplicationPackage ¶
func (Actor) StagePackage ¶
func (Actor) StartApplication ¶
StartApplication starts an application.
func (Actor) StopApplication ¶
StopApplication stops an application.
func (Actor) TerminateTask ¶
func (Actor) UnmapRoute ¶
func (*Actor) UnsetEnvironmentVariableByApplicationNameAndSpace ¶
func (actor *Actor) UnsetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, environmentVariableName string) (Warnings, error)
UnsetEnvironmentVariableByApplicationNameAndSpace removes an environment variable from an application. It must be restarted for changes to take effect.
func (Actor) UnsharePrivateDomain ¶
func (Actor) UnshareServiceInstanceByServiceInstanceAndSpace ¶
func (Actor) UpdateApplication ¶
func (actor Actor) UpdateApplication(app Application) (Application, Warnings, error)
UpdateApplication updates the buildpacks on an application
func (*Actor) UpdateApplicationLabelsByApplicationName ¶
func (Actor) UpdateBuildpackByNameAndStack ¶
func (Actor) UpdateOrganization ¶
func (actor Actor) UpdateOrganization(org Organization) (Organization, Warnings, error)
UpdateOrganization updates the name and/or labels of an organization
func (*Actor) UpdateOrganizationLabelsByOrganizationName ¶
func (Actor) UpdateProcessByTypeAndApplication ¶
func (*Actor) UpdateSpaceLabelsBySpaceName ¶
func (Actor) UploadBitsPackage ¶
func (actor Actor) UploadBitsPackage(pkg Package, matchedResources []sharedaction.V3Resource, newResources io.Reader, newResourcesLength int64) (Package, Warnings, error)
func (Actor) UploadBuildpack ¶
type Application ¶
type Application struct { Name string GUID string StackName string State constant.ApplicationState LifecycleType constant.AppLifecycleType LifecycleBuildpacks []string Metadata *Metadata }
Application represents a V3 actor application.
func (Application) Started ¶
func (app Application) Started() bool
func (Application) Stopped ¶
func (app Application) Stopped() bool
type ApplicationSummary ¶
type ApplicationSummary struct { Application CurrentDroplet Droplet ProcessSummaries ProcessSummaries Routes []Route }
ApplicationSummary represents an application with its processes and droplet.
func (ApplicationSummary) GetIsolationSegmentName ¶
func (a ApplicationSummary) GetIsolationSegmentName() (string, bool)
type ApplicationWithProcessSummary ¶
type ApplicationWithProcessSummary struct { Application ProcessSummaries ProcessSummaries }
type CloudControllerClient ¶
type CloudControllerClient interface { AppSSHEndpoint() string AppSSHHostKeyFingerprint() string CheckRoute(domainGUID string, hostname string, path string) (bool, ccv3.Warnings, error) CloudControllerAPIVersion() string CancelDeployment(deploymentGUID string) (ccv3.Warnings, error) CreateApplication(app ccv3.Application) (ccv3.Application, ccv3.Warnings, error) CreateApplicationDeployment(appGUID string, dropletGUID string) (string, ccv3.Warnings, error) CreateApplicationProcessScale(appGUID string, process ccv3.Process) (ccv3.Process, ccv3.Warnings, error) CreateApplicationTask(appGUID string, task ccv3.Task) (ccv3.Task, ccv3.Warnings, error) CreateBuild(build ccv3.Build) (ccv3.Build, ccv3.Warnings, error) CreateBuildpack(bp ccv3.Buildpack) (ccv3.Buildpack, ccv3.Warnings, error) CreateDomain(domain ccv3.Domain) (ccv3.Domain, ccv3.Warnings, error) CreateDroplet(appGUID string) (ccv3.Droplet, ccv3.Warnings, error) CreateIsolationSegment(isolationSegment ccv3.IsolationSegment) (ccv3.IsolationSegment, ccv3.Warnings, error) CreatePackage(pkg ccv3.Package) (ccv3.Package, ccv3.Warnings, error) CreateRoute(route ccv3.Route) (ccv3.Route, ccv3.Warnings, error) CreateServiceBroker(name, username, password, url, spaceGUID string) (ccv3.Warnings, error) DeleteApplication(guid string) (ccv3.JobURL, ccv3.Warnings, error) DeleteApplicationProcessInstance(appGUID string, processType string, instanceIndex int) (ccv3.Warnings, error) DeleteBuildpack(buildpackGUID string) (ccv3.JobURL, ccv3.Warnings, error) DeleteDomain(domainGUID string) (ccv3.JobURL, ccv3.Warnings, error) DeleteIsolationSegment(guid string) (ccv3.Warnings, error) DeleteIsolationSegmentOrganization(isolationSegmentGUID string, organizationGUID string) (ccv3.Warnings, error) DeleteOrphanedRoutes(spaceGUID string) (ccv3.JobURL, ccv3.Warnings, error) DeleteRoute(routeGUID string) (ccv3.JobURL, ccv3.Warnings, error) EntitleIsolationSegmentToOrganizations(isoGUID string, orgGUIDs []string) (ccv3.RelationshipList, ccv3.Warnings, error) GetApplicationDropletCurrent(appGUID string) (ccv3.Droplet, ccv3.Warnings, error) GetApplicationEnvironment(appGUID string) (ccv3.Environment, ccv3.Warnings, error) GetApplicationManifest(appGUID string) ([]byte, ccv3.Warnings, error) GetApplicationProcessByType(appGUID string, processType string) (ccv3.Process, ccv3.Warnings, error) GetApplicationProcesses(appGUID string) ([]ccv3.Process, ccv3.Warnings, error) GetApplicationRoutes(appGUID string) ([]ccv3.Route, ccv3.Warnings, error) GetApplicationTasks(appGUID string, query ...ccv3.Query) ([]ccv3.Task, ccv3.Warnings, error) GetApplications(query ...ccv3.Query) ([]ccv3.Application, ccv3.Warnings, error) GetBuild(guid string) (ccv3.Build, ccv3.Warnings, error) GetBuildpacks(query ...ccv3.Query) ([]ccv3.Buildpack, ccv3.Warnings, error) GetDefaultDomain(orgGuid string) (ccv3.Domain, ccv3.Warnings, error) GetDeployment(guid string) (ccv3.Deployment, ccv3.Warnings, error) GetDeployments(query ...ccv3.Query) ([]ccv3.Deployment, ccv3.Warnings, error) GetDomain(GUID string) (ccv3.Domain, ccv3.Warnings, error) GetDomains(query ...ccv3.Query) ([]ccv3.Domain, ccv3.Warnings, error) GetDroplet(guid string) (ccv3.Droplet, ccv3.Warnings, error) GetDroplets(query ...ccv3.Query) ([]ccv3.Droplet, ccv3.Warnings, error) GetFeatureFlag(featureFlagName string) (ccv3.FeatureFlag, ccv3.Warnings, error) GetFeatureFlags() ([]ccv3.FeatureFlag, ccv3.Warnings, error) GetIsolationSegment(guid string) (ccv3.IsolationSegment, ccv3.Warnings, error) GetIsolationSegmentOrganizations(isolationSegmentGUID string) ([]ccv3.Organization, ccv3.Warnings, error) GetIsolationSegments(query ...ccv3.Query) ([]ccv3.IsolationSegment, ccv3.Warnings, error) GetNewApplicationProcesses(appGUID string, deploymentGUID string) ([]ccv3.Process, ccv3.Warnings, error) GetOrganizationDefaultIsolationSegment(orgGUID string) (ccv3.Relationship, ccv3.Warnings, error) GetOrganizationDomains(orgGUID string, query ...ccv3.Query) ([]ccv3.Domain, ccv3.Warnings, error) GetOrganizations(query ...ccv3.Query) ([]ccv3.Organization, ccv3.Warnings, error) GetPackage(guid string) (ccv3.Package, ccv3.Warnings, error) GetPackages(query ...ccv3.Query) ([]ccv3.Package, ccv3.Warnings, error) GetProcess(processGUID string) (ccv3.Process, ccv3.Warnings, error) GetProcessInstances(processGUID string) ([]ccv3.ProcessInstance, ccv3.Warnings, error) GetRouteDestinations(routeGUID string) ([]ccv3.RouteDestination, ccv3.Warnings, error) GetRoutes(query ...ccv3.Query) ([]ccv3.Route, ccv3.Warnings, error) GetServiceBrokers() ([]ccv3.ServiceBroker, ccv3.Warnings, error) GetServiceInstances(query ...ccv3.Query) ([]ccv3.ServiceInstance, ccv3.Warnings, error) GetSpaceIsolationSegment(spaceGUID string) (ccv3.Relationship, ccv3.Warnings, error) GetSpaces(query ...ccv3.Query) ([]ccv3.Space, ccv3.Warnings, error) GetStacks(query ...ccv3.Query) ([]ccv3.Stack, ccv3.Warnings, error) MapRoute(routeGUID string, appGUID string) (ccv3.Warnings, error) PollJob(jobURL ccv3.JobURL) (ccv3.Warnings, error) ResourceMatch(resources []ccv3.Resource) ([]ccv3.Resource, ccv3.Warnings, error) SetApplicationDroplet(appGUID string, dropletGUID string) (ccv3.Relationship, ccv3.Warnings, error) UnmapRoute(routeGUID string, destinationGUID string) (ccv3.Warnings, error) UpdateApplication(app ccv3.Application) (ccv3.Application, ccv3.Warnings, error) UpdateApplicationApplyManifest(appGUID string, rawManifest []byte) (ccv3.JobURL, ccv3.Warnings, error) UpdateApplicationEnvironmentVariables(appGUID string, envVars ccv3.EnvironmentVariables) (ccv3.EnvironmentVariables, ccv3.Warnings, error) UpdateApplicationRestart(appGUID string) (ccv3.Application, ccv3.Warnings, error) UpdateApplicationStart(appGUID string) (ccv3.Application, ccv3.Warnings, error) UpdateApplicationStop(appGUID string) (ccv3.Application, ccv3.Warnings, error) UpdateBuildpack(buildpack ccv3.Buildpack) (ccv3.Buildpack, ccv3.Warnings, error) UpdateFeatureFlag(flag ccv3.FeatureFlag) (ccv3.FeatureFlag, ccv3.Warnings, error) UpdateOrganization(org ccv3.Organization) (ccv3.Organization, ccv3.Warnings, error) UpdateOrganizationDefaultIsolationSegmentRelationship(orgGUID string, isolationSegmentGUID string) (ccv3.Relationship, ccv3.Warnings, error) UpdateProcess(process ccv3.Process) (ccv3.Process, ccv3.Warnings, error) UpdateResourceMetadata(resource string, resourceGUID string, metadata ccv3.Metadata) (ccv3.ResourceMetadata, ccv3.Warnings, error) UpdateSpace(space ccv3.Space) (ccv3.Space, ccv3.Warnings, error) UpdateSpaceApplyManifest(spaceGUID string, rawManifest []byte, query ...ccv3.Query) (ccv3.JobURL, ccv3.Warnings, error) UpdateSpaceIsolationSegmentRelationship(spaceGUID string, isolationSegmentGUID string) (ccv3.Relationship, ccv3.Warnings, error) UpdateTaskCancel(taskGUID string) (ccv3.Task, ccv3.Warnings, error) UploadBitsPackage(pkg ccv3.Package, matchedResources []ccv3.Resource, newResources io.Reader, newResourcesLength int64) (ccv3.Package, ccv3.Warnings, error) UploadBuildpack(buildpackGUID string, buildpackPath string, buildpack io.Reader, buildpackLength int64) (ccv3.JobURL, ccv3.Warnings, error) UploadDropletBits(dropletGUID string, dropletPath string, droplet io.Reader, dropletLength int64) (ccv3.JobURL, ccv3.Warnings, error) UploadPackage(pkg ccv3.Package, zipFilepath string) (ccv3.Package, ccv3.Warnings, error) }
CloudControllerClient is the interface to the cloud controller V3 API.
type Deployment ¶
type Deployment ccv3.Deployment
type DockerImageCredentials ¶
type Downloader ¶
type Droplet ¶
type Droplet struct { GUID string State constant.DropletState CreatedAt string Stack string Image string Buildpacks []DropletBuildpack }
Droplet represents a Cloud Controller droplet.
type DropletBuildpack ¶
type DropletBuildpack ccv3.DropletBuildpack
type EnvironmentVariableGroups ¶
type EnvironmentVariableGroups ccv3.Environment
EnvironmentVariableGroups represents all environment variables for application
type EnvironmentVariablePair ¶
EnvironmentVariablePair represents an environment variable and its value on an application
type FeatureFlag ¶
type FeatureFlag ccv3.FeatureFlag
type IsolationSegment ¶
type IsolationSegment ccv3.IsolationSegment
IsolationSegment represents a V3 actor IsolationSegment.
type IsolationSegmentSummary ¶
type LogMessage ¶
type LogMessage struct {
// contains filtered or unexported fields
}
func NewLogMessage ¶
func (LogMessage) Message ¶
func (log LogMessage) Message() string
func (LogMessage) SourceInstance ¶
func (log LogMessage) SourceInstance() string
func (LogMessage) SourceType ¶
func (log LogMessage) SourceType() string
func (LogMessage) Staging ¶
func (log LogMessage) Staging() bool
func (LogMessage) Timestamp ¶
func (log LogMessage) Timestamp() time.Time
func (LogMessage) Type ¶
func (log LogMessage) Type() string
type LogMessages ¶
type LogMessages []*LogMessage
func (LogMessages) Len ¶
func (lm LogMessages) Len() int
func (LogMessages) Less ¶
func (lm LogMessages) Less(i, j int) bool
func (LogMessages) Swap ¶
func (lm LogMessages) Swap(i, j int)
type ManifestParser ¶
type NOAAClient ¶
type NOAAClient interface { Close() error RecentLogs(appGUID string, authToken string) ([]*events.LogMessage, error) SetOnConnectCallback(cb func()) TailingLogs(appGUID, authToken string) (<-chan *events.LogMessage, <-chan error) }
NOAAClient is a client for getting logs.
type Organization ¶
type Organization struct { // GUID is the unique organization identifier. GUID string // Name is the name of the organization. Name string // Metadata is used for custom tagging of API resources Metadata *Metadata }
Organization represents a V3 actor organization.
type ProcessHealthCheck ¶
type ProcessHealthCheck struct { ProcessType string HealthCheckType constant.HealthCheckType Endpoint string InvocationTimeout int64 }
type ProcessHealthChecks ¶
type ProcessHealthChecks []ProcessHealthCheck
func (ProcessHealthChecks) Sort ¶
func (phs ProcessHealthChecks) Sort()
type ProcessInstance ¶
type ProcessInstance ccv3.ProcessInstance
func (ProcessInstance) Running ¶
func (instance ProcessInstance) Running() bool
Running will return true if the instance is running.
func (*ProcessInstance) StartTime ¶
func (instance *ProcessInstance) StartTime() time.Time
StartTime returns the time that the instance started.
type ProcessInstances ¶
type ProcessInstances []ccv3.ProcessInstance
func (ProcessInstances) AllCrashed ¶
func (pi ProcessInstances) AllCrashed() bool
func (ProcessInstances) AnyRunning ¶
func (pi ProcessInstances) AnyRunning() bool
func (ProcessInstances) Empty ¶
func (pi ProcessInstances) Empty() bool
type ProcessSummaries ¶
type ProcessSummaries []ProcessSummary
func (ProcessSummaries) Sort ¶
func (ps ProcessSummaries) Sort()
func (ProcessSummaries) String ¶
func (ps ProcessSummaries) String() string
type ProcessSummary ¶
type ProcessSummary struct { Process InstanceDetails []ProcessInstance }
ProcessSummary represents a process with instance details.
func (ProcessSummary) HealthyInstanceCount ¶
func (p ProcessSummary) HealthyInstanceCount() int
func (ProcessSummary) TotalInstanceCount ¶
func (p ProcessSummary) TotalInstanceCount() int
type ProgressBar ¶
type ProgressBar struct {
// contains filtered or unexported fields
}
func NewProgressBar ¶
func NewProgressBar() *ProgressBar
func (*ProgressBar) Initialize ¶
func (*ProgressBar) Terminate ¶
func (p *ProgressBar) Terminate()
type RelationshipList ¶
type RelationshipList ccv3.RelationshipList
type RouteDestination ¶
type RouteDestination struct { GUID string App RouteDestinationApp }
type RouteDestinationApp ¶
type RouteDestinationApp ccv3.RouteDestinationApp
type SSHActor ¶
type SSHActor interface {
ExecuteSecureShell(sshOptions sharedaction.SSHOptions) error
}
type SSHAuthentication ¶
type ServiceBroker ¶
type ServiceBroker = ccv3.ServiceBroker
type ServiceInstance ¶
type ServiceInstance ccv3.ServiceInstance
type SharedActor ¶
type SharedActor interface {}
type SharedOrgs ¶
type SharedOrgs ccv3.SharedOrgs
type SimpleProgressBar ¶
Source Files ¶
- actor.go
- application.go
- application_manifest.go
- application_summary.go
- application_with_process_summary.go
- build.go
- buildpack.go
- cloud_controller_client.go
- config.go
- deployment.go
- domain.go
- droplet.go
- environment_variable.go
- feature_flag.go
- fix_mode_unix.go
- isolation_segment.go
- job.go
- label.go
- logging.go
- metadata.go
- noaa_client.go
- organization.go
- package.go
- process.go
- process_health_check.go
- process_instance.go
- process_summary.go
- progress_bar.go
- relationship_list.go
- resource_match.go
- route.go
- service_broker.go
- service_instance.go
- shared_actor.go
- space.go
- space_manifest.go
- ssh.go
- ssh_actor.go
- stack.go
- task.go
- uaa_client.go
- version.go