Initial varlink implementation

.gitignore

@@ -11,3 +11,4 @@
 /test/checkseccomp/checkseccomp
 /test/copyimg/copyimg
 /build/
+cmd/podman/ioprojectatomicpodman/ioprojectatomicpodman.go

Dockerfile.Fedora

@@ -79,4 +79,6 @@ RUN mkdir -p /etc/containers
 COPY test/policy.json /etc/containers/policy.json
 COPY test/redhat_sigstore.yaml /etc/containers/registries.d/registry.access.redhat.com.yaml
 
+# Install varlink stuff
+RUN pip3 install varlink
 WORKDIR /go/src/github.com/projectatomic/libpod

Makefile

@@ -15,7 +15,9 @@ MANDIR ?= ${PREFIX}/share/man
 SHAREDIR_CONTAINERS ?= ${PREFIX}/share/containers
 ETCDIR ?= ${DESTDIR}/etc
 ETCDIR_LIBPOD ?= ${ETCDIR}/crio
+SYSTEMDDIR ?= ${PREFIX}/lib/systemd/system
 BUILDTAGS ?= seccomp $(shell hack/btrfs_tag.sh) $(shell hack/libdm_tag.sh) $(shell hack/btrfs_installed_tag.sh) $(shell hack/ostree_tag.sh) $(shell hack/selinux_tag.sh)
+PYTHON ?= /usr/bin/python3
 
 BASHINSTALLDIR=${PREFIX}/share/bash-completion/completions
 OCIUMOUNTINSTALLDIR=$(PREFIX)/share/oci-umount/oci-umount.d
@@ -65,7 +67,7 @@ ifeq ("$(wildcard $(GOPKGDIR))","")
 endif
 	touch "$(GOPATH)/.gopathok"
 
-lint: .gopathok
+lint: .gopathok varlink_generate
 	@echo "checking lint"
 	@./.tool/lint
 
@@ -101,6 +103,7 @@ endif
 	rm -f test/copyimg/copyimg
 	rm -f test/checkseccomp/checkseccomp
 	rm -fr build/
+	rm -f cmd/podman/ioprojectatomicpodman/ioprojectatomicpodman.go
 
 libpodimage:
 	docker build -t ${LIBPOD_IMAGE} .
@@ -126,19 +129,20 @@ shell: libpodimage
 testunit: libpodimage
 	docker run -e STORAGE_OPTIONS="--storage-driver=vfs" -e TESTFLAGS -e TRAVIS -t --privileged --rm -v ${CURDIR}:/go/src/${PROJECT} ${LIBPOD_IMAGE} make localunit
 
-localunit:
+localunit: varlink_generate
 	$(GO) test -tags "$(BUILDTAGS)" -cover $(PACKAGES)
 
 ginkgo:
 	ginkgo -v test/e2e/
 
-localintegration: test-binaries
+localintegration: varlink_generate test-binaries
 	ginkgo -v -cover -flakeAttempts 3 -progress -trace -noColor test/e2e/.
+	sh test/varlink/run_varlink_tests.sh
 
 vagrant-check:
 	BOX=$(BOX) sh ./vagrant.sh
 
-binaries: podman
+binaries: varlink_generate podman
 
 test-binaries: test/bin2img/bin2img test/copyimg/copyimg test/checkseccomp/checkseccomp
 
@@ -163,7 +167,7 @@ changelog:
 	$(shell cat $(TMPFILE) >> changelog.txt)
 	$(shell rm $(TMPFILE))
 
-install: .gopathok install.bin install.man install.cni
+install: .gopathok install.bin install.man install.cni install.systemd
 
 install.bin:
 	install ${SELINUXOPT} -D -m 755 bin/podman $(BINDIR)/podman
@@ -189,6 +193,10 @@ install.docker: docker-docs
 	install ${SELINUXOPT} -d -m 755 $(MANDIR)/man1
 	install ${SELINUXOPT} -m 644 docs/docker*.1 -t $(MANDIR)/man1
 
