v7

package
v6.43.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 20, 2019 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Overview

Package v3 should not be imported by external consumers. It was not designed for external use.

Index

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
	SharedActor command.SharedActor
	RouteActor  v7action.RouteActor
	Actor       AppActor
	// contains filtered or unexported fields
}

func (AppCommand) Execute 

func (cmd AppCommand) Execute(args []string) error

func (*AppCommand) Setup 

func (cmd *AppCommand) Setup(config command.Config, ui command.UI) error

type BuildpacksActor 

type BuildpacksActor interface {
	GetBuildpacks() ([]v7action.Buildpack, v7action.Warnings, error)
}

type BuildpacksCommand 

type BuildpacksCommand struct {
	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	Actor       BuildpacksActor
	// contains filtered or unexported fields
}

func (BuildpacksCommand) Execute 

func (cmd BuildpacksCommand) Execute(args []string) error

func (*BuildpacksCommand) Setup 

func (cmd *BuildpacksCommand) Setup(config command.Config, ui command.UI) error

type CreateAppManifestActor 

type CreateAppManifestActor interface {
	GetRawApplicationManifestByNameAndSpace(appName string, spaceGUID string) ([]byte, v7action.Warnings, error)
}

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
	SharedActor command.SharedActor
	Actor       CreateAppManifestActor
	PWD         string
	// contains filtered or unexported fields
}

func (CreateAppManifestCommand) Execute 

func (cmd CreateAppManifestCommand) Execute(args []string) error

func (*CreateAppManifestCommand) Setup 

func (cmd *CreateAppManifestCommand) Setup(config command.Config, ui command.UI) 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
	SharedActor command.SharedActor
	Actor       CreateBuildpackActor
	// contains filtered or unexported fields
}

func (CreateBuildpackCommand) Execute 

func (cmd CreateBuildpackCommand) Execute(args []string) error

func (*CreateBuildpackCommand) Setup 

func (cmd *CreateBuildpackCommand) Setup(config command.Config, ui command.UI) error

type DeleteActor 

type DeleteActor interface {
	CloudControllerAPIVersion() string
	DeleteApplicationByNameAndSpace(name string, spaceGUID string) (v7action.Warnings, error)
}

type DeleteBuildpackActor 

type DeleteBuildpackActor interface {
	DeleteBuildpackByNameAndStack(buildpackName string, buildpackStack string) (v7action.Warnings, error)
}

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
	SharedActor command.SharedActor
	// contains filtered or unexported fields
}

func (DeleteBuildpackCommand) Execute 

func (cmd DeleteBuildpackCommand) Execute(args []string) error

func (*DeleteBuildpackCommand) Setup 

func (cmd *DeleteBuildpackCommand) Setup(config command.Config, ui command.UI) 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
	SharedActor command.SharedActor
	Actor       DeleteActor
	// contains filtered or unexported fields
}

func (DeleteCommand) Execute 

func (cmd DeleteCommand) Execute(args []string) error

func (*DeleteCommand) Setup 

func (cmd *DeleteCommand) Setup(config command.Config, ui command.UI) error

type EnvActor 

type EnvActor interface {
	GetEnvironmentVariablesByApplicationNameAndSpace(appName string, spaceGUID string) (v7action.EnvironmentVariableGroups, v7action.Warnings, error)
}

type EnvCommand 

type EnvCommand struct {
	RequiredArgs flag.EnvironmentArgs `positional-args:"yes"`

	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	Actor       EnvActor
	// contains filtered or unexported fields
}

func (EnvCommand) Execute 

func (cmd EnvCommand) Execute(_ []string) error

func (*EnvCommand) Setup 

func (cmd *EnvCommand) Setup(config command.Config, ui command.UI) error

type GetHealthCheckActor 

type GetHealthCheckActor interface {
	CloudControllerAPIVersion() string
	GetApplicationProcessHealthChecksByNameAndSpace(appName string, spaceGUID string) ([]v7action.ProcessHealthCheck, v7action.Warnings, error)
}

type GetHealthCheckCommand 

type GetHealthCheckCommand struct {
	RequiredArgs flag.AppName `positional-args:"yes"`

	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	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

func (*GetHealthCheckCommand) Setup 

func (cmd *GetHealthCheckCommand) Setup(config command.Config, ui command.UI) 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, manifest []byte) ([]v7pushaction.PushState, v7pushaction.Warnings, error)
}

type PushCommand 

