ocid: add config subcommand

This subcommand is so that users can get a nice commented version of the
ocid configuration file. This comes from the "current" version of the
configuration (allowing somone to get their custom configuration as a
file). It also has a --default option.

In addition, update the tests to use `ocid config` so that we test this
setup (the loading and saving of the options).

Signed-off-by: Aleksa Sarai <asarai@suse.de>

cmd/server/config.go

@@ -0,0 +1,109 @@
+package main
+
+import (
+	"os"
+	"path/filepath"
+	"text/template"
+
+	"github.com/kubernetes-incubator/cri-o/server"
+	"github.com/opencontainers/runc/libcontainer/selinux"
+	"github.com/urfave/cli"
+)
+
+const (
+	ocidRoot   = "/var/lib/ocid"
+	conmonPath = "/usr/libexec/ocid/conmon"
+	pausePath  = "/usr/libexec/ocid/pause"
+)
+
+var commentedConfigTemplate = template.Must(template.New("config").Parse(`
+# The "ocid" table contains all of the server options.
+[ocid]
+
+# root is a path to the "root directory". OCID stores all of its state
+# data, including container images, in this directory.
+root = "{{ .Root }}"
+
+# sandbox_dir is the directory where ocid will store all of its sandbox
+# state and other information.
+sandbox_dir = "{{ .SandboxDir }}"
+
+# container_dir is the directory where ocid will store all of its
+# container state and other information.
+container_dir = "{{ .ContainerDir }}"
+
+# The "ocid.api" table contains settings for the kubelet/gRPC
+# interface (which is also used by ocic).
+[ocid.api]
+
+# listen is the path to the AF_LOCAL socket on which ocid will listen.
+listen = "{{ .Listen }}"
+
+# The "ocid.runtime" table contains settings pertaining to the OCI
+# runtime used and options for how to set up and manage the OCI runtime.
+[ocid.runtime]
+
+# runtime is a path to the OCI runtime which ocid will be using.
+runtime = "{{ .Runtime }}"
+
+# conmon is the path to conmon binary, used for managing the runtime.
+conmon = "{{ .Conmon }}"
+
+# selinux indicates whether or not SELinux will be used for pod
+# separation on the host. If you enable this flag, SELinux must be running
+# on the host.
+selinux = {{ .SELinux }}
+
+# The "ocid.image" table contains settings pertaining to the
+# management of OCI images.
+[ocid.image]
+
+# pause is the path to the statically linked pause container binary, used
+# as the entrypoint for infra containers.
+pause = "{{ .Pause }}"
+`))
+
+// DefaultConfig returns the default configuration for ocid.
+func DefaultConfig() *server.Config {
+	return &server.Config{
+		RootConfig: server.RootConfig{
+			Root:         ocidRoot,
+			SandboxDir:   filepath.Join(ocidRoot, "sandboxes"),
+			ContainerDir: filepath.Join(ocidRoot, "containers"),
+		},
+		APIConfig: server.APIConfig{
+			Listen: "/var/run/ocid.sock",
+		},
+		RuntimeConfig: server.RuntimeConfig{
+			Runtime: "/usr/bin/runc",
+			Conmon:  conmonPath,
+			SELinux: selinux.SelinuxEnabled(),
+		},
+		ImageConfig: server.ImageConfig{
+			Pause:      pausePath,
+			ImageStore: filepath.Join(ocidRoot, "store"),
+		},
+	}
+}
+
+var configCommand = cli.Command{
+	Name:  "config",
+	Usage: "generate ocid configuration files",
+	Flags: []cli.Flag{
+		cli.BoolFlag{
+			Name:  "default",
+			Usage: "output the default configuration",
+		},
+	},
+	Action: func(c *cli.Context) error {
+		// At this point, app.Before has already parsed the user's chosen
+		// config file. So no need to handle that here.
+		config := c.App.Metadata["config"].(*server.Config)
+		if c.Bool("default") {
+			config = DefaultConfig()
+		}
+
+		// Output the commented config.
+		return commentedConfigTemplate.ExecuteTemplate(os.Stdout, "config", config)
+	},
+}

