containers

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}