type PushCommand struct {
	RequiredArgs            flag.AppName                  `positional-args:"yes"`
	Buildpacks              []string                      `` /* 334-byte string literal not displayed */
	Stack                   string                        `` /* 136-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          `` /* 157-byte string literal not displayed */
	HealthCheckHTTPEndpoint string                        `` /* 129-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"`
	PathsToVarsFiles        []flag.PathWithExistenceCheck `long:"vars-file" description:"Path to a variable substitution file for manifest; can specify multiple times"`
	Memory                  flag.Megabytes                `long:"memory" short:"m" description:"Memory limit (e.g. 256M, 1024M, 1G)"`
	Disk                    flag.Megabytes                `long:"disk" short:"k" description:"Disk 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"`
	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"`

	UI           command.UI
	Config       command.Config
	NOAAClient   v3action.NOAAClient
	Actor        PushActor
	VersionActor V7ActorForPush
	SharedActor  command.SharedActor
	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)

func (*PushCommand) Setup 

func (cmd *PushCommand) Setup(config command.Config, ui command.UI) error

func (PushCommand) ValidateFlags 

func (cmd PushCommand) ValidateFlags() error

type ResetSpaceIsolationSegmentActor 

type ResetSpaceIsolationSegmentActor interface {
	ResetSpaceIsolationSegment(orgGUID string, spaceGUID string) (string, v7action.Warnings, error)
}

type ResetSpaceIsolationSegmentActorV2 

type ResetSpaceIsolationSegmentActorV2 interface {
	GetSpaceByOrganizationAndName(orgGUID string, spaceName string) (v2action.Space, v2action.Warnings, error)
}

type ResetSpaceIsolationSegmentCommand 

type ResetSpaceIsolationSegmentCommand struct {
	RequiredArgs flag.ResetSpaceIsolationArgs `positional-args:"yes"`

	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	Actor       ResetSpaceIsolationSegmentActor
	ActorV2     ResetSpaceIsolationSegmentActorV2
	// contains filtered or unexported fields
}

func (ResetSpaceIsolationSegmentCommand) Execute 

func (cmd ResetSpaceIsolationSegmentCommand) Execute(args []string) error

func (*ResetSpaceIsolationSegmentCommand) Setup 

func (cmd *ResetSpaceIsolationSegmentCommand) Setup(config command.Config, ui command.UI) error

type SSHActor 

type SSHActor interface {
	GetSecureShellConfigurationByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, processIndex uint) (v7action.SSHAuthentication, v7action.Warnings, 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
	SharedActor command.SharedActor
	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

func (*SSHCommand) Setup 

func (cmd *SSHCommand) Setup(config command.Config, ui command.UI) 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
	SharedActor command.SharedActor
	RouteActor  v7action.RouteActor
	// contains filtered or unexported fields
}

func (ScaleCommand) Execute 

func (cmd ScaleCommand) Execute(args []string) error

func (*ScaleCommand) Setup 

func (cmd *ScaleCommand) Setup(config command.Config, ui command.UI) error

type SetEnvActor 

type SetEnvActor interface {
	CloudControllerAPIVersion() string
	SetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, envPair v7action.EnvironmentVariablePair) (v7action.Warnings, error)
}

type SetEnvCommand 

type SetEnvCommand struct {
	RequiredArgs flag.SetEnvironmentArgs `positional-args:"yes"`

	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	Actor       SetEnvActor
	// contains filtered or unexported fields
}

func (SetEnvCommand) Execute 

func (cmd SetEnvCommand) Execute(args []string) error

func (*SetEnvCommand) Setup 

func (cmd *SetEnvCommand) Setup(config command.Config, ui command.UI) 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
	SharedActor command.SharedActor
	Actor       SetHealthCheckActor
	// contains filtered or unexported fields
}

func (SetHealthCheckCommand) Execute 

func (cmd SetHealthCheckCommand) Execute(args []string) error

func (*SetHealthCheckCommand) Setup 

func (cmd *SetHealthCheckCommand) Setup(config command.Config, ui command.UI) error

type SharedSSHActor 

type SharedSSHActor interface {
	ExecuteSecureShell(sshClient sharedaction.SecureShellClient, sshOptions sharedaction.SSHOptions) error
}

type StackActor 

type StackActor interface {
	GetStackByName(stackName string) (v7action.Stack, v7action.Warnings, error)
}

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
	SharedActor command.SharedActor
	Actor       StackActor
	// contains filtered or unexported fields
}

func (*StackCommand) Execute 

func (cmd *StackCommand) Execute(args []string) error

func (*StackCommand) Setup 

func (cmd *StackCommand) Setup(config command.Config, ui command.UI) error

type StacksActor 

type StacksActor interface {
	GetStacks() ([]v7action.Stack, v7action.Warnings, error)
}

type StacksCommand 

type StacksCommand struct {
	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	Actor       StacksActor
	// contains filtered or unexported fields
}

func (StacksCommand) Execute 

func (cmd StacksCommand) Execute(args []string) error

func (*StacksCommand) Setup 

func (cmd *StacksCommand) Setup(config command.Config, ui command.UI) 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
	SharedActor command.SharedActor
	Actor       TargetActor
	// contains filtered or unexported fields
}

func (*TargetCommand) Execute 

func (cmd *TargetCommand) Execute(args []string) error

func (*TargetCommand) Setup 

func (cmd *TargetCommand) Setup(config command.Config, ui command.UI) error

type UnsetEnvActor 

type UnsetEnvActor interface {
	UnsetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, EnvironmentVariableName string) (v7action.Warnings, error)
}

type UnsetEnvCommand 

type UnsetEnvCommand struct {
	RequiredArgs flag.UnsetEnvironmentArgs `positional-args:"yes"`

	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	Actor       UnsetEnvActor
	// contains filtered or unexported fields
}

func (UnsetEnvCommand) Execute 

func (cmd UnsetEnvCommand) Execute(args []string) error

func (*UnsetEnvCommand) Setup 

func (cmd *UnsetEnvCommand) Setup(config command.Config, ui command.UI) 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
	SharedActor command.SharedActor
	Actor       UpdateBuildpackActor
	// contains filtered or unexported fields
}

func (UpdateBuildpackCommand) Execute 

func (cmd UpdateBuildpackCommand) Execute(args []string) error

func (*UpdateBuildpackCommand) Setup 

func (cmd *UpdateBuildpackCommand) Setup(config command.Config, ui command.UI) error

type V7ActorForPush 

type V7ActorForPush interface {
	AppActor
	GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client v7action.NOAAClient) (<-chan *v7action.LogMessage, <-chan error, v7action.Warnings, error)
	RestartApplication(appGUID string) (v7action.Warnings, error)
}

Source Files

View all Source files

Directories

Path Synopsis
Package shared should not be imported by external consumers.
 Package shared should not be imported by external consumers.
Code generated by counterfeiter.
 Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.