server

package
v1.29.6 Latest Latest
Warning

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

 Go to latest Published: Jul 1, 2024 License: Apache-2.0 Imports: 104 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	InspectConfigEndpoint     = "/config"
	InspectContainersEndpoint = "/containers"
	InspectInfoEndpoint       = "/info"
	InspectPauseEndpoint      = "/pause"
	InspectUnpauseEndpoint    = "/unpause"
)
View Source 
const (
	// PodInfraOOMAdj is the value that we set for oom score adj for
	// the pod infra container.
	// TODO: Remove this const once this value is provided over CRI
	// See https://github.com/kubernetes/kubernetes/issues/47938
	PodInfraOOMAdj int = -998
	// PodInfraCPUshares is default cpu shares for sandbox container.
	PodInfraCPUshares = 2
)
View Source 
const DefaultUserNSSize = 65536

DefaultUserNSSize is the default size for the user namespace created

Variables

This section is empty.

Functions

func ConvertImage added in v1.13.10 

func ConvertImage(from *storage.ImageResult) *types.Image

ConvertImage takes an containers/storage ImageResult and converts it into a CRI protobuf type. More information about the "why"s of this function can be found in ../cri.md.

func Listen added in v1.12.0 

func Listen(network, address string) (net.Listener, error)

Listen opens the network address for the server. Expects the config.Listen address.

This is a platform specific wrapper.

Types

type Server 

type Server struct {
	*lib.ContainerServer

	ContainerEventsChan chan types.ContainerEventResponse
	// contains filtered or unexported fields
}

Server implements the RuntimeService and ImageService

func New 

func New(
	ctx context.Context,
	configIface libconfig.Iface,
) (*Server, error)

New creates a new Server with the provided context and configuration

func (*Server) Attach 

func (s *Server) Attach(ctx context.Context, req *types.AttachRequest) (*types.AttachResponse, error)

Attach prepares a streaming endpoint to attach to a running container.

func (*Server) CRImportCheckpoint added in v1.25.0 

func (s *Server) CRImportCheckpoint(
	ctx context.Context,
	createConfig *types.ContainerConfig,
	sbID, sandboxUID string,
) (ctrID string, retErr error)

taken from Podman

func (*Server) CheckpointContainer added in v1.25.0 

func (s *Server) CheckpointContainer(ctx context.Context, req *types.CheckpointContainerRequest) (*types.CheckpointContainerResponse, error)

CheckpointContainer checkpoints a container

func (*Server) ContainerStats added in v1.0.0 

func (s *Server) ContainerStats(ctx context.Context, req *types.ContainerStatsRequest) (*types.ContainerStatsResponse, error)

ContainerStats returns stats of the container. If the container does not exist, the call returns an error.

func (*Server) ContainerStatus 

func (s *Server) ContainerStatus(ctx context.Context, req *types.ContainerStatusRequest) (*types.ContainerStatusResponse, error)

ContainerStatus returns status of the container.

func (*Server) CreateContainer 

func (s *Server) CreateContainer(ctx context.Context, req *types.CreateContainerRequest) (res *types.CreateContainerResponse, retErr error)

CreateContainer creates a new container in specified PodSandbox

func (*Server) Exec 

func (s *Server) Exec(ctx context.Context, req *types.ExecRequest) (*types.ExecResponse, error)

Exec prepares a streaming endpoint to execute a command in the container.

func (*Server) ExecSync 

func (s *Server) ExecSync(ctx context.Context, req *types.ExecSyncRequest) (*types.ExecSyncResponse, error)

ExecSync runs a command in a container synchronously.

func (*Server) FilterDisallowedAnnotations added in v1.23.0 

func (s *Server) FilterDisallowedAnnotations(toFind, toFilter map[string]string, runtimeHandler string) error

FilterDisallowedAnnotations is a common place to have a map of annotations filtered for both runtimes and workloads. This function exists until the support for runtime level allowed annotations is dropped. toFind is used to find the workload for the specific pod or container, toFilter are the annotations for which disallowed annotations will be filtered. They may be the same. After this function, toFilter will no longer container disallowed annotations.

func (*Server) GetContainerEvents added in v1.26.0 

func (s *Server) GetContainerEvents(_ *types.GetEventsRequest, ces types.RuntimeService_GetContainerEventsServer) error

GetContainerEvents sends the stream of container events to clients

func (*Server) GetExtendInterfaceMux added in v1.24.0 

