Merge pull request #2822 from marlon-gamez/pipeline-example

add example for skaffold generate-pipeline

Author: tejal29

examples/generate-pipeline/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/generate-pipeline/README.adoc

@@ -0,0 +1,27 @@
+=== Example: Getting started with skaffold and CI/CD using Tekton
+:icons: font
+
+This is a simple example to show users how to run the generate-pipeline command
+
+_Please keep in mind that the generate-pipeline command is still a WIP_
+
+Prerequisites:
+
+* Install tekton on your cluster (https://github.com/tektoncd/pipeline/blob/master/docs/install.md)
+* Have kaniko secrets setup (https://github.com/GoogleContainerTools/kaniko)
+* Container registry must be public
+* Give your default service account the cluster-admin role (necessary to have pipeline access secrets)
+----
+kubectl create clusterrolebinding serviceaccounts-cluster-admin \
+--clusterrole=cluster-admin \
+--user=system:serviceaccount:default:default
+----
+
+To generate and run a pipeline:
+
+* Run skaffold generate-pipeline
+* Modify skaffold.yaml to use a valid GCSbucket for kaniko
+* Commit and push updated skaffold.yaml
+* kubectl apply -f pipeline.yaml
+* Create a pipelinerun.yaml
+* kubectl apply -f pipelinerun.yaml

examples/generate-pipeline/k8s-pod.yaml

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

examples/generate-pipeline/main.go

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

examples/generate-pipeline/skaffold.yaml

@@ -0,0 +1,9 @@
+apiVersion: skaffold/v1beta14
+kind: Config
+build:
+  artifacts:
+  - image: gcr.io/k8s-skaffold/pipeline-example
+deploy:
+  kubectl:
+    manifests:
+      - k8s-*

integration/examples/generate-pipeline/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/generate-pipeline/README.adoc

@@ -0,0 +1,27 @@
+=== Example: Getting started with skaffold and CI/CD using Tekton
+:icons: font
+
+This is a simple example to show users how to run the generate-pipeline command
+
+_Please keep in mind that the generate-pipeline command is still a WIP_
+
+Prerequisites:
+
+* Install tekton on your cluster (https://github.com/tektoncd/pipeline/blob/master/docs/install.md)
+* Have kaniko secrets setup (https://github.com/GoogleContainerTools/kaniko)
+* Container registry must be public
+* Give your default service account the cluster-admin role (necessary to have pipeline access secrets)
+----
+kubectl create clusterrolebinding serviceaccounts-cluster-admin \
+--clusterrole=cluster-admin \
+--user=system:serviceaccount:default:default
+----
+
+To generate and run a pipeline:
+
+* Run skaffold generate-pipeline
+* Modify skaffold.yaml to use a valid GCSbucket for kaniko
+* Commit and push updated skaffold.yaml
+* kubectl apply -f pipeline.yaml
+* Create a pipelinerun.yaml
+* kubectl apply -f pipelinerun.yaml

integration/examples/generate-pipeline/expectedPipeline.yaml

@@ -0,0 +1,113 @@
+apiVersion: tekton.dev/v1alpha1
+kind: PipelineResource
+metadata:
+  creationTimestamp: null
+  name: source-git
+spec:
+  params:
+  - name: url
+    value: this-is-a-test
+  type: git
+status: {}
+---
+apiVersion: tekton.dev/v1alpha1
+kind: Task
+metadata:
+  creationTimestamp: null
+  name: skaffold-build-0
+spec:
+  inputs:
+    resources:
+    - name: source
+      outputImageDir: ""
+      targetPath: ""
+      type: git
+  outputs:
+    resources:
+    - name: source
+      outputImageDir: ""
+      targetPath: ""
+      type: git
+  steps:
+  - args:
+    - --filename
+    - skaffold.yaml
+    - --profile
+    - oncluster
+    - --file-output
+    - build.out
+    command:
+    - skaffold
+    - build
+    env:
+    - name: GOOGLE_APPLICATION_CREDENTIALS
+      value: /secret/kaniko-secret
+    image: gcr.io/k8s-skaffold/skaffold:test-version
+    name: run-build
+    resources: {}
+    volumeMounts:
+    - mountPath: /secret
+      name: kaniko-secret
+    workingDir: /workspace/source
+  volumes:
+  - name: kaniko-secret
+    secret:
+      secretName: kaniko-secret
+---
+apiVersion: tekton.dev/v1alpha1
+kind: Task
+metadata:
+  creationTimestamp: null
+  name: skaffold-deploy-0
+spec:
+  inputs:
+    resources:
+    - name: source
+      outputImageDir: ""
+      targetPath: ""
+      type: git
+  steps:
+  - args:
+    - --filename
+    - skaffold.yaml
+    - --build-artifacts
+    - build.out
+    command:
+    - skaffold
+    - deploy
+    image: gcr.io/k8s-skaffold/skaffold:test-version
+    name: run-deploy
+    resources: {}
+    workingDir: /workspace/source
+---
+apiVersion: tekton.dev/v1alpha1
+kind: Pipeline
+metadata:
+  creationTimestamp: null
+  name: skaffold-pipeline
+spec:
+  resources:
+  - name: source-repo
+    type: git
+  tasks:
+  - name: skaffold-build-0-task
+    resources:
+      inputs:
+      - name: source
+        resource: source-repo
+      outputs:
+      - name: source
+        resource: source-repo
+    taskRef:
+      name: skaffold-build-0
+  - name: skaffold-deploy-0-task
+    resources:
+      inputs:
+      - from:
+        - skaffold-build-0-task
+        name: source
+        resource: source-repo
+    taskRef:
+      name: skaffold-deploy-0
+status: {}
+---

integration/examples/generate-pipeline/expectedSkaffold.yaml

@@ -0,0 +1,22 @@
+apiVersion: skaffold/v1beta14
+kind: Config
+build:
+  artifacts:
+  - image: gcr.io/k8s-skaffold/pipeline-example
+deploy:
+  kubectl:
+    manifests:
+    - k8s-*
+profiles:
+- name: oncluster
+  build:
+    artifacts:
+    - image: gcr.io/k8s-skaffold/pipeline-example-pipeline
+      context: .
+      kaniko:
+        buildContext:
+          gcsBucket: skaffold-kaniko
+    tagPolicy:
+      gitCommit: {}
+    cluster:
+      pullSecretName: kaniko-secret

integration/examples/generate-pipeline/k8s-pod.yaml

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

integration/examples/generate-pipeline/main.go

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

integration/examples/generate-pipeline/skaffold.yaml

@@ -0,0 +1,9 @@
+apiVersion: skaffold/v1beta14
+kind: Config
+build:
+  artifacts:
+  - image: gcr.io/k8s-skaffold/pipeline-example
+deploy:
+  kubectl:
+    manifests:
+    - k8s-*

integration/generate_pipeline_test.go

@@ -66,6 +66,11 @@ func TestGeneratePipeline(t *testing.T) {
 			input:       []byte{'y', '\n', 'y', '\n'},
 			configFiles: []string{"sub-app/skaffold.yaml"},
 		},
+		{
+			description: "user example",
+			dir:         "examples/generate-pipeline",
+			input:       []byte("y\n"),
+		},
 	}
 
 	for _, test := range tests {
@@ -123,11 +128,11 @@ func writeOriginalContents(contents []configContents) {
 func checkFileContents(t *testing.T, wantFile, gotFile string) {
 	wantContents, err := ioutil.ReadFile(wantFile)
 	if err != nil {
-		t.Errorf("Error while reading contents of file %s", wantFile)
+		t.Errorf("Error while reading contents of file %s: %s", wantFile, err)
 	}
 	gotContents, err := ioutil.ReadFile(gotFile)
 	if err != nil {
-		t.Errorf("Error while reading contents of file %s", gotFile)
+		t.Errorf("Error while reading contents of file %s: %s", gotFile, err)
 	}
 
 	if !bytes.Equal(wantContents, gotContents) {