commands

package
Version: v2.8.0-rc.24+incompatible Latest Latest
Warning

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

Go to latest
Published: Mar 13, 2017 License: Apache-2.0 Imports: 40 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrShowHelpMessage = errors.New("help command invoked")

Functions

func GetBuild

func GetBuild(client concourse.Client, team concourse.Team, jobName string, buildNameOrID string, pipelineName string) (atc.Build, error)

func GetExpirationFromString

func GetExpirationFromString(token *rc.TargetToken) string

func SliceItoa

func SliceItoa(slice []int) string

Types

type AbortBuildCommand

type AbortBuildCommand struct {
	Job   flaghelpers.JobFlag `short:"j" long:"job"   required:"true" value-name:"PIPELINE/JOB"   description:"Name of a job to cancel"`
	Build string              `short:"b" long:"build" required:"true" description:"Name of the build to cancel"`
}

func (*AbortBuildCommand) Execute

func (command *AbortBuildCommand) Execute([]string) error

type BuildsCommand

type BuildsCommand struct {
	Count int                 `short:"c" long:"count" default:"50"															description:"number of builds you want to limit the return to"`
	Job   flaghelpers.JobFlag `short:"j" long:"job"									value-name:"PIPELINE/JOB"		description:"Name of a job to get builds for"`
}

func (*BuildsCommand) Execute

func (command *BuildsCommand) Execute([]string) error

type CheckResourceCommand

type CheckResourceCommand struct {
	Resource flaghelpers.ResourceFlag `` /* 126-byte string literal not displayed */
	Version  *atc.Version             `` /* 161-byte string literal not displayed */
}

func (*CheckResourceCommand) Execute

func (command *CheckResourceCommand) Execute(args []string) error

type ChecklistCommand

type ChecklistCommand struct {
	Pipeline string `short:"p" long:"pipeline" required:"true" description:"The pipeline from which to generate the Checkfile"`
}

func (*ChecklistCommand) Execute

func (command *ChecklistCommand) Execute([]string) error

type ContainersCommand

type ContainersCommand struct{}

func (*ContainersCommand) Execute

func (command *ContainersCommand) Execute([]string) error

type DestroyPipelineCommand

type DestroyPipelineCommand struct {
	Pipeline        string `short:"p"  long:"pipeline" required:"true" description:"Pipeline to destroy"`
	SkipInteractive bool   `short:"n"  long:"non-interactive"          description:"Destroy the pipeline without confirmation"`
}

func (*DestroyPipelineCommand) Execute

func (command *DestroyPipelineCommand) Execute(args []string) error

type DestroyTeamCommand

type DestroyTeamCommand struct {
	TeamName string `short:"n" long:"team-name" required:"true"        description:"The team to delete"`
}

func (*DestroyTeamCommand) Execute

func (command *DestroyTeamCommand) Execute([]string) error

type ExecuteCommand

type ExecuteCommand struct {
	TaskConfig     atc.PathFlag                 `short:"c" long:"config" required:"true"                description:"The task config to execute"`
	Privileged     bool                         `short:"p" long:"privileged"                            description:"Run the task with full privileges"`
	ExcludeIgnored bool                         `` /* 182-byte string literal not displayed */
	Inputs         []flaghelpers.InputPairFlag  `` /* 134-byte string literal not displayed */
	InputsFrom     flaghelpers.JobFlag          `short:"j" long:"inputs-from" value-name:"PIPELINE/JOB" description:"A job to base the inputs on"`
	Outputs        []flaghelpers.OutputPairFlag `` /* 135-byte string literal not displayed */
	Tags           []string                     `` /* 135-byte string literal not displayed */
}

func (*ExecuteCommand) Execute

func (command *ExecuteCommand) Execute(args []string) error

type ExposePipelineCommand

type ExposePipelineCommand struct {
	Pipeline string `short:"p" long:"pipeline" required:"true" description:"Pipeline to expose"`
}

func (*ExposePipelineCommand) Execute

func (command *ExposePipelineCommand) Execute(args []string) error

type FlyCommand

