containers

package
v0.1.0-M4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 24, 2023 License: Apache-2.0, EPL-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package containers provides type definitions used by the Containers gRPC service

Index

Constants

This section is empty.

Variables

View Source 
var File_api_types_containers_container_config_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_container_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_decrypt_config_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_device_mapping_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_endpoint_settings_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_hook_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_host_config_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_image_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_io_config_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_log_config_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_mount_point_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_network_settings_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_port_mapping_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_resources_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_restart_policy_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_state_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_stop_options_proto protoreflect.FileDescriptor
View Source 
var File_api_types_containers_update_options_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Container 

type Container struct {

	// ID is the user-specified identifier.
	//
	// This field may not be updated.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	//The name of the container
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The image information for the container
	Image *Image `protobuf:"bytes,3,opt,name=image,proto3" json:"image,omitempty"`
	// Hostname for the container
	HostName string `protobuf:"bytes,4,opt,name=host_name,json=hostName,proto3" json:"host_name,omitempty"`
	// Domain name for the container
	DomainName string `protobuf:"bytes,5,opt,name=domain_name,json=domainName,proto3" json:"domain_name,omitempty"`
	// The path to the container's resolv.conf file
	ResolvConfPath string `protobuf:"bytes,6,opt,name=resolv_conf_path,json=resolvConfPath,proto3" json:"resolv_conf_path,omitempty"`
	// The path to the container's hosts file
	HostsPath string `protobuf:"bytes,7,opt,name=hosts_path,json=hostsPath,proto3" json:"hosts_path,omitempty"`
	// The path to the container's hostname file
	HostnamePath string `protobuf:"bytes,8,opt,name=hostname_path,json=hostnamePath,proto3" json:"hostname_path,omitempty"`
	// Mounts for the container
	Mounts []*MountPoint `protobuf:"bytes,9,rep,name=mounts,proto3" json:"mounts,omitempty"`
	// Hooks to perform on container start/stop, etc.
	Hooks []*Hook `protobuf:"bytes,10,rep,name=hooks,proto3" json:"hooks,omitempty"`
	// Host configuration for the container
	HostConfig *HostConfig `protobuf:"bytes,11,opt,name=host_config,json=hostConfig,proto3" json:"host_config,omitempty"`
	// IO configuration for the container
	IoConfig *IOConfig `protobuf:"bytes,12,opt,name=io_config,json=ioConfig,proto3" json:"io_config,omitempty"`
	// Configuration of the container's root process
	Config *ContainerConfiguration `protobuf:"bytes,13,opt,name=config,proto3" json:"config,omitempty"`
	// Network settings for the container
	NetworkSettings *NetworkSettings `protobuf:"bytes,14,opt,name=network_settings,json=networkSettings,proto3" json:"network_settings,omitempty"`
	// The container's state
	State *State `protobuf:"bytes,15,opt,name=state,proto3" json:"state,omitempty"`
	// The time of the container's creation
	Created string `protobuf:"bytes,16,opt,name=created,proto3" json:"created,omitempty"`
	// A flag indicating whether the container has been manually stopped or internally by the system due to errors
	ManuallyStopped bool `protobuf:"varint,17,opt,name=manually_stopped,json=manuallyStopped,proto3" json:"manually_stopped,omitempty"`
	// A metric for the container showing how many restart retries have been performed on it
	RestartCount int64 `protobuf:"varint,18,opt,name=restart_count,json=restartCount,proto3" json:"restart_count,omitempty"`
	// contains filtered or unexported fields
}

func (*Container) Descriptor deprecated 

func (*Container) Descriptor() ([]byte, []int)

Deprecated: Use Container.ProtoReflect.Descriptor instead.

func (*Container) GetConfig 

func (x *Container) GetConfig() *ContainerConfiguration

func (*Container) GetCreated 

func (x *Container) GetCreated() string

func (*Container) GetDomainName 

func (x *Container) GetDomainName() string

func (*Container) GetHooks 

func (x *Container) GetHooks() []*Hook

func (*Container) GetHostConfig 

func (x *Container) GetHostConfig() *HostConfig

func (*Container) GetHostName 

func (x *Container) GetHostName() string

func (*Container) GetHostnamePath 

func (x *Container) GetHostnamePath() string

func (*Container) GetHostsPath 

func (x *Container) GetHostsPath() string

func (*Container) GetId 

func (x *Container) GetId() string

func (*Container) GetImage 

func (x *Container) GetImage() *Image

func (*Container) GetIoConfig 

func (x *Container) GetIoConfig() *IOConfig

func (*Container) GetManuallyStopped 

func (x *Container) GetManuallyStopped() bool

func (*Container) GetMounts 

func (x *Container) GetMounts() []*MountPoint

