commands

Documentation

Index

• Constants
• Variables
• func AddMetrics2PoolLabels(poolLabels *[]api.PoolLabel)
• func AliasNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
• func ApplyReSimStyle(cmd *cobra.Command)
• func DetermineTriggerMethod() *api.TriggeredVia
• func Execute() error
• func GetBffClient(ctx context.Context, cache CredentialCache) graphql.Client
• func GetCIEnvironmentVariableAccount() string
• func GetClient(ctx context.Context, cache CredentialCache) (*api.ClientWithResponses, error)
• func GetConfigDir() (string, error)
• func OutputJson(data interface{})
• func ParseBuildSpec(buildSpecLocation string, withOsEnv bool, withEnvFiles []string, ...) (*compose_types.Project, error)
• func ParseParameterString(parameterString string) (string, string, error)
• func ProcessMetricsSet(metricsSetKey string, poolLabels *[]api.PoolLabel) *string
• func RegisterViperFlags(cmd *cobra.Command, args []string)
• func RegisterViperFlagsAndSetClient(cmd *cobra.Command, args []string)
• func SetClient(cmd *cobra.Command, args []string)
• func ValidateResponse(expectedStatusCode int, message string, response *http.Response, body []byte)
• type AuthMode
• type CredentialCache
  • func Authenticate(ctx context.Context) (*CredentialCache, error)
  • func (c *CredentialCache) SaveCredentialCache()
• type DownloadableLog
  • func DownloadableLogsFromBatchLogs(batchLogs []api.BatchLog) []DownloadableLog
  • func DownloadableLogsFromJobLogs(jobLogs []api.JobLog) []DownloadableLog
• type FlagSets
  • func (fs FlagSets) HasOptional() bool
  • func (fs FlagSets) HasRequired() bool
  • func (fs FlagSets) OptionalUsages() string
  • func (fs FlagSets) RequiredUsages() string
• type LogConfig
• type LogsFile
• type Spinner
  • func NewSpinner(ccmd *cobra.Command) *Spinner
  • func (s *Spinner) Fatal(v ...any)
  • func (s *Spinner) Start(msg string)
  • func (s *Spinner) Stop(finalMsg *string)
  • func (s *Spinner) Update(msg string)
• type SuperviseParams
• type SuperviseResult
• type TimeoutError
  • func (e *TimeoutError) Error() string
  • func (e *TimeoutError) IsTimeout() bool

Constants

const (

	//Defaults:
	DefaultCPUs           = 4
	DefaultGPUs           = 0
	DefaultMemoryMiB      = 16384
	DefaultSharedMemoryMB = 64
)

const ConfigPath = "$HOME/.resim"

const CredentialCacheFilename = "cache.json"

const (
	LogIngestURI = "public.ecr.aws/resim/open-builds/log-ingest:latest"
)

const METRICS_2_POOL_LABEL = "resim:metrics2"

Variables

var BffClient graphql.Client

var Client api.ClientWithResponsesInterface

var FlagSetUsageTemplate string = `` /* 163-byte string literal not displayed */

var ReSimUsageTemplate string = `` /* 1503-byte string literal not displayed */

Functions

func AddMetrics2PoolLabels

func AddMetrics2PoolLabels(poolLabels *[]api.PoolLabel)

Add Metrics 2.0 Pool labels to the list of pool labels:

func AliasNormalizeFunc

func AliasNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName

func ApplyReSimStyle

func ApplyReSimStyle(cmd *cobra.Command)

func DetermineTriggerMethod

func DetermineTriggerMethod() *api.TriggeredVia

Attempt to determine the environment we're in. i.e. are we running in Gitlab CI? Github CI? or maybe just running locally on a customer's machine? This information is useful downstream, for understanding where a batch was triggered from.

func Execute

func Execute() error

func GetBffClient

func GetBffClient(ctx context.Context, cache CredentialCache) graphql.Client

func GetCIEnvironmentVariableAccount

func GetCIEnvironmentVariableAccount() string

func GetClient

func GetClient(ctx context.Context, cache CredentialCache) (*api.ClientWithResponses, error)

func GetConfigDir

func GetConfigDir() (string, error)

func OutputJson

