dipod

README

dipod

dipod is a Docker Interface for PODman. Why? Because it's easier to proxy than to rewrite Docker-reliant software. dipod also eases migration of workflows and CI pipelines away from Docker.

Table of Contents

• Prerequisites
• Build from Source
• Running Tests

Prerequisites

• Go v1.12 or later to build
• varlink-enabled podman to run the backend
• docker-cli to interact with proxy
• bats and jq to run tests

Build from Source

• Clone the repo:
  git clone https://github.com/EricHripko/dipod.git
• Go inside:
  cd dipod
• Build: go build cmd/dipod/dipod.go
• Start the proxy:
  ./dipod

Run Tests

• Ensure that dipod is started
• Run CLI tests: bats tests/cli

Documentation

Index

• Constants
• Variables
• func Connect()
• func ErrorMessage(err error) string
• func Serve()

Constants

const APIVersion = "1.40"

APIVersion defines maximum Docker Engine API version supported by this proxy.

const DockerUnixAddress = "/var/run/docker.sock"

DockerUnixAddress is the default address of the Docker unix socket.

const MinAPIVersion = "1.12"

MinAPIVersion defines minimum Docker Engine API version supported by this proxy.

const PodmanUnixAddress = "unix:///run/podman/io.podman"

PodmanUnixAddress is the default address of the Podman unix socket.

const ProxyVersion = "0.0.1"

ProxyVersion identified the dipod version.

Variables

var ErrNotImplemented = errors.New("dipod: not implemented")

ErrNotImplemented is returned when functionality requested was not implemented yet.

Functions

func Connect

func Connect()

Connect to the Podman's varlink interface.

func ErrorMessage

func ErrorMessage(err error) string

ErrorMessage returns a human-readable error message from go/varlink error.

func Serve

func Serve()

Serve starts a Docker Engine proxy.