+install.systemd:
+	install ${SELINUXOPT} -m 644 contrib/varlink/io.projectatomic.podman.socket ${SYSTEMDDIR}/io.projectatomic.podman.socket
+	install ${SELINUXOPT} -m 644 contrib/varlink/io.projectatomic.podman.service ${SYSTEMDDIR}/io.projectatomic.podman.service
+
 uninstall:
 	for i in $(filter %.1,$(MANPAGES)); do \
 		rm -f $(MANDIR)/man1/$$(basename $${i}); \
@@ -229,6 +237,14 @@ install.tools: .install.gitvalidation .install.gometalinter .install.md2man
 		make all install; \
 	fi
 
+.install.varlink: .gopathok
+	$(GO) get -u github.com/varlink/go/varlink
+	$(GO) get -u github.com/varlink/go/cmd/varlink-go-interface-generator
+
+varlink_generate: .gopathok .install.varlink
+	rm -f cmd/podman/ioprojectatomicpodman/ioprojectatomicpodman.go
+	$(GO) generate ./cmd/podman/ioprojectatomicpodman/...
+
 validate: gofmt .gitvalidation
 
 .PHONY: \

cmd/podman/info.go

@@ -79,6 +79,6 @@ func debugInfo(c *cli.Context) map[string]interface{} {
 	info["compiler"] = runtime.Compiler
 	info["go version"] = runtime.Version()
 	info["podman version"] = c.App.Version
-	info["git commit"] = gitCommit
+	info["git commit"] = libpod.GitCommit
 	return info
 }

cmd/podman/ioprojectatomicpodman/generate.go

@@ -0,0 +1,3 @@
+package ioprojectatomicpodman
+
+//go:generate $GOPATH/bin/varlink-go-interface-generator io.projectatomic.podman.varlink

cmd/podman/ioprojectatomicpodman/io.projectatomic.podman.varlink

@@ -0,0 +1,65 @@
+# Podman Service Interface
+interface io.projectatomic.podman
+
+type Version (
+  version: string,
+  go_version: string,
+  git_commit: string,
+  built: int,
+  os_arch: string
+)
+
+type NotImplemented (
+    comment: string
+)
+
+type StringResponse (
+    message: string
+)
+
+# System
+method Ping() -> (ping: StringResponse)
+method GetVersion() -> (version: Version)
+
+# Containers
+method ListContainers() -> (notimplemented: NotImplemented)
+method CreateContainer() -> (notimplemented: NotImplemented)
+method InspectContainer() -> (notimplemented: NotImplemented)
+method ListContainerProcesses() -> (notimplemented: NotImplemented)
+method GetContainerLogs() -> (notimplemented: NotImplemented)
+method ListContainerChanges() -> (notimplemented: NotImplemented)
+method ExportContainer() -> (notimplemented: NotImplemented)
+method GetContainerStats() -> (notimplemented: NotImplemented)
+method ResizeContainerTty() -> (notimplemented: NotImplemented)
+method StartContainer() -> (notimplemented: NotImplemented)
+method StopContainer() -> (notimplemented: NotImplemented)
+method RestartContainer() -> (notimplemented: NotImplemented)
+method KillContainer() -> (notimplemented: NotImplemented)
+method UpdateContainer() -> (notimplemented: NotImplemented)
+method RenameContainer() -> (notimplemented: NotImplemented)
+method PauseContainer() -> (notimplemented: NotImplemented)
+method UnpauseContainer() -> (notimplemented: NotImplemented)
+method AttachToContainer() -> (notimplemented: NotImplemented)
+method WaitContainer() -> (notimplemented: NotImplemented)
+method RemoveContainer() -> (notimplemented: NotImplemented)
+method DeleteStoppedContainers() -> (notimplemented: NotImplemented)
+
+# Images
+method ListImages() -> (notimplemented: NotImplemented)
+method BuildImage() -> (notimplemented: NotImplemented)
+method CreateImage() -> (notimplemented: NotImplemented)
+method InspectImage() -> (notimplemented: NotImplemented)
+method HistoryImage() -> (notimplemented: NotImplemented)
+method PushImage() -> (notimplemented: NotImplemented)
+method TagImage() -> (notimplemented: NotImplemented)
+method RemoveImage() -> (notimplemented: NotImplemented)
+method SearchImage() -> (notimplemented: NotImplemented)
+method DeleteUnusedImages() -> (notimplemented: NotImplemented)
+method CreateFromContainer() -> (notimplemented: NotImplemented)
+method ImportImage() -> (notimplemented: NotImplemented)
+method ExportImage() -> (notimplemented: NotImplemented)
+method PullImage() -> (notimplemented: NotImplemented)
+
+
+# Something failed
+error ActionFailed (reason: string)

