package api
import "k8s.io/kubernetes/pkg/kubelet/api"
Index ¶
- type ContainerManager
- type ImageManagerService
- type PodSandboxManager
- type RuntimeService
- type RuntimeVersioner
Types ¶
type ContainerManager ¶
type ContainerManager interface { // CreateContainer creates a new container in specified PodSandbox. CreateContainer(podSandboxID string, config *runtimeapi.ContainerConfig, sandboxConfig *runtimeapi.PodSandboxConfig) (string, error) // StartContainer starts the container. StartContainer(containerID string) error // StopContainer stops a running container with a grace period (i.e., timeout). StopContainer(containerID string, timeout int64) error // RemoveContainer removes the container. RemoveContainer(containerID string) error // ListContainers lists all containers by filters. ListContainers(filter *runtimeapi.ContainerFilter) ([]*runtimeapi.Container, error) // ContainerStatus returns the status of the container. ContainerStatus(containerID string) (*runtimeapi.ContainerStatus, 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. ExecSync(containerID string, cmd []string, timeout time.Duration) (stdout []byte, stderr []byte, err error) // Exec prepares a streaming endpoint to execute a command in the container, and returns the address. Exec(*runtimeapi.ExecRequest) (*runtimeapi.ExecResponse, error) // Attach prepares a streaming endpoint to attach to a running container, and returns the address. Attach(req *runtimeapi.AttachRequest) (*runtimeapi.AttachResponse, error) }
ContainerManager contains methods to manipulate containers managed by a container runtime. The methods are thread-safe.
type ImageManagerService ¶
type ImageManagerService interface { // ListImages lists the existing images. ListImages(filter *runtimeapi.ImageFilter) ([]*runtimeapi.Image, error) // ImageStatus returns the status of the image. ImageStatus(image *runtimeapi.ImageSpec) (*runtimeapi.Image, error) // PullImage pulls an image with the authentication config. PullImage(image *runtimeapi.ImageSpec, auth *runtimeapi.AuthConfig) (string, error) // RemoveImage removes the image. RemoveImage(image *runtimeapi.ImageSpec) error }
ImageManagerService interface should be implemented by a container image manager. The methods should be thread-safe.
type PodSandboxManager ¶
type PodSandboxManager interface { // RunPodSandbox creates and starts a pod-level sandbox. Runtimes should ensure // the sandbox is in ready state. RunPodSandbox(config *runtimeapi.PodSandboxConfig) (string, error) // StopPodSandbox stops the sandbox. If there are any running containers in the // sandbox, they should be force terminated. StopPodSandbox(podSandboxID string) error // RemovePodSandbox removes the sandbox. If there are running containers in the // sandbox, they should be forcibly removed. RemovePodSandbox(podSandboxID string) error // PodSandboxStatus returns the Status of the PodSandbox. PodSandboxStatus(podSandboxID string) (*runtimeapi.PodSandboxStatus, error) // ListPodSandbox returns a list of Sandbox. ListPodSandbox(filter *runtimeapi.PodSandboxFilter) ([]*runtimeapi.PodSandbox, error) // PortForward prepares a streaming endpoint to forward ports from a PodSandbox, and returns the address. PortForward(*runtimeapi.PortForwardRequest) (*runtimeapi.PortForwardResponse, error) }
PodSandboxManager contains methods for operating on PodSandboxes. The methods are thread-safe.
type RuntimeService ¶
type RuntimeService interface { RuntimeVersioner ContainerManager PodSandboxManager // UpdateRuntimeConfig updates runtime configuration if specified UpdateRuntimeConfig(runtimeConfig *runtimeapi.RuntimeConfig) error // Status returns the status of the runtime. Status() (*runtimeapi.RuntimeStatus, error) }
RuntimeService interface should be implemented by a container runtime. The methods should be thread-safe.
type RuntimeVersioner ¶
type RuntimeVersioner interface { // Version returns the runtime name, runtime version and runtime API version Version(apiVersion string) (*runtimeapi.VersionResponse, error) }
RuntimeVersioner contains methods for runtime name, version and API version.
Source Files ¶
services.go
Directories ¶
Path | Synopsis |
---|---|
pkg/kubelet/api/testing | |
pkg/kubelet/api/v1alpha1 | |
pkg/kubelet/api/v1alpha1/runtime | Package runtime is a generated protocol buffer package. |
pkg/kubelet/api/v1alpha1/stats |
- Version
- v1.6.0-rc.1
- Published
- Mar 24, 2017
- Platform
- js/wasm
- Imports
- 2 packages
- Last checked
- 1 minute ago –
Tools for package owners.