remote

Documentation

Overview

Package remote containers gRPC implementation of internalApi.RuntimeService and internalApi.ImageManagerService.

Index

• func NewRemoteImageService(addr string, connectionTimout time.Duration) (internalApi.ImageManagerService, error)
• func NewRemoteRuntimeService(addr string, connectionTimout time.Duration) (internalApi.RuntimeService, error)
• type RemoteImageService
  • func (r *RemoteImageService) ImageStatus(image *runtimeApi.ImageSpec) (*runtimeApi.Image, error)
  • func (r *RemoteImageService) ListImages(filter *runtimeApi.ImageFilter) ([]*runtimeApi.Image, error)
  • func (r *RemoteImageService) PullImage(image *runtimeApi.ImageSpec, auth *runtimeApi.AuthConfig) error
  • func (r *RemoteImageService) RemoveImage(image *runtimeApi.ImageSpec) error
• type RemoteRuntimeService
  • func (r *RemoteRuntimeService) Attach(req *runtimeApi.AttachRequest) (*runtimeApi.AttachResponse, error)
  • func (r *RemoteRuntimeService) ContainerStatus(containerID string) (*runtimeApi.ContainerStatus, error)
  • func (r *RemoteRuntimeService) CreateContainer(podSandBoxID string, config *runtimeApi.ContainerConfig, ...) (string, error)
  • func (r *RemoteRuntimeService) Exec(req *runtimeApi.ExecRequest) (*runtimeApi.ExecResponse, error)
  • func (r *RemoteRuntimeService) ExecSync(containerID string, cmd []string, timeout time.Duration) (stdout []byte, stderr []byte, err error)
  • func (r *RemoteRuntimeService) ListContainers(filter *runtimeApi.ContainerFilter) ([]*runtimeApi.Container, error)
  • func (r *RemoteRuntimeService) ListPodSandbox(filter *runtimeApi.PodSandboxFilter) ([]*runtimeApi.PodSandbox, error)
  • func (r *RemoteRuntimeService) PodSandboxStatus(podSandBoxID string) (*runtimeApi.PodSandboxStatus, error)
  • func (r *RemoteRuntimeService) PortForward(req *runtimeApi.PortForwardRequest) (*runtimeApi.PortForwardResponse, error)
  • func (r *RemoteRuntimeService) RemoveContainer(containerID string) error
  • func (r *RemoteRuntimeService) RemovePodSandbox(podSandBoxID string) error
  • func (r *RemoteRuntimeService) RunPodSandbox(config *runtimeApi.PodSandboxConfig) (string, error)
  • func (r *RemoteRuntimeService) StartContainer(containerID string) error
  • func (r *RemoteRuntimeService) Status() (*runtimeApi.RuntimeStatus, error)
  • func (r *RemoteRuntimeService) StopContainer(containerID string, timeout int64) error
  • func (r *RemoteRuntimeService) StopPodSandbox(podSandBoxID string) error
  • func (r *RemoteRuntimeService) UpdateRuntimeConfig(runtimeConfig *runtimeApi.RuntimeConfig) error
  • func (r *RemoteRuntimeService) Version(apiVersion string) (*runtimeApi.VersionResponse, error)

Functions

func NewRemoteImageService

func NewRemoteImageService(addr string, connectionTimout time.Duration) (internalApi.ImageManagerService, error)

NewRemoteImageService creates a new internalApi.ImageManagerService.

func NewRemoteRuntimeService

func NewRemoteRuntimeService(addr string, connectionTimout time.Duration) (internalApi.RuntimeService, error)

NewRemoteRuntimeService creates a new internalApi.RuntimeService.

Types

type RemoteImageService

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

RemoteImageService is a gRPC implementation of internalApi.ImageManagerService.

func (*RemoteImageService) ImageStatus

func (r *RemoteImageService) ImageStatus(image *runtimeApi.ImageSpec) (*runtimeApi.Image, error)

ImageStatus returns the status of the image.

func (*RemoteImageService) ListImages

func (r *RemoteImageService) ListImages(filter *runtimeApi.ImageFilter) ([]*runtimeApi.Image, error)

ListImages lists available images.

func (*RemoteImageService) PullImage

func (r *RemoteImageService) PullImage(image *runtimeApi.ImageSpec, auth *runtimeApi.AuthConfig) error

PullImage pulls an image with authentication config.

func (*RemoteImageService) RemoveImage

func (r *RemoteImageService) RemoveImage(image *runtimeApi.ImageSpec) error

RemoveImage removes the image.