cmd/podman/main.go

@@ -70,6 +70,7 @@ func main() {
 		topCommand,
 		umountCommand,
 		unpauseCommand,
+		varlinkCommand,
 		versionCommand,
 		waitCommand,
 	}

cmd/podman/varlink.go

@@ -0,0 +1,60 @@
+package main
+
+import (
+	"github.com/pkg/errors"
+	"github.com/projectatomic/libpod/cmd/podman/ioprojectatomicpodman"
+	"github.com/projectatomic/libpod/pkg/varlinkapi"
+	"github.com/projectatomic/libpod/version"
+	"github.com/urfave/cli"
+	"github.com/varlink/go/varlink"
+)
+
+var (
+	varlinkDescription = `
+	podman varlink
+
+	run varlink interface
+`
+	varlinkFlags   = []cli.Flag{}
+	varlinkCommand = cli.Command{
+		Name:        "varlink",
+		Usage:       "Run varlink interface",
+		Description: varlinkDescription,
+		Flags:       varlinkFlags,
+		Action:      varlinkCmd,
+		ArgsUsage:   "VARLINK_URI",
+	}
+)
+
+func varlinkCmd(c *cli.Context) error {
+	args := c.Args()
+	if len(args) < 1 {
+		return errors.Errorf("you must provide a varlink URI")
+	}
+
+	var varlinkInterfaces = []*ioprojectatomicpodman.VarlinkInterface{varlinkapi.VarlinkLibpod}
+	// Register varlink service. The metadata can be retrieved with:
+	// $ varlink info [varlink address URI]
+	service, err := varlink.NewService(
+		"Atomic",
+		"podman",
+		version.Version,
+		"https://github.com/projectatomic/libpod",
+	)
+	if err != nil {
+		return errors.Wrapf(err, "unable to create new varlink service")
+	}
+
+	for _, i := range varlinkInterfaces {
+		if err := service.RegisterInterface(i); err != nil {
+			return errors.Errorf("unable to register varlink interface %v", i)
+		}
+	}
+
+	// Run the varlink server at the given address
+	if err = service.Listen(args[0], 0); err != nil {
+		return errors.Errorf("unable to start varlink service")
+	}
+
+	return nil
+}

cmd/podman/version.go

@@ -2,41 +2,30 @@ package main
 
 import (
 	"fmt"
-	"runtime"
-	"strconv"
 	"time"
 
+	"github.com/pkg/errors"
+	"github.com/projectatomic/libpod/libpod"
 	"github.com/urfave/cli"
 )
 