func (*Container) GetName 

func (x *Container) GetName() string

func (*Container) GetNetworkSettings 

func (x *Container) GetNetworkSettings() *NetworkSettings

func (*Container) GetResolvConfPath 

func (x *Container) GetResolvConfPath() string

func (*Container) GetRestartCount 

func (x *Container) GetRestartCount() int64

func (*Container) GetState 

func (x *Container) GetState() *State

func (*Container) ProtoMessage 

func (*Container) ProtoMessage()

func (*Container) ProtoReflect 

func (x *Container) ProtoReflect() protoreflect.Message

func (*Container) Reset 

func (x *Container) Reset()

func (*Container) String 

func (x *Container) String() string

type ContainerConfiguration 

type ContainerConfiguration struct {

	// Provides the environmental configuration of the container's process - i.e. environmental variables
	Env []string `protobuf:"bytes,1,rep,name=env,proto3" json:"env,omitempty"`
	// Provides the command to be run upon container start
	Cmd []string `protobuf:"bytes,2,rep,name=cmd,proto3" json:"cmd,omitempty"`
	// contains filtered or unexported fields
}

Represents the container's process configuration

func (*ContainerConfiguration) Descriptor deprecated 

func (*ContainerConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use ContainerConfiguration.ProtoReflect.Descriptor instead.

func (*ContainerConfiguration) GetCmd 

func (x *ContainerConfiguration) GetCmd() []string

func (*ContainerConfiguration) GetEnv 

func (x *ContainerConfiguration) GetEnv() []string

func (*ContainerConfiguration) ProtoMessage 

func (*ContainerConfiguration) ProtoMessage()

func (*ContainerConfiguration) ProtoReflect 

func (x *ContainerConfiguration) ProtoReflect() protoreflect.Message

func (*ContainerConfiguration) Reset 

func (x *ContainerConfiguration) Reset()

func (*ContainerConfiguration) String 

func (x *ContainerConfiguration) String() string

type DecryptConfig 

type DecryptConfig struct {

	// Private key filepath with an optional password separated by a colon
	Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
	// Recipient protocol(pkcs7) and filepath to a x509 certificate separated by a colon
	Recipients []string `protobuf:"bytes,2,rep,name=recipients,proto3" json:"recipients,omitempty"`
	// contains filtered or unexported fields
}

Represents container image's decryption configuration

func (*DecryptConfig) Descriptor deprecated 

func (*DecryptConfig) Descriptor() ([]byte, []int)

Deprecated: Use DecryptConfig.ProtoReflect.Descriptor instead.

func (*DecryptConfig) GetKeys 

func (x *DecryptConfig) GetKeys() []string

func (*DecryptConfig) GetRecipients 

func (x *DecryptConfig) GetRecipients() []string

func (*DecryptConfig) ProtoMessage 

func (*DecryptConfig) ProtoMessage()

func (*DecryptConfig) ProtoReflect 

func (x *DecryptConfig) ProtoReflect() protoreflect.Message

func (*DecryptConfig) Reset 

func (x *DecryptConfig) Reset()

func (*DecryptConfig) String 

func (x *DecryptConfig) String() string

type DeviceMapping 

type DeviceMapping struct {

	// The path of the device on the host
	PathOnHost string `protobuf:"bytes,1,opt,name=path_on_host,json=pathOnHost,proto3" json:"path_on_host,omitempty"`
	// The path of the device in the container
	PathInContainer string `protobuf:"bytes,2,opt,name=path_in_container,json=pathInContainer,proto3" json:"path_in_container,omitempty"`
	// cgroup permissions for the device access -  e.g. rwm
	CgroupPermissions string `protobuf:"bytes,3,opt,name=cgroup_permissions,json=cgroupPermissions,proto3" json:"cgroup_permissions,omitempty"`
	// contains filtered or unexported fields
}

Represents a device mapping from the host to the container - e.g. /dev/ttyACM0

func (*DeviceMapping) Descriptor deprecated 

func (*DeviceMapping) Descriptor() ([]byte, []int)

Deprecated: Use DeviceMapping.ProtoReflect.Descriptor instead.

func (*DeviceMapping) GetCgroupPermissions 

func (x *DeviceMapping) GetCgroupPermissions() string

func (*DeviceMapping) GetPathInContainer 

func (x *DeviceMapping) GetPathInContainer() string

func (*DeviceMapping) GetPathOnHost 

func (x *DeviceMapping) GetPathOnHost() string

func (*DeviceMapping) ProtoMessage 

func (*DeviceMapping) ProtoMessage()

func (*DeviceMapping) ProtoReflect 

func (x *DeviceMapping) ProtoReflect() protoreflect.Message

func (*DeviceMapping) Reset 

func (x *DeviceMapping) Reset()

func (*DeviceMapping) String 

func (x *DeviceMapping) String() string

type EndpointSettings 

type EndpointSettings struct {

	// EP ID
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// EP Gateway
	Gateway string `protobuf:"bytes,2,opt,name=gateway,proto3" json:"gateway,omitempty"`
	// EP IP Address
	IpAddress string `protobuf:"bytes,3,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
	// EP Mac address
	MacAddress string `protobuf:"bytes,4,opt,name=mac_address,json=macAddress,proto3" json:"mac_address,omitempty"`
	// EP Network ID
	NetworkId string `protobuf:"bytes,5,opt,name=network_id,json=networkId,proto3" json:"network_id,omitempty"`
	// contains filtered or unexported fields
}

Represents the network endpoint settings

func (*EndpointSettings) Descriptor deprecated 

func (*EndpointSettings) Descriptor() ([]byte, []int)

Deprecated: Use EndpointSettings.ProtoReflect.Descriptor instead.

func (*EndpointSettings) GetGateway 

func (x *EndpointSettings) GetGateway() string

func (*EndpointSettings) GetId 

func (x *EndpointSettings) GetId() string

func (*EndpointSettings) GetIpAddress 

func (x *EndpointSettings) GetIpAddress() string

func (*EndpointSettings) GetMacAddress 

func (x *EndpointSettings) GetMacAddress() string

func (*EndpointSettings) GetNetworkId 

func (x *EndpointSettings) GetNetworkId() string

func (*EndpointSettings) ProtoMessage 

func (*EndpointSettings) ProtoMessage()

func (*EndpointSettings) ProtoReflect 

func (x *EndpointSettings) ProtoReflect() protoreflect.Message

func (*EndpointSettings) Reset 

func (x *EndpointSettings) Reset()

func (*EndpointSettings) String 

func (x *EndpointSettings) String() string

type Hook 

type Hook struct {

	// The path for the execution of the hook
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// The hook arguments
	Args []string `protobuf:"bytes,2,rep,name=args,proto3" json:"args,omitempty"`
	// The environmental variables needed for the hook
	Env []string `protobuf:"bytes,3,rep,name=env,proto3" json:"env,omitempty"`
	// Timeout for the hook's execution
	Timeout int32 `protobuf:"varint,4,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// The type of the Hook - prestart, poststart, poststop, etc.
	Type string `protobuf:"bytes,5,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Represents a single runC hook

func (*Hook) Descriptor deprecated 

func (*Hook) Descriptor() ([]byte, []int)

Deprecated: Use Hook.ProtoReflect.Descriptor instead.

func (*Hook) GetArgs 

func (x *Hook) GetArgs() []string

func (*Hook) GetEnv 

func (x *Hook) GetEnv() []string

func (*Hook) GetPath 

func (x *Hook) GetPath() string

func (*Hook) GetTimeout 

func (x *Hook) GetTimeout() int32

func (*Hook) GetType 

func (x *Hook) GetType() string

func (*Hook) ProtoMessage 

func (*Hook) ProtoMessage()

func (*Hook) ProtoReflect 

func (x *Hook) ProtoReflect() protoreflect.Message

func (*Hook) Reset 

func (x *Hook) Reset()

func (*Hook) String 

func (x *Hook) String() string

type HostConfig 

type HostConfig struct {

	// Accessible devices from the host
	Devices []*DeviceMapping `protobuf:"bytes,1,rep,name=devices,proto3" json:"devices,omitempty"`
	// Network mode for the container - bridge, host, none - default is bridge
	NetworkMode string `protobuf:"bytes,2,opt,name=network_mode,json=networkMode,proto3" json:"network_mode,omitempty"`
	// Whether the container has a privileged access to the host
	Privileged bool `protobuf:"varint,3,opt,name=privileged,proto3" json:"privileged,omitempty"`
	// The container's restart policy
	RestartPolicy *RestartPolicy `protobuf:"bytes,4,opt,name=restart_policy,json=restartPolicy,proto3" json:"restart_policy,omitempty"`
	// The specific runtime name - the default for containerd is io.containerd.runtime.v1.[os name]
	Runtime string `protobuf:"bytes,5,opt,name=runtime,proto3" json:"runtime,omitempty"`
	// Additional host address for container to host communication
	ExtraHosts []string `protobuf:"bytes,6,rep,name=extra_hosts,json=extraHosts,proto3" json:"extra_hosts,omitempty"`
	// Mapped ports
	PortMappings []*PortMapping `protobuf:"bytes,7,rep,name=port_mappings,json=portMappings,proto3" json:"port_mappings,omitempty"`
	// Log configuration
	LogConfig *LogConfiguration `protobuf:"bytes,8,opt,name=log_config,json=logConfig,proto3" json:"log_config,omitempty"`
	// Resources
	Resources *Resources `protobuf:"bytes,9,opt,name=resources,proto3" json:"resources,omitempty"`
	//Additional capabilities for a container
	ExtraCapabilities []string `protobuf:"bytes,10,rep,name=extra_capabilities,json=extraCapabilities,proto3" json:"extra_capabilities,omitempty"`
	// contains filtered or unexported fields
}

Defines the resources, behavior, etc. that the host must manage on the container

func (*HostConfig) Descriptor deprecated 

func (*HostConfig) Descriptor() ([]byte, []int)

Deprecated: Use HostConfig.ProtoReflect.Descriptor instead.

func (*HostConfig) GetDevices 

func (x *HostConfig) GetDevices() []*DeviceMapping

func (*HostConfig) GetExtraCapabilities 

func (x *HostConfig) GetExtraCapabilities() []string

func (*HostConfig) GetExtraHosts 

func (x *HostConfig) GetExtraHosts() []string

func (*HostConfig) GetLogConfig 

func (x *HostConfig) GetLogConfig() *LogConfiguration

func (*HostConfig) GetNetworkMode 

func (x *HostConfig) GetNetworkMode() string

func (*HostConfig) GetPortMappings 

func (x *HostConfig) GetPortMappings() []*PortMapping

func (*HostConfig) GetPrivileged 

func (x *HostConfig) GetPrivileged() bool

func (*HostConfig) GetResources 

func (x *HostConfig) GetResources() *Resources

func (*HostConfig) GetRestartPolicy 

func (x *HostConfig) GetRestartPolicy() *RestartPolicy

func (*HostConfig) GetRuntime 

func (x *HostConfig) GetRuntime() string

func (*HostConfig) ProtoMessage 

func (*HostConfig) ProtoMessage()

func (*HostConfig) ProtoReflect 

func (x *HostConfig) ProtoReflect() protoreflect.Message

func (*HostConfig) Reset 

func (x *HostConfig) Reset()

func (*HostConfig) String 

func (x *HostConfig) String() string

type IOConfig 

type IOConfig struct {

	// Whether to attach to `stderr`.
	AttachStderr bool `protobuf:"varint,1,opt,name=attach_stderr,json=attachStderr,proto3" json:"attach_stderr,omitempty"`
	// Whether to attach to `stdin`.
	AttachStdin bool `protobuf:"varint,2,opt,name=attach_stdin,json=attachStdin,proto3" json:"attach_stdin,omitempty"`
	// Whether to attach to `stdout`.
	AttachStdout bool `protobuf:"varint,3,opt,name=attach_stdout,json=attachStdout,proto3" json:"attach_stdout,omitempty"`
	// Open `stdin`
	OpenStdin bool `protobuf:"varint,4,opt,name=open_stdin,json=openStdin,proto3" json:"open_stdin,omitempty"`
	// Close `stdin` after one attached client disconnects
	StdinOnce bool `protobuf:"varint,5,opt,name=stdin_once,json=stdinOnce,proto3" json:"stdin_once,omitempty"`
	// Attach standard streams to a TTY, including `stdin` if it is not closed.
	Tty bool `protobuf:"varint,6,opt,name=tty,proto3" json:"tty,omitempty"`
	// contains filtered or unexported fields
}

IO configuration contains the streams to be attached to this container

func (*IOConfig) Descriptor deprecated 

func (*IOConfig) Descriptor() ([]byte, []int)

Deprecated: Use IOConfig.ProtoReflect.Descriptor instead.

func (*IOConfig) GetAttachStderr 

func (x *IOConfig) GetAttachStderr() bool

func (*IOConfig) GetAttachStdin 

func (x *IOConfig) GetAttachStdin() bool

func (*IOConfig) GetAttachStdout 

func (x *IOConfig) GetAttachStdout() bool

func (*IOConfig) GetOpenStdin 

func (x *IOConfig) GetOpenStdin() bool

func (*IOConfig) GetStdinOnce 

func (x *IOConfig) GetStdinOnce() bool

func (*IOConfig) GetTty 

func (x *IOConfig) GetTty() bool

func (*IOConfig) ProtoMessage 

func (*IOConfig) ProtoMessage()

func (*IOConfig) ProtoReflect 

func (x *IOConfig) ProtoReflect() protoreflect.Message

func (*IOConfig) Reset 

func (x *IOConfig) Reset()

func (*IOConfig) String 

func (x *IOConfig) String() string

type Image 

type Image struct {

	// Image name or id
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Data needed for image decryption
	DecryptConfig *DecryptConfig `protobuf:"bytes,2,opt,name=decrypt_config,json=decryptConfig,proto3" json:"decrypt_config,omitempty"`
	// contains filtered or unexported fields
}

Image contains the reference of the image used to build the specification and snapshots for running this container.

If this field is updated, the spec and rootfs needed to updated, as well.

func (*Image) Descriptor deprecated 

func (*Image) Descriptor() ([]byte, []int)

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetDecryptConfig 

func (x *Image) GetDecryptConfig() *DecryptConfig

func (*Image) GetName 

func (x *Image) GetName() string

func (*Image) ProtoMessage 

func (*Image) ProtoMessage()

func (*Image) ProtoReflect 

func (x *Image) ProtoReflect() protoreflect.Message

func (*Image) Reset 

func (x *Image) Reset()

func (*Image) String 

func (x *Image) String() string

type LogConfiguration 

type LogConfiguration struct {

	// The full log driver configuration
	DriverConfig *LogDriverConfiguration `protobuf:"bytes,1,opt,name=driver_config,json=driverConfig,proto3" json:"driver_config,omitempty"`
	// The full log mode configuration
	ModeConfig *LogModeConfiguration `protobuf:"bytes,2,opt,name=mode_config,json=modeConfig,proto3" json:"mode_config,omitempty"`
	// contains filtered or unexported fields
}

Log configuration for the container

func (*LogConfiguration) Descriptor deprecated 

func (*LogConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use LogConfiguration.ProtoReflect.Descriptor instead.

func (*LogConfiguration) GetDriverConfig 

func (x *LogConfiguration) GetDriverConfig() *LogDriverConfiguration

func (*LogConfiguration) GetModeConfig 

func (x *LogConfiguration) GetModeConfig() *LogModeConfiguration

func (*LogConfiguration) ProtoMessage 

func (*LogConfiguration) ProtoMessage()

func (*LogConfiguration) ProtoReflect 

func (x *LogConfiguration) ProtoReflect() protoreflect.Message

func (*LogConfiguration) Reset 

func (x *LogConfiguration) Reset()

func (*LogConfiguration) String 

func (x *LogConfiguration) String() string

type LogDriverConfiguration 

type LogDriverConfiguration struct {

	// The type of the driver - json-file, none
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Max number of files before rotating the log files
	MaxFiles int64 `protobuf:"varint,2,opt,name=max_files,json=maxFiles,proto3" json:"max_files,omitempty"`
	// Max size of the logs in the form of 1.2M, 5k, etc.
	MaxSize string `protobuf:"bytes,3,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
	// Specify a root directory for the container's log files to be stored
	RootDir string `protobuf:"bytes,4,opt,name=root_dir,json=rootDir,proto3" json:"root_dir,omitempty"`
	// contains filtered or unexported fields
}

Configures which of the available log drivers to be used and how

func (*LogDriverConfiguration) Descriptor deprecated 

func (*LogDriverConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use LogDriverConfiguration.ProtoReflect.Descriptor instead.

func (*LogDriverConfiguration) GetMaxFiles 

func (x *LogDriverConfiguration) GetMaxFiles() int64

func (*LogDriverConfiguration) GetMaxSize 

func (x *LogDriverConfiguration) GetMaxSize() string

func (*LogDriverConfiguration) GetRootDir 

func (x *LogDriverConfiguration) GetRootDir() string

func (*LogDriverConfiguration) GetType 

func (x *LogDriverConfiguration) GetType() string

func (*LogDriverConfiguration) ProtoMessage 

func (*LogDriverConfiguration) ProtoMessage()

func (*LogDriverConfiguration) ProtoReflect 

func (x *LogDriverConfiguration) ProtoReflect() protoreflect.Message

func (*LogDriverConfiguration) Reset 

func (x *LogDriverConfiguration) Reset()

func (*LogDriverConfiguration) String 

func (x *LogDriverConfiguration) String() string

type LogModeConfiguration 

type LogModeConfiguration struct {

	// The logging mode - blocking, non-blocking
	Mode string `protobuf:"bytes,1,opt,name=mode,proto3" json:"mode,omitempty"`
	// The size of the buffer used in the form of 1.2M, 5k, etc. - applicable for non-blocking mode
	MaxBufferSize string `protobuf:"bytes,2,opt,name=max_buffer_size,json=maxBufferSize,proto3" json:"max_buffer_size,omitempty"`
	// contains filtered or unexported fields
}

Configures which of the supported log modes to be applied for the chosen log driver

func (*LogModeConfiguration) Descriptor deprecated 

func (*LogModeConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use LogModeConfiguration.ProtoReflect.Descriptor instead.

func (*LogModeConfiguration) GetMaxBufferSize 

func (x *LogModeConfiguration) GetMaxBufferSize() string

func (*LogModeConfiguration) GetMode 

func (x *LogModeConfiguration) GetMode() string

func (*LogModeConfiguration) ProtoMessage 

func (*LogModeConfiguration) ProtoMessage()

func (*LogModeConfiguration) ProtoReflect 

func (x *LogModeConfiguration) ProtoReflect() protoreflect.Message

func (*LogModeConfiguration) Reset 

func (x *LogModeConfiguration) Reset()

func (*LogModeConfiguration) String 

func (x *LogModeConfiguration) String() string

type MountPoint 

type MountPoint struct {

	// Destination in the container
	Destination string `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`
	// Source path on the host
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// Propagation mode for the mount - private, rprivate, etc.
	PropagationMode string `protobuf:"bytes,3,opt,name=propagation_mode,json=propagationMode,proto3" json:"propagation_mode,omitempty"`
	// contains filtered or unexported fields
}

Defines a single mount point from the host to the container

func (*MountPoint) Descriptor deprecated 

func (*MountPoint) Descriptor() ([]byte, []int)

Deprecated: Use MountPoint.ProtoReflect.Descriptor instead.

func (*MountPoint) GetDestination 

func (x *MountPoint) GetDestination() string

func (*MountPoint) GetPropagationMode 

func (x *MountPoint) GetPropagationMode() string

func (*MountPoint) GetSource 

func (x *MountPoint) GetSource() string

func (*MountPoint) ProtoMessage 

func (*MountPoint) ProtoMessage()

func (*MountPoint) ProtoReflect 

func (x *MountPoint) ProtoReflect() protoreflect.Message

func (*MountPoint) Reset 

func (x *MountPoint) Reset()

func (*MountPoint) String 

func (x *MountPoint) String() string

type NetworkSettings 

type NetworkSettings struct {

	// A map - network id to endpoint settings for all the joined networks
	Networks map[string]*EndpointSettings `` /* 157-byte string literal not displayed */
	// The container's network sandbox id
	SandboxId string `protobuf:"bytes,2,opt,name=sandbox_id,json=sandboxId,proto3" json:"sandbox_id,omitempty"`
	// The container's network sandbox key
	SandboxKey string `protobuf:"bytes,3,opt,name=sandbox_key,json=sandboxKey,proto3" json:"sandbox_key,omitempty"`
	// The container's network controller id
	NetworkControllerId string `protobuf:"bytes,4,opt,name=network_controller_id,json=networkControllerId,proto3" json:"network_controller_id,omitempty"`
	// contains filtered or unexported fields
}

Represents the network settings of a container

func (*NetworkSettings) Descriptor deprecated 

func (*NetworkSettings) Descriptor() ([]byte, []int)

Deprecated: Use NetworkSettings.ProtoReflect.Descriptor instead.

func (*NetworkSettings) GetNetworkControllerId 

func (x *NetworkSettings) GetNetworkControllerId() string

func (*NetworkSettings) GetNetworks 

func (x *NetworkSettings) GetNetworks() map[string]*EndpointSettings

func (*NetworkSettings) GetSandboxId 

func (x *NetworkSettings) GetSandboxId() string

func (*NetworkSettings) GetSandboxKey 

func (x *NetworkSettings) GetSandboxKey() string

func (*NetworkSettings) ProtoMessage 

func (*NetworkSettings) ProtoMessage()

func (*NetworkSettings) ProtoReflect 

func (x *NetworkSettings) ProtoReflect() protoreflect.Message

func (*NetworkSettings) Reset 

func (x *NetworkSettings) Reset()

func (*NetworkSettings) String 

func (x *NetworkSettings) String() string

type PortMapping 

type PortMapping struct {

	// Protocol
	Protocol string `protobuf:"bytes,1,opt,name=protocol,proto3" json:"protocol,omitempty"`
	// Host IP
	HostIp string `protobuf:"bytes,2,opt,name=host_ip,json=hostIp,proto3" json:"host_ip,omitempty"`
	// Host port
	HostPort int64 `protobuf:"varint,3,opt,name=host_port,json=hostPort,proto3" json:"host_port,omitempty"`
	// Host port range end
	HostPortEnd int64 `protobuf:"varint,4,opt,name=host_port_end,json=hostPortEnd,proto3" json:"host_port_end,omitempty"`
	// Container port
	ContainerPort int64 `protobuf:"varint,5,opt,name=container_port,json=containerPort,proto3" json:"container_port,omitempty"`
	// contains filtered or unexported fields
}

Represents port mapping from the host to a container

func (*PortMapping) Descriptor deprecated 

func (*PortMapping) Descriptor() ([]byte, []int)

Deprecated: Use PortMapping.ProtoReflect.Descriptor instead.

func (*PortMapping) GetContainerPort 

func (x *PortMapping) GetContainerPort() int64

func (*PortMapping) GetHostIp 

func (x *PortMapping) GetHostIp() string

func (*PortMapping) GetHostPort 

func (x *PortMapping) GetHostPort() int64

func (*PortMapping) GetHostPortEnd 

func (x *PortMapping) GetHostPortEnd() int64

func (*PortMapping) GetProtocol 

func (x *PortMapping) GetProtocol() string

func (*PortMapping) ProtoMessage 

func (*PortMapping) ProtoMessage()

func (*PortMapping) ProtoReflect 

func (x *PortMapping) ProtoReflect() protoreflect.Message

func (*PortMapping) Reset 

func (x *PortMapping) Reset()

func (*PortMapping) String 

func (x *PortMapping) String() string

type Resources 

type Resources struct {

	// Hard memory limit
	Memory string `protobuf:"bytes,1,opt,name=memory,proto3" json:"memory,omitempty"`
	// Soft memory limit
	MemoryReservation string `protobuf:"bytes,2,opt,name=memory_reservation,json=memoryReservation,proto3" json:"memory_reservation,omitempty"`
	// Swap memory limit(memory + swap)
	MemorySwap string `protobuf:"bytes,3,opt,name=memory_swap,json=memorySwap,proto3" json:"memory_swap,omitempty"`
	// contains filtered or unexported fields
}

Represents resource limitation of a container

func (*Resources) Descriptor deprecated 

func (*Resources) Descriptor() ([]byte, []int)

Deprecated: Use Resources.ProtoReflect.Descriptor instead.

func (*Resources) GetMemory 

func (x *Resources) GetMemory() string

func (*Resources) GetMemoryReservation 

func (x *Resources) GetMemoryReservation() string

func (*Resources) GetMemorySwap 

func (x *Resources) GetMemorySwap() string

func (*Resources) ProtoMessage 

func (*Resources) ProtoMessage()

func (*Resources) ProtoReflect 

func (x *Resources) ProtoReflect() protoreflect.Message

func (*Resources) Reset 

func (x *Resources) Reset()

func (*Resources) String 

func (x *Resources) String() string

type RestartPolicy 

type RestartPolicy struct {

	// maximum retry count
	MaximumRetryCount int64 `protobuf:"varint,1,opt,name=maximum_retry_count,json=maximumRetryCount,proto3" json:"maximum_retry_count,omitempty"`
	// retry timeout
	RetryTimeout int64 `protobuf:"varint,2,opt,name=retry_timeout,json=retryTimeout,proto3" json:"retry_timeout,omitempty"`
	// type - always, no, on-failure, unless-stopped
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Represents the containers restart policy

func (*RestartPolicy) Descriptor deprecated 

func (*RestartPolicy) Descriptor() ([]byte, []int)

Deprecated: Use RestartPolicy.ProtoReflect.Descriptor instead.

func (*RestartPolicy) GetMaximumRetryCount 

func (x *RestartPolicy) GetMaximumRetryCount() int64

func (*RestartPolicy) GetRetryTimeout 

func (x *RestartPolicy) GetRetryTimeout() int64

func (*RestartPolicy) GetType 

func (x *RestartPolicy) GetType() string

func (*RestartPolicy) ProtoMessage 

func (*RestartPolicy) ProtoMessage()

func (*RestartPolicy) ProtoReflect 

func (x *RestartPolicy) ProtoReflect() protoreflect.Message

func (*RestartPolicy) Reset 

func (x *RestartPolicy) Reset()

func (*RestartPolicy) String 

func (x *RestartPolicy) String() string

type State 

type State struct {

	// pid represents the container's process's PID
	Pid int64 `protobuf:"varint,1,opt,name=pid,proto3" json:"pid,omitempty"`
	// started_at defines the time when this container was last started
	StartedAt string `protobuf:"bytes,2,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"`
	// error indicates whether there was a problem that has occurred while changing the state of a container
	Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// exit_code represents the last exit code of the container's internal root process
	ExitCode int64 `protobuf:"varint,4,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`
	// finished_at defines a timestamp of the last container's exit
	FinishedAt string `protobuf:"bytes,5,opt,name=finished_at,json=finishedAt,proto3" json:"finished_at,omitempty"`
	// exited defines whether the container has exited on its own for some reason - daemon reboot or internal error - distinguishes between manual stop and internal exit
	Exited bool `protobuf:"varint,6,opt,name=exited,proto3" json:"exited,omitempty"`
	// dead identifies whether the underlying container is dead
	Dead bool `protobuf:"varint,7,opt,name=dead,proto3" json:"dead,omitempty"`
	// restarting identifies whether the underlying container is currently restarting
	Restarting bool `protobuf:"varint,8,opt,name=restarting,proto3" json:"restarting,omitempty"`
	// paused indicates whether this container is paused
	Paused bool `protobuf:"varint,9,opt,name=paused,proto3" json:"paused,omitempty"`
	// running indicates whether this container is running
	// Note: paused and running are not mutually exclusive as pausing actually requires the process to be running - it's only 'freezed' but still running
	Running bool `protobuf:"varint,10,opt,name=running,proto3" json:"running,omitempty"`
	// status represents the status of this container
	Status string `protobuf:"bytes,11,opt,name=status,proto3" json:"status,omitempty"`
	// oomKilled indicates whether this container is killed due to out of memory
	OomKilled bool `protobuf:"varint,12,opt,name=oomKilled,proto3" json:"oomKilled,omitempty"`
	// contains filtered or unexported fields
}

State represents a container's state

func (*State) Descriptor deprecated 

func (*State) Descriptor() ([]byte, []int)

Deprecated: Use State.ProtoReflect.Descriptor instead.

func (*State) GetDead 

func (x *State) GetDead() bool

func (*State) GetError 

func (x *State) GetError() string

func (*State) GetExitCode 

func (x *State) GetExitCode() int64

func (*State) GetExited 

func (x *State) GetExited() bool

func (*State) GetFinishedAt 

func (x *State) GetFinishedAt() string

func (*State) GetOomKilled 

func (x *State) GetOomKilled() bool

func (*State) GetPaused 

func (x *State) GetPaused() bool

func (*State) GetPid 

func (x *State) GetPid() int64

func (*State) GetRestarting 

func (x *State) GetRestarting() bool

func (*State) GetRunning 

func (x *State) GetRunning() bool

func (*State) GetStartedAt 

func (x *State) GetStartedAt() string

func (*State) GetStatus 

func (x *State) GetStatus() string

func (*State) ProtoMessage 

func (*State) ProtoMessage()

func (*State) ProtoReflect 

func (x *State) ProtoReflect() protoreflect.Message

func (*State) Reset 

func (x *State) Reset()

func (*State) String 

func (x *State) String() string

type StopOptions 

type StopOptions struct {

	// Timeout period in seconds to gracefully stop the container.
	Timeout int64 `protobuf:"varint,1,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// Force determines whether a SIGKILL signal will be send to the container's process if it does not finish within the timeout specified.
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// Signal to be send to the container's process. Signal could be specified by using their names or numbers, e.g. SIGINT or 2.
	Signal string `protobuf:"bytes,3,opt,name=signal,proto3" json:"signal,omitempty"`
	// contains filtered or unexported fields
}

StopOptions represent options for stoping a container.

func (*StopOptions) Descriptor deprecated 

func (*StopOptions) Descriptor() ([]byte, []int)

Deprecated: Use StopOptions.ProtoReflect.Descriptor instead.

func (*StopOptions) GetForce 

func (x *StopOptions) GetForce() bool

func (*StopOptions) GetSignal 

func (x *StopOptions) GetSignal() string

func (*StopOptions) GetTimeout 

func (x *StopOptions) GetTimeout() int64

func (*StopOptions) ProtoMessage 

func (*StopOptions) ProtoMessage()

func (*StopOptions) ProtoReflect 

func (x *StopOptions) ProtoReflect() protoreflect.Message

func (*StopOptions) Reset 

func (x *StopOptions) Reset()

func (*StopOptions) String 

func (x *StopOptions) String() string

type UpdateOptions 

type UpdateOptions struct {

	// The container's restart policy
	RestartPolicy *RestartPolicy `protobuf:"bytes,1,opt,name=restart_policy,json=restartPolicy,proto3" json:"restart_policy,omitempty"`
	// The container's resource config
	Resources *Resources `protobuf:"bytes,2,opt,name=resources,proto3" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

UpdateOptions represent options for updating a container.

func (*UpdateOptions) Descriptor deprecated 

func (*UpdateOptions) Descriptor() ([]byte, []int)

Deprecated: Use UpdateOptions.ProtoReflect.Descriptor instead.

func (*UpdateOptions) GetResources 

func (x *UpdateOptions) GetResources() *Resources

func (*UpdateOptions) GetRestartPolicy 

func (x *UpdateOptions) GetRestartPolicy() *RestartPolicy

func (*UpdateOptions) ProtoMessage 

func (*UpdateOptions) ProtoMessage()

func (*UpdateOptions) ProtoReflect 

func (x *UpdateOptions) ProtoReflect() protoreflect.Message

func (*UpdateOptions) Reset 

func (x *UpdateOptions) Reset()

func (*UpdateOptions) String 

func (x *UpdateOptions) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.