func OutputJson(data interface{})

func ParseBuildSpec

func ParseBuildSpec(buildSpecLocation string, withOsEnv bool, withEnvFiles []string, profiles []string, quiet bool) (*compose_types.Project, error)

func ParseParameterString

func ParseParameterString(parameterString string) (string, string, error)

ParseParameterString parses a string in the format "key=value" or "key:value" into a key-value pair. It first tries to split on "=" and falls back to ":" if that fails. This is especially useful for cases where parameter names contain colons, which is often the case in ros-based systems (e.g., "namespace::param").

func ProcessMetricsSet

func ProcessMetricsSet(metricsSetKey string, poolLabels *[]api.PoolLabel) *string

ProcessMetricsSet handles the common logic for processing metrics sets and automatically adding the special metrics 2.0 pool label when needed. Returns the metrics set name if set, nil otherwise.

func RegisterViperFlags

func RegisterViperFlags(cmd *cobra.Command, args []string)

func RegisterViperFlagsAndSetClient

func RegisterViperFlagsAndSetClient(cmd *cobra.Command, args []string)

func SetClient

func SetClient(cmd *cobra.Command, args []string)

func ValidateResponse

func ValidateResponse(expectedStatusCode int, message string, response *http.Response, body []byte)

Validate Response fails the command if the response is nil, or the status code is not what we expect.

Types

type AuthMode

type AuthMode string

const (
	ClientCredentials AuthMode = "clientcredentials"
	DeviceCode        AuthMode = "devicecode"
	Password          AuthMode = "password"
)

type CredentialCache

type CredentialCache struct {
	Tokens      map[string]oauth2.Token `json:"tokens"`
	TokenSource oauth2.TokenSource
	ClientID    string
}

func Authenticate

func Authenticate(ctx context.Context) (*CredentialCache, error)

func (*CredentialCache) SaveCredentialCache

func (c *CredentialCache) SaveCredentialCache()

type DownloadableLog

type DownloadableLog struct {
	FileName          string
	LogOutputLocation string
	FileSize          int64
	LogType           api.LogType
}

func DownloadableLogsFromBatchLogs

func DownloadableLogsFromBatchLogs(batchLogs []api.BatchLog) []DownloadableLog

func DownloadableLogsFromJobLogs

func DownloadableLogsFromJobLogs(jobLogs []api.JobLog) []DownloadableLog

type FlagSets

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

func (FlagSets) HasOptional

func (fs FlagSets) HasOptional() bool

func (FlagSets) HasRequired

func (fs FlagSets) HasRequired() bool

func (FlagSets) OptionalUsages

func (fs FlagSets) OptionalUsages() string

func (FlagSets) RequiredUsages

func (fs FlagSets) RequiredUsages() string

type LogConfig

type LogConfig struct {
	Name     string `yaml:"name"`
	Location string `yaml:"location"`
}

type LogsFile

type LogsFile struct {
	Logs []LogConfig `yaml:"logs"`
}

type Spinner

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

func NewSpinner

func NewSpinner(ccmd *cobra.Command) *Spinner

func (*Spinner) Fatal

func (s *Spinner) Fatal(v ...any)

func (*Spinner) Start

func (s *Spinner) Start(msg string)

func (*Spinner) Stop

func (s *Spinner) Stop(finalMsg *string)

func (*Spinner) Update

func (s *Spinner) Update(msg string)

type SuperviseParams

type SuperviseParams struct {
	ProjectID                uuid.UUID
	MaxRerunAttempts         int
	RerunMaxFailurePercent   float64
	UndesiredConflatedStates []api.ConflatedJobStatus
	Timeout                  time.Duration
	PollInterval             time.Duration
	BatchID                  string
	BatchName                string
}

SuperviseParams contains the parameters needed for actualSuperviseBatch

type SuperviseResult

type SuperviseResult struct {
	Batch *api.Batch
	Error error
}

SuperviseResult contains the result information from actualSuperviseBatch

type TimeoutError

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

TimeoutError represents a timeout condition

func (*TimeoutError) Error

func (e *TimeoutError) Error() string

func (*TimeoutError) IsTimeout

func (e *TimeoutError) IsTimeout() bool