diff --git a/docs/cuj/README.md b/docs/cuj/README.md deleted file mode 100644 index 977359d3105..00000000000 --- a/docs/cuj/README.md +++ /dev/null @@ -1,47 +0,0 @@ -# User Critical Journey - -This folder contains all the resources for User Critical Journey for Pipeline -CRDs - -**STOP READING** If you want to be or are part of user study. Please do not read -docs and exercises before hand as it may not gives us the right signals. - -If you are conducting a Critical User Journey, go ahead and read all the -documents. - -## Conducting a User Study. - -1. Find a potential candidate for user study. A candidate can be - 1. A Kubernetes developer with any level of experience. - 1. Any engineer with CI/CD experience -1. Schedule a 50-60 minutes session with a potential candidate. Ideally we would - not want to spend more than 45 minutes per session with 5-10 mins of buffer - time. -1. Review all the documents in this folder beforehand. -1. Please ping [tejal29](https://github.com/tejal29) to get access to User Study - Matrix to record results. This document also contains tips and other pointers - to give when the user is stuck. -1. The Exercises are in [Exercises](./exercises) folder. Please try to complete - first 3 exercises. - - [Exercise4](./exercises/exercise4) is optional and is only to be conducted - when time permits or at user's discretion. - -1. Allot time for each exercise. - - Recommended time limit - - - Exercise 1: 20-25 mins - - Exercise 2: 10-15 mins - - Exercise 3: 5-10 mins - - Exercise 4: Optional - -1. Answers to exercises are in [answers](./answers) folder. You can share them - with users once they completed the exercise or if run out of alloted time. - -And **most important** - -1. Listen more Talk less. -1. Avoid discussing design decisions or getting into techinal details. -1. _Be Neutral_ and not defensive -1. Finally, record all feedback. diff --git a/docs/cuj/answers/exercise3/go-test.yaml b/docs/cuj/answers/exercise3/go-test.yaml deleted file mode 100644 index 56f7cae85ca..00000000000 --- a/docs/cuj/answers/exercise3/go-test.yaml +++ /dev/null @@ -1,20 +0,0 @@ -apiVersion: pipeline.knative.dev/v1alpha1 -kind: Task -metadata: - name: go-test - namespace: default -spec: - inputs: - resources: - - name: workspace - type: git - params: - - name: package - steps: - - name: run-test - image: gcr.io/google_appengine/golang - command: - - go - args: - - test - - ${inputs.params.package} \ No newline at end of file diff --git a/docs/cuj/answers/exercise4/checkout-pipeline.yaml b/docs/cuj/answers/exercise4/checkout-pipeline.yaml deleted file mode 100644 index 302b7df0b1b..00000000000 --- a/docs/cuj/answers/exercise4/checkout-pipeline.yaml +++ /dev/null @@ -1,23 +0,0 @@ -apiVersion: pipeline.knative.dev/v1alpha1 -kind: Pipeline -metadata: - name: microservices-pipeline - namespace: default -spec: - tasks: - - name: test-checkout - taskRef: - name: go-test - params: - - name: target - value: ./src/checkoutservice./... - - name: build-checkoutservice - taskRef: - name: build-push - inputs: - - name: workspace - providedBy: - - test-checkout - params: - - name: pathToDockerfile - value: src/checkoutservice/Dockerfile \ No newline at end of file diff --git a/docs/cuj/exercises/exercise1/Exercise1.md b/docs/cuj/exercises/exercise1/Exercise1.md deleted file mode 100644 index b77a4bc6113..00000000000 --- a/docs/cuj/exercises/exercise1/Exercise1.md +++ /dev/null @@ -1,8 +0,0 @@ -# Definition - -Assume you are a new Kubernetes developer and you need write a CI/CD pipeline -for your application. You stumbled upon this project and want to evavluate if -this a possible solution for defining a CI/CD pipeline. - -Read the [Pipeline CRD Concepts](./../../../Concepts.md) to understand this -project. diff --git a/docs/cuj/exercises/exercise2/Exercise2.md b/docs/cuj/exercises/exercise2/Exercise2.md deleted file mode 100644 index d7a51cdc0fe..00000000000 --- a/docs/cuj/exercises/exercise2/Exercise2.md +++ /dev/null @@ -1,25 +0,0 @@ -# Definition - -In this exercise, we will go thourgh a pipeline defined for the -[Hipster Shop](https://github.com/GoogleCloudPlatform/microservices-demo) - -Hipster Shop, contains a 10-tier microservices application. The application is a -web-based e-commerce app called “Hipster Shop” where users can browse items, add -them to the cart, and purchase them. - -For this exercise, you do not need to know the specifics of each service. We -will be concentrating on 3 of the 10 microservices in this exercise. - -1. Product Catalog Service -2. Checkout Service -3. Frontend Service - -Please go through the following configuration files in order. - -1. [Tasks](./build-push-task.yaml) Contains the definitions of tasks used in the - pipeline. -2. [Resources](./resources.yaml) Defines resources used in the pipeline. -3. [Pipeline](./hipster-pipeline.yaml) Pipeline defination. -4. [PipelineRun](./hipster-pipeline-run.yaml) Runs the pipeline. - -Can you explain what does the above pipeline do? diff --git a/docs/cuj/exercises/exercise2/build-push-task.yaml b/docs/cuj/exercises/exercise2/build-push-task.yaml deleted file mode 100644 index 8558b859710..00000000000 --- a/docs/cuj/exercises/exercise2/build-push-task.yaml +++ /dev/null @@ -1,24 +0,0 @@ -apiVersion: pipeline.knative.dev/v1alpha1 -kind: Task -metadata: - name: build-push - namespace: default -spec: - inputs: - resources: - - name: workspace - type: git - params: - - name: pathToDockerFile - outputs: - resources: - - name: builtImage - type: image - steps: - - name: build-and-push - image: gcr.io/kaniko-project/executor - command: - - /kaniko/executor - args: - - --dockerfile=${inputs.params.pathToDockerFile} - - --destination=${outputs.resources.builtImage} diff --git a/docs/cuj/exercises/exercise2/hipster-pipeline-run.yaml b/docs/cuj/exercises/exercise2/hipster-pipeline-run.yaml deleted file mode 100644 index ddf6a266632..00000000000 --- a/docs/cuj/exercises/exercise2/hipster-pipeline-run.yaml +++ /dev/null @@ -1,45 +0,0 @@ -apiVersion: pipeline.knative.dev/v1alpha1 -kind: PipelineRun -metadata: - name: microservices-pipeline-run - namespace: default -spec: - pipelineRef: - name: microservices-pipeline - resources: - - name: build-productcatalog - inputs: - - name: workspace - resourceRef: - name: hipster-git-source - outputs: - - name: builtImage - resourceRef: - name: productcatalogservice-image - - name: build-checkoutservice - inputs: - - name: workspace - resourceRef: - name: hipster-git-source - outputs: - - name: builtImage - resourceRef: - name: checkoutservice-image - - name: build-frontend - inputs: - - name: workspace - resourceRef: - name: hipster-git-source - outputs: - - name: builtImage - resourceRef: - name: frontend-image - - name: deploy-all - inputs: - - name: workspace - resourceRef: - name: hipster-git-source - providedBy: - - build-checkoutservice - - build-productcatalog - - build-frontend \ No newline at end of file diff --git a/docs/cuj/exercises/exercise2/hipster-pipeline.yaml b/docs/cuj/exercises/exercise2/hipster-pipeline.yaml deleted file mode 100644 index eb80d52ad7e..00000000000 --- a/docs/cuj/exercises/exercise2/hipster-pipeline.yaml +++ /dev/null @@ -1,37 +0,0 @@ -apiVersion: pipeline.knative.dev/v1alpha1 -kind: Pipeline -metadata: - name: microservices-pipeline - namespace: default -spec: - tasks: - - name: build-productcatalog - taskRef: - name: build-push - params: - - name: pathToDockerfile - value: src/productcatalogservice/Dockerfile - - name: build-checkoutservice - taskRef: - name: build-push - params: - - name: pathToDockerfile - value: src/checkoutservice/Dockerfile - - name: build-frontend - taskRef: - name: build-push - params: - - name: pathToDockerfile - value: src/frontend/Dockerfile - - name: deploy-all - taskRef: - name: deploy-with-kubectl - inputs: - - name: workspace - providedBy: - - build-checkoutservice - - build-productcatalog - - build-frontend - params: - - name: pathToFiles - value: kubernetes-manifests \ No newline at end of file diff --git a/docs/cuj/exercises/exercise2/resources.yaml b/docs/cuj/exercises/exercise2/resources.yaml deleted file mode 100644 index fee99a621c3..00000000000 --- a/docs/cuj/exercises/exercise2/resources.yaml +++ /dev/null @@ -1,45 +0,0 @@ -apiVersion: pipeline.knative.dev/v1alpha1 -kind: Resource -metadata: - name: hipster-git-source - namespace: default -spec: - type: git - params: - - name: url - value: https://github.com/tejal29/microservices-demo - - name: revision - value: master ---- -apiVersion: pipeline.knative.dev/v1alpha1 -kind: Resource -metadata: - name: frontend-image - namespace: default -spec: - type: image - params: - - name: url - value: gcr.io/pipeline-crd-demo/frontend ---- -apiVersion: pipeline.knative.dev/v1alpha1 -kind: Resource -metadata: - name: checkoutservice-image - namespace: default -spec: - type: image - params: - - name: url - value: gcr.io/pipeline-crd-demo/checkoutservice ---- -apiVersion: pipeline.knative.dev/v1alpha1 -kind: Resource -metadata: - name: productcatalogservice-image - namespace: default -spec: - type: image - params: - - name: url - value: gcr.io/pipeline-crd-demo/productcatalogservice \ No newline at end of file diff --git a/docs/cuj/exercises/exercise3/Exercise3.md b/docs/cuj/exercises/exercise3/Exercise3.md deleted file mode 100644 index d33481ea2a2..00000000000 --- a/docs/cuj/exercises/exercise3/Exercise3.md +++ /dev/null @@ -1,16 +0,0 @@ -# Definition - -In this exercise, we will define a task which executes `go test` to test your go -code. This task will run `go test` command for your go project. - -You can use the go runtime image `gcr.io/google_appengine/golang` - -The command used to run all tests inside inside this container image for your -code is: - -```shell -docker run -i gcr.io/google_appengine/golang go test -``` - -You can review the documentation for [`Task`](./../../../Concepts.md#task) An -example `Task` definition is [here](./../exercise2/build-push-task.yaml) diff --git a/docs/cuj/exercises/exercise4/Excercise4.md b/docs/cuj/exercises/exercise4/Excercise4.md deleted file mode 100644 index ae366f1eeb7..00000000000 --- a/docs/cuj/exercises/exercise4/Excercise4.md +++ /dev/null @@ -1,20 +0,0 @@ -# Definition - -_Continue only if you have spend less than 45 mins for first 3 exercises or -unless User is willing to spend extra time_ - -In this exercise, we will define a pipeline for -[checkout service](https://github.com/GoogleCloudPlatform/microservices-demo/tree/master/src/checkoutservice) - -This pipeline will consists of 3 tasks - -1. Run unit tests for - [checkoutout service](https://github.com/GoogleCloudPlatform/microservices-demo/tree/master/src/checkoutservice). - You can run those by running: - -```shell -go test github.com/GoogleCloudPlatform/microservices-demo/src/checkoutservice/... -``` - -2. Build the checkout service and finally -3. Deploys the checkout service in test cluster