type RemoteRuntimeService

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

RemoteRuntimeService is a gRPC implementation of internalApi.RuntimeService.

func (*RemoteRuntimeService) Attach

func (r *RemoteRuntimeService) Attach(req *runtimeApi.AttachRequest) (*runtimeApi.AttachResponse, error)

Attach prepares a streaming endpoint to attach to a running container, and returns the address.

func (*RemoteRuntimeService) ContainerStatus

func (r *RemoteRuntimeService) ContainerStatus(containerID string) (*runtimeApi.ContainerStatus, error)

ContainerStatus returns the container status.

func (*RemoteRuntimeService) CreateContainer

func (r *RemoteRuntimeService) CreateContainer(podSandBoxID string, config *runtimeApi.ContainerConfig, sandboxConfig *runtimeApi.PodSandboxConfig) (string, error)

CreateContainer creates a new container in the specified PodSandbox.

func (*RemoteRuntimeService) Exec

func (r *RemoteRuntimeService) Exec(req *runtimeApi.ExecRequest) (*runtimeApi.ExecResponse, error)

Exec prepares a streaming endpoint to execute a command in the container, and returns the address.

func (*RemoteRuntimeService) ExecSync

func (r *RemoteRuntimeService) ExecSync(containerID string, cmd []string, timeout time.Duration) (stdout []byte, stderr []byte, err error)

ExecSync executes a command in the container, and returns the stdout output. If command exits with a non-zero exit code, an error is returned.

func (*RemoteRuntimeService) ListContainers

func (r *RemoteRuntimeService) ListContainers(filter *runtimeApi.ContainerFilter) ([]*runtimeApi.Container, error)

ListContainers lists containers by filters.

func (*RemoteRuntimeService) ListPodSandbox

func (r *RemoteRuntimeService) ListPodSandbox(filter *runtimeApi.PodSandboxFilter) ([]*runtimeApi.PodSandbox, error)

ListPodSandbox returns a list of PodSandboxes.

func (*RemoteRuntimeService) PodSandboxStatus

func (r *RemoteRuntimeService) PodSandboxStatus(podSandBoxID string) (*runtimeApi.PodSandboxStatus, error)

PodSandboxStatus returns the status of the PodSandbox.

func (*RemoteRuntimeService) PortForward

func (r *RemoteRuntimeService) PortForward(req *runtimeApi.PortForwardRequest) (*runtimeApi.PortForwardResponse, error)

PortForward prepares a streaming endpoint to forward ports from a PodSandbox, and returns the address.

func (*RemoteRuntimeService) RemoveContainer

func (r *RemoteRuntimeService) RemoveContainer(containerID string) error

RemoveContainer removes the container. If the container is running, the container should be forced to removal.

func (*RemoteRuntimeService) RemovePodSandbox

func (r *RemoteRuntimeService) RemovePodSandbox(podSandBoxID string) error

RemovePodSandbox removes the sandbox. If there are any containers in the sandbox, they should be forcibly removed.

func (*RemoteRuntimeService) RunPodSandbox

func (r *RemoteRuntimeService) RunPodSandbox(config *runtimeApi.PodSandboxConfig) (string, error)

RunPodSandbox creates and starts a pod-level sandbox. Runtimes should ensure the sandbox is in ready state.

func (*RemoteRuntimeService) StartContainer

func (r *RemoteRuntimeService) StartContainer(containerID string) error

StartContainer starts the container.

func (*RemoteRuntimeService) Status

func (r *RemoteRuntimeService) Status() (*runtimeApi.RuntimeStatus, error)

Status returns the status of the runtime.

func (*RemoteRuntimeService) StopContainer

func (r *RemoteRuntimeService) StopContainer(containerID string, timeout int64) error

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

func (*RemoteRuntimeService) StopPodSandbox

func (r *RemoteRuntimeService) StopPodSandbox(podSandBoxID string) error

StopPodSandbox stops the sandbox. If there are any running containers in the sandbox, they should be forced to termination.

func (*RemoteRuntimeService) UpdateRuntimeConfig

func (r *RemoteRuntimeService) UpdateRuntimeConfig(runtimeConfig *runtimeApi.RuntimeConfig) error

UpdateRuntimeConfig updates the config of a runtime service. The only update payload currently supported is the pod CIDR assigned to a node, and the runtime service just proxies it down to the network plugin.

func (*RemoteRuntimeService) Version

func (r *RemoteRuntimeService) Version(apiVersion string) (*runtimeApi.VersionResponse, error)

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