This walkthrough uses Argo Workflows 2.x. The Ingress example uses the API available at the time. Kubernetes removed that API in 1.22. For newer clusters, see the Ingress migration guide.

The Argo Server is a server that exposes an API and UI for workflows. You’ll need to use this if you want to offload large workflows or the workflow archive.

You can run this in either “hosted” or “local” mode.

It replaces the Argo UI.

Hosted Mode#

Use this mode if:

  • You want a drop-in replacement for the Argo UI.
  • If you need to prevent users from directly accessing the database.

Hosted mode is provided as part of the standard manifests, specifically in argo-server-deployment.yaml .

Local Mode#

Use this mode if:

  • You want something that does not require complex set-up.
  • You do not need to run a database.

This is the most common use case for development especially#

To run locally:

text
argo server

This will start a server on port 2746 which you can view at http://localhost:2746.

Options#

Auth Mode#

See auth.

Managed Namespace#

See managed namespace.

Base href#

If the server is running behind reverse proxy with a subpath different from / (for example, /argo), you can set an alternative subpath with the --base-href flag or the BASE_HREF environment variable.

You probably now should read how to set-up an ingress

Transport Layer Security#

See TLS.

SSO#

See SSO.

Access the Argo Workflows UI#

By default, the Argo UI service is not exposed with an external IP. To access the UI, use one of the following:

kubectl port-forward#

shell
kubectl -n argo port-forward svc/argo-server 2746:2746

Then visit: http://127.0.0.1:2746

Expose a LoadBalancer#

Update the service to be of type LoadBalancer.

shell
kubectl patch svc argo-server -n argo -p '{"spec": {"type": "LoadBalancer"}}'

Then wait for the external IP to be made available:

shell
kubectl get svc argo-server -n argo
console
NAME          TYPE           CLUSTER-IP     EXTERNAL-IP   PORT(S)          AGE
argo-server   LoadBalancer   10.43.43.130   172.18.0.2    2746:30008/TCP   18h

Ingress#

You can get ingress working as follows:

Update service/argo-server spec with type: LoadBalancer:

yaml
spec:
  ports:
    - name: web
      port: 2746
      targetPort: 2746
  type: LoadBalancer

Add BASE_HREF as environment variable to deployment/argo-server :

yaml
- name: argo-server
  image: argoproj/argocli:latest
  args: [server]
  env:
    - name: BASE_HREF
      value: /argo/

Create a ingress, with the annotation ingress.kubernetes.io/rewrite-target: /:

yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: argo-server
  annotations:
    ingress.kubernetes.io/rewrite-target: /
spec:
  rules:
    - http:
        paths:
          - backend:
              serviceName: argo-server
              servicePort: 2746
            path: /argo

Learn more