host

Documentation

Overview

Package host contains a utility to run commands on the Docker host by using an image in privileged mode.

Create an HostHelper with NewHostHelper

Index

• Constants
• type HostHelper
  • func NewHostHelper(dockerHelper *dockerhelper.Helper, image string) *HostHelper
  • func (h *HostHelper) CanUseNsenterMounter() (bool, error)
  • func (h *HostHelper) CopyFromHost(src, dst string) error
  • func (h *HostHelper) CopyToHost(src, dst string) error
  • func (h *HostHelper) EnsureVolumeUseShareMount(volumesDir string) error

Constants

const (

	// RemoteHostOriginDir is a directory on the remote machine that runs Docker
	RemoteHostOriginDir = "/var/lib/origin/cluster-up"
)

Types

type HostHelper

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

HostHelper contains methods to help check settings on a Docker host machine using a privileged container

func NewHostHelper

func NewHostHelper(dockerHelper *dockerhelper.Helper, image string) *HostHelper

NewHostHelper creates a new HostHelper

func (*HostHelper) CanUseNsenterMounter

func (h *HostHelper) CanUseNsenterMounter() (bool, error)

CanUseNsenterMounter returns true if the Docker host machine can execute findmnt through nsenter

func (*HostHelper) CopyFromHost

func (h *HostHelper) CopyFromHost(src, dst string) error

func (*HostHelper) CopyToHost

func (h *HostHelper) CopyToHost(src, dst string) error

func (*HostHelper) EnsureVolumeUseShareMount

func (h *HostHelper) EnsureVolumeUseShareMount(volumesDir string) error

EnsureVolumeUseShareMount ensures that the host Docker VM has a shared directory that can be used for OpenShift volumes. This is needed for Docker for Mac.