Documentation
¶
Index ¶
- Constants
- Variables
- func CreateVersionFactory(version, commit string) cli.CommandFactory
- func DatasetDownloadFactory() (cli.Command, error)
- func DatasetFactory() (cli.Command, error)
- func DatasetListFactory() (cli.Command, error)
- func DatasetUploadFactory() (cli.Command, error)
- func ErrorCauser(err error) error
- func HandleError(err error) error
- func LoginFactory() (cli.Command, error)
- func NewClient(c *conf.Config, session *conf.Session, outputter *format.Outputter) (*v1batch.Client, error)
- func ProgressBar(w io.Writer, total int64, progressCh <-chan int64, doneCh chan<- struct{})
- func ProjectExpelFactory() (cli.Command, error)
- func ProjectFactory() (cli.Command, error)
- func ProjectListFactory() (cli.Command, error)
- func ProjectPlaceFactory() (cli.Command, error)
- func ProjectSetFactory() (cli.Command, error)
- func SecretCreateFactory() (cli.Command, error)
- func SecretDeleteFactory() (cli.Command, error)
- func SecretDescribeFactory() (cli.Command, error)
- func SecretFactory() (cli.Command, error)
- func SecretListFactory() (cli.Command, error)
- func TaskCreateFactory() (cli.Command, error)
- func TaskDescribeFactory() (cli.Command, error)
- func TaskFactory() (cli.Command, error)
- func TaskFailureFactory() (cli.Command, error)
- func TaskHeartbeatFactory() (cli.Command, error)
- func TaskListFactory() (cli.Command, error)
- func TaskReceiveFactory() (cli.Command, error)
- func TaskStopFactory() (cli.Command, error)
- func TaskSuccessFactory() (cli.Command, error)
- func UserPassProvider(ui cli.Ui) func() (string, string, error)
- func WorkerFactory() (cli.Command, error)
- func WorkerLogsFactory() (cli.Command, error)
- func WorkloadDescribeFactory() (cli.Command, error)
- func WorkloadDownloadFactory() (cli.Command, error)
- func WorkloadFactory() (cli.Command, error)
- func WorkloadListFactory() (cli.Command, error)
- func WorkloadStartFactory() (cli.Command, error)
- func WorkloadStopFactory() (cli.Command, error)
- func WorkloadWorkFactory() (cli.Command, error)
- type Chunker
- type ConfOpts
- type Dataset
- type DatasetList
- type Download
- type Login
- type LoginOpts
- type OutputOpts
- type Project
- func (c Project) Description() string
- func (cmd *Project) DoRun(args []string) (err error)
- func (c Project) Help() string
- func (cmd *Project) HelpTemplate() string
- func (c Project) Options() *flags.Parser
- func (c Project) Run(args []string) int
- func (c Project) Synopsis() string
- func (c Project) Usage() string
- type ProjectExpel
- func (c ProjectExpel) Description() string
- func (cmd *ProjectExpel) DoRun(args []string) (err error)
- func (c ProjectExpel) Help() string
- func (c ProjectExpel) Options() *flags.Parser
- func (c ProjectExpel) Run(args []string) int
- func (c ProjectExpel) Synopsis() string
- func (c ProjectExpel) Usage() string
- type ProjectList
- type ProjectPlace
- func (c ProjectPlace) Description() string
- func (cmd *ProjectPlace) DoRun(args []string) (err error)
- func (c ProjectPlace) Help() string
- func (c ProjectPlace) Options() *flags.Parser
- func (c ProjectPlace) Run(args []string) int
- func (c ProjectPlace) Synopsis() string
- func (c ProjectPlace) Usage() string
- type ProjectPlaceOpts
- type ProjectSet
- type ProjectSetOpts
- type Secret
- type SecretCreate
- func (c SecretCreate) Description() string
- func (cmd *SecretCreate) DoRun(args []string) (err error)
- func (c SecretCreate) Help() string
- func (c SecretCreate) Options() *flags.Parser
- func (c SecretCreate) Run(args []string) int
- func (c SecretCreate) Synopsis() string
- func (c SecretCreate) Usage() string
- type SecretCreateOpts
- type SecretDelete
- func (c SecretDelete) Description() string
- func (cmd *SecretDelete) DoRun(args []string) (err error)
- func (c SecretDelete) Help() string
- func (c SecretDelete) Options() *flags.Parser
- func (c SecretDelete) Run(args []string) int
- func (c SecretDelete) Synopsis() string
- func (c SecretDelete) Usage() string
- type SecretDescribe
- func (c SecretDescribe) Description() string
- func (cmd *SecretDescribe) DoRun(args []string) (err error)
- func (c SecretDescribe) Help() string
- func (c SecretDescribe) Options() *flags.Parser
- func (c SecretDescribe) Run(args []string) int
- func (c SecretDescribe) Synopsis() string
- func (c SecretDescribe) Usage() string
- type SecretList
- type SecretListOpts
- type Task
- type TaskCreate
- type TaskCreateOpts
- type TaskDescribe
- func (c TaskDescribe) Description() string
- func (cmd *TaskDescribe) DoRun(args []string) (err error)
- func (c TaskDescribe) Help() string
- func (c TaskDescribe) Options() *flags.Parser
- func (c TaskDescribe) Run(args []string) int
- func (c TaskDescribe) Synopsis() string
- func (c TaskDescribe) Usage() string
- type TaskFailure
- type TaskHeartbeat
- func (c TaskHeartbeat) Description() string
- func (cmd *TaskHeartbeat) DoRun(args []string) (err error)
- func (c TaskHeartbeat) Help() string
- func (c TaskHeartbeat) Options() *flags.Parser
- func (c TaskHeartbeat) Run(args []string) int
- func (c TaskHeartbeat) Synopsis() string
- func (c TaskHeartbeat) Usage() string
- type TaskList
- type TaskReceive
- type TaskStop
- type TaskSuccess
- type Upload
- type Version
- type Worker
- type WorkerLogs
- type Workload
- func (c Workload) Description() string
- func (cmd *Workload) DoRun(args []string) (err error)
- func (c Workload) Help() string
- func (cmd *Workload) HelpTemplate() string
- func (c Workload) Options() *flags.Parser
- func (c Workload) Run(args []string) int
- func (c Workload) Synopsis() string
- func (c Workload) Usage() string
- type WorkloadDescribe
- func (c WorkloadDescribe) Description() string
- func (cmd *WorkloadDescribe) DoRun(args []string) (err error)
- func (c WorkloadDescribe) Help() string
- func (c WorkloadDescribe) Options() *flags.Parser
- func (c WorkloadDescribe) Run(args []string) int
- func (c WorkloadDescribe) Synopsis() string
- func (c WorkloadDescribe) Usage() string
- type WorkloadDownload
- func (c WorkloadDownload) Description() string
- func (cmd *WorkloadDownload) DoRun(args []string) (err error)
- func (c WorkloadDownload) Help() string
- func (c WorkloadDownload) Options() *flags.Parser
- func (c WorkloadDownload) Run(args []string) int
- func (c WorkloadDownload) Synopsis() string
- func (c WorkloadDownload) Usage() string
- type WorkloadList
- func (c WorkloadList) Description() string
- func (cmd *WorkloadList) DoRun(args []string) (err error)
- func (c WorkloadList) Help() string
- func (c WorkloadList) Options() *flags.Parser
- func (c WorkloadList) Run(args []string) int
- func (c WorkloadList) Synopsis() string
- func (c WorkloadList) Usage() string
- type WorkloadStart
- func (c WorkloadStart) Description() string
- func (cmd *WorkloadStart) DoRun(args []string) (err error)
- func (c WorkloadStart) Help() string
- func (c WorkloadStart) Options() *flags.Parser
- func (c WorkloadStart) Run(args []string) int
- func (c WorkloadStart) Synopsis() string
- func (c WorkloadStart) Usage() string
- type WorkloadStartOpts
- type WorkloadStop
- func (c WorkloadStop) Description() string
- func (cmd *WorkloadStop) DoRun(args []string) (err error)
- func (c WorkloadStop) Help() string
- func (c WorkloadStop) Options() *flags.Parser
- func (c WorkloadStop) Run(args []string) int
- func (c WorkloadStop) Synopsis() string
- func (c WorkloadStop) Usage() string
- type WorkloadWork
- func (c WorkloadWork) Description() string
- func (cmd *WorkloadWork) DoRun(args []string) (err error)
- func (c WorkloadWork) Help() string
- func (c WorkloadWork) Options() *flags.Parser
- func (c WorkloadWork) Run(args []string) int
- func (c WorkloadWork) Synopsis() string
- func (c WorkloadWork) Usage() string
- type WorkloadWorkOpts
Constants ¶
const ( //EnvConfigJSON can be used to pass the config file as a json encoded string EnvConfigJSON = "NERD_CONFIG_JSON" //EnvNerdProject can be used to set the nerd project EnvNerdProject = "NERD_PROJECT" )
const ( //OutputDirPermissions are the output directory's permissions. OutputDirPermissions = 0755 //DownloadConcurrency is the amount of concurrent download threads. DownloadConcurrency = 10 )
const (
//UploadConcurrency is the amount of concurrent upload threads.
UploadConcurrency = 64
)
Variables ¶
var (
SharedOptionsGroup = "Other Options"
)Functions ¶
func CreateVersionFactory ¶ added in v0.5.6
func CreateVersionFactory(version, commit string) cli.CommandFactory
CreateVersionFactory returns a factory method for the join command
func DatasetDownloadFactory ¶ added in v0.4.12
DatasetDownloadFactory returns a factory method for the join command
func DatasetFactory ¶ added in v0.4.12
DatasetFactory returns a factory method for the join command
func DatasetListFactory ¶ added in v0.4.15
DatasetListFactory returns a factory method for the join command
func DatasetUploadFactory ¶ added in v0.4.12
DatasetUploadFactory returns a factory method for the join command
func ErrorCauser ¶
ErrorCauser returns the error that is one level up in the error chain.
func HandleError ¶
HandleError handles the way errors are presented to the user.
func LoginFactory ¶
LoginFactory returns a factory method for the join command
func NewClient ¶
func NewClient(c *conf.Config, session *conf.Session, outputter *format.Outputter) (*v1batch.Client, error)
NewClient creates a new batch Client.
func ProgressBar ¶ added in v0.4.12
ProgressBar creates a new CLI progess bar and adds input from the progressCh to the bar.
func ProjectExpelFactory ¶ added in v0.4.12
ProjectExpelFactory returns a factory method for the join command
func ProjectFactory ¶ added in v0.4.12
ProjectFactory returns a factory method for the join command
func ProjectListFactory ¶ added in v0.4.12
ProjectListFactory returns a factory method for the join command
func ProjectPlaceFactory ¶ added in v0.4.12
ProjectPlaceFactory returns a factory method for the join command
func ProjectSetFactory ¶ added in v0.4.12
ProjectSetFactory returns a factory method for the join command
func SecretCreateFactory ¶ added in v0.5.6
SecretCreateFactory returns a factory method for the secret create command
func SecretDeleteFactory ¶ added in v0.5.6
SecretDeleteFactory returns a factory method for the secret delete command
func SecretDescribeFactory ¶ added in v0.5.6
SecretDescribeFactory returns a factory method for the secret describe command
func SecretFactory ¶ added in v0.5.6
SecretFactory returns a factory method for the secret command
func SecretListFactory ¶ added in v0.5.6
SecretListFactory returns a factory method for the secret list command
func TaskCreateFactory ¶ added in v0.5.7
TaskCreateFactory returns a factory method for the join command
func TaskDescribeFactory ¶ added in v0.4.12
TaskDescribeFactory returns a factory method for the join command
func TaskFactory ¶ added in v0.4.12
TaskFactory returns a factory method for the join command
func TaskFailureFactory ¶ added in v0.4.12
TaskFailureFactory returns a factory method for the join command
func TaskHeartbeatFactory ¶ added in v0.4.12
TaskHeartbeatFactory returns a factory method for the join command
func TaskListFactory ¶ added in v0.4.12
TaskListFactory returns a factory method for the join command
func TaskReceiveFactory ¶ added in v0.4.12
TaskReceiveFactory returns a factory method for the join command
func TaskStopFactory ¶ added in v0.4.12
TaskStopFactory returns a factory method for the join command
func TaskSuccessFactory ¶ added in v0.4.12
TaskSuccessFactory returns a factory method for the join command
func UserPassProvider ¶ added in v0.1.1
UserPassProvider prompts the username and password on stdin.
func WorkerFactory ¶ added in v0.4.12
WorkerFactory returns a factory method for the join command
func WorkerLogsFactory ¶ added in v0.5.1
WorkerLogsFactory returns a factory method for the join command
func WorkloadDescribeFactory ¶ added in v0.4.15
WorkloadDescribeFactory returns a factory method for the join command
func WorkloadDownloadFactory ¶ added in v0.4.15
WorkloadDownloadFactory returns a factory method for the join command
func WorkloadFactory ¶ added in v0.4.15
WorkloadFactory returns a factory method for the join command
func WorkloadListFactory ¶ added in v0.4.15
WorkloadListFactory returns a factory method for the join command
func WorkloadStartFactory ¶ added in v0.4.15
WorkloadStartFactory returns a factory method for the join command
func WorkloadStopFactory ¶ added in v0.4.15
WorkloadStopFactory returns a factory method for the join command
func WorkloadWorkFactory ¶ added in v0.4.15
WorkloadWorkFactory returns a factory method for the join command
Types ¶
type Chunker ¶ added in v0.4.12
type Chunker struct {
// contains filtered or unexported fields
}
Chunker is a wrapper of the restic/chunker library, to make it compatible with the v1data.Chunker interface.
func NewChunker ¶ added in v0.4.12
NewChunker returns a new Chunker
type ConfOpts ¶
type ConfOpts struct { ConfigFile func(string) `long:"config-file" default:"" default-mask:"" env:"NERD_CONFIG_FILE" description:"Location of config file"` SessionFile func(string) `long:"session-file" default:"" default-mask:"" env:"NERD_SESSION_FILE" description:"Location of session file"` OutputOpts }
ConfOpts are the options related to config file and the way output is handled.
type Dataset ¶ added in v0.4.12
type Dataset struct {
// contains filtered or unexported fields
}
Dataset command
func (Dataset) Description ¶ added in v0.5.1
func (c Dataset) Description() string
func (Dataset) Help ¶ added in v0.4.12
func (c Dataset) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (Dataset) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type DatasetList ¶ added in v0.4.15
type DatasetList struct {
// contains filtered or unexported fields
}
DatasetList command
func (DatasetList) Description ¶ added in v0.5.1
func (c DatasetList) Description() string
func (*DatasetList) DoRun ¶ added in v0.4.15
func (cmd *DatasetList) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (DatasetList) Help ¶ added in v0.4.15
func (c DatasetList) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (DatasetList) Run ¶ added in v0.4.15
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type Download ¶
type Download struct {
// contains filtered or unexported fields
}
Download command
func (Download) Description ¶ added in v0.5.1
func (c Download) Description() string
func (Download) Help ¶
func (c Download) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (Download) Run ¶
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type Login ¶
type Login struct {
// contains filtered or unexported fields
}
Login command
func (Login) Description ¶ added in v0.5.1
func (c Login) Description() string
func (Login) Help ¶
func (c Login) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (Login) Run ¶
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type LoginOpts ¶
type LoginOpts struct { Config string `long:"config-src" default:"oidc" default-mask:"" description:"type of configuration to use (from env, endpoint, or oidc)"` KubeConfig string `` /* 135-byte string literal not displayed */ }
LoginOpts defines options for login command
type OutputOpts ¶
type OutputOpts struct { Debug func(bool) `long:"debug" default:"false" optional:"true" optional-value:"true" description:"Show debug output" env:"NERD_DEBUG"` Output func(string) `long:"output" default:"pretty" description:"Format of the output" choice:"pretty" choice:"raw" choice:"json"` }
OutputOpts are options that are related to CLI output.
type Project ¶ added in v0.4.12
type Project struct {
// contains filtered or unexported fields
}
Project command
func (Project) Description ¶ added in v0.5.1
func (c Project) Description() string
func (Project) Help ¶ added in v0.4.12
func (c Project) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (*Project) HelpTemplate ¶ added in v0.4.15
HelpTemplate provides a template for the help command, which excludes the "expel" and "place" subcommands
func (Project) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type ProjectExpel ¶ added in v0.4.12
type ProjectExpel struct {
// contains filtered or unexported fields
}
ProjectExpel command
func (ProjectExpel) Description ¶ added in v0.5.1
func (c ProjectExpel) Description() string
func (*ProjectExpel) DoRun ¶ added in v0.4.12
func (cmd *ProjectExpel) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (ProjectExpel) Help ¶ added in v0.4.12
func (c ProjectExpel) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (ProjectExpel) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type ProjectList ¶ added in v0.4.12
type ProjectList struct {
// contains filtered or unexported fields
}
ProjectList command
func (ProjectList) Description ¶ added in v0.5.1
func (c ProjectList) Description() string
func (*ProjectList) DoRun ¶ added in v0.4.12
func (cmd *ProjectList) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (ProjectList) Help ¶ added in v0.4.12
func (c ProjectList) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (ProjectList) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type ProjectPlace ¶ added in v0.4.12
type ProjectPlace struct {
// contains filtered or unexported fields
}
ProjectPlace command
func (ProjectPlace) Description ¶ added in v0.5.1
func (c ProjectPlace) Description() string
func (*ProjectPlace) DoRun ¶ added in v0.4.12
func (cmd *ProjectPlace) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (ProjectPlace) Help ¶ added in v0.4.12
func (c ProjectPlace) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (ProjectPlace) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type ProjectPlaceOpts ¶ added in v0.4.12
type ProjectPlaceOpts struct { Token string `long:"token" default:"" default-mask:"" description:"placement that authenticates using JWT"` Username string `long:"username" default:"" default-mask:"" description:"username for placement that authenticates using username/password"` Password string `long:"password" default:"" default-mask:"" description:"password for placement that authenticates using username/password"` Insecure bool `long:"insecure" default-mask:"" description:"disable checking of server certificate"` ComputeUnits string `long:"compute_units" default:"2" description:"default size of a project"` }
ProjectPlaceOpts describes command options
type ProjectSet ¶ added in v0.4.12
type ProjectSet struct {
// contains filtered or unexported fields
}
ProjectSet command
func (ProjectSet) Description ¶ added in v0.5.1
func (c ProjectSet) Description() string
func (*ProjectSet) DoRun ¶ added in v0.4.12
func (cmd *ProjectSet) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (ProjectSet) Help ¶ added in v0.4.12
func (c ProjectSet) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (ProjectSet) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type ProjectSetOpts ¶
type ProjectSetOpts struct { Config string `long:"config-src" default:"oidc" default-mask:"" description:"type of configuration to use (from env, endpoint, or oidc)"` KubeConfig string `` /* 135-byte string literal not displayed */ }
ProjectSetOpts determine
type Secret ¶ added in v0.5.6
type Secret struct {
// contains filtered or unexported fields
}
Secret command
func (Secret) Description ¶ added in v0.5.6
func (c Secret) Description() string
func (Secret) Help ¶ added in v0.5.6
func (c Secret) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (Secret) Run ¶ added in v0.5.6
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type SecretCreate ¶ added in v0.5.6
type SecretCreate struct {
// contains filtered or unexported fields
}
SecretCreate command
func (SecretCreate) Description ¶ added in v0.5.6
func (c SecretCreate) Description() string
func (*SecretCreate) DoRun ¶ added in v0.5.6
func (cmd *SecretCreate) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (SecretCreate) Help ¶ added in v0.5.6
func (c SecretCreate) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (SecretCreate) Run ¶ added in v0.5.6
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type SecretCreateOpts ¶ added in v0.5.6
type SecretCreateOpts struct { Username string `long:"username" default:"" default-mask:"" description:"Username for Docker registry authentication"` Password string `long:"password" default:"" default-mask:"" description:"Password for Docker registry authentication"` Type string `long:"type" default:"opaque" default-mask:"" description:"Type of secret to display"` }
SecretCreateOpts describes the options to the SecretCreate command
type SecretDelete ¶ added in v0.5.6
type SecretDelete struct {
// contains filtered or unexported fields
}
SecretDelete command
func (SecretDelete) Description ¶ added in v0.5.6
func (c SecretDelete) Description() string
func (*SecretDelete) DoRun ¶ added in v0.5.6
func (cmd *SecretDelete) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (SecretDelete) Help ¶ added in v0.5.6
func (c SecretDelete) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (SecretDelete) Run ¶ added in v0.5.6
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type SecretDescribe ¶ added in v0.5.6
type SecretDescribe struct {
// contains filtered or unexported fields
}
SecretDescribe command
func (SecretDescribe) Description ¶ added in v0.5.6
func (c SecretDescribe) Description() string
func (*SecretDescribe) DoRun ¶ added in v0.5.6
func (cmd *SecretDescribe) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (SecretDescribe) Help ¶ added in v0.5.6
func (c SecretDescribe) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (SecretDescribe) Run ¶ added in v0.5.6
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type SecretList ¶ added in v0.5.6
type SecretList struct {
// contains filtered or unexported fields
}
SecretList command
func (SecretList) Description ¶ added in v0.5.6
func (c SecretList) Description() string
func (*SecretList) DoRun ¶ added in v0.5.6
func (cmd *SecretList) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (SecretList) Help ¶ added in v0.5.6
func (c SecretList) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (SecretList) Run ¶ added in v0.5.6
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type SecretListOpts ¶ added in v0.5.6
type SecretListOpts struct {
Type string `long:"type" default:"all" default-mask:"" description:"Type of secret to display, defaults to all."`
}
SecretListOpts describes the options to the SecretList command
type Task ¶ added in v0.4.12
type Task struct {
// contains filtered or unexported fields
}
Task command
func (Task) Description ¶ added in v0.5.1
func (c Task) Description() string
func (Task) Help ¶ added in v0.4.12
func (c Task) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (*Task) HelpTemplate ¶ added in v0.4.15
HelpTemplate provides a template for the help command, which excludes the "failure", "heartbeat", "receive", and "success" subcommands
func (Task) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type TaskCreate ¶ added in v0.5.7
type TaskCreate struct {
// contains filtered or unexported fields
}
TaskCreate command
func (TaskCreate) Description ¶ added in v0.5.7
func (c TaskCreate) Description() string
func (*TaskCreate) DoRun ¶ added in v0.5.7
func (cmd *TaskCreate) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (TaskCreate) Help ¶ added in v0.5.7
func (c TaskCreate) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (TaskCreate) Run ¶ added in v0.5.7
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type TaskCreateOpts ¶ added in v0.5.7
type TaskCreateOpts struct {
Env []string `long:"env" short:"e" description:"environment variables to use"`
}
TaskCreateOpts describes command options
type TaskDescribe ¶ added in v0.4.12
type TaskDescribe struct {
// contains filtered or unexported fields
}
TaskDescribe command
func (TaskDescribe) Description ¶ added in v0.5.1
func (c TaskDescribe) Description() string
func (*TaskDescribe) DoRun ¶ added in v0.4.12
func (cmd *TaskDescribe) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (TaskDescribe) Help ¶ added in v0.4.12
func (c TaskDescribe) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (TaskDescribe) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type TaskFailure ¶ added in v0.4.12
type TaskFailure struct {
// contains filtered or unexported fields
}
TaskFailure command
func (TaskFailure) Description ¶ added in v0.5.1
func (c TaskFailure) Description() string
func (*TaskFailure) DoRun ¶ added in v0.4.12
func (cmd *TaskFailure) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (TaskFailure) Help ¶ added in v0.4.12
func (c TaskFailure) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (TaskFailure) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type TaskHeartbeat ¶ added in v0.4.12
type TaskHeartbeat struct {
// contains filtered or unexported fields
}
TaskHeartbeat command
func (TaskHeartbeat) Description ¶ added in v0.5.1
func (c TaskHeartbeat) Description() string
func (*TaskHeartbeat) DoRun ¶ added in v0.4.12
func (cmd *TaskHeartbeat) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (TaskHeartbeat) Help ¶ added in v0.4.12
func (c TaskHeartbeat) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (TaskHeartbeat) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type TaskList ¶ added in v0.4.12
type TaskList struct {
// contains filtered or unexported fields
}
TaskList command
func (TaskList) Description ¶ added in v0.5.1
func (c TaskList) Description() string
func (TaskList) Help ¶ added in v0.4.12
func (c TaskList) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (TaskList) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type TaskReceive ¶ added in v0.4.12
type TaskReceive struct {
// contains filtered or unexported fields
}
TaskReceive command
func (TaskReceive) Description ¶ added in v0.5.1
func (c TaskReceive) Description() string
func (*TaskReceive) DoRun ¶ added in v0.4.12
func (cmd *TaskReceive) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (TaskReceive) Help ¶ added in v0.4.12
func (c TaskReceive) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (TaskReceive) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type TaskStop ¶ added in v0.4.12
type TaskStop struct {
// contains filtered or unexported fields
}
TaskStop command
func (TaskStop) Description ¶ added in v0.5.1
func (c TaskStop) Description() string
func (TaskStop) Help ¶ added in v0.4.12
func (c TaskStop) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (TaskStop) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type TaskSuccess ¶ added in v0.4.12
type TaskSuccess struct {
// contains filtered or unexported fields
}
TaskSuccess command
func (TaskSuccess) Description ¶ added in v0.5.1
func (c TaskSuccess) Description() string
func (*TaskSuccess) DoRun ¶ added in v0.4.12
func (cmd *TaskSuccess) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (TaskSuccess) Help ¶ added in v0.4.12
func (c TaskSuccess) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (TaskSuccess) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type Upload ¶
type Upload struct {
// contains filtered or unexported fields
}
Upload command
func (Upload) Description ¶ added in v0.5.1
func (c Upload) Description() string
func (Upload) Help ¶
func (c Upload) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (Upload) Run ¶
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type Version ¶ added in v0.5.6
type Version struct {
// contains filtered or unexported fields
}
Version command
func (Version) Description ¶ added in v0.5.6
func (c Version) Description() string
func (Version) Help ¶ added in v0.5.6
func (c Version) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
type Worker ¶ added in v0.4.12
type Worker struct {
// contains filtered or unexported fields
}
Worker command
func (Worker) Description ¶ added in v0.5.1
func (c Worker) Description() string
func (Worker) Help ¶ added in v0.4.12
func (c Worker) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (Worker) Run ¶ added in v0.4.12
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type WorkerLogs ¶ added in v0.5.1
type WorkerLogs struct {
// contains filtered or unexported fields
}
WorkerLogs command
func (WorkerLogs) Description ¶ added in v0.5.1
func (c WorkerLogs) Description() string
func (*WorkerLogs) DoRun ¶ added in v0.5.1
func (cmd *WorkerLogs) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (WorkerLogs) Help ¶ added in v0.5.1
func (c WorkerLogs) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (WorkerLogs) Run ¶ added in v0.5.1
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type Workload ¶ added in v0.4.15
type Workload struct {
// contains filtered or unexported fields
}
Workload command
func (Workload) Description ¶ added in v0.5.1
func (c Workload) Description() string
func (Workload) Help ¶ added in v0.4.15
func (c Workload) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (*Workload) HelpTemplate ¶ added in v0.4.15
HelpTemplate provides a template for the help command, which excludes the "workload work" command
func (Workload) Run ¶ added in v0.4.15
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type WorkloadDescribe ¶ added in v0.4.15
type WorkloadDescribe struct {
// contains filtered or unexported fields
}
WorkloadDescribe command
func (WorkloadDescribe) Description ¶ added in v0.5.1
func (c WorkloadDescribe) Description() string
func (*WorkloadDescribe) DoRun ¶ added in v0.4.15
func (cmd *WorkloadDescribe) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (WorkloadDescribe) Help ¶ added in v0.4.15
func (c WorkloadDescribe) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (WorkloadDescribe) Run ¶ added in v0.4.15
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type WorkloadDownload ¶ added in v0.4.15
type WorkloadDownload struct {
// contains filtered or unexported fields
}
WorkloadDownload command
func (WorkloadDownload) Description ¶ added in v0.5.1
func (c WorkloadDownload) Description() string
func (*WorkloadDownload) DoRun ¶ added in v0.4.15
func (cmd *WorkloadDownload) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (WorkloadDownload) Help ¶ added in v0.4.15
func (c WorkloadDownload) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (WorkloadDownload) Run ¶ added in v0.4.15
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type WorkloadList ¶ added in v0.4.15
type WorkloadList struct {
// contains filtered or unexported fields
}
WorkloadList command
func (WorkloadList) Description ¶ added in v0.5.1
func (c WorkloadList) Description() string
func (*WorkloadList) DoRun ¶ added in v0.4.15
func (cmd *WorkloadList) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (WorkloadList) Help ¶ added in v0.4.15
func (c WorkloadList) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (WorkloadList) Run ¶ added in v0.4.15
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type WorkloadStart ¶ added in v0.4.15
type WorkloadStart struct {
// contains filtered or unexported fields
}
WorkloadStart command
func (WorkloadStart) Description ¶ added in v0.5.1
func (c WorkloadStart) Description() string
func (*WorkloadStart) DoRun ¶ added in v0.4.15
func (cmd *WorkloadStart) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (WorkloadStart) Help ¶ added in v0.4.15
func (c WorkloadStart) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (WorkloadStart) Run ¶ added in v0.4.15
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type WorkloadStartOpts ¶ added in v0.4.15
type WorkloadStartOpts struct { Env []string `long:"env" short:"e" description:"Environment variables"` InputDataset string `long:"input-dataset" short:"d" description:"Input dataset ID, will be available in /input in your container"` Instances int `long:"instances" short:"i" default:"1" description:"Number of working instances"` PullSecret string `long:"pull-secret" short:"p" description:"The pull secret will be used to fetch the private image"` Size uint64 `long:"size" short:"s" description:"The amount of resources you want to use for your workload, in compute units."` }
WorkloadStartOpts describes command options
type WorkloadStop ¶ added in v0.4.15
type WorkloadStop struct {
// contains filtered or unexported fields
}
WorkloadStop command
func (WorkloadStop) Description ¶ added in v0.5.1
func (c WorkloadStop) Description() string
func (*WorkloadStop) DoRun ¶ added in v0.4.15
func (cmd *WorkloadStop) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (WorkloadStop) Help ¶ added in v0.4.15
func (c WorkloadStop) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (WorkloadStop) Run ¶ added in v0.4.15
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type WorkloadWork ¶ added in v0.4.15
type WorkloadWork struct {
// contains filtered or unexported fields
}
WorkloadWork command
func (WorkloadWork) Description ¶ added in v0.5.1
func (c WorkloadWork) Description() string
func (*WorkloadWork) DoRun ¶ added in v0.4.15
func (cmd *WorkloadWork) DoRun(args []string) (err error)
DoRun is called by run and allows an error to be returned
func (WorkloadWork) Help ¶ added in v0.4.15
func (c WorkloadWork) Help() string
Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.
func (WorkloadWork) Run ¶ added in v0.4.15
Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1
type WorkloadWorkOpts ¶ added in v0.4.15
type WorkloadWorkOpts struct { EntrypointJSONB64 string `long:"entrypoint-json-base64" default:"W10=" description:"Work entrypoint, first json and then base64 encoded."` CmdJSONB64 string `long:"cmd-json-base64" default:"W10=" description:"Work cmd, first json and then base64 encoded."` OutputDir string `` /* 127-byte string literal not displayed */ }
WorkloadWorkOpts describes command options
Source Files
¶
- command.go
- dataset.go
- dataset_download.go
- dataset_list.go
- dataset_upload.go
- login.go
- opts.go
- project.go
- project_expel.go
- project_list.go
- project_place.go
- project_set.go
- secret.go
- secret_create.go
- secret_delete.go
- secret_describe.go
- secret_list.go
- task.go
- task_create.go
- task_describe.go
- task_failure.go
- task_heartbeat.go
- task_list.go
- task_receive.go
- task_stop.go
- task_success.go
- utils.go
- version.go
- worker.go
- worker_logs.go
- workload.go
- workload_describe.go
- workload_download.go
- workload_list.go
- workload_start.go
- workload_stop.go
- workload_work.go