cliflags

Documentation

Index

• Constants
• func DealFlags(settings *DealFlagSettings) *pflag.FlagSet
• func NetworkingFlags(settings *NetworkingFlagSettings) *pflag.FlagSet
• func NewDownloadFlags(settings *DownloaderSettings) *pflag.FlagSet
• func NewRunTimeSettingsFlags(settings *RunTimeSettings) *pflag.FlagSet
• func OutputFormatFlags(format *output.OutputOptions) *pflag.FlagSet
• func ResourceUsageFlags(settings *ResourceUsageSettings) *pflag.FlagSet
• func SpecFlags(settings *SpecFlagSettings) *pflag.FlagSet
• type DealFlagSettings
  • func NewDefaultDealFlagSettings() *DealFlagSettings
• type DownloaderSettings
  • func NewDefaultDownloaderSettings() *DownloaderSettings
• type NetworkingFlagSettings
  • func NewDefaultNetworkingFlagSettings() *NetworkingFlagSettings
• type ResourceUsageSettings
  • func NewDefaultResourceUsageSettings() *ResourceUsageSettings
• type RunTimeSettings
  • func NewDefaultRunTimeSettings() *RunTimeSettings
• type SpecFlagSettings
  • func NewSpecFlagDefaultSettings() *SpecFlagSettings

Constants

const DefaultRunWaitSeconds = 600

const InputUsageMsg = `` /* 440-byte string literal not displayed */

Functions

func DealFlags

func DealFlags(settings *DealFlagSettings) *pflag.FlagSet

func NetworkingFlags

func NetworkingFlags(settings *NetworkingFlagSettings) *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 ResourceUsageFlags

func ResourceUsageFlags(settings *ResourceUsageSettings) *pflag.FlagSet

func SpecFlags

func SpecFlags(settings *SpecFlagSettings) *pflag.FlagSet

Types

type DealFlagSettings

type DealFlagSettings struct {
	TargetingMode model.TargetingMode
	Concurrency   int // Number of concurrent jobs to run
}

func NewDefaultDealFlagSettings

func NewDefaultDealFlagSettings() *DealFlagSettings

type DownloaderSettings

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

func NewDefaultDownloaderSettings

func NewDefaultDownloaderSettings() *DownloaderSettings

type NetworkingFlagSettings

type NetworkingFlagSettings struct {
	Network model.Network
	Domains []string
}

func NewDefaultNetworkingFlagSettings

func NewDefaultNetworkingFlagSettings() *NetworkingFlagSettings

type ResourceUsageSettings

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

func NewDefaultResourceUsageSettings

func NewDefaultResourceUsageSettings() *ResourceUsageSettings

type RunTimeSettings

type RunTimeSettings struct {
	AutoDownloadResults   bool // Automatically download the results after finishing
	IPFSGetTimeOut        int  // Timeout for IPFS in seconds
	IsLocal               bool // Job should be executed locally
	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 // Print the node details as output
	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 NewDefaultRunTimeSettings

func NewDefaultRunTimeSettings() *RunTimeSettings

type SpecFlagSettings

type SpecFlagSettings struct {
	Publisher     opts.PublisherOpt // Publisher - publisher.Publisher
	Inputs        opts.StorageOpt   // Array of inputs
	OutputVolumes []string          // Array of output volumes in 'name:mount point' form
	EnvVar        []string          // Array of environment variables
	Timeout       int64             // Job execution timeout in seconds
	Labels        []string          // Labels for the job on the Bacalhau network (for searching)
	Selector      string            // Selector (label query) to filter nodes on which this job can be executed
	DoNotTrack    bool
}

func NewSpecFlagDefaultSettings

func NewSpecFlagDefaultSettings() *SpecFlagSettings