util

Documentation

Index

• Constants
• Variables
• func DownloadResultsHandler(ctx context.Context, cmd *cobra.Command, cfg types.Bacalhau, ...) error
• func EnsureValidVersion(ctx context.Context, clientVersion, serverVersion *models.BuildVersionInfo) error
• func GetAPIClientV2(cmd *cobra.Command, cfg types.Bacalhau) (clientv2.API, error)
• func GetCleanupManager(ctx context.Context) *system.CleanupManager
• func GetDefaultJobFolder(jobID string) string
• func InjectCleanupManager(ctx context.Context) context.Context
• func Logs(cmd *cobra.Command, api clientv2.API, options LogOptions) error
• func ReadFromFile(path string) ([]byte, error)
• func ReadFromStdinIfAvailable(cmd *cobra.Command) ([]byte, error)
• func ReadJobFromUser(cmd *cobra.Command, args []string) ([]byte, error)
• func ReadToken(path string, apiURL string) (*apimodels.HTTPCredential, error)
• func SetupConfig(cmd *cobra.Command) (types.Bacalhau, error)
• func SetupConfigType(cmd *cobra.Command) (*config.Config, error)
• func SetupConfigs(cmd *cobra.Command) (types.Bacalhau, *config.Config, error)
• func SetupRepo(cfg types.Bacalhau) (*repo.FsRepo, error)
• func SetupRepoConfig(cmd *cobra.Command) (types.Bacalhau, error)
• func UnmarshalBacalhauConfig(cfg *config.Config) (types.Bacalhau, error)
• func WriteToken(path, apiURL string, cred *apimodels.HTTPCredential) error
• type LiveTableWriter
  • func NewLiveTableWriter() *LiveTableWriter
  • func (w *LiveTableWriter) Flush() error
  • func (w *LiveTableWriter) Write(buf []byte) (n int, err error)
• type LogOptions
• type Versions
  • func GetAllVersions(ctx context.Context, cfg types.Bacalhau, api clientv2.API, r *repo.FsRepo) (Versions, error)

Constants

const AutoDownloadFolderPerm = 0755

const ESC = 27

Variables

var Fatal = fatalError

var LoggingMode = logger.LogModeDefault

var ShutdownSignals = []os.Signal{
	os.Interrupt,
	syscall.SIGTERM,
}

var SystemManagerKey = contextKey{/* contains filtered or unexported fields */}

var TestError error

Functions

func DownloadResultsHandler

func DownloadResultsHandler(
	ctx context.Context,
	cmd *cobra.Command,
	cfg types.Bacalhau,
	apiV2 clientv2.API,
	jobID string,
	downloadSettings *cliflags.DownloaderSettings,
) error

func EnsureValidVersion

func EnsureValidVersion(ctx context.Context, clientVersion, serverVersion *models.BuildVersionInfo) error

func GetAPIClientV2

func GetAPIClientV2(cmd *cobra.Command, cfg types.Bacalhau) (clientv2.API, error)

func GetCleanupManager

func GetCleanupManager(ctx context.Context) *system.CleanupManager

func GetDefaultJobFolder

func GetDefaultJobFolder(jobID string) string

func InjectCleanupManager

func InjectCleanupManager(ctx context.Context) context.Context

injects a Cleanup Manager into the context. TODO deprecated this and the CleanupManager.

func Logs

func Logs(cmd *cobra.Command, api clientv2.API, options LogOptions) error

func ReadFromFile

func ReadFromFile(path string) ([]byte, error)

func ReadFromStdinIfAvailable

func ReadFromStdinIfAvailable(cmd *cobra.Command) ([]byte, error)

func ReadJobFromUser

func ReadJobFromUser(cmd *cobra.Command, args []string) ([]byte, error)

func ReadToken

func ReadToken(path string, apiURL string) (*apimodels.HTTPCredential, error)

Read the authorization credentials associated with the passed API base URL. If there is no credential currently stored, ReadToken will return nil with no error.

func SetupConfig

func SetupConfig(cmd *cobra.Command) (types.Bacalhau, error)

func SetupConfigType

func SetupConfigType(cmd *cobra.Command) (*config.Config, error)

func SetupConfigs

func SetupConfigs(cmd *cobra.Command) (types.Bacalhau, *config.Config, error)

func SetupRepo

func SetupRepo(cfg types.Bacalhau) (*repo.FsRepo, error)

func SetupRepoConfig

func SetupRepoConfig(cmd *cobra.Command) (types.Bacalhau, error)

func UnmarshalBacalhauConfig

func UnmarshalBacalhauConfig(cfg *config.Config) (types.Bacalhau, error)

func WriteToken

func WriteToken(path, apiURL string, cred *apimodels.HTTPCredential) error

Persistently store the authorization token against the passed API base URL. Callers may pass nil for the credential which will delete any existing stored token.

Types

type LiveTableWriter

type LiveTableWriter struct {
	// Out is the writer to write the table to.
	Out io.Writer
	// contains filtered or unexported fields
}

LiveTableWriter is a buffered table writer that updates the terminal. The contents of LiveTableWriter will be flushed on a timed interval or when Flush is called.

func NewLiveTableWriter

func NewLiveTableWriter() *LiveTableWriter

NewLiveTableWriter returns a new LiveTableWriter with defaults

func (*LiveTableWriter) Flush

func (w *LiveTableWriter) Flush() error

Flush writes out the table and resets the buffer. It should be called after the last call to Write to ensure that any data buffered in the Writer is written to the output. An error is returned if the contents of the buffer cannot be written to the underlying output stream.

func (*LiveTableWriter) Write

func (w *LiveTableWriter) Write(buf []byte) (n int, err error)

Write saves the table contents of buf to the writer b. The only errors are ones encountered while writing to the underlying buffer.

type LogOptions

type LogOptions struct {
	JobID       string
	ExecutionID string
	Follow      bool
	Tail        bool
}

type Versions

type Versions struct {
	ClientVersion *models.BuildVersionInfo `json:"clientVersion,omitempty"`
	ServerVersion *models.BuildVersionInfo `json:"serverVersion,omitempty"`
	LatestVersion *models.BuildVersionInfo `json:"latestVersion,omitempty"`
	UpdateMessage string                   `json:"updateMessage,omitempty"`
}

func GetAllVersions

func GetAllVersions(ctx context.Context, cfg types.Bacalhau, api clientv2.API, r *repo.FsRepo) (Versions, error)