types

type BadEntryPointError struct {
	Reason error
}

type Container interface {
	AllowCPUBursting() bool
	AllowNetworkBursting() bool
	AppArmorProfile() *string
	AppName() string
	IngressBandwidthLimitBps() *int64
	BatchPriority() *string
	Capabilities() *corev1.Capabilities
	ContainerCapabilities(containerName string) ([]titus.ContainerCapability, error)
	CombinedAppStackDetails() string
	SyntheticContainerInfo() (*titus.ContainerInfo, error)
	EBSInfo() EBSInfo
	Env() map[string]string
	EnvOverrides() map[string]string
	ElasticIPPool() *string
	ElasticIPs() *string
	ExtraUserContainers() []*ExtraContainer
	ExtraPlatformContainers() []*ExtraContainer
	ExtraContainerEnv(c *ExtraContainer) map[string]string
	GetPlaformContainerNames() []string
	GetUserContainerNames() []string
	GPUInfo() GPUContainer
	HostnameStyle() *string
	IamRole() *string
	ID() string
	ImageDigest() *string
	ImageName() *string
	ImageVersion() *string
	ImageTagForMetrics() map[string]string
	IPv4Address() *string
	IPv6Address() *string
	IsSystemD() bool
	JobGroupDetail() string
	JobGroupStack() string
	JobGroupSequence() string
	JobID() *string
	JobType() *string
	KillWaitSeconds() *uint32
	KvmEnabled() bool
	Labels() map[string]string
	LogKeepLocalFileAfterUpload() bool
	LogStdioCheckInterval() *time.Duration
	LogUploadCheckInterval() *time.Duration
	LogUploaderConfig() *uploader.Config
	LogUploadRegexp() *regexp.Regexp
	LogUploadThresholdTime() *time.Duration
	MetatronCreds() *titus.ContainerInfo_MetatronCreds
	EffectiveNetworkMode() string
	NormalizedENIIndex() *int
	OomScoreAdj() *int32
	OrderSortedContainerNames() []string
	OwnerEmail() *string
	Pod() (*v1.Pod, *sync.Mutex)
	Process() ([]string, []string)
	QualifiedImageName() string
	Resources() *Resources
	RequireIMDSToken() *string
	Runtime() string
	SeccompAgentEnabledForPerfSyscalls() bool
	SecurityGroupIDs() *[]string
	ServiceMeshEnabled() bool
	SetEnv(string, string)
	SetEnvs(env map[string]string)
	SetGPUInfo(GPUContainer)
	SetID(string)
	SetSystemD(bool)
	SetVPCAllocation(*vpcapi.Assignment)
	ShmSizeMiB() *uint32
	SystemServices() ([]*ServiceOpts, error)
	SignedAddressAllocationUUID() *string
	SortedEnvArray() []string
	SortedEnvArrayExtraContainer(c *ExtraContainer) []string
	SubnetIDs() *[]string
	TaskID() string
	TTYEnabled() bool
	UploadDir(string) string
	UseJumboFrames() bool
	VPCAllocation() *vpcapi.Assignment
	VPCAccountID() *string
	TrafficSteeringEnabled() bool
	HTBClassID() *uint32
}

type ContainerRuntimeProvider func(ctx context.Context, c Container, startTime time.Time) (Runtime, error)

type Details struct {
	ComponentVersions    map[string]string
	NetworkConfiguration *NetworkConfigurationDetails
}

type EBSInfo struct {
	VolumeID  string
	MountPath string
	MountPerm string
	FSType    string
}

type ExtraContainer struct {
	Name         string                    // Name of the container from the pod spec
	V1Container  corev1.Container          // The k8s definition of the container from the pod object
	Status       corev1.ContainerStatus    // Status of the container, shows up in podstatus
	ImageInspect *dockerTypes.ImageInspect // Inspect of the image that the extra container will run
}

type GPUContainer interface {
	Devices() []string
	// Deallocate GPU Container. Must be idempotent.
	Deallocate() int
	Runtime() string
	// Env returns any GPU specific environment overrides required
	Env() map[string]string
}

type GPUManager interface {
	AllocDevices(ctx context.Context, n int) (GPUContainer, error)
}

type InvalidConfigurationError struct {
	Reason error
}

type InvalidSecurityGroupError struct {
	Reason error
}

type NFSMount struct {
	Server     string
	ServerPath string
	ReadOnly   bool
	MountPoint string
}

type NetworkConfigurationDetails struct {
	IsRoutableIP        bool
	ElasticIPAddress    string
	EniIPv4Address      string
	EniIPv6Address      string
	NetworkMode         string
	EniID               string
	ResourceID          string
	TransitionIPAddress string
}

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

type RegistryImageNotFoundError struct {
	Reason error
}

type Resources struct {
	Mem     int64 // in MiB
	CPU     int64
	GPU     int64
	Disk    int64
	Network int64
}

type Runtime interface {
	// Prepare the host to run a Container: download images, prepare filesystems, etc.
	// Implementations must set *Container.ID to a runtime specific identifier.
	// bindMounts are strings in the Docker format "src:dst:mode"
	// TODO(fabio): better (non-Docker specific) abstraction for binds
	// The context passed to the Prepare, and Start function is valid over the lifetime of the container,
	// NOT per-operation
	Prepare(containerCtx context.Context) error
	// Start a container -- Returns an optional Log Directory if an external Logger is desired
	Start(containerCtx context.Context) (string, *Details, <-chan StatusMessage, error)
	// Kill a container. MUST be idempotent.
	Kill(ctx context.Context, wasKilled bool) error
	// Cleanup can be called to tear down resources after a container has been Killed or has naturally
	// stopped. Must always be called.
	Cleanup(ctx context.Context) error
}

type ServiceOpts struct {
	ServiceName   string              // A human-friendly name for the system sidecar
	UnitName      string              // The systemd unit filename
	InitCommand   string              // Optional command to run first before starting, outside the systemd unit
	Required      bool                // If true, the startup of a task will fail, otherwise will just log
	EnabledCheck  serviceEnabledFunc  // A function the returns a bool representing if titus-executor should run this sidecar or not
	Target        bool                // If true, treat this as a systemd target, not a service
	Image         string              // If set, represents a docker image for the code representing this sidecar. This is populated at runtime.
	Volumes       map[string]struct{} // Volumes to map in from the docker image into the main container, usually /titus/$servicename
	ContainerName string              // A mutable string that is dynamically configured to be compatible with docker ps, calculated at runtime
	Version       string              // A mutable string that represents the version of the system service, as specified by the image
}

type SidecarContainerConfig struct {
	ServiceName string
	Image       string
	Volumes     map[string]struct{}
}

type Status int

type StatusMessage struct {
	Status Status
	Msg    string
}

type WorkloadType string