Skip to content

Latest commit

 

History

History
122 lines (100 loc) · 4.85 KB

demo.md

File metadata and controls

122 lines (100 loc) · 4.85 KB
Raw

Argo v2.0 Getting Started

To see how Argo works, you can run examples of simple workflows and workflows that use artifacts. For the latter, you'll set up an artifact repository for storing the artifacts that are passed in the workflows. Here are the requirements and steps to run the workflows.

Requirements

  • Installed Kubernetes 1.8 or later
  • Installed the kubectl command-line tool
  • Have a kubeconfig file (default location is ~/.kube/config).

1. Download Argo

On Mac:

$ curl -sSL -o /usr/local/bin/argo https://github.com/argoproj/argo/releases/download/v2.0.0-alpha2/argo-darwin-amd64
$ chmod +x /usr/local/bin/argo

On Linux:

$ curl -sSL -o /usr/local/bin/argo https://github.com/argoproj/argo/releases/download/v2.0.0-alpha2/argo-linux-amd64
$ chmod +x /usr/local/bin/argo

2. Install the Controller and UI

$ argo install

Installation command does not configure access for argo UI. Please use following command to create externally accessable Kubernetes service:

$ kubectl create -f https://raw.githubusercontent.com/argoproj/argo/master/ui/deploy/service.yaml --namespace kube-system

Service's external IP can be retrieved using following command:

$ kubectl get services --namespace kube-system

Note: service namespace should correspond to namespace chosen during argo installation (kube-system is default namespace).

Note: If you are installing Argo on Minikube, you won't get an external IP on creating the service above. Instead, it will just show pending. It should look something like below:

argo-ui                LoadBalancer   <redacted-IP>   <pending>     80:31185/TCP    1h

So, to access the Argo UI, you need to hit the IP of the Docker environment and the internal port. For instance, in the above case, it would be 192.168.99.100:31185.

3. Run Simple Example Workflows

$ argo submit https://raw.githubusercontent.com/argoproj/argo/master/examples/hello-world.yaml
$ argo submit https://raw.githubusercontent.com/argoproj/argo/master/examples/coinflip.yaml
$ argo submit https://raw.githubusercontent.com/argoproj/argo/master/examples/loops-maps.yaml
$ argo list
$ argo get xxx-workflow-name-xxx
$ argo logs xxx-pod-name-xxx #from get command above

You can also run workflows directly with kubectl. However, the Argo CLI offers extra features that kubectl does not, such as YAML validation, workflow visualization, and overall less typing.

$ kubectl create -f https://raw.githubusercontent.com/argoproj/argo/master/examples/hello-world.yaml
$ kubectl get wf
$ kubectl get wf hello-world-xxx
$ kubectl get po --selector=workflows.argoproj.io/workflow=hello-world-xxx --show-all
$ kubectl logs hello-world-yyy -c main

Additional examples are availabe here.

4. Install an Artifact Repository

You'll create the artifact repo using Minio.

$ brew install kubernetes-helm #mac. This is not really needed if you already have the kubectl cli installed.
$ helm init
$ helm install stable/minio --name argo-artifacts

Login to Minio using a web browser after obtaining the external IP using kubectl.

$ kubectl get service argo-artifacts-minio-svc

NOTE: When minio is installed via Helm, it uses the following hard-wired default credentials, which you will use to login to the UI:

  • AccessKey: AKIAIOSFODNN7EXAMPLE
  • SecretKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Create a bucket named my-bucket from the Minio UI.

5. Reconfigure the workflow controller to use the Minio artifact repository configured in step 4.

Look at minio created resources:

# kubectl get all -l release=argo-artifacts

Edit the workflow-controller config to reference the service name (argo-artifacts-minio-svc) and secret (argo-artifacts-minio-user) created by the helm install:

$ kubectl edit configmap workflow-controller-configmap -n kube-system
...
    executorImage: argoproj/argoexec:v2.0.0-alpha2
    artifactRepository:
      s3:
        bucket: my-bucket
        endpoint: argo-artifacts-minio-svc.default:9000
        insecure: true
        # accessKeySecret and secretKeySecret are secret selectors.
        # It references the k8s secret named 'argo-artifacts-minio-user'
        # which was created during the minio helm install. The keys,
        # 'accesskey' and 'secretkey', inside that secret are where the
        # actual minio credentials are stored.
        accessKeySecret:
          name: argo-artifacts-minio-user
          key: accesskey
        secretKeySecret:
          name: argo-artifacts-minio-user
          key: secretkey

6. Run a workflow which uses artifacts

$ argo submit https://raw.githubusercontent.com/argoproj/argo/master/examples/artifact-passing.yaml