Add CNAB examples

chris-crone · silvin-lubecki · commit 520a7b145dbe · 2019-01-31T16:43:09.000+01:00
*Fix running docker-app validate only on application package examples and skip CNAB examples.

Signed-off-by: Christopher Crone &lt;christopher.crone@docker.com&gt;
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ An *experimental* utility to help make Compose files more reusable and sharable.
 
 You can find some preview binaries of `docker-app` with CNAB support [here](https://github.com/docker/app/releases/tag/cnab-dockercon-preview).
 
-There is a [simple example](https://github.com/docker/app/tree/cnab-preview/examples/cnab-simple) and an [example of how to deploy a Helm Chart](https://github.com/docker/app/tree/cnab-preview/examples/cnab-helm).
+There is a [simple example](./examples/cnab-simple) and an [example of how to deploy a Helm Chart](./examples/cnab-helm).
 
 ## The problem application packages solve
 
diff --git a/e2e/example_test.go b/e2e/example_test.go
@@ -12,15 +12,19 @@ import (
 
 func TestExamplesAreValid(t *testing.T) {
 	err := filepath.Walk("../examples", func(p string, info os.FileInfo, err error) error {
+		appPath := filepath.Join(p, filepath.Base(p)+".dockerapp")
+		_, statErr := os.Stat(appPath)
 		switch {
 		case strings.HasSuffix(p, "examples"):
 			return nil
 		case strings.HasSuffix(p, ".resources"):
 			return filepath.SkipDir
 		case !info.IsDir():
 			return nil
+		case os.IsNotExist(statErr):
+			return nil
 		default:
-			result := icmd.RunCommand(dockerApp, "validate", filepath.Join(p, filepath.Base(p)+".dockerapp"))
+			result := icmd.RunCommand(dockerApp, "validate", appPath)
 			result.Assert(t, icmd.Success)
 			return filepath.SkipDir
 		}
diff --git a/examples/README.md b/examples/README.md
@@ -19,3 +19,11 @@ To learn how to create the Docker voting app from [Docker samples](https://githu
 To learn how to create a basic WordPress with a database.
 
 ![WordPress app screenshot](.resources/wordpress.png "WordPress app screenshot")
+
+### [CNAB simple application](cnab-simple)
+
+Inspect and bundle a simple application as a [CNAB](https://cnab.io).
+
+### [Deploy a Helm Chart using docker-app](cnab-helm)
+
+As `docker-app` is a [CNAB](https://cnab.io) compliant client, you can deploy any CNAB.
diff --git a/examples/cnab-helm/README.md b/examples/cnab-helm/README.md
@@ -0,0 +1,56 @@
+## Requirements
+
+* Working Docker Desktop install with Kubernetes enabled
+* [`docker-app` with CNAB support](https://github.com/docker/app/releases/tag/cnab-dockercon-preview) installed
+* Source code from this directory
+* Create a context with `docker-app context`
+* Set the `DOCKER_TARGET_CONTEXT` environment variable
+* Helm configured for your Kubernetes cluster
+* A `duffle` credential set created
+
+## Examples
+
+
+Install the Helm chart example using `docker-app`
+
+
+```
+$ docker-app install -c local bundle.json
+Do install for hellohelm
+helm install --namespace hellohelm -n hellohelm /cnab/app/charts/alpine
+NAME:   hellohelm
+LAST DEPLOYED: Wed Nov 28 13:58:22 2018
+NAMESPACE: hellohelm
+STATUS: DEPLOYED
+
+RESOURCES:
+==> v1/Pod
+NAME              AGE
+hellohelm-alpine  0s
+```
+
+
+Check the status of the Helm-based application:
+
+```console
+$ docker-app status -c local hellohelm
+Do Status
+helm status hellohelm
+LAST DEPLOYED: Wed Nov 28 13:58:22 2018
+NAMESPACE: hellohelm
+STATUS: DEPLOYED
+
+RESOURCES:
+==> v1/Pod
+NAME              AGE
+hellohelm-alpine  2m
+```
+
+Uninstall the Helm-based application:
+
+```console
+docker-app uninstall -c local hellohelm
+Do Uninstall
+helm delete --purge hellohelm
+release "hellohelm" deleted
+```
diff --git a/examples/cnab-helm/bundle.json b/examples/cnab-helm/bundle.json
@@ -0,0 +1,34 @@
+{
+    "name": "hellohelm",
+    "version": "0.1.0",
+    "invocationImages": [
+        {
+        "imageType": "docker",
+        "image": "cnab/hellohelm:latest"
+        }
+    ],
+    "images": [
+        {
+            "description": "alpine",
+            "image": "technosophos/demo2alpine:0.1.0",
+            "imageType": "docker",
+            "refs": [
+                {
+                    "path": "cnab/app/charts/alpine/values.yaml",
+                    "field": "image.repository"
+                }
+            ]
+        }
+    ],
+    "parameters": {
+        "port": {
+            "defaultValue": 8080,
+            "type": "int"
+        }
+    },
+    "credentials": {
+        "kubeconfig": {
+            "path": "/root/.kube/config"
+        }
+    }
+}
diff --git a/examples/cnab-helm/cnab/Dockerfile b/examples/cnab-helm/cnab/Dockerfile
@@ -0,0 +1,4 @@
+FROM cnab/k8sbase:latest
+
+COPY app/Makefile /cnab/app/Makefile
+COPY app/charts /cnab/app/charts
diff --git a/examples/cnab-helm/cnab/app/Makefile b/examples/cnab-helm/cnab/app/Makefile
@@ -0,0 +1,27 @@
+KUBECONFIG=/root/.kube/config
+
+CNAB_ACTION ?= status
+CNAB_INSTALLATION_NAME ?= helmtest
+
+CNAB_P_HELM_OPTIONS ?= --dry-run --debug
+CNAB_P_NAMESPACE ?= hellohelm
+
+CHART=/cnab/app/charts/alpine
+
+install:
+	@echo "Do $(CNAB_ACTION) for $(CNAB_INSTALLATION_NAME)"
+	helm install --namespace $(CNAB_P_NAMESPACE) -n $(CNAB_INSTALLATION_NAME) $(CHART)
+
+uninstall: 
+	@echo "Do Uninstall"
+	helm delete --purge $(CNAB_INSTALLATION_NAME)
+
+upgrade:
+	@echo "Do Upgrade"
+	helm upgrade --namespace $(CNAB_P_NAMESPACE) $(CNAB_INSTALLATION_NAME) $(CHART)
+
+status:
+	@echo "Do Status"
+	helm status $(CNAB_INSTALLATION_NAME)
+
+.PHONY: install uninstall upgrade status
diff --git a/examples/cnab-helm/cnab/app/charts/alpine/Chart.yaml b/examples/cnab-helm/cnab/app/charts/alpine/Chart.yaml
@@ -0,0 +1,7 @@
+name: alpine
+description: Deploy a basic Alpine Linux pod
+version: 0.1.0
+home: https://github.com/kubernetes/helm
+sources:
+  - https://github.com/kubernetes/helm
+appVersion: 3.3
diff --git a/examples/cnab-helm/cnab/app/charts/alpine/Dockerfile b/examples/cnab-helm/cnab/app/charts/alpine/Dockerfile
@@ -0,0 +1,3 @@
+FROM alpine:3.7
+
+CMD ["sleep", "9000"]
diff --git a/examples/cnab-helm/cnab/app/charts/alpine/README.md b/examples/cnab-helm/cnab/app/charts/alpine/README.md
@@ -0,0 +1,11 @@
+# Alpine: A simple Helm chart
+
+Run a single pod of Alpine Linux.
+
+The `templates/` directory contains a very simple pod resource with a
+couple of parameters.
+
+The `values.yaml` file contains the default values for the
+`alpine-pod.yaml` template.
+
+You can install this example using `helm install docs/examples/alpine`.
diff --git a/examples/cnab-helm/cnab/app/charts/alpine/templates/_helpers.tpl b/examples/cnab-helm/cnab/app/charts/alpine/templates/_helpers.tpl
@@ -0,0 +1,16 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "alpine.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+*/}}
+{{- define "alpine.fullname" -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
diff --git a/examples/cnab-helm/cnab/app/charts/alpine/templates/alpine-pod.yaml b/examples/cnab-helm/cnab/app/charts/alpine/templates/alpine-pod.yaml
@@ -0,0 +1,23 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: {{ template "alpine.fullname" . }}
+  labels:
+    # The "heritage" label is used to track which tool deployed a given chart.
+    # It is useful for admins who want to see what releases a particular tool
+    # is responsible for.
+    heritage: {{ .Release.Service }}
+    # The "release" convention makes it easy to tie a release to all of the
+    # Kubernetes resources that were created as part of that release.
+    release: {{ .Release.Name }}
+    # This makes it easy to audit chart usage.
+    chart: {{ .Chart.Name }}-{{ .Chart.Version }}
+    app: {{ template "alpine.name" . }}
+spec:
+  # This shows how to use a simple value. This will look for a passed-in value called restartPolicy.
+  restartPolicy: {{ .Values.restartPolicy }}
+  containers:
+  - name: waiter
+    image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+    imagePullPolicy: {{ .Values.image.pullPolicy }}
+    command: ["/bin/sleep", "9000"]
diff --git a/examples/cnab-helm/cnab/app/charts/alpine/values.yaml b/examples/cnab-helm/cnab/app/charts/alpine/values.yaml
@@ -0,0 +1,6 @@
+image:
+  repository: alpine
+  tag: 3.3
+  pullPolicy: IfNotPresent
+
+restartPolicy: Never
diff --git a/examples/cnab-helm/duffle.toml b/examples/cnab-helm/duffle.toml
@@ -0,0 +1,3 @@
+name = "hellohelm"
+registry = "cnab"
+components = ["cnab"]
diff --git a/examples/cnab-helm/local.yaml b/examples/cnab-helm/local.yaml
@@ -0,0 +1,5 @@
+name: local
+credentials:
+  - name: kubeconfig
+    source:
+      path: C:\Users\garet\.kube\desktop
diff --git a/examples/cnab-helm/values.toml b/examples/cnab-helm/values.toml
@@ -0,0 +1 @@
+greeting = "YO"
diff --git a/examples/cnab-simple/README.md b/examples/cnab-simple/README.md
@@ -0,0 +1,62 @@
+## Requirements
+
+* Working Docker Desktop install with Kubernetes enabled
+* [`docker-app` with CNAB support](https://github.com/docker/app/releases/tag/cnab-dockercon-preview) installed
+* Source code from this directory
+* Create a context with `docker-app context`
+* Set the `DOCKER_TARGET_CONTEXT` environment variable
+
+## Examples
+
+Show the details of the application with `inspect`
+
+```console
+$ docker-app inspect
+hello 0.1.0
+
+Maintained by: garethr <garethr@docker.com>
+
+sample app for DockerCon
+
+Service (1) Replicas Ports Image
+----------- -------- ----- -----
+hello       1        8765  hashicorp/http-echo:latest
+
+Parameters (3) Value
+-------------- -----
+port           8765
+text           hello DockerCon
+version        latest
+```
+
+Install the application:
+
+```
+docker-app install
+```
+
+Show the details of the installation:
+
+```
+docker-app status hello
+```
+
+Upgrade the installation, demonstrating setting parameters:
+
+```
+docker-app upgrade--set port=9876 --set text="hello DockerCon EU"
+```
+
+Uninstall the application installation:
+
+
+```
+docker-app uninstall hello
+```
+
+Demonstrate building a `bundle.json` for CNAB.
+
+```console
+$ docker-app bundle
+Invocation image "hello:0.1.0-invoc" successfully built
+```
diff --git a/examples/cnab-simple/bundle.json b/examples/cnab-simple/bundle.json
diff --git a/examples/cnab-simple/docker-compose.yml b/examples/cnab-simple/docker-compose.yml
diff --git a/examples/cnab-simple/hello.dockerapp b/examples/cnab-simple/hello.dockerapp
diff --git a/examples/cnab-simple/prod.yml b/examples/cnab-simple/prod.yml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+FROM alpine:3.7`
	`2`	`+`
	`3`	`+CMD ["sleep", "9000"]`