Merge pull request #1282 from nkubala/compose

Add --compose-file option to skaffold init

cmd/skaffold/app/cmd/init.go

@@ -22,6 +22,7 @@ import (
 	"io"
 	"io/ioutil"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"strings"
 
@@ -45,6 +46,7 @@ import (
 const NoDockerfile = "None (image not built from these sources)"
 
 var (
+	composeFile  string
 	cliArtifacts []string
 	skipBuild    bool
 	force        bool
@@ -63,13 +65,23 @@ func NewCmdInit(out io.Writer) *cobra.Command {
 	cmd.Flags().StringVarP(&opts.ConfigurationFile, "filename", "f", "skaffold.yaml", "Filename or URL to the pipeline file")
 	cmd.Flags().BoolVar(&skipBuild, "skip-build", false, "Skip generating build artifacts in skaffold config")
 	cmd.Flags().BoolVar(&force, "force", false, "Force the generation of the skaffold config")
+	cmd.Flags().StringVar(&composeFile, "compose-file", "", "Initialize from a docker-compose file")
 	cmd.Flags().StringArrayVarP(&cliArtifacts, "artifact", "a", nil, "'='-delimited dockerfile/image pair to generate build artifact\n(example: --artifact=/web/Dockerfile.web=gcr.io/web-project/image)")
 	return cmd
 }
 
 func doInit(out io.Writer) error {
 	rootDir := "."
 
+	if composeFile != "" {
+		// run kompose first to generate k8s manifests, then run skaffold init
+		logrus.Infof("running 'kompose convert' for file %s", composeFile)
+		komposeCmd := exec.Command("kompose", "convert", "-f", composeFile)
+		if err := util.RunCmd(komposeCmd); err != nil {
+			return errors.Wrap(err, "running kompose")
+		}
+	}
+
 	var potentialConfigs, k8sConfigs, dockerfiles, images []string
 	err := filepath.Walk(rootDir, func(path string, f os.FileInfo, e error) error {
 		if f.IsDir() {

deploy/skaffold/Dockerfile

@@ -43,6 +43,11 @@ RUN curl -LO https://github.com/kubernetes-sigs/kustomize/releases/download/v${K
     chmod +x kustomize_${KUSTOMIZE_VERSION}_linux_amd64 && \
     mv kustomize_${KUSTOMIZE_VERSION}_linux_amd64 /usr/local/bin/kustomize
 
+ENV KOMPOSE_VERSION=1.17.0
+RUN curl -L https://github.com/kubernetes/kompose/releases/download/v${KOMPOSE_VERSION}/kompose-linux-amd64 -o kompose && \
+    chmod +x kompose && \
+    mv kompose /usr/local/bin
+
 RUN echo "deb [arch=amd64] http://storage.googleapis.com/bazel-apt stable jdk1.8" | tee /etc/apt/sources.list.d/bazel.list \
   && curl https://bazel.build/bazel-release.pub.gpg | apt-key add -
 

examples/compose/Dockerfile

@@ -0,0 +1,7 @@
+FROM golang:1.10.1-alpine3.7 as builder
+COPY main.go .
+RUN go build -o /app main.go
+
+FROM alpine:3.7  
+CMD ["./app"]
+COPY --from=builder /app .

examples/compose/README.adoc

@@ -0,0 +1,10 @@
+=== Example: Running skaffold with docker-compose files
+:icons: font
+
+This example provides a simple application set up to run with 
+https://docs.docker.com/compose/[docker-compose].
+Notice there is no skaffold configuration present: to run this example,
+first run `skaffold init --compose-file docker-compose.yaml`, which will
+invoke the https://github.com/kubernetes/kompose[kompose] binary to generate
+kubernetes manifests based off of the docker-compose configuration, and then run
+`skaffold init` to generate the skaffold configuration.

examples/compose/docker-compose.yaml

@@ -0,0 +1,7 @@
+version: '3'
+services:
+  compose:
+    build: .
+    image: "gcr.io/k8s-skaffold/compose"
+    ports:
+     - "5000:5000"

examples/compose/main.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	for {
+		fmt.Println("Hello world!")
+		time.Sleep(time.Second * 1)
+	}
+}

integration/examples/compose/Dockerfile

@@ -0,0 +1,7 @@
+FROM golang:1.10.1-alpine3.7 as builder
+COPY main.go .
+RUN go build -o /app main.go
+
+FROM alpine:3.7  
+CMD ["./app"]
+COPY --from=builder /app .

integration/examples/compose/README.adoc

@@ -0,0 +1,10 @@
+=== Example: Running skaffold with docker-compose files
+:icons: font
+
+This example provides a simple application set up to run with 
+https://docs.docker.com/compose/[docker-compose].
+Notice there is no skaffold configuration present: to run this example,
+first run `skaffold init --compose-file docker-compose.yaml`, which will
+invoke the https://github.com/kubernetes/kompose[kompose] binary to generate
+kubernetes manifests based off of the docker-compose configuration, and then run
+`skaffold init` to generate the skaffold configuration.

integration/examples/compose/docker-compose.yaml

@@ -0,0 +1,7 @@
+version: '3'
+services:
+  compose:
+    build: .
+    image: "gcr.io/k8s-skaffold/compose"
+    ports:
+     - "5000:5000"

integration/examples/compose/main.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	for {
+		fmt.Println("Hello world!")
+		time.Sleep(time.Second * 1)
+	}
+}

integration/run_test.go

@@ -408,9 +408,10 @@ func TestListConfig(t *testing.T) {
 
 func TestInit(t *testing.T) {
 	type testCase struct {
-		name string
-		dir  string
-		args []string
+		name             string
+		dir              string
+		args             []string
+		skipSkaffoldYaml bool
 	}
 
 	tests := []testCase{
@@ -426,16 +427,24 @@ func TestInit(t *testing.T) {
 				"-a", "leeroy-web/Dockerfile=gcr.io/k8s-skaffold/leeroy-web",
 			},
 		},
+		{
+			name:             "compose",
+			dir:              "../examples/compose",
+			args:             []string{"--compose-file", "docker-compose.yaml"},
+			skipSkaffoldYaml: true,
+		},
 	}
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			oldYamlPath := filepath.Join(test.dir, "skaffold.yaml")
-			oldYaml, err := removeOldSkaffoldYaml(oldYamlPath)
-			if err != nil {
-				t.Fatalf("removing original skaffold.yaml: %s", err)
+			if !test.skipSkaffoldYaml {
+				oldYamlPath := filepath.Join(test.dir, "skaffold.yaml")
+				oldYaml, err := removeOldSkaffoldYaml(oldYamlPath)
+				if err != nil {
+					t.Fatalf("removing original skaffold.yaml: %s", err)
+				}
+				defer restoreOldSkaffoldYaml(oldYaml, oldYamlPath)
 			}
-			defer restoreOldSkaffoldYaml(oldYaml, oldYamlPath)
 
 			generatedYaml := "skaffold.yaml.out"
 			defer func() {