From a781888cc4388947b53582683a5bfe3ba6fad208 Mon Sep 17 00:00:00 2001 From: Shri Javadekar Date: Thu, 28 Jun 2018 10:15:26 -0700 Subject: [PATCH] Update docs/quickstart.md with more thorough instructions. (#39) * Update docs/quickstart.md with more thorough instructions. Closes #37. * Update helm command to install with specific name. --- docs/quickstart.md | 63 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 60 insertions(+), 3 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index f3431f204e19..dc42b2a27660 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -40,8 +40,65 @@ Note: This process is manual right now, but we're working on providing a Helm ch kubectl create -f hack/k8s/manifests/* ``` -## 7. Creating a sensor -See the `examples/` directory for a list of sample `Sensors`. Once the `sensor-controller` is deployed, creating a sensor is easy as: +## 7. Install minio + +``` +$ helm init +... +$ helm install stable/minio --name artifacts +... + +$ #Verify that the minio pod, the minio service and minio secret are present +$ kubectl get all -n default -l app=minio + +NAME READY STATUS RESTARTS AGE +pod/artifacts-minio-85547b6bd9-bhtt8 1/1 Running 0 21m + +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +service/artifacts-minio ClusterIP None 9000/TCP 21m + +NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE +deployment.apps/artifacts-minio 1 1 1 1 21m + +NAME DESIRED CURRENT READY AGE +replicaset.apps/artifacts-minio-85547b6bd9 1 1 1 21m +``` + +## 8. Create a bucket in Minio and upload the hello-world.yaml into that bucket. +Download the hello-world.yaml from https://raw.githubusercontent.com/argoproj/argo/master/examples/hello-world.yaml +``` +$ kubectl port-forward `kubectl get pod -l app=minio -o name` 9000:9000 +``` +Open the browser at http://localhost:9000 +Create a new bucket called 'workflows'. +Upload the hello-world.yaml into that bucket + +## 9. Install Argo +Follow instructions from https://github.com/argoproj/argo/blob/master/demo.md + +## 10. Create an example sensor ``` -kubectl create -f examples/calendar-sensor.yaml +$ kubectl create -f examples/calendar-sensor.yaml ``` + +Verify that the sensor was created. +``` +$ kubectl get sensors -n default +``` + +Verify that the job associated with this sensor was run +``` +$ kubectl get jobs -n default +``` + +Verify that the Argo workflow was run when the trigger was executed. +``` +$ argo list +``` + +Verify that the sensor was updated correctly +``` +$ kubectl get sensors cal-example -n default -o yaml +``` + +Check the logs of the sensor-controller pod if there are problems. \ No newline at end of file