type FlyCommand struct {
	Help HelpCommand `command:"help" description:"Print this help message"`

	Target  rc.TargetName  `short:"t" long:"target" description:"Concourse target name"`
	Targets TargetsCommand `command:"targets" alias:"ts" description:"List saved targets"`

	Version func() `short:"v" long:"version" description:"Print the version of Fly and exit"`

	PrintTableHeaders bool `long:"print-table-headers" description:"Print table headers even for redirected output"`

	Login  LoginCommand  `command:"login" alias:"l" description:"Authenticate with the target"`
	Logout LogoutCommand `command:"logout" alias:"o" description:"Release authentication with the target"`
	Sync   SyncCommand   `command:"sync"  alias:"s" description:"Download and replace the current fly from the target"`

	Teams       TeamsCommand       `command:"teams" alias:"t" description:"List the configured teams"`
	SetTeam     SetTeamCommand     `command:"set-team"  alias:"st" description:"Create or modify a team to have the given credentials"`
	DestroyTeam DestroyTeamCommand `command:"destroy-team"  alias:"dt" description:"Destroy a team and delete all of its data"`

	Checklist ChecklistCommand `command:"checklist" alias:"cl" description:"Print a Checkfile of the given pipeline"`

	Execute ExecuteCommand `command:"execute" alias:"e" description:"Execute a one-off build using local bits"`
	Watch   WatchCommand   `command:"watch"   alias:"w" description:"Stream a build's output"`

	Containers ContainersCommand `command:"containers" alias:"cs" description:"Print the active containers"`
	Hijack     HijackCommand     `command:"hijack"     alias:"intercept" alias:"i" description:"Execute a command in a container"`

	PauseJob   PauseJobCommand   `command:"pause-job" alias:"pj" description:"Pause a job"`
	UnpauseJob UnpauseJobCommand `command:"unpause-job" alias:"uj" description:"Unpause a job"`

	Pipelines        PipelinesCommand        `command:"pipelines"         alias:"ps" description:"List the configured pipelines"`
	DestroyPipeline  DestroyPipelineCommand  `command:"destroy-pipeline"  alias:"dp" description:"Destroy a pipeline"`
	ValidatePipeline ValidatePipelineCommand `command:"validate-pipeline" alias:"vp" description:"Validate a pipeline's current configuration"`
	GetPipeline      GetPipelineCommand      `command:"get-pipeline"      alias:"gp" description:"Get a pipeline's current configuration"`
	SetPipeline      SetPipelineCommand      `command:"set-pipeline"      alias:"sp" description:"Create or update a pipeline's configuration"`
	PausePipeline    PausePipelineCommand    `command:"pause-pipeline"    alias:"pp" description:"Pause a pipeline"`
	UnpausePipeline  UnpausePipelineCommand  `command:"unpause-pipeline"  alias:"up" description:"Un-pause a pipeline"`
	ExposePipeline   ExposePipelineCommand   `command:"expose-pipeline"   alias:"ep" description:"Make a pipeline publicly viewable"`
	HidePipeline     HidePipelineCommand     `command:"hide-pipeline"     alias:"hp" description:"Hide a pipeline from the public"`
	RenamePipeline   RenamePipelineCommand   `command:"rename-pipeline"   alias:"rp" description:"Rename a pipeline"`

	CheckResource   CheckResourceCommand   `command:"check-resource"    alias:"cr" description:"Check a resource"`
	PauseResource   PauseResourceCommand   `command:"pause-resource"    alias:"pr" description:"Pause a resource"`
	UnpauseResource UnpauseResourceCommand `command:"unpause-resource"  alias:"ur" description:"Unpause a resource"`

	Builds     BuildsCommand     `command:"builds"      alias:"bs" description:"List builds data"`
	AbortBuild AbortBuildCommand `command:"abort-build" alias:"ab" description:"Abort a build"`

	TriggerJob TriggerJobCommand `command:"trigger-job" alias:"tj" description:"Start a job in a pipeline"`

	Volumes VolumesCommand `command:"volumes" alias:"vs" description:"List the active volumes"`

	Workers     WorkersCommand     `command:"workers" alias:"ws" description:"List the registered workers"`
	PruneWorker PruneWorkerCommand `command:"prune-worker" alias:"pw" description:"Prune a stalled, landing, landed, or retiring worker"`
}
var Fly FlyCommand

type GetPipelineCommand

type GetPipelineCommand struct {
	Pipeline string `short:"p" long:"pipeline" required:"true" description:"Get configuration of this pipeline"`
	JSON     bool   `short:"j" long:"json"                     description:"Print config as json instead of yaml"`
}

