v2.5 and after
Since version v2.5 Argo Workflows ships with a server that provide more features and security than before.
The server can be configured with or without client auth (server --auth-mode client). When it is disabled, then clients must pass their Kubeconfig base 64 encoded in the HTTP Authorization header:
ARGO_TOKEN=$(argo auth token)
curl -H "Authorization: $ARGO_TOKEN" http://localhost:2746/api/v1/workflows/argo
Learn more on how to generate an access token.
To view the API:
- Open https://editor.swagger.io/
- Copy and paste
../api/openapi-spec/swagger.json
v2.4 and before
Argo is implemented as a kubernetes controller and Workflow Custom Resource.
Argo itself does not run an API server, and with all CRDs, it extends the Kubernetes API server by
introducing a new API Group/Version (argoproj.io/v1alpha1) and Kind (Workflow). When CRDs are
registered in a cluster, access to those resources are made available by exposing new endpoints in
the kubernetes API server. For example, to list workflows in the default namespace, a client would
make an HTTP GET request to: https://<k8s-api-server>/apis/argoproj.io/v1alpha1/namespaces/default/workflows
NOTE: the optional argo-ui does run a thin API layer to power the UI, but is not intended for programatic interaction.
A common scenario is to programatically submit and retrieve workflows. To do this, you would use the existing Kubernetes REST client in the language of preference, which often libraries for performing CRUD operation on custom resource objects.
A kubernetes Workflow clientset library is auto-generated under argoproj/argo/pkg/client and can be imported by golang applications. See the golang code example on how to make use of this client.
The python kubernetes client has libraries for interacting with custom objects. See: https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/CustomObjectsApi.md
The Java kubernetes client has libraries for interacting with custom objects. See: https://github.com/kubernetes-client/java/blob/master/kubernetes/docs/CustomObjectsApi.md
The Ruby kubernetes client has libraries for interacting with custom objects. See: https://github.com/kubernetes-client/ruby/tree/master/kubernetes See this external Ruby example on how to make use of this client.
An OpenAPI Spec is generated under argoproj/argo/api/openapi-spec. This spec may be used to auto-generate concrete datastructures in other languages.