common

package

v1.43.0 Latest Latest Go to latest Published: Sep 4, 2025 License: GPL-3.0 Imports: 6 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/AliceO2Group/Control

Links

Open Source Insights

Documentation ¶

Overview ¶

Package common serves as a catch-all package for sharing types between O² Control components.

Index ¶

func GetEnvironmentIdFromLabelerType(labeler Labeler) uid.ID
func GetValueFromLabelerType(labeler Labeler, key string) string
type CommandInfo
type Labeler
type LogTaskOutput
type TaskCommandInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetEnvironmentIdFromLabelerType ¶ added in v0.48.0

func GetEnvironmentIdFromLabelerType(labeler Labeler) uid.ID

func GetValueFromLabelerType ¶ added in v0.49.0

func GetValueFromLabelerType(labeler Labeler, key string) string

Types ¶

type CommandInfo ¶

type CommandInfo struct {
	Env       []string `json:"env,omitempty" yaml:"env,omitempty"`
	Shell     *bool    `json:"shell,omitempty" yaml:"shell,omitempty"`
	Value     *string  `json:"value,omitempty" yaml:"value,omitempty"`
	User      *string  `json:"user,omitempty" yaml:"user,omitempty"`
	Arguments []string `json:"arguments,omitempty" yaml:"arguments,omitempty"`
	Stdout    *string  `json:"stdout,omitempty" yaml:"stdout,omitempty"`
	Stderr    *string  `json:"stderr,omitempty" yaml:"stderr,omitempty"`
}

func (*CommandInfo) Copy ¶

func (m *CommandInfo) Copy() *CommandInfo

func (*CommandInfo) Equals ¶

func (m *CommandInfo) Equals(other *CommandInfo) (response bool)

func (*CommandInfo) GetArguments ¶

func (m *CommandInfo) GetArguments() []string

func (*CommandInfo) GetEnv ¶

func (m *CommandInfo) GetEnv() []string

func (*CommandInfo) GetShell ¶

func (m *CommandInfo) GetShell() bool

func (*CommandInfo) GetUser ¶

func (m *CommandInfo) GetUser() string

func (*CommandInfo) GetValue ¶

func (m *CommandInfo) GetValue() string

func (*CommandInfo) Reset ¶

func (m *CommandInfo) Reset()

func (*CommandInfo) UnmarshalYAML ¶

func (m *CommandInfo) UnmarshalYAML(unmarshal func(interface{}) error) (err error)

func (*CommandInfo) UpdateFrom ¶

func (m *CommandInfo) UpdateFrom(n *CommandInfo)

type Labeler ¶ added in v0.48.0

type Labeler interface {
	GetLabels() map[string]string
}

type LogTaskOutput ¶ added in v0.21.1

type LogTaskOutput int

type TaskCommandInfo ¶

type TaskCommandInfo struct {
	CommandInfo
	ControlPort uint64                  `json:"controlPort"`
	ControlMode controlmode.ControlMode `json:"controlMode"`

	// Only applies to hooks and basic tasks
	Timeout time.Duration `json:"timeout,omitempty"`
}

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
controlmode Package controlmode contains some enums for switching between executor process control modes.	Package controlmode contains some enums for switching between executor process control modes.
event Package event provides event publishing and streaming functionality for O² Control components, supporting Kafka and dummy event writers.	Package event provides event publishing and streaming functionality for O² Control components, supporting Kafka and dummy event writers.
topic Package topic defines constants and types for event system topics.	Package topic defines constants and types for event system topics.
gera Package gera implements a hierarchical key-value store.	Package gera implements a hierarchical key-value store.
golangmetrics Package golangmetrics provides Go runtime metrics collection and reporting functionality for monitoring system resource usage and performance.	Package golangmetrics provides Go runtime metrics collection and reporting functionality for monitoring system resource usage and performance.
logger Package logger is a convenience wrapper package for using logrus in O² Control.	Package logger is a convenience wrapper package for using logrus in O² Control.
infologger Package infologger provides InfoLogger protocol implementation for integration with the ALICE InfoLogger logging system.	Package infologger provides InfoLogger protocol implementation for integration with the ALICE InfoLogger logging system.
monitoring Package monitoring provides monitoring and metrics collection functionality for O² Control components.	Package monitoring provides monitoring and metrics collection functionality for O² Control components.
product Package product provides version information and build metadata for O² Control products and components.	Package product provides version information and build metadata for O² Control products and components.
protos
runtype
system
utils Package utils provides common utility functions for string manipulation, data conversion, and various helper operations used across O² Control components.	Package utils provides common utility functions for string manipulation, data conversion, and various helper operations used across O² Control components.
safeacks Package safeacks provides thread-safe acknowledgment handling for managing communication between multiple senders and a single receiver.	Package safeacks provides thread-safe acknowledgment handling for managing communication between multiple senders and a single receiver.
uid Package uid provides unique identifier generation functionality.	Package uid provides unique identifier generation functionality.