Merge pull request #3112 from martinhoefling/profile-composability-docs

document activation of multiple profiles

docs/content/en/docs/environment/profiles.md

@@ -99,3 +99,14 @@ In the example below instead of overriding the whole `build` section, the `dev`
 defines a different Dockerfile to use for the first artifact.
 
 {{% readfile file="samples/profiles/patches.yaml" %}}
+
+### Activating multiple profiles at the same time
+
+Multiple profiles can be specified either by using the `-p` flag multiple times or by comma separated profiles.
+
+```bash
+skaffold dev -p hello,world
+```
+
+Skaffold will activate both profiles, `hello` and `world`. 
+This is e.g. useful when combined with patches to provide a composable development setup where `hello` and `world` can be added on demand.

examples/profile-patches/README.adoc

@@ -0,0 +1,23 @@
+=== Example: Getting started with a simple go app
+:icons: font
+
+This is a simple show-case of how Skaffold profiles can be patched.
+Patched profiles e.g. can be used in development to provide a composable development setup.
+Here, a "base" service is always started. Two additional services "hello" and "world" can be activated via profiles.
+
+==== Init
+Use the `--profile` option to add profiles `skaffold dev --profile hello,world`
+
+==== Workflow
+* Build only the `base-service` when using the main profile
+* Build `hello` and/or `world` when specified via `-p` flag. Multiple `-p` flags are supported as well as comma separated values.
+
+ifndef::env-github[]
+==== link:{github-repo-tree}/examples/profiles[Example files icon:github[]]
+
+[source,yaml, indent=3, title=skaffold.yaml]
+----
+include::skaffold.yaml[]
+----
+
+endif::[]

examples/profile-patches/base-service/Dockerfile

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

examples/profile-patches/base-service/k8s-pod.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: base-service
+spec:
+  containers:
+  - name: base-service
+    image: gcr.io/k8s-skaffold/skaffold-base

examples/profile-patches/base-service/main.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	for {
+		fmt.Println("BASE")
+
+		time.Sleep(time.Second * 1)
+	}
+}

examples/profile-patches/hello-service/Dockerfile

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

examples/profile-patches/hello-service/k8s-pod.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: hello-service
+spec:
+  containers:
+  - name: hello-service
+    image: gcr.io/k8s-skaffold/skaffold-hello

examples/profile-patches/hello-service/main.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	for {
+		fmt.Println("HELLO")
+
+		time.Sleep(time.Second * 1)
+	}
+}

examples/profile-patches/skaffold.yaml

@@ -0,0 +1,34 @@
+apiVersion: skaffold/v1beta16
+kind: Config
+build:
+  # only build and deploy "base-service" on main profile
+  artifacts:
+  - image: gcr.io/k8s-skaffold/skaffold-base
+    context: base-service
+deploy:
+  kubectl:
+    manifests:
+      - 'base-service/*.yaml'
+
+profiles:
+  - name: hello
+    patches:
+      - op: add
+        path: /build/artifacts/1
+        value:
+          image: gcr.io/k8s-skaffold/skaffold-hello
+          context: hello-service
+      - op: add
+        path: /deploy/kubectl/manifests/1
+        value: 'hello-service/*.yaml'
+
+  - name: world
+    patches:
+      - op: add
+        path: /build/artifacts/1
+        value:
+          image: gcr.io/k8s-skaffold/skaffold-world
+          context: world-service
+      - op: add
+        path: /deploy/kubectl/manifests/1
+        value: 'world-service/*.yaml'

examples/profile-patches/world-service/Dockerfile

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

examples/profile-patches/world-service/k8s-pod.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: world-service
+spec:
+  containers:
+  - name: world-service
+    image: gcr.io/k8s-skaffold/skaffold-world

examples/profile-patches/world-service/main.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	for {
+		fmt.Println("WORLD")
+
+		time.Sleep(time.Second * 1)
+	}
+}

integration/examples/profile-patches/README.adoc

@@ -0,0 +1,23 @@
+=== Example: Getting started with a simple go app
+:icons: font
+
+This is a simple show-case of how Skaffold profiles can be patched.
+Patched profiles e.g. can be used in development to provide a composable development setup.
+Here, a "base" service is always started. Two additional services "hello" and "world" can be activated via profiles.
+
+==== Init
+Use the `--profile` option to add profiles `skaffold dev --profile hello,world`
+
+==== Workflow
+* Build only the `base-service` when using the main profile
+* Build `hello` and/or `world` when specified via `-p` flag. Multiple `-p` flags are supported as well as comma separated values.
+
+ifndef::env-github[]
+==== link:{github-repo-tree}/examples/profiles[Example files icon:github[]]
+
+[source,yaml, indent=3, title=skaffold.yaml]
+----
+include::skaffold.yaml[]
+----
+
+endif::[]

integration/examples/profile-patches/base-service/Dockerfile

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

integration/examples/profile-patches/base-service/k8s-pod.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: base-service
+spec:
+  containers:
+  - name: base-service
+    image: gcr.io/k8s-skaffold/skaffold-base

integration/examples/profile-patches/base-service/main.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	for {
+		fmt.Println("BASE")
+
+		time.Sleep(time.Second * 1)
+	}
+}

integration/examples/profile-patches/hello-service/Dockerfile

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

integration/examples/profile-patches/hello-service/k8s-pod.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: hello-service
+spec:
+  containers:
+  - name: hello-service
+    image: gcr.io/k8s-skaffold/skaffold-hello

integration/examples/profile-patches/hello-service/main.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	for {
+		fmt.Println("HELLO")
+
+		time.Sleep(time.Second * 1)
+	}
+}

integration/examples/profile-patches/skaffold.yaml

@@ -0,0 +1,34 @@
+apiVersion: skaffold/v1beta16
+kind: Config
+build:
+  # only build and deploy "base-service" on main profile
+  artifacts:
+  - image: gcr.io/k8s-skaffold/skaffold-base
+    context: base-service
+deploy:
+  kubectl:
+    manifests:
+      - 'base-service/*.yaml'
+
+profiles:
+  - name: hello
+    patches:
+      - op: add
+        path: /build/artifacts/1
+        value:
+          image: gcr.io/k8s-skaffold/skaffold-hello
+          context: hello-service
+      - op: add
+        path: /deploy/kubectl/manifests/1
+        value: 'hello-service/*.yaml'
+
+  - name: world
+    patches:
+      - op: add
+        path: /build/artifacts/1
+        value:
+          image: gcr.io/k8s-skaffold/skaffold-world
+          context: world-service
+      - op: add
+        path: /deploy/kubectl/manifests/1
+        value: 'world-service/*.yaml'

integration/examples/profile-patches/world-service/Dockerfile

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

integration/examples/profile-patches/world-service/k8s-pod.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: world-service
+spec:
+  containers:
+  - name: world-service
+    image: gcr.io/k8s-skaffold/skaffold-world

integration/examples/profile-patches/world-service/main.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	for {
+		fmt.Println("WORLD")
+
+		time.Sleep(time.Second * 1)
+	}
+}