func (s *Server) GetExtendInterfaceMux(enableProfile bool) *chi.Mux

GetExtendInterfaceMux returns the mux used to serve extend interface requests

func (*Server) ImageFsInfo added in v1.0.0 

func (s *Server) ImageFsInfo(context.Context, *types.ImageFsInfoRequest) (*types.ImageFsInfoResponse, error)

ImageFsInfo returns information of the filesystem that is used to store images.

func (*Server) ImageStatus 

func (s *Server) ImageStatus(ctx context.Context, req *types.ImageStatusRequest) (*types.ImageStatusResponse, error)

ImageStatus returns the status of the image.

func (*Server) ListContainerStats added in v1.0.0 

func (s *Server) ListContainerStats(ctx context.Context, req *types.ListContainerStatsRequest) (*types.ListContainerStatsResponse, error)

ListContainerStats returns stats of all running containers.

func (*Server) ListContainers 

func (s *Server) ListContainers(ctx context.Context, req *types.ListContainersRequest) (*types.ListContainersResponse, error)

ListContainers lists all containers by filters.

func (*Server) ListImages 

func (s *Server) ListImages(ctx context.Context, req *types.ListImagesRequest) (*types.ListImagesResponse, error)

ListImages lists existing images.

func (*Server) ListMetricDescriptors added in v1.26.1 

func (s *Server) ListMetricDescriptors(ctx context.Context, req *types.ListMetricDescriptorsRequest) (*types.ListMetricDescriptorsResponse, error)

ListMetricDescriptors lists all metric descriptors

func (*Server) ListPodSandbox 

func (s *Server) ListPodSandbox(ctx context.Context, req *types.ListPodSandboxRequest) (*types.ListPodSandboxResponse, error)

ListPodSandbox returns a list of SandBoxes.

func (*Server) ListPodSandboxMetrics added in v1.26.1 

func (s *Server) ListPodSandboxMetrics(ctx context.Context, req *types.ListPodSandboxMetricsRequest) (*types.ListPodSandboxMetricsResponse, error)

ListPodSandboxMetrics lists all pod sandbox metrics

func (*Server) ListPodSandboxStats added in v1.23.0 

func (s *Server) ListPodSandboxStats(ctx context.Context, req *types.ListPodSandboxStatsRequest) (*types.ListPodSandboxStatsResponse, error)

ListPodSandboxStats returns stats of all sandboxes.

func (*Server) MonitorsCloseChan added in v1.10.0 

func (s *Server) MonitorsCloseChan() chan struct{}

MonitorsCloseChan returns the close chan for the exit monitor

func (*Server) PodSandboxStats added in v1.23.0 

func (s *Server) PodSandboxStats(ctx context.Context, req *types.PodSandboxStatsRequest) (*types.PodSandboxStatsResponse, error)

PodSandboxStats returns stats of the sandbox. If the sandbox does not exist, the call returns an error.

func (*Server) PodSandboxStatus 

func (s *Server) PodSandboxStatus(ctx context.Context, req *types.PodSandboxStatusRequest) (*types.PodSandboxStatusResponse, error)

PodSandboxStatus returns the Status of the PodSandbox.

func (*Server) PortForward 

func (s *Server) PortForward(ctx context.Context, req *types.PortForwardRequest) (*types.PortForwardResponse, error)

PortForward prepares a streaming endpoint to forward ports from a PodSandbox.

func (*Server) PullImage 

func (s *Server) PullImage(ctx context.Context, req *types.PullImageRequest) (*types.PullImageResponse, error)

PullImage pulls a image with authentication config.

func (*Server) RemoveContainer 

func (s *Server) RemoveContainer(ctx context.Context, req *types.RemoveContainerRequest) (*types.RemoveContainerResponse, error)

RemoveContainer removes the container. If the container is running, the container should be force removed.

func (*Server) RemoveImage 

func (s *Server) RemoveImage(ctx context.Context, req *types.RemoveImageRequest) (*types.RemoveImageResponse, error)

RemoveImage removes the image.

func (*Server) RemovePodSandbox 

func (s *Server) RemovePodSandbox(ctx context.Context, req *types.RemovePodSandboxRequest) (*types.RemovePodSandboxResponse, error)

RemovePodSandbox deletes the sandbox. If there are any running containers in the sandbox, they should be force deleted.

func (*Server) ReopenContainerLog added in v1.10.0 