-// Overwritten at build time
-var (
-	// gitCommit is the commit that the binary is being built from.
-	// It will be populated by the Makefile.
-	gitCommit string
-	// buildInfo is the time at which the binary was built
-	// It will be populated by the Makefile.
-	buildInfo string
-)
-
 // versionCmd gets and prints version info for version command
 func versionCmd(c *cli.Context) error {
-	fmt.Println("Version:      ", c.App.Version)
-	fmt.Println("Go Version:   ", runtime.Version())
-	if gitCommit != "" {
-		fmt.Println("Git Commit:   ", gitCommit)
+	output, err := libpod.GetVersion()
+	if err != nil {
+		errors.Wrapf(err, "unable to determine version")
+	}
+	fmt.Println("Version:      ", output.Version)
+	fmt.Println("Go Version:   ", output.GoVersion)
+	if output.GitCommit != "" {
+		fmt.Println("Git Commit:   ", output.GitCommit)
 	}
-	if buildInfo != "" {
-		// Converts unix time from string to int64
-		buildTime, err := strconv.ParseInt(buildInfo, 10, 64)
-		if err != nil {
-			return err
-		}
-		// Prints out the build time in readable format
-		fmt.Println("Built:        ", time.Unix(buildTime, 0).Format(time.ANSIC))
+	// Prints out the build time in readable format
+	if libpod.BuildInfo != "" {
+		fmt.Println("Built:        ", time.Unix(output.Built, 0).Format(time.ANSIC))
 	}
-	fmt.Println("OS/Arch:      ", runtime.GOOS+"/"+runtime.GOARCH)
 
+	fmt.Println("OS/Arch:      ", output.OsArch)
 	return nil
 }
 

commands.md

@@ -42,5 +42,6 @@
 | [podman-top(1)](/docs/podman-top.1.md)                   | Display the running processes of a container              |[![...](/docs/play.png)](https://asciinema.org/a/5WCCi1LXwSuRbvaO9cBUYf3fk)|
 | [podman-umount(1)](/docs/podman-umount.1.md)             | Unmount a working container's root filesystem                             |[![...](/docs/play.png)](https://asciinema.org/a/MZPTWD5CVs3dMREkBxQBY9C5z)|
 | [podman-unpause(1)](/docs/podman-unpause.1.md)           | Unpause one or more running containers                                    |[![...](/docs/play.png)](https://asciinema.org/a/141292)|
+| [podman-varlink(1)](/docs/podman-varlink.1.md)           | Run the varlink backend                                           ||
 | [podman-version(1)](/docs/podman-version.1.md)           | Display the version information                                           |[![...](/docs/play.png)](https://asciinema.org/a/mfrn61pjZT9Fc8L4NbfdSqfgu)|
 | [podman-wait(1)](/docs/podman-wait.1.md)                 | Wait on one or more containers to stop and print their exit codes  |[![...](/docs/play.png)](https://asciinema.org/a/QNPGKdjWuPgI96GcfkycQtah0)|

completions/bash/podman

@@ -1514,6 +1514,14 @@ _podman_unpause() {
      _complete_ "$options_with_args" "$boolean_options"
 }
 
+_podman_varlink() {
+     local options_with_args="
+     --help -h
+     "
+     local boolean_options=""
+     _complete_ "$options_with_args" "$boolean_options"
+}
+
 _podman_wait() {
      local options_with_args=""
      local boolean_options="
@@ -1633,6 +1641,7 @@ _podman_podman() {
     umount
     unmount
     unpause
+    varlink
     version
     wait
      "

contrib/varlink/io.projectatomic.podman.service

@@ -0,0 +1,12 @@
+[Unit]
+Description=Pod Manager
+Requires=io.projectatomic.podman.socket
+After=io.projectatomic.podman.socket
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/podman --varlink=unix:/run/io.projectatomic.podman
+
+[Install]
+WantedBy=multi-user.target
+Also=io.projectatomic.podman.socket

contrib/varlink/io.projectatomic.podman.socket

@@ -0,0 +1,8 @@
+[Unit]
+Description=Pod Manager Socket
+
+[Socket]
+ListenStream=/run/io.projectatomic.podman
+
+[Install]
+WantedBy=sockets.target

docs/podman-varlink.1.md

@@ -0,0 +1,38 @@
+% podman(1) podman-varlink - Waits on a container
+% Brent Baude
+# podman-varlink "1" "April 2018" "podman"
+
+## NAME
+podman varlink - Runs the varlink backend interface
+
+## SYNOPSIS
+**podman varlink**
+[**--help**|**-h**]
+VARLINK_URI
+
+## DESCRIPTION
+Starts the varlink service that allows varlink clients to interact with podman.
+<!--
+More will go here as the docs and api firm up.
+-->
+
+**podman [GLOBAL OPTIONS] varlink **
+
+## GLOBAL OPTIONS
+
+**--help, -h**
+  Print usage statement
+
+## EXAMPLES
+
+  podman varlink unix:/run/io.projectatomic.podman
+<!--
+    TODO: More examples with TCP can be added when that works
+    as well.
+-->
+
+## SEE ALSO
+podman(1)
+
+## HISTORY
+April 2018, Originally compiled by Brent Baude<bbaude@redhat.com>