Documentation ¶
Overview ¶
Package v3 should not be imported by external consumers. It was not designed for external use.
Index ¶
- type AppActor
- type AppCommand
- type CreateAppManifestActor
- type CreateAppManifestCommand
- type DeleteActor
- type DeleteCommand
- type EnvActor
- type EnvCommand
- type GetHealthCheckActor
- type GetHealthCheckCommand
- type ProgressBar
- type PushActor
- type PushCommand
- type ResetSpaceIsolationSegmentActor
- type ResetSpaceIsolationSegmentActorV2
- type ResetSpaceIsolationSegmentCommand
- type SSHActor
- type SSHCommand
- type ScaleActor
- type ScaleCommand
- type SetEnvActor
- type SetEnvCommand
- type SetHealthCheckActor
- type SetHealthCheckCommand
- type SharedSSHActor
- type UnsetEnvActor
- type UnsetEnvCommand
- type V7ActorForPush
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppActor ¶
type AppActor interface { CloudControllerAPIVersion() string GetApplicationByNameAndSpace(name string, spaceGUID string) (v7action.Application, v7action.Warnings, error) GetApplicationSummaryByNameAndSpace(appName string, spaceGUID string, withObfuscatedValues bool, routeActor v7action.RouteActor) (v7action.ApplicationSummary, v7action.Warnings, error) }
type AppCommand ¶
type AppCommand struct { RequiredArgs flag.AppName `positional-args:"yes"` GUID bool `` /* 131-byte string literal not displayed */ UI command.UI Config command.Config RouteActor v7action.RouteActor Actor AppActor // contains filtered or unexported fields }
func (AppCommand) Execute ¶
func (cmd AppCommand) Execute(args []string) error
type CreateAppManifestActor ¶
type CreateAppManifestCommand ¶
type CreateAppManifestCommand struct { RequiredArgs flag.AppName `positional-args:"yes"` FilePath flag.Path `` /* 135-byte string literal not displayed */ UI command.UI Config command.Config Actor CreateAppManifestActor PWD string // contains filtered or unexported fields }
func (CreateAppManifestCommand) Execute ¶
func (cmd CreateAppManifestCommand) Execute(args []string) error
type DeleteActor ¶
type DeleteCommand ¶
type DeleteCommand struct { RequiredArgs flag.AppName `positional-args:"yes"` Force bool `short:"f" description:"Force deletion without confirmation"` DeleteMappedRoutes bool `short:"r" description:"Also delete any mapped routes [Not currently functional]"` UI command.UI Config command.Config Actor DeleteActor // contains filtered or unexported fields }
func (DeleteCommand) Execute ¶
func (cmd DeleteCommand) Execute(args []string) error
type EnvCommand ¶
type EnvCommand struct { RequiredArgs flag.EnvironmentArgs `positional-args:"yes"` UI command.UI Config command.Config Actor EnvActor // contains filtered or unexported fields }
func (EnvCommand) Execute ¶
func (cmd EnvCommand) Execute(_ []string) error
type GetHealthCheckActor ¶
type GetHealthCheckCommand ¶
type GetHealthCheckCommand struct { RequiredArgs flag.AppName `positional-args:"yes"` UI command.UI Config command.Config Actor GetHealthCheckActor // contains filtered or unexported fields }
func (GetHealthCheckCommand) DisplayProcessTable ¶
func (cmd GetHealthCheckCommand) DisplayProcessTable(processHealthChecks []v7action.ProcessHealthCheck) error
func (GetHealthCheckCommand) Execute ¶
func (cmd GetHealthCheckCommand) Execute(args []string) error
type ProgressBar ¶
type ProgressBar interface { v7pushaction.ProgressBar Complete() Ready() }
type PushActor ¶
type PushActor interface { // Actualize applies any necessary changes. Actualize(state v7pushaction.PushState, progressBar v7pushaction.ProgressBar) (<-chan v7pushaction.PushState, <-chan v7pushaction.Event, <-chan v7pushaction.Warnings, <-chan error) // Conceptualize figures out the state of the world. Conceptualize(appName string, spaceGUID string, orgGUID string, currentDir string, flagOverrides v7pushaction.FlagOverrides) ([]v7pushaction.PushState, v7pushaction.Warnings, error) }
type PushCommand ¶
type PushCommand struct { RequiredArgs flag.AppName `positional-args:"yes"` Buildpacks []string `` /* 334-byte string literal not displayed */ DockerImage flag.DockerImage `long:"docker-image" short:"o" description:"Docker image to use (e.g. user/docker-image-name)"` DockerUsername string `long:"docker-username" description:"Repository username; used with password from environment variable CF_DOCKER_PASSWORD"` HealthCheckType flag.HealthCheckType `` /* 138-byte string literal not displayed */ Memory flag.Megabytes `long:"memory" short:"m" description:"Memory limit (e.g. 256M, 1024M, 1G)"` NoRoute bool `long:"no-route" description:"Do not map a route to this app"` NoStart bool `long:"no-start" description:"Do not stage and start the app after pushing"` AppPath flag.PathWithExistenceCheck `short:"p" description:"Path to app directory or to a zip file of the contents of the app directory"` StartCommand flag.Command `long:"start-command" short:"c" description:"Startup command, set to null to reset to default start command"` UI command.UI Config command.Config NOAAClient v3action.NOAAClient Actor PushActor VersionActor V7ActorForPush RouteActor v7action.RouteActor ProgressBar ProgressBar PWD string // contains filtered or unexported fields }
func (PushCommand) Execute ¶
func (cmd PushCommand) Execute(args []string) error
func (PushCommand) GetFlagOverrides ¶
func (cmd PushCommand) GetFlagOverrides() (v7pushaction.FlagOverrides, error)
type ResetSpaceIsolationSegmentCommand ¶
type ResetSpaceIsolationSegmentCommand struct { RequiredArgs flag.ResetSpaceIsolationArgs `positional-args:"yes"` UI command.UI Config command.Config Actor ResetSpaceIsolationSegmentActor ActorV2 ResetSpaceIsolationSegmentActorV2 // contains filtered or unexported fields }
func (ResetSpaceIsolationSegmentCommand) Execute ¶
func (cmd ResetSpaceIsolationSegmentCommand) Execute(args []string) error
type SSHCommand ¶
type SSHCommand struct { RequiredArgs flag.AppName `positional-args:"yes"` ProcessIndex uint `long:"app-instance-index" short:"i" default:"0" description:"App process instance index"` Commands []string `long:"command" short:"c" description:"Command to run"` DisablePseudoTTY bool `long:"disable-pseudo-tty" short:"T" description:"Disable pseudo-tty allocation"` ForcePseudoTTY bool `long:"force-pseudo-tty" description:"Force pseudo-tty allocation"` LocalPortForwardSpecs []flag.SSHPortForwarding `short:"L" description:"Local port forward specification"` ProcessType string `long:"process" default:"web" description:"App process name"` RequestPseudoTTY bool `long:"request-pseudo-tty" short:"t" description:"Request pseudo-tty allocation"` SkipHostValidation bool `long:"skip-host-validation" short:"k" description:"Skip host key validation. Not recommended!"` SkipRemoteExecution bool `long:"skip-remote-execution" short:"N" description:"Do not execute a remote command"` UI command.UI Config command.Config Actor SSHActor SSHActor SharedSSHActor SSHClient *clissh.SecureShell // contains filtered or unexported fields }
func (SSHCommand) EvaluateTTYOption ¶
func (cmd SSHCommand) EvaluateTTYOption() (sharedaction.TTYOption, error)
EvaluateTTYOption determines which TTY options are mutually exclusive and returns an error accordingly.
func (SSHCommand) Execute ¶
func (cmd SSHCommand) Execute(args []string) error
type ScaleActor ¶
type ScaleActor interface { AppActor ScaleProcessByApplication(appGUID string, process v7action.Process) (v7action.Warnings, error) StopApplication(appGUID string) (v7action.Warnings, error) StartApplication(appGUID string) (v7action.Application, v7action.Warnings, error) PollStart(appGUID string, warnings chan<- v7action.Warnings) error }
type ScaleCommand ¶
type ScaleCommand struct { RequiredArgs flag.AppName `positional-args:"yes"` Force bool `short:"f" description:"Force restart of app without prompt"` Instances flag.Instances `short:"i" required:"false" description:"Number of instances"` DiskLimit flag.Megabytes `short:"k" required:"false" description:"Disk limit (e.g. 256M, 1024M, 1G)"` MemoryLimit flag.Megabytes `short:"m" required:"false" description:"Memory limit (e.g. 256M, 1024M, 1G)"` ProcessType string `long:"process" default:"web" description:"App process to scale"` UI command.UI Config command.Config Actor ScaleActor RouteActor v7action.RouteActor // contains filtered or unexported fields }
func (ScaleCommand) Execute ¶
func (cmd ScaleCommand) Execute(args []string) error
type SetEnvActor ¶
type SetEnvCommand ¶
type SetEnvCommand struct { RequiredArgs flag.SetEnvironmentArgs `positional-args:"yes"` UI command.UI Config command.Config Actor SetEnvActor // contains filtered or unexported fields }
func (SetEnvCommand) Execute ¶
func (cmd SetEnvCommand) Execute(args []string) error
type SetHealthCheckActor ¶
type SetHealthCheckActor interface { CloudControllerAPIVersion() string SetApplicationProcessHealthCheckTypeByNameAndSpace(appName string, spaceGUID string, healthCheckType constant.HealthCheckType, httpEndpoint string, processType string, invocationTimeout int) (v7action.Application, v7action.Warnings, error) }
type SetHealthCheckCommand ¶
type SetHealthCheckCommand struct { RequiredArgs flag.SetHealthCheckArgs `positional-args:"yes"` HTTPEndpoint string `long:"endpoint" default:"/" description:"Path on the app"` InvocationTimeout flag.PositiveInteger `long:"invocation-timeout" description:"Time (in seconds) that controls individual health check invocations"` ProcessType string `long:"process" default:"web" description:"App process to update"` UI command.UI Config command.Config Actor SetHealthCheckActor // contains filtered or unexported fields }
func (SetHealthCheckCommand) Execute ¶
func (cmd SetHealthCheckCommand) Execute(args []string) error
type SharedSSHActor ¶
type SharedSSHActor interface {
}type UnsetEnvActor ¶
type UnsetEnvCommand ¶
type UnsetEnvCommand struct { RequiredArgs flag.UnsetEnvironmentArgs `positional-args:"yes"` UI command.UI Config command.Config Actor UnsetEnvActor // contains filtered or unexported fields }
func (UnsetEnvCommand) Execute ¶
func (cmd UnsetEnvCommand) Execute(args []string) error
type V7ActorForPush ¶
type V7ActorForPush interface { AppActor GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client v7action.NOAAClient) (<-chan *v7action.LogMessage, <-chan error, v7action.Warnings, error) PollStart(appGUID string, warningsChannel chan<- v7action.Warnings) error RestartApplication(appGUID string) (v7action.Warnings, error) }
Source Files ¶
Click to show internal directories.
Click to hide internal directories.