func (s *Server) ReopenContainerLog(ctx context.Context, req *types.ReopenContainerLogRequest) (*types.ReopenContainerLogResponse, error)

ReopenContainerLog reopens the containers log file

func (*Server) ReserveSandboxContainerIDAndName added in v1.15.0 

func (s *Server) ReserveSandboxContainerIDAndName(config *types.PodSandboxConfig) (string, error)

func (*Server) RunPodSandbox 

func (s *Server) RunPodSandbox(ctx context.Context, req *types.RunPodSandboxRequest) (*types.RunPodSandboxResponse, error)

RunPodSandbox creates and runs a pod-level sandbox.

func (*Server) RuntimeConfig added in v1.28.0 

func (s *Server) RuntimeConfig(_ context.Context, req *types.RuntimeConfigRequest) (*types.RuntimeConfigResponse, error)

RuntimeConfig returns configuration information of the runtime.

func (*Server) Shutdown added in v1.0.0 

func (s *Server) Shutdown(ctx context.Context) error

Shutdown attempts to shut down the server's storage cleanly

func (*Server) StartContainer 

func (s *Server) StartContainer(ctx context.Context, req *types.StartContainerRequest) (res *types.StartContainerResponse, retErr error)

StartContainer starts the container.

func (*Server) StartExitMonitor added in v1.0.0 

func (s *Server) StartExitMonitor(ctx context.Context)

StartExitMonitor start a routine that monitors container exits and updates the container status

func (*Server) Status 

func (s *Server) Status(ctx context.Context, req *types.StatusRequest) (*types.StatusResponse, error)

Status returns the status of the runtime

func (*Server) StopContainer 

func (s *Server) StopContainer(ctx context.Context, req *types.StopContainerRequest) (*types.StopContainerResponse, error)

StopContainer stops a running container with a grace period (i.e., timeout).

func (*Server) StopMonitors added in v1.10.0 

func (s *Server) StopMonitors()

StopMonitors stops all the monitors

func (*Server) StopPodSandbox 

func (s *Server) StopPodSandbox(ctx context.Context, req *types.StopPodSandboxRequest) (*types.StopPodSandboxResponse, error)

StopPodSandbox stops the sandbox. If there are any running containers in the sandbox, they should be force terminated.

func (*Server) StopStreamServer added in v1.0.0 

func (s *Server) StopStreamServer() error

StopStreamServer stops the stream server

func (*Server) StreamingServerCloseChan added in v1.0.0 

func (s *Server) StreamingServerCloseChan() chan struct{}

StreamingServerCloseChan returns the close channel for the streaming server

func (*Server) UpdateContainerResources added in v1.8.0 

func (s *Server) UpdateContainerResources(ctx context.Context, req *types.UpdateContainerResourcesRequest) (*types.UpdateContainerResourcesResponse, error)

UpdateContainerResources updates ContainerConfig of the container.

func (*Server) UpdateRuntimeConfig 

func (s *Server) UpdateRuntimeConfig(
	ctx context.Context, req *types.UpdateRuntimeConfigRequest,
) (*types.UpdateRuntimeConfigResponse, error)

func (*Server) Version 

func (s *Server) Version(context.Context, *types.VersionRequest) (*types.VersionResponse, error)

Version returns the runtime name, runtime version and runtime API version

type StreamService added in v1.15.0 

type StreamService struct {
	streaming.Runtime
	// contains filtered or unexported fields
}

StreamService implements streaming.Runtime.

func (StreamService) Attach added in v1.15.0 

func (s StreamService) Attach(ctx context.Context, containerID string, inputStream io.Reader, outputStream, errorStream io.WriteCloser, tty bool, resizeChan <-chan remotecommand.TerminalSize) error

Attach endpoint for streaming.Runtime

func (StreamService) Exec added in v1.15.0 

func (s StreamService) Exec(ctx context.Context, containerID string, cmd []string, stdin io.Reader, stdout, stderr io.WriteCloser, tty bool, resizeChan <-chan remotecommand.TerminalSize) error

Exec endpoint for streaming.Runtime

func (StreamService) PortForward added in v1.15.0 

func (s StreamService) PortForward(ctx context.Context, podSandboxID string, port int32, stream io.ReadWriteCloser) error

Source Files

View all Source files

Directories

Path Synopsis
collectors
Package useragent provides helper functions to pack version information into a single User-Agent header.
 Package useragent provides helper functions to pack version information into a single User-Agent header.

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.