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 (h *HostHelper) CanUseNsenterMounter() (bool, error)
- func (h *HostHelper) DownloadDirFromContainer(sourceDir, destDir string) error
- func (h *HostHelper) EnsureHostDirectories(createVolumeShare bool) error
- func (h *HostHelper) EnsureVolumeShare() error
- func (h *HostHelper) Hostname() (string, error)
- func (h *HostHelper) UploadFileToContainer(src, dst string) error
Constants ¶
const ( DefaultVolumesDir = "/var/lib/origin/openshift.local.volumes" DefaultConfigDir = "/var/lib/origin/openshift.local.config" DefaultPersistentVolumesDir = "/var/lib/origin/openshift.local.pv" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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(client *docker.Client, image, volumesDir, configDir, dataDir, pvDir 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) DownloadDirFromContainer ¶ added in v1.4.0
func (h *HostHelper) DownloadDirFromContainer(sourceDir, destDir string) error
DownloadDirFromContainer copies a set of files from the Docker host to the local file system
func (*HostHelper) EnsureHostDirectories ¶
func (h *HostHelper) EnsureHostDirectories(createVolumeShare bool) error
func (*HostHelper) EnsureVolumeShare ¶
func (h *HostHelper) EnsureVolumeShare() error
EnsureVolumeShare ensures that the host Docker machine has a shared directory that can be used for OpenShift volumes
func (*HostHelper) Hostname ¶
func (h *HostHelper) Hostname() (string, error)
Hostname retrieves the FQDN of the Docker host machine
func (*HostHelper) UploadFileToContainer ¶ added in v1.4.0
func (h *HostHelper) UploadFileToContainer(src, dst string) error
UploadFileToContainer copies a local file to the Docker host
Source Files
¶
- doc.go
- host.go