cliflags

Documentation

Index

• Constants
• func ConfigAutoComplete(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
• func ListFlags(options *ListOptions) *pflag.FlagSet
• func NewDownloadFlags(settings *DownloaderSettings) *pflag.FlagSet
• func NewRunTimeSettingsFlags(settings *RunTimeSettings) *pflag.FlagSet
• func OutputFormatFlags(format *output.OutputOptions) *pflag.FlagSet
• func OutputNonTabularFormatFlags(format *output.NonTabularOutputOptions) *pflag.FlagSet
• func RegisterJobFlags(cmd *cobra.Command, s *JobSettings)
• func RegisterTaskFlags(cmd *cobra.Command, s *TaskSettings)
• type ConfigFlag
  • func NewConfigFlag() *ConfigFlag
  • func (cf *ConfigFlag) Parse() error
  • func (cf *ConfigFlag) Set(value string) error
  • func (cf *ConfigFlag) String() string
  • func (cf *ConfigFlag) Type() string
• type DownloaderSettings
  • func NewDefaultDownloaderSettings() *DownloaderSettings
• type JobSettings
  • func DefaultJobSettings() *JobSettings
  • func (j *JobSettings) Constraints() ([]*models.LabelSelectorRequirement, error)
  • func (j *JobSettings) Count() int
  • func (j *JobSettings) Labels() (map[string]string, error)
  • func (j *JobSettings) Name() string
  • func (j *JobSettings) Namespace() string
  • func (j *JobSettings) Priority() int
  • func (j *JobSettings) Type() string
• type LegacyJobFlags
• type ListOptions
• type NetworkSettings
• type RepoFlag
  • func NewRepoFlag() *RepoFlag
  • func (rf *RepoFlag) Set(value string) error
  • func (rf *RepoFlag) String() string
  • func (rf *RepoFlag) Type() string
• type ResourceSettings
• type RunTimeSettings
  • func DefaultRunTimeSettings() *RunTimeSettings
• type Something
• type TaskSettings
  • func DefaultTaskSettings() *TaskSettings

Constants

const (
	NameUsageMsg = `The name to refer to this task by`

	PublisherInputUsageMsg = `` /* 438-byte string literal not displayed */

	ResultPathUsageMsg = "name=path of the output data volumes. 'outputs:/outputs' is always added unless " +
		"'/outputs' is mapped to a different name."

	PublisherUsageMsg = `Where to publish the result of the job`

	ResourceCPUUsageMsg    = `Job CPU cores (e.g. 500m, 2, 8).`
	ResourceMemoryUsageMsg = `Job Memory requirement (e.g. 500Mb, 2Gb, 8Gb).`
	ResourceDiskUsageMsg   = `Job Disk requirement (e.g. 500Gb, 2Tb, 8Tb).`
	ResourceGPUUsageMsg    = `Job GPU requirement (e.g. 1, 2, 8).`

	NetworkTypeUsageMsg   = `Networking capability required by the job. None, HTTP, or Full`
	NetworkDomainUsageMsg = `Domain(s) that the job needs to access (for HTTP networking)`
)

const DefaultRunWaitSeconds = 600

const RootCommandConfigFiles = "Root.Command.Config.Files"

const RootCommandConfigFlags = "Root.Command.Config.Flags"

const RootCommandConfigValues = "Root.Command.Config.Values"

Functions

func ConfigAutoComplete

func ConfigAutoComplete(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

ConfigAutoComplete provides auto-completion suggestions for configuration keys.

func ListFlags

func ListFlags(options *ListOptions) *pflag.FlagSet

func NewDownloadFlags

func NewDownloadFlags(settings *DownloaderSettings) *pflag.FlagSet

func NewRunTimeSettingsFlags

func NewRunTimeSettingsFlags(settings *RunTimeSettings) *pflag.FlagSet

func OutputFormatFlags

func OutputFormatFlags(format *output.OutputOptions) *pflag.FlagSet

func OutputNonTabularFormatFlags

func OutputNonTabularFormatFlags(format *output.NonTabularOutputOptions) *pflag.FlagSet

func RegisterJobFlags

func RegisterJobFlags(cmd *cobra.Command, s *JobSettings)

func RegisterTaskFlags

func RegisterTaskFlags(cmd *cobra.Command, s *TaskSettings)

Types

type ConfigFlag

type ConfigFlag struct {
	Value string
}

func NewConfigFlag

func NewConfigFlag() *ConfigFlag

func (*ConfigFlag) Parse

func (cf *ConfigFlag) Parse() error

func (*ConfigFlag) Set

func (cf *ConfigFlag) Set(value string) error

func (*ConfigFlag) String

func (cf *ConfigFlag) String() string

func (*ConfigFlag) Type

func (cf *ConfigFlag) Type() string

type DownloaderSettings

type DownloaderSettings struct {
	Timeout    time.Duration
	OutputDir  string
	SingleFile string
	Raw        bool
}

func NewDefaultDownloaderSettings

func NewDefaultDownloaderSettings() *DownloaderSettings

type JobSettings

type JobSettings struct {
	// contains filtered or unexported fields
}

func DefaultJobSettings

func DefaultJobSettings() *JobSettings

func (*JobSettings) Constraints

func (j *JobSettings) Constraints() ([]*models.LabelSelectorRequirement, error)

func (*JobSettings) Count

func (j *JobSettings) Count() int

func (*JobSettings) Labels

func (j *JobSettings) Labels() (map[string]string, error)

TODO(forrest): based on a conversation with walid we should be returning an error here if at anypoint if a label if provided that is invalid. We cannont remove them as we did previously.

func (*JobSettings) Name

func (j *JobSettings) Name() string

func (*JobSettings) Namespace

func (j *JobSettings) Namespace() string

func (*JobSettings) Priority

func (j *JobSettings) Priority() int

func (*JobSettings) Type

func (j *JobSettings) Type() string

type LegacyJobFlags

type LegacyJobFlags struct {
	// contains filtered or unexported fields
}

type ListOptions

type ListOptions struct {
	Limit         uint32
	NextToken     string
	OrderBy       string
	OrderByFields []string
	Reverse       bool
}

type NetworkSettings

type NetworkSettings struct {
	Network models.Network
	Domains []string
}

type RepoFlag

type RepoFlag struct {
	Value string
}

func NewRepoFlag

func NewRepoFlag() *RepoFlag

NewRepoFlag creates a new RepoFlag with the default value set

func (*RepoFlag) Set

func (rf *RepoFlag) Set(value string) error

func (*RepoFlag) String

func (rf *RepoFlag) String() string

func (*RepoFlag) Type

func (rf *RepoFlag) Type() string

type ResourceSettings

type ResourceSettings struct {
	CPU    string
	Memory string
	Disk   string
	GPU    string
}

type RunTimeSettings

type RunTimeSettings struct {
	WaitForJobToFinish    bool // Wait for the job to finish before returning
	WaitForJobTimeoutSecs int  // Timeout for waiting for the job to finish
	PrintJobIDOnly        bool // Only print the Job ID as output
	PrintNodeDetails      bool
	Follow                bool // Follow along with the output of the job
	DryRun                bool // iff true do not submit the job, but instead print out what will be submitted.
}

func DefaultRunTimeSettings

func DefaultRunTimeSettings() *RunTimeSettings

type Something

type Something struct {
	ConfigFiles  []string
	ConfigParams map[string]any
}

type TaskSettings

type TaskSettings struct {
	Name                 string
	InputSources         opts.StorageSpecConfigOpt
	ResultPaths          []*models.ResultPath
	EnvironmentVariables map[string]string
	Publisher            opts.PublisherSpecConfigOpt
	Resources            ResourceSettings
	Network              NetworkSettings
	Timeout              int64
	QueueTimeout         int64
}

func DefaultTaskSettings

func DefaultTaskSettings() *TaskSettings