sdk

Documentation

Overview

Package sdk provides a factory method for creating a Docker client.

Index

• Constants
• Variables
• func NewDockerClient(ctx context.Context) (*client.Client, string, runtime.Type, error)

Constants

const (
	// DockerSocketEnv is the environment variable for custom Docker socket path
	DockerSocketEnv = "TOOLHIVE_DOCKER_SOCKET"
	// PodmanSocketEnv is the environment variable for custom Podman socket path
	PodmanSocketEnv = "TOOLHIVE_PODMAN_SOCKET"
)

Environment variable names

const (
	// PodmanSocketPath is the default Podman socket path
	PodmanSocketPath = "/var/run/podman/podman.sock"
	// PodmanXDGRuntimeSocketPath is the XDG runtime Podman socket path
	PodmanXDGRuntimeSocketPath = "podman/podman.sock"
	// DockerSocketPath is the default Docker socket path
	DockerSocketPath = "/var/run/docker.sock"
	// DockerDesktopMacSocketPath is the Docker Desktop socket path on macOS
	DockerDesktopMacSocketPath = ".docker/run/docker.sock"
	// RancherDesktopMacSocketPath is the Docker socket path for Rancher Desktop on macOS
	RancherDesktopMacSocketPath = ".rd/docker.sock"
)

Common socket paths

Variables

var ErrRuntimeNotFound = fmt.Errorf("container runtime not found")

ErrRuntimeNotFound is returned when a container runtime is not found

Functions

func NewDockerClient

func NewDockerClient(ctx context.Context) (*client.Client, string, runtime.Type, error)

NewDockerClient creates a new container client