func (*GetPipelineCommand) Execute

func (command *GetPipelineCommand) Execute(args []string) error

type HelpCommand

type HelpCommand struct{}

func (*HelpCommand) Execute

func (command *HelpCommand) Execute(args []string) error

type HidePipelineCommand

type HidePipelineCommand struct {
	Pipeline string `short:"p" long:"pipeline" required:"true" description:"Pipeline to ide"`
}

func (*HidePipelineCommand) Execute

func (command *HidePipelineCommand) Execute(args []string) error

type HijackCommand

type HijackCommand struct {
	Job            flaghelpers.JobFlag      `short:"j" long:"job"   value-name:"PIPELINE/JOB"   description:"Name of a job to hijack"`
	Check          flaghelpers.ResourceFlag `short:"c" long:"check" value-name:"PIPELINE/CHECK" description:"Name of a resource's checking container to hijack"`
	Build          string                   `short:"b" long:"build"                             description:"Build number within the job, or global build ID"`
	StepName       string                   `short:"s" long:"step"                              description:"Name of step to hijack (e.g. build, unit, resource name)"`
	Attempt        []int                    `short:"a" long:"attempt" description:"Attempt number of step to hijack. Can be specified multiple times for nested retries"`
	PositionalArgs struct {
		Command []string `positional-arg-name:"command" description:"The command to run in the container (default: bash)"`
	} `positional-args:"yes"`
}

func (*HijackCommand) Execute

func (command *HijackCommand) Execute([]string) error

type LoginCommand

type LoginCommand struct {
	ATCURL   string       `short:"c" long:"concourse-url" description:"Concourse URL to authenticate with"`
	Insecure bool         `short:"k" long:"insecure" description:"Skip verification of the endpoint's SSL certificate"`
	Username string       `short:"u" long:"username" description:"Username for basic auth"`
	Password string       `short:"p" long:"password" description:"Password for basic auth"`
	TeamName string       `short:"n" long:"team-name" description:"Team to authenticate with"`
	CACert   atc.PathFlag `long:"ca-cert" description:"Path to Concourse PEM-encoded CA certificate file."`
}

func (*LoginCommand) Execute

func (command *LoginCommand) Execute(args []string) error

type LogoutCommand

type LogoutCommand struct {
	All bool `short:"a" long:"all" description:"Logout of all targets"`
}

func (*LogoutCommand) Execute

func (command *LogoutCommand) Execute(args []string) error

type PauseJobCommand

type PauseJobCommand struct {
	Job flaghelpers.JobFlag `short:"j" long:"job" required:"true" value-name:"PIPELINE/JOB" description:"Name of a job to pause"`
}

func (*PauseJobCommand) Execute

func (command *PauseJobCommand) Execute(args []string) error

type PausePipelineCommand

type PausePipelineCommand struct {
	Pipeline string `short:"p"  long:"pipeline" required:"true" description:"Pipeline to pause"`
}

func (*PausePipelineCommand) Execute

func (command *PausePipelineCommand) Execute(args []string) error

type PauseResourceCommand

type PauseResourceCommand struct {
	Resource flaghelpers.ResourceFlag `short:"r" long:"resource" required:"true" value-name:"PIPELINE/RESOURCE" description:"Name of a resource to pause"`
}

func (*PauseResourceCommand) Execute

func (command *PauseResourceCommand) Execute(args []string) error

type PipelinesCommand

type PipelinesCommand struct {
	All bool `short:"a"  long:"all" description:"Show all pipelines"`
}

func (*PipelinesCommand) Execute

func (command *PipelinesCommand) Execute([]string) error

type PruneWorkerCommand

type PruneWorkerCommand struct {
	Worker string `short:"w"  long:"worker" required:"true" description:"Worker to prune"`
}

func (*PruneWorkerCommand) Execute

func (command *PruneWorkerCommand) Execute(args []string) error

type RenamePipelineCommand

type RenamePipelineCommand struct {
	Pipeline string `short:"o"  long:"old-name" required:"true"  description:"Pipeline to rename"`
	Name     string `short:"n"  long:"new-name" required:"true"  description:"Name to set as pipeline name"`
}

func (*RenamePipelineCommand) Execute

