Documentation ¶
Index ¶
- func DetectCRISocket() (string, error)
- type CRIRuntime
- func (runtime *CRIRuntime) ImageExists(image string) (bool, error)
- func (runtime *CRIRuntime) IsDocker() bool
- func (runtime *CRIRuntime) IsRunning() error
- func (runtime *CRIRuntime) ListKubeContainers() ([]string, error)
- func (runtime *CRIRuntime) PullImage(image string) error
- func (runtime *CRIRuntime) RemoveContainers(containers []string) error
- type ContainerRuntime
- type DockerRuntime
- func (runtime *DockerRuntime) ImageExists(image string) (bool, error)
- func (runtime *DockerRuntime) IsDocker() bool
- func (runtime *DockerRuntime) IsRunning() error
- func (runtime *DockerRuntime) ListKubeContainers() ([]string, error)
- func (runtime *DockerRuntime) PullImage(image string) error
- func (runtime *DockerRuntime) RemoveContainers(containers []string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DetectCRISocket ¶ added in v1.14.0
DetectCRISocket uses a list of known CRI sockets to detect one. If more than one or none is discovered, an error is returned.
Types ¶
type CRIRuntime ¶
type CRIRuntime struct {
// contains filtered or unexported fields
}
CRIRuntime is a struct that interfaces with the CRI
func (*CRIRuntime) ImageExists ¶
func (runtime *CRIRuntime) ImageExists(image string) (bool, error)
ImageExists checks to see if the image exists on the system
func (*CRIRuntime) IsDocker ¶
func (runtime *CRIRuntime) IsDocker() bool
IsDocker returns true if the runtime is docker
func (*CRIRuntime) IsRunning ¶
func (runtime *CRIRuntime) IsRunning() error
IsRunning checks if runtime is running
func (*CRIRuntime) ListKubeContainers ¶
func (runtime *CRIRuntime) ListKubeContainers() ([]string, error)
ListKubeContainers lists running k8s CRI pods
func (*CRIRuntime) PullImage ¶
func (runtime *CRIRuntime) PullImage(image string) error
PullImage pulls the image
func (*CRIRuntime) RemoveContainers ¶
func (runtime *CRIRuntime) RemoveContainers(containers []string) error
RemoveContainers removes running k8s pods
type ContainerRuntime ¶
type ContainerRuntime interface { IsDocker() bool IsRunning() error ListKubeContainers() ([]string, error) RemoveContainers(containers []string) error PullImage(image string) error ImageExists(image string) (bool, error) }
ContainerRuntime is an interface for working with container runtimes
func NewContainerRuntime ¶
func NewContainerRuntime(execer utilsexec.Interface, criSocket string) (ContainerRuntime, error)
NewContainerRuntime sets up and returns a ContainerRuntime struct
type DockerRuntime ¶
type DockerRuntime struct {
// contains filtered or unexported fields
}
DockerRuntime is a struct that interfaces with the Docker daemon
func (*DockerRuntime) ImageExists ¶
func (runtime *DockerRuntime) ImageExists(image string) (bool, error)
ImageExists checks to see if the image exists on the system
func (*DockerRuntime) IsDocker ¶
func (runtime *DockerRuntime) IsDocker() bool
IsDocker returns true if the runtime is docker
func (*DockerRuntime) IsRunning ¶
func (runtime *DockerRuntime) IsRunning() error
IsRunning checks if runtime is running
func (*DockerRuntime) ListKubeContainers ¶
func (runtime *DockerRuntime) ListKubeContainers() ([]string, error)
ListKubeContainers lists running k8s containers
func (*DockerRuntime) PullImage ¶
func (runtime *DockerRuntime) PullImage(image string) error
PullImage pulls the image
func (*DockerRuntime) RemoveContainers ¶
func (runtime *DockerRuntime) RemoveContainers(containers []string) error
RemoveContainers removes running containers