Documentation
¶
Index ¶
- Constants
- Variables
- func CompleteAppConfig(config *newcmd.AppConfig, f *clientcmd.Factory, c *cobra.Command, ...) error
- func NewCmdAnnotate(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdApply(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdAttach(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
- func NewCmdAuth(fullName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
- func NewCmdAutoscale(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdBuildLogs(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdCancelBuild(name, baseName string, f *clientcmd.Factory, in io.Reader, ...) *cobra.Command
- func NewCmdCompletion(fullName string, out io.Writer) *cobra.Command
- func NewCmdConfig(parentName, name string, out, errOut io.Writer) *cobra.Command
- func NewCmdConvert(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdCp(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
- func NewCmdCreate(parentName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdDebug(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
- func NewCmdDelete(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdDeploy(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdDescribe(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdEdit(fullName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
- func NewCmdExec(fullName string, f *clientcmd.Factory, cmdIn io.Reader, ...) *cobra.Command
- func NewCmdExplain(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdExport(fullName string, f *clientcmd.Factory, in io.Reader, out io.Writer) *cobra.Command
- func NewCmdExpose(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdExtract(fullName string, f *clientcmd.Factory, in io.Reader, out, errOut io.Writer) *cobra.Command
- func NewCmdGet(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdIdle(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
- func NewCmdImportImage(fullName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
- func NewCmdLabel(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdLogs(name, baseName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdNewApplication(name, baseName string, f *clientcmd.Factory, in io.Reader, ...) *cobra.Command
- func NewCmdNewBuild(name, baseName string, f *clientcmd.Factory, in io.Reader, ...) *cobra.Command
- func NewCmdOptions(out io.Writer) *cobra.Command
- func NewCmdPatch(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdPlugin(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
- func NewCmdPortForward(fullName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
- func NewCmdProcess(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
- func NewCmdProject(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdProjects(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdProxy(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdReplace(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdRequestProject(name, baseName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
- func NewCmdRollback(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdRsh(name string, parent string, f *clientcmd.Factory, in io.Reader, ...) *cobra.Command
- func NewCmdRun(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
- func NewCmdScale(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdStartBuild(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
- func NewCmdStatus(name, baseCLIName, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdTYPE(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
- func NewCmdTag(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdTypes(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdVersion(fullName string, f *clientcmd.Factory, out io.Writer, options VersionOptions) *cobra.Command
- func NewCmdWhoAmI(name, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func RunBuildLogs(fullName string, f *clientcmd.Factory, out io.Writer, cmd *cobra.Command, ...) error
- func RunExport(f *clientcmd.Factory, exporter Exporter, in io.Reader, out io.Writer, ...) error
- func RunProcess(f *clientcmd.Factory, in io.Reader, out, errout io.Writer, cmd *cobra.Command, ...) error
- func RunWhoAmI(f *clientcmd.Factory, out io.Writer, cmd *cobra.Command, args []string, ...) error
- func TransformUnsupportedError(err error) error
- func WaitForBuildComplete(c buildclient.BuildResourceInterface, name string) error
- type CancelBuildOptions
- type DebugOptions
- type DefaultExporter
- type DeployOptions
- type Exporter
- type ExtractOptions
- type IdleOptions
- type ImportImageOptions
- type LogsForObjectFunc
- type NewAppOptions
- type NewBuildOptions
- type NewProjectOptions
- type ObjectGeneratorOptions
- type OpenShiftLogsOptions
- type ProjectOptions
- type ProjectsOptions
- type RollbackOptions
- type RshOptions
- type SortByProjectName
- type StartBuildOptions
- type StatusOptions
- type TYPEOptions
- type TagOptions
- type VersionOptions
- type WhoAmIOptions
Constants ¶
const (
RshRecommendedName = "rsh"
DefaultShell = "/bin/sh"
)
const CancelBuildRecommendedCommandName = "cancel-build"
CancelBuildRecommendedCommandName is the recommended command name.
const ExposeRecommendedName = "expose"
ExposeRecommendedName is the recommended command name to expose app.
const LogsRecommendedCommandName = "logs"
LogsRecommendedCommandName is the recommended command name TODO: Probably move this pattern upstream?
const NewAppRecommendedCommandName = "new-app"
NewAppRecommendedCommandName is the recommended command name.
const NewBuildRecommendedCommandName = "new-build"
NewBuildRecommendedCommandName is the recommended command name.
const RequestProjectRecommendedCommandName = "new-project"
RequestProjectRecommendedCommandName is the recommended command name.
const RoutePollTimeout = 5 * time.Second
RoutePollTimoutSeconds sets how long new-app command waits for route host to be prepopulated
const StatusRecommendedName = "status"
StatusRecommendedName is the recommended command name.
const WhoAmIRecommendedCommandName = "whoami"
Variables ¶
var ErrExportOmit = fmt.Errorf("object is omitted")
Functions ¶
func CompleteAppConfig ¶
func CompleteAppConfig(config *newcmd.AppConfig, f *clientcmd.Factory, c *cobra.Command, args []string) error
func NewCmdAnnotate ¶
func NewCmdAnnotate(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdAnnotate is a wrapper for the Kubernetes cli annotate command
func NewCmdApply ¶
func NewCmdApply(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
NewCmdApply is a wrapper for the Kubernetes cli apply command
func NewCmdAttach ¶
func NewCmdAttach(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdAttach is a wrapper for the Kubernetes cli attach command
func NewCmdAuth ¶
func NewCmdAuth(fullName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
func NewCmdAutoscale ¶
func NewCmdAutoscale(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdAutoscale is a wrapper for the Kubernetes cli autoscale command
func NewCmdBuildLogs ¶
func NewCmdBuildLogs(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdBuildLogs implements the OpenShift cli build-logs command
func NewCmdCancelBuild ¶
func NewCmdCancelBuild(name, baseName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdCancelBuild implements the OpenShift cli cancel-build command
func NewCmdCompletion ¶
func NewCmdCompletion(fullName string, out io.Writer) *cobra.Command
func NewCmdConfig ¶
func NewCmdConfig(parentName, name string, out, errOut io.Writer) *cobra.Command
NewCmdConfig is a wrapper for the Kubernetes cli config command
func NewCmdConvert ¶
func NewCmdConvert(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdConvert is a wrapper for the Kubernetes cli convert command
func NewCmdCp ¶
func NewCmdCp(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdCp is a wrapper for the Kubernetes cli cp command
func NewCmdCreate ¶
func NewCmdCreate(parentName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
NewCmdCreate is a wrapper for the Kubernetes cli create command
func NewCmdDebug ¶
func NewCmdDebug(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdDebug creates a command for debugging pods.
func NewCmdDelete ¶
func NewCmdDelete(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
NewCmdDelete is a wrapper for the Kubernetes cli delete command
func NewCmdDeploy ¶
func NewCmdDeploy(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdDeploy creates a new `deploy` command.
func NewCmdDescribe ¶
func NewCmdDescribe(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
NewCmdDescribe is a wrapper for the Kubernetes cli describe command
func NewCmdEdit ¶
func NewCmdEdit(fullName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
NewCmdEdit is a wrapper for the Kubernetes cli edit command
func NewCmdExec ¶
func NewCmdExec(fullName string, f *clientcmd.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command
NewCmdExec is a wrapper for the Kubernetes cli exec command
func NewCmdExplain ¶
func NewCmdExplain(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
NewCmdExplain is a wrapper for the Kubernetes cli explain command
func NewCmdExport ¶
func NewCmdExport(fullName string, f *clientcmd.Factory, in io.Reader, out io.Writer) *cobra.Command
func NewCmdExpose ¶
func NewCmdExpose(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdExpose is a wrapper for the Kubernetes cli expose command
func NewCmdExtract ¶
func NewCmdExtract(fullName string, f *clientcmd.Factory, in io.Reader, out, errOut io.Writer) *cobra.Command
func NewCmdGet ¶
func NewCmdGet(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
NewCmdGet is a wrapper for the Kubernetes cli get command
func NewCmdIdle ¶
func NewCmdIdle(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command
NewCmdIdle implements the OpenShift cli idle command
func NewCmdImportImage ¶
func NewCmdImportImage(fullName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
NewCmdImportImage implements the OpenShift cli import-image command.
func NewCmdLabel ¶
func NewCmdLabel(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdLabel is a wrapper for the Kubernetes cli label command
func NewCmdLogs ¶
func NewCmdLogs(name, baseName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdLogs creates a new logs command that supports OpenShift resources.
func NewCmdNewApplication ¶
func NewCmdNewApplication(name, baseName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdNewApplication implements the OpenShift cli new-app command.
func NewCmdNewBuild ¶
func NewCmdNewBuild(name, baseName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdNewBuild implements the OpenShift cli new-build command
func NewCmdOptions ¶
func NewCmdOptions(out io.Writer) *cobra.Command
NewCmdOptions implements the OpenShift cli options command
func NewCmdPatch ¶
func NewCmdPatch(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdPatch is a wrapper for the Kubernetes cli patch command
func NewCmdPlugin ¶
func NewCmdPlugin(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
func NewCmdPortForward ¶
func NewCmdPortForward(fullName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
NewCmdPortForward is a wrapper for the Kubernetes cli port-forward command
func NewCmdProcess ¶
func NewCmdProcess(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdProcess implements the OpenShift cli process command
func NewCmdProject ¶
func NewCmdProject(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdProject implements the OpenShift cli rollback command
func NewCmdProjects ¶
func NewCmdProjects(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdProjects implements the OpenShift cli rollback command
func NewCmdProxy ¶
func NewCmdProxy(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdProxy is a wrapper for the Kubernetes cli proxy command
func NewCmdReplace ¶
func NewCmdReplace(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdReplace is a wrapper for the Kubernetes cli replace command
func NewCmdRequestProject ¶
func NewCmdRequestProject(name, baseName string, f *clientcmd.Factory, out, errout io.Writer) *cobra.Command
NewCmdRequestProject implement the OpenShift cli RequestProject command.
func NewCmdRollback ¶
func NewCmdRollback(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdRollback creates a CLI rollback command.
func NewCmdRsh ¶
func NewCmdRsh(name string, parent string, f *clientcmd.Factory, in io.Reader, out, err io.Writer) *cobra.Command
NewCmdRsh returns a command that attempts to open a shell session to the server.
func NewCmdRun ¶
func NewCmdRun(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdRun is a wrapper for the Kubernetes cli run command
func NewCmdScale ¶
func NewCmdScale(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdScale is a wrapper for the Kubernetes cli scale command
func NewCmdStartBuild ¶
func NewCmdStartBuild(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdStartBuild implements the OpenShift cli start-build command
func NewCmdStatus ¶
func NewCmdStatus(name, baseCLIName, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdStatus implements the OpenShift cli status command. baseCLIName is the path from root cmd to the parent of this cmd.
func NewCmdTYPE ¶
func NewCmdTYPE(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command
NewCmdTYPE implements a TYPE command This is an example type for templating.
func NewCmdTag ¶
func NewCmdTag(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
NewCmdTag implements the OpenShift cli tag command.
func NewCmdTypes ¶
func NewCmdTypes(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
func NewCmdVersion ¶
func NewCmdVersion(fullName string, f *clientcmd.Factory, out io.Writer, options VersionOptions) *cobra.Command
NewCmdVersion creates a command for displaying the version of this binary
func NewCmdWhoAmI ¶
func NewCmdWhoAmI(name, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
func RunBuildLogs ¶
func RunBuildLogs(fullName string, f *clientcmd.Factory, out io.Writer, cmd *cobra.Command, opts buildapi.BuildLogOptions, args []string) error
RunBuildLogs contains all the necessary functionality for the OpenShift cli build-logs command
func RunExport ¶
func RunExport(f *clientcmd.Factory, exporter Exporter, in io.Reader, out io.Writer, cmd *cobra.Command, args []string, filenames []string) error
func RunProcess ¶
func RunProcess(f *clientcmd.Factory, in io.Reader, out, errout io.Writer, cmd *cobra.Command, args []string) error
RunProcess contains all the necessary functionality for the OpenShift cli process command
func RunWhoAmI ¶
func RunWhoAmI(f *clientcmd.Factory, out io.Writer, cmd *cobra.Command, args []string, o *WhoAmIOptions) error
func TransformUnsupportedError ¶
func TransformUnsupportedError(err error) error
TransformUnsupportedError converts specific error conditions to unsupported
func WaitForBuildComplete ¶
func WaitForBuildComplete(c buildclient.BuildResourceInterface, name string) error
WaitForBuildComplete waits for a build identified by the name to complete
Types ¶
type CancelBuildOptions ¶
type CancelBuildOptions struct {
In io.Reader
Out, ErrOut io.Writer
DumpLogs bool
Restart bool
States []string
Namespace string
BuildNames []string
HasError bool
ReportError func(error)
Mapper meta.RESTMapper
Client buildinternalclient.Interface
BuildClient buildtypedclient.BuildResourceInterface
BuildLister buildlister.BuildLister
// contains filtered or unexported fields
}
CancelBuildOptions contains all the options for running the CancelBuild cli command.
func (*CancelBuildOptions) Complete ¶
func (o *CancelBuildOptions) Complete(f *clientcmd.Factory, cmd *cobra.Command, args []string, in io.Reader, out, errout io.Writer) error
Complete completes all the required options.
func (*CancelBuildOptions) RunCancelBuild ¶
func (o *CancelBuildOptions) RunCancelBuild() error
RunCancelBuild implements all the necessary functionality for CancelBuild.
type DebugOptions ¶
type DebugOptions struct {
Attach kcmd.AttachOptions
AppsClient appsclient.AppsInterface
ImageClient imageclient.ImageInterface
Print func(pod *kapi.Pod, w io.Writer) error
LogsForObject func(object, options runtime.Object, timeout time.Duration) (*restclient.Request, error)
NoStdin bool
ForceTTY bool
DisableTTY bool
Filename string
Timeout time.Duration
Command []string
Annotations map[string]string
AsRoot bool
AsNonRoot bool
AsUser int64
KeepLabels bool // TODO: evaluate selecting the right labels automatically
KeepAnnotations bool
KeepLiveness bool
KeepReadiness bool
KeepInitContainers bool
OneContainer bool
NodeName string
AddEnv []kapi.EnvVar
RemoveEnv []string
}
func (*DebugOptions) Complete ¶
func (o *DebugOptions) Complete(cmd *cobra.Command, f *clientcmd.Factory, args []string, in io.Reader, out, errout io.Writer) error
type DefaultExporter ¶
type DefaultExporter struct{}
func (*DefaultExporter) AddExportOptions ¶
func (e *DefaultExporter) AddExportOptions(flags *pflag.FlagSet)
type DeployOptions ¶
type DeployOptions struct {
// contains filtered or unexported fields
}
DeployOptions holds all the options for the `deploy` command
type Exporter ¶
type Exporter interface {
AddExportOptions(*pflag.FlagSet)
Export(obj runtime.Object, exact bool) error
}
type ExtractOptions ¶
type ExtractOptions struct {
Out, Err io.Writer
Filenames []string
OnlyKeys []string
TargetDirectory string
Overwrite bool
VisitorFn func(resource.VisitorFunc) error
ExtractFileContentsFn func(runtime.Object) (map[string][]byte, bool, error)
}
type IdleOptions ¶
type IdleOptions struct {
// contains filtered or unexported fields
}
func (*IdleOptions) Complete ¶
func (o *IdleOptions) Complete(f *clientcmd.Factory, cmd *cobra.Command, args []string) error
func (*IdleOptions) RunIdle ¶
func (o *IdleOptions) RunIdle(f *clientcmd.Factory) error
RunIdle runs the idling command logic, taking a list of resources or services in a file, scaling the associated scalable resources to zero, and annotating the associated endpoints objects with the scalable resources to unidle when they receive traffic.
type ImportImageOptions ¶
type ImportImageOptions struct {
// user set values
From string
Confirm bool
All bool
Scheduled bool
Insecure *bool
DryRun bool
// internal values
Namespace string
Name string
Tag string
Target string
ReferencePolicy string
CommandName string
// contains filtered or unexported fields
}
ImageImportOptions contains all the necessary information to perform an import.
func (*ImportImageOptions) Complete ¶
func (o *ImportImageOptions) Complete(f *clientcmd.Factory, cmd *cobra.Command, args []string, commandName string, out, errout io.Writer) error
Complete turns a partially defined ImportImageOptions into a solvent structure which can be validated and used for aa import.
type LogsForObjectFunc ¶
type LogsForObjectFunc func(object, options runtime.Object, timeout time.Duration) (*restclient.Request, error)
type NewAppOptions ¶
type NewAppOptions struct {
*ObjectGeneratorOptions
}
type NewBuildOptions ¶
type NewBuildOptions struct {
*ObjectGeneratorOptions
}
func (*NewBuildOptions) Complete ¶
func (o *NewBuildOptions) Complete(baseName, commandName string, f *clientcmd.Factory, c *cobra.Command, args []string, in io.Reader, out, errout io.Writer) error
Complete sets any default behavior for the command
func (*NewBuildOptions) RunNewBuild ¶
func (o *NewBuildOptions) RunNewBuild() error
RunNewBuild contains all the necessary functionality for the OpenShift cli new-build command
type NewProjectOptions ¶
type NewProjectOptions struct {
ProjectName string
DisplayName string
Description string
Name string
Server string
SkipConfigWrite bool
Client projectclient.ProjectInterface
ProjectOptions *ProjectOptions
Out io.Writer
}
NewProjectOptions contains all the options for running the RequestProject cli command.
type ObjectGeneratorOptions ¶
type ObjectGeneratorOptions struct {
Action configcmd.BulkAction
Config *newcmd.AppConfig
BaseName string
CommandPath string
CommandName string
In io.Reader
ErrOut io.Writer
PrintObject func(obj runtime.Object) error
LogsForObject LogsForObjectFunc
}
type OpenShiftLogsOptions ¶
type OpenShiftLogsOptions struct {
// Options should hold our own *LogOptions objects.
Options runtime.Object
// KubeLogOptions contains all the necessary options for
// running the upstream logs command.
KubeLogOptions *kcmd.LogsOptions
// Client enables access to the Build object when processing
// build logs for Jenkins Pipeline Strategy builds
Client buildclient.BuildsGetter
// Namespace is a required parameter when accessing the Build object when processing
// build logs for Jenkins Pipeline Strategy builds
Namespace string
}
OpenShiftLogsOptions holds all the necessary options for running oc logs.
func (*OpenShiftLogsOptions) Complete ¶
func (o *OpenShiftLogsOptions) Complete(f *clientcmd.Factory, cmd *cobra.Command, args []string, out io.Writer) error
Complete calls the upstream Complete for the logs command and then resolves the resource a user requested to view its logs and creates the appropriate logOptions object for it.
type ProjectOptions ¶
type ProjectOptions struct {
Config clientcmdapi.Config
ClientConfig *restclient.Config
ClientFn func() (projectclient.ProjectInterface, kclientset.Interface, error)
Out io.Writer
PathOptions *kclientcmd.PathOptions
ProjectName string
ProjectOnly bool
DisplayShort bool
// SkipAccessValidation means that if a specific name is requested, don't bother checking for access to the project
SkipAccessValidation bool
}
func (*ProjectOptions) Complete ¶
func (o *ProjectOptions) Complete(f *clientcmd.Factory, args []string, out io.Writer) error
func (*ProjectOptions) GetContextFromName ¶
func (o *ProjectOptions) GetContextFromName(contextName string) (*clientcmdapi.Context, bool)
returns a context by the given contextName and a boolean true if the context exists
func (ProjectOptions) RunProject ¶
func (o ProjectOptions) RunProject() error
RunProject contains all the necessary functionality for the OpenShift cli project command
type ProjectsOptions ¶
type ProjectsOptions struct {
Config clientcmdapi.Config
ClientConfig *restclient.Config
Client projectclient.ProjectInterface
KubeClient kclientset.Interface
Out io.Writer
PathOptions *kclientcmd.PathOptions
// internal strings
CommandName string
DisplayShort bool
}
func (*ProjectsOptions) Complete ¶
func (o *ProjectsOptions) Complete(f *clientcmd.Factory, args []string, commandName string, out io.Writer) error
func (ProjectsOptions) RunProjects ¶
func (o ProjectsOptions) RunProjects() error
RunProjects lists all projects a user belongs to
type RollbackOptions ¶
type RollbackOptions struct {
Namespace string
TargetName string
DesiredVersion int64
Format string
Template string
DryRun bool
IncludeTriggers bool
IncludeStrategy bool
IncludeScalingSettings bool
// contains filtered or unexported fields
}
RollbackOptions contains all the necessary state to perform a rollback.
type RshOptions ¶
type RshOptions struct {
ForceTTY bool
DisableTTY bool
Executable string
Timeout int
*kubecmd.ExecOptions
}
RshOptions declare the arguments accepted by the Rsh command
func (*RshOptions) Complete ¶
func (o *RshOptions) Complete(f *clientcmd.Factory, cmd *cobra.Command, args []string) error
Complete applies the command environment to RshOptions
type StartBuildOptions ¶
type StartBuildOptions struct {
In io.Reader
Out, ErrOut io.Writer
Git git.Repository
FromBuild string
FromWebhook string
ListWebhooks string
Commit string
FromFile string
FromDir string
FromRepo string
FromArchive string
Env []string
Args []string
Follow bool
WaitForComplete bool
IncrementalOverride bool
Incremental bool
NoCacheOverride bool
NoCache bool
LogLevel string
GitRepository string
GitPostReceive string
Mapper meta.RESTMapper
BuildClient buildclient.BuildInterface
ClientConfig kclientcmd.ClientConfig
AsBinary bool
ShortOutput bool
EnvVar []kapi.EnvVar
BuildArgs []kapi.EnvVar
Name string
Namespace string
}
func (*StartBuildOptions) Complete ¶
func (o *StartBuildOptions) Complete(f *clientcmd.Factory, in io.Reader, out, errout io.Writer, cmd *cobra.Command, cmdFullName string, args []string) error
func (*StartBuildOptions) Run ¶
func (o *StartBuildOptions) Run() error
Run contains all the necessary functionality for the OpenShift cli start-build command
func (*StartBuildOptions) RunListBuildWebHooks ¶
func (o *StartBuildOptions) RunListBuildWebHooks() error
RunListBuildWebHooks prints the webhooks for the provided build config.
func (*StartBuildOptions) RunStartBuildWebHook ¶
func (o *StartBuildOptions) RunStartBuildWebHook() error
RunStartBuildWebHook tries to trigger the provided webhook. It will attempt to utilize the current client configuration if the webhook has the same URL.
type StatusOptions ¶
type StatusOptions struct {
// contains filtered or unexported fields
}
StatusOptions contains all the necessary options for the Openshift cli status command.
func (*StatusOptions) Complete ¶
func (o *StatusOptions) Complete(f *clientcmd.Factory, cmd *cobra.Command, baseCLIName string, args []string, out io.Writer) error
Complete completes the options for the Openshift cli status command.
type TYPEOptions ¶
type TYPEOptions struct {
In io.Reader
Out, ErrOut io.Writer
}
type TagOptions ¶
type TagOptions struct {
// contains filtered or unexported fields
}
TagOptions contains all the necessary options for the cli tag command.
func (*TagOptions) Complete ¶
func (o *TagOptions) Complete(f *clientcmd.Factory, cmd *cobra.Command, args []string, out io.Writer) error
Complete completes all the required options for the tag command.
type VersionOptions ¶
type VersionOptions struct {
BaseName string
Out io.Writer
ClientConfig kclientcmd.ClientConfig
Clients func() (kclientset.Interface, error)
Timeout time.Duration
IsServer bool
PrintEtcdVersion bool
PrintClientFeatures bool
}
func (*VersionOptions) Complete ¶
func (o *VersionOptions) Complete(cmd *cobra.Command, f *clientcmd.Factory, out io.Writer) error
func (VersionOptions) RunVersion ¶
func (o VersionOptions) RunVersion() error
RunVersion attempts to display client and server versions for Kubernetes and OpenShift
type WhoAmIOptions ¶
type WhoAmIOptions struct {
UserInterface userclient.UserResourceInterface
Out io.Writer
}
Source Files
¶
- buildlogs.go
- cancelbuild.go
- debug.go
- deploy.go
- example.go
- export.go
- exporter.go
- expose.go
- extract.go
- helper.go
- idle.go
- importimage.go
- logs.go
- newapp.go
- newbuild.go
- options.go
- process.go
- project.go
- projects.go
- request_project.go
- rollback.go
- rsh.go
- startbuild.go
- status.go
- tag.go
- types.go
- version.go
- whoami.go
- wrappers.go