Documentation
      ¶
    
    
  
    
  
    Overview ¶
Provides global docker information.
Handler for Docker containers.
Index ¶
- Constants
 - Variables
 - func APIVersion() ([]int, error)
 - func APIVersionString() (string, error)
 - func Client() (*dclient.Client, error)
 - func ContainerNameToDockerId(name string) string
 - func Images() ([]v1.DockerImage, error)
 - func Register(factory info.MachineInfoFactory, fsInfo fs.FsInfo, ...) error
 - func RootDir() string
 - func SetTimeout(timeout time.Duration)
 - func Status() (v1.DockerStatus, error)
 - func StatusFromDockerInfo(dockerInfo dockertypes.Info) (v1.DockerStatus, error)
 - func StatusWithContext(ctx context.Context) (v1.DockerStatus, error)
 - func ValidateInfo() (*dockertypes.Info, error)
 - func Version() ([]int, error)
 - func VersionString() (string, error)
 
Constants ¶
      View Source
      
  const DockerNamespace = "docker"
    The namespace under which Docker aliases are unique.
Variables ¶
      View Source
      
  
    var ArgDockerCA = flag.String("docker-tls-ca", "ca.pem", "path to trusted CA")
    
      View Source
      
  
    var ArgDockerCert = flag.String("docker-tls-cert", "cert.pem", "path to client certificate")
    
      View Source
      
  
    var ArgDockerEndpoint = flag.String("docker", "unix:///var/run/docker.sock", "docker endpoint")
    
      View Source
      
  
    var ArgDockerKey = flag.String("docker-tls-key", "key.pem", "path to private key")
    
      View Source
      
  
var ArgDockerTLS = flag.Bool("docker-tls", false, "use TLS to connect to docker")
    Functions ¶
func APIVersion ¶ added in v0.26.0
func APIVersionString ¶ added in v0.26.0
func ContainerNameToDockerId ¶
Returns the Docker ID from the full container name.
func Images ¶ added in v0.23.1
func Images() ([]v1.DockerImage, error)
func Register ¶
func Register(factory info.MachineInfoFactory, fsInfo fs.FsInfo, ignoreMetrics container.MetricSet) error
Register root container before running this function!
func SetTimeout ¶ added in v0.29.0
func Status ¶ added in v0.23.1
func Status() (v1.DockerStatus, error)
func StatusFromDockerInfo ¶ added in v0.26.0
func StatusFromDockerInfo(dockerInfo dockertypes.Info) (v1.DockerStatus, error)
func StatusWithContext ¶ added in v0.29.0
func StatusWithContext(ctx context.Context) (v1.DockerStatus, error)
func ValidateInfo ¶ added in v0.23.0
func ValidateInfo() (*dockertypes.Info, error)
Checks whether the dockerInfo reflects a valid docker setup, and returns it if it does, or an error otherwise.
func VersionString ¶ added in v0.23.1
Types ¶
This section is empty.
 Click to show internal directories. 
   Click to hide internal directories.