cmd/server/main.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 	"net"
 	"os"
-	"path/filepath"
 
 	"github.com/Sirupsen/logrus"
 	"github.com/kubernetes-incubator/cri-o/server"
@@ -14,35 +13,7 @@ import (
 	"k8s.io/kubernetes/pkg/kubelet/api/v1alpha1/runtime"
 )
 
-const (
-	ocidRoot      = "/var/lib/ocid"
-	conmonPath    = "/usr/libexec/ocid/conmon"
-	pausePath     = "/usr/libexec/ocid/pause"
-	ociConfigPath = "/etc/ocid.conf"
-)
-
-// DefaultConfig returns the default configuration for ocid.
-func DefaultConfig() *server.Config {
-	return &server.Config{
-		RootConfig: server.RootConfig{
-			Root:         ocidRoot,
-			SandboxDir:   filepath.Join(ocidRoot, "sandboxes"),
-			ContainerDir: filepath.Join(ocidRoot, "containers"),
-		},
-		APIConfig: server.APIConfig{
-			Listen: "/var/run/ocid.sock",
-		},
-		RuntimeConfig: server.RuntimeConfig{
-			Runtime: "/usr/bin/runc",
-			Conmon:  conmonPath,
-			SELinux: selinux.SelinuxEnabled(),
-		},
-		ImageConfig: server.ImageConfig{
-			Pause:      pausePath,
-			ImageStore: filepath.Join(ocidRoot, "store"),
-		},
-	}
-}
+const ociConfigPath = "/etc/ocid.conf"
 
 func mergeConfig(config *server.Config, ctx *cli.Context) error {
 	// Don't parse the config if the user explicitly set it to "".
@@ -150,6 +121,10 @@ func main() {
 		},
 	}
 
+	app.Commands = []cli.Command{
+		configCommand,
+	}
+
 	app.Before = func(c *cli.Context) error {
 		// Load the configuration file.
 		config := c.App.Metadata["config"].(*server.Config)

test/helpers.bash

@@ -23,6 +23,7 @@ RUNC_BINARY=${RUNC_PATH:-/usr/local/sbin/runc}
 
 TESTDIR=$(mktemp -d)
 OCID_SOCKET="$TESTDIR/ocid.sock"
+OCID_CONFIG="$TESTDIR/ocid.conf"
 
 cp "$CONMON_BINARY" "$TESTDIR/conmon"
 
@@ -72,7 +73,8 @@ function wait_until_reachable() {
 
 # Start ocid.
 function start_ocid() {
-	"$OCID_BINARY" --conmon "$CONMON_BINARY" --pause "$PAUSE_BINARY" --debug --listen "$TESTDIR/ocid.sock" --runtime "$RUNC_BINARY" --root "$TESTDIR/ocid" --sandboxdir "$TESTDIR/sandboxes" --containerdir "$TESTDIR/ocid/containers" & OCID_PID=$!
+	"$OCID_BINARY" --conmon "$CONMON_BINARY" --pause "$PAUSE_BINARY" --listen "$OCID_SOCKET" --runtime "$RUNC_BINARY" --root "$TESTDIR/ocid" --sandboxdir "$TESTDIR/sandboxes" --containerdir "$TESTDIR/ocid/containers" config >$OCID_CONFIG
+	"$OCID_BINARY" --debug --config "$OCID_CONFIG" & OCID_PID=$!
 	wait_until_reachable
 }
 
@@ -106,6 +108,7 @@ function cleanup_pods() {
 function stop_ocid() {
 	if [ "$OCID_PID" != "" ]; then
 		kill "$OCID_PID" >/dev/null 2>&1
+		rm -f "$OCID_CONFIG"
 	fi
 }