func (rp *RenamePipelineCommand) Execute([]string) error

type SetPipelineCommand

type SetPipelineCommand struct {
	Pipeline        string                         `short:"p"  long:"pipeline" required:"true"      description:"Pipeline to configure"`
	Config          atc.PathFlag                   `short:"c"  long:"config" required:"true"        description:"Pipeline configuration file"`
	Var             []flaghelpers.VariablePairFlag `` /* 140-byte string literal not displayed */
	VarsFrom        []atc.PathFlag                 `` /* 157-byte string literal not displayed */
	SkipInteractive bool                           `short:"n"  long:"non-interactive"               description:"Skips interactions, uses default values"`
}

func (*SetPipelineCommand) Execute

func (command *SetPipelineCommand) Execute(args []string) error

type SetTeamCommand

type SetTeamCommand struct {
	TeamName       string        `short:"n" long:"team-name" required:"true"        description:"The team to create or modify"`
	Authentication atc.AuthFlags `group:"Authentication"`
}

func (*SetTeamCommand) Execute

func (command *SetTeamCommand) Execute([]string) error

func (*SetTeamCommand) ValidateFlags

func (command *SetTeamCommand) ValidateFlags() error

type SyncCommand

type SyncCommand struct{}

func (*SyncCommand) Execute

func (command *SyncCommand) Execute(args []string) error

type TargetsCommand

type TargetsCommand struct{}

func (*TargetsCommand) Execute

func (command *TargetsCommand) Execute([]string) error

type TeamsCommand

type TeamsCommand struct{}

func (*TeamsCommand) Execute

func (command *TeamsCommand) Execute([]string) error

type TriggerJobCommand

type TriggerJobCommand struct {
	Job   flaghelpers.JobFlag `short:"j" long:"job" required:"true" value-name:"PIPELINE/JOB" description:"Name of a job to trigger"`
	Watch bool                `short:"w" long:"watch" description:"Start watching the build output"`
}

func (*TriggerJobCommand) Execute

func (command *TriggerJobCommand) Execute(args []string) error

type UnpauseJobCommand

type UnpauseJobCommand struct {
	Job flaghelpers.JobFlag `short:"j" long:"job" required:"true" value-name:"PIPELINE/JOB" description:"Name of a job to unpause"`
}

func (*UnpauseJobCommand) Execute

func (command *UnpauseJobCommand) Execute(args []string) error

type UnpausePipelineCommand

type UnpausePipelineCommand struct {
	Pipeline string `short:"p" long:"pipeline" required:"true" description:"Pipeline to unpause"`
}

func (*UnpausePipelineCommand) Execute

func (command *UnpausePipelineCommand) Execute(args []string) error

type UnpauseResourceCommand

type UnpauseResourceCommand struct {
	Resource flaghelpers.ResourceFlag `short:"r" long:"resource" required:"true" value-name:"PIPELINE/RESOURCE" description:"Name of a resource to unpause"`
}

func (*UnpauseResourceCommand) Execute

func (command *UnpauseResourceCommand) Execute(args []string) error

type ValidatePipelineCommand

type ValidatePipelineCommand struct {
	Config atc.PathFlag `short:"c" long:"config" required:"true"        description:"Pipeline configuration file"`
	Strict bool         `short:"s" long:"strict"                        description:"Fail on warnings"`
}

func (*ValidatePipelineCommand) Execute

func (command *ValidatePipelineCommand) Execute(args []string) error

type VolumesCommand

type VolumesCommand struct {
	Details bool `short:"d" long:"details" description:"Print additional information for each volume"`
}

func (*VolumesCommand) Execute

func (command *VolumesCommand) Execute([]string) error

type WatchCommand

type WatchCommand struct {
	Job   flaghelpers.JobFlag `short:"j" long:"job"   value-name:"PIPELINE/JOB"   description:"Watches builds of the given job"`
	Build string              `short:"b" long:"build"                               description:"Watches a specific build"`
}

func (*WatchCommand) Execute

func (command *WatchCommand) Execute(args []string) error

type WorkersCommand

type WorkersCommand struct {
	Details bool `short:"d" long:"details" description:"Print additional information for each worker"`
}

func (*WorkersCommand) Execute

func (command *WorkersCommand) Execute([]string) error

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL