Documentation ¶
Overview ¶
Package v3 should not be imported by external consumers. It was not designed for external use.
Index ¶
- type AppActor
- type AppCommand
- type BuildpacksActor
- type BuildpacksCommand
- type CreateAppManifestActor
- type CreateAppManifestCommand
- type CreateBuildpackActor
- type CreateBuildpackCommand
- type DeleteActor
- type DeleteBuildpackActor
- type DeleteBuildpackCommand
- type DeleteCommand
- type DisableFeatureFlagActor
- type DisableFeatureFlagCommand
- type EnableFeatureFlagActor
- type EnableFeatureFlagCommand
- type EnvActor
- type EnvCommand
- type FeatureFlagActor
- type FeatureFlagCommand
- type FeatureFlagsActor
- type FeatureFlagsCommand
- type GetHealthCheckActor
- type GetHealthCheckCommand
- type ManifestParser
- type ProgressBar
- type PushActor
- type PushCommand
- func (cmd PushCommand) Execute(args []string) error
- func (cmd PushCommand) GetDockerPassword(dockerUsername string, containsPrivateDockerImages bool) (string, error)
- func (cmd PushCommand) GetFlagOverrides() (v7pushaction.FlagOverrides, error)
- func (cmd PushCommand) ReadManifest() error
- func (cmd *PushCommand) Setup(config command.Config, ui command.UI) error
- func (cmd PushCommand) ValidateAllowedFlagsForMultipleApps(containsMultipleApps bool) error
- func (cmd PushCommand) ValidateFlags() error
- 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 StackActor
- type StackCommand
- type StacksActor
- type StacksCommand
- type TargetActor
- type TargetCommand
- type UnsetEnvActor
- type UnsetEnvCommand
- type UpdateBuildpackActor
- type UpdateBuildpackCommand
- type V7ActorForPush
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppActor ¶
type AppActor interface { 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 BuildpacksActor ¶
type BuildpacksCommand ¶
type BuildpacksCommand struct { UI command.UI Config command.Config Actor BuildpacksActor // contains filtered or unexported fields }
func (BuildpacksCommand) Execute ¶
func (cmd BuildpacksCommand) 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 CreateBuildpackActor ¶
type CreateBuildpackActor interface { CreateBuildpack(buildpack v7action.Buildpack) (v7action.Buildpack, v7action.Warnings, error) UploadBuildpack(guid string, pathToBuildpackBits string, progressBar v7action.SimpleProgressBar) (ccv3.JobURL, v7action.Warnings, error) PrepareBuildpackBits(inputPath string, tmpDirPath string, downloader v7action.Downloader) (string, error) PollUploadBuildpackJob(jobURL ccv3.JobURL) (v7action.Warnings, error) }
type CreateBuildpackCommand ¶
type CreateBuildpackCommand struct { RequiredArgs flag.CreateBuildpackArgs `positional-args:"Yes"` Disable bool `long:"disable" description:"Disable the buildpack from being used for staging"` UI command.UI Config command.Config ProgressBar v7action.SimpleProgressBar Actor CreateBuildpackActor // contains filtered or unexported fields }
func (CreateBuildpackCommand) Execute ¶
func (cmd CreateBuildpackCommand) Execute(args []string) error
type DeleteActor ¶
type DeleteBuildpackActor ¶
type DeleteBuildpackCommand ¶
type DeleteBuildpackCommand struct { RequiredArgs flag.BuildpackName `positional-args:"yes"` Force bool `long:"force" short:"f" description:"Force deletion without confirmation"` Stack string `` /* 139-byte string literal not displayed */ Actor DeleteBuildpackActor UI command.UI Config command.Config // contains filtered or unexported fields }
func (DeleteBuildpackCommand) Execute ¶
func (cmd DeleteBuildpackCommand) Execute(args []string) error
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 DisableFeatureFlagActor ¶
type DisableFeatureFlagCommand ¶
type DisableFeatureFlagCommand struct { RequiredArgs flag.Feature `positional-args:"yes"` UI command.UI Config command.Config Actor DisableFeatureFlagActor // contains filtered or unexported fields }
func (DisableFeatureFlagCommand) Execute ¶
func (cmd DisableFeatureFlagCommand) Execute(args []string) error
type EnableFeatureFlagActor ¶
type EnableFeatureFlagCommand ¶
type EnableFeatureFlagCommand struct { RequiredArgs flag.Feature `positional-args:"yes"` UI command.UI Config command.Config Actor EnableFeatureFlagActor // contains filtered or unexported fields }
func (EnableFeatureFlagCommand) Execute ¶
func (cmd EnableFeatureFlagCommand) 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 FeatureFlagActor ¶
type FeatureFlagCommand ¶
type FeatureFlagCommand struct { RequiredArgs flag.Feature `positional-args:"yes"` UI command.UI Config command.Config Actor FeatureFlagActor // contains filtered or unexported fields }
func (FeatureFlagCommand) Execute ¶
func (cmd FeatureFlagCommand) Execute(args []string) error
type FeatureFlagsActor ¶
type FeatureFlagsActor interface {
GetFeatureFlags() ([]v7action.FeatureFlag, v7action.Warnings, error)
}
type FeatureFlagsCommand ¶
type FeatureFlagsCommand struct { UI command.UI Config command.Config Actor FeatureFlagsActor // contains filtered or unexported fields }
func (FeatureFlagsCommand) Execute ¶
func (cmd FeatureFlagsCommand) Execute(args []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 ManifestParser ¶
type ManifestParser interface { v7pushaction.ManifestParser ContainsMultipleApps() bool InterpolateAndParse(pathToManifest string, pathsToVarsFiles []string, vars []template.VarKV) error Validate() error ContainsPrivateDockerImages() bool }
type ProgressBar ¶
type ProgressBar interface { v7pushaction.ProgressBar Complete() Ready() }
type PushActor ¶
type PushActor interface { CreatePushPlans(appNameArg string, spaceGUID string, orgGUID string, parser v7pushaction.ManifestParser, overrides v7pushaction.FlagOverrides) ([]v7pushaction.PushPlan, error) // Prepare the space by creating needed apps/applying the manifest PrepareSpace(pushPlans []v7pushaction.PushPlan, parser v7pushaction.ManifestParser) (<-chan []v7pushaction.PushPlan, <-chan v7pushaction.Event, <-chan v7pushaction.Warnings, <-chan error) // UpdateApplicationSettings figures out the state of the world. UpdateApplicationSettings(pushPlans []v7pushaction.PushPlan) ([]v7pushaction.PushPlan, v7pushaction.Warnings, error) // Actualize applies any necessary changes. Actualize(plan v7pushaction.PushPlan, progressBar v7pushaction.ProgressBar) (<-chan v7pushaction.PushPlan, <-chan v7pushaction.Event, <-chan v7pushaction.Warnings, <-chan error) }
type PushCommand ¶
type PushCommand struct { OptionalArgs flag.OptionalAppName `positional-args:"yes"` HealthCheckTimeout flag.PositiveInteger `` /* 155-byte string literal not displayed */ Buildpacks []string `` /* 334-byte string literal not displayed */ Disk flag.Megabytes `long:"disk" short:"k" description:"Disk limit (e.g. 256M, 1024M, 1G)"` 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"` HealthCheckHTTPEndpoint string `` /* 129-byte string literal not displayed */ HealthCheckType flag.HealthCheckType `` /* 157-byte string literal not displayed */ Instances flag.Instances `long:"instances" short:"i" description:"Number of instances"` PathToManifest flag.PathWithExistenceCheck `long:"manifest" short:"f" description:"Path to manifest"` Memory flag.Megabytes `long:"memory" short:"m" description:"Memory limit (e.g. 256M, 1024M, 1G)"` NoManifest bool `long:"no-manifest" description:""` 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 `long:"path" short:"p" description:"Path to app directory or to a zip file of the contents of the app directory"` Stack string `` /* 136-byte string literal not displayed */ StartCommand flag.Command `long:"start-command" short:"c" description:"Startup command, set to null to reset to default start command"` Vars []template.VarKV `long:"var" description:"Variable key value pair for variable substitution, (e.g., name=app1); can specify multiple times"` PathsToVarsFiles []flag.PathWithExistenceCheck `long:"vars-file" description:"Path to a variable substitution file for manifest; can specify multiple times"` Config command.Config UI command.UI NOAAClient v3action.NOAAClient Actor PushActor VersionActor V7ActorForPush RouteActor v7action.RouteActor ProgressBar ProgressBar PWD string ManifestParser ManifestParser // contains filtered or unexported fields }
func (PushCommand) Execute ¶
func (cmd PushCommand) Execute(args []string) error
func (PushCommand) GetDockerPassword ¶
func (cmd PushCommand) GetDockerPassword(dockerUsername string, containsPrivateDockerImages bool) (string, error)
func (PushCommand) GetFlagOverrides ¶
func (cmd PushCommand) GetFlagOverrides() (v7pushaction.FlagOverrides, error)
func (PushCommand) ReadManifest ¶
func (cmd PushCommand) ReadManifest() error
func (PushCommand) ValidateAllowedFlagsForMultipleApps ¶
func (cmd PushCommand) ValidateAllowedFlagsForMultipleApps(containsMultipleApps bool) error
func (PushCommand) ValidateFlags ¶
func (cmd PushCommand) ValidateFlags() 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) (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 int64) (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 StackActor ¶
type StackCommand ¶
type StackCommand struct { RequiredArgs flag.StackName `positional-args:"yes"` GUID bool `long:"guid" description:"Retrieve and display the given stack's guid. All other output for the stack is suppressed."` UI command.UI Config command.Config Actor StackActor // contains filtered or unexported fields }
func (*StackCommand) Execute ¶
func (cmd *StackCommand) Execute(args []string) error
type StacksActor ¶
type StacksCommand ¶
type StacksCommand struct { UI command.UI Config command.Config Actor StacksActor // contains filtered or unexported fields }
func (StacksCommand) Execute ¶
func (cmd StacksCommand) Execute(args []string) error
type TargetActor ¶
type TargetActor interface { GetOrganizationByName(orgName string) (v7action.Organization, v7action.Warnings, error) GetOrganizationSpaces(orgGUID string) ([]v7action.Space, v7action.Warnings, error) GetSpaceByNameAndOrganization(spaceName string, orgGUID string) (v7action.Space, v7action.Warnings, error) CloudControllerAPIVersion() string }
type TargetCommand ¶
type TargetCommand struct { Organization string `short:"o" description:"Organization"` Space string `short:"s" description:"Space"` UI command.UI Config command.Config Actor TargetActor // contains filtered or unexported fields }
func (*TargetCommand) Execute ¶
func (cmd *TargetCommand) Execute(args []string) error
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 UpdateBuildpackActor ¶
type UpdateBuildpackActor interface { UpdateBuildpackByNameAndStack(buildpackName string, buildpackStack string, buildpack v7action.Buildpack) (v7action.Buildpack, v7action.Warnings, error) UploadBuildpack(guid string, pathToBuildpackBits string, progressBar v7action.SimpleProgressBar) (ccv3.JobURL, v7action.Warnings, error) PrepareBuildpackBits(inputPath string, tmpDirPath string, downloader v7action.Downloader) (string, error) PollUploadBuildpackJob(jobURL ccv3.JobURL) (v7action.Warnings, error) }
type UpdateBuildpackCommand ¶
type UpdateBuildpackCommand struct { RequiredArgs flag.BuildpackName `positional-args:"Yes"` NewStack string `long:"assign-stack" description:"Assign a stack to a buildpack that does not have a stack association"` Disable bool `long:"disable" description:"Disable the buildpack from being used for staging"` Enable bool `long:"enable" description:"Enable the buildpack to be used for staging"` Lock bool `long:"lock" description:"Lock the buildpack to prevent updates"` Path flag.PathWithExistenceCheckOrURL `long:"path" short:"p" description:"Path to directory or zip file"` Position types.NullInt `long:"position" short:"i" description:"The order in which the buildpacks are checked during buildpack auto-detection"` NewName string `long:"rename" description:"Rename an existing buildpack"` CurrentStack string `long:"stack" short:"s" description:"Specify stack to disambiguate buildpacks with the same name"` Unlock bool `long:"unlock" description:"Unlock the buildpack to enable updates"` UI command.UI Config command.Config ProgressBar v7action.SimpleProgressBar Actor UpdateBuildpackActor // contains filtered or unexported fields }
func (UpdateBuildpackCommand) Execute ¶
func (cmd UpdateBuildpackCommand) Execute(args []string) error
type V7ActorForPush ¶
Source Files ¶
- app_command.go
- buildpacks_command.go
- create_app_manifest_command.go
- create_buildpack_command.go
- delete_buildpack_command.go
- delete_command.go
- disable_feature_flag_command.go
- docker_password_getter.go
- enable_feature_flag_command.go
- env_command.go
- feature_flag_command.go
- feature_flags_command.go
- get_health_check_command.go
- godoc.go
- push_command.go
- reset_space_isolation_segment_command.go
- scale_command.go
- set_env_command.go
- set_health_check_command.go
- ssh_command.go
- stack_command.go
- stacks_command.go
- target_command.go
- unset_env_command.go
- update_buildpack_command.go
Click to show internal directories.
Click to hide internal directories.