-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: local cluster environment with Argo Workflows (#810)
#### Motivation It is useful to be able to deploy a Kubernetes cluster locally to do some tests without having to rely on AWS. #### Modification Document how to install a K8s cluster locally using `kind`. #### Checklist - [ ] Tests updated NA - [x] Docs updated - [ ] Issue linked in Title NA
- Loading branch information
1 parent
9420533
commit 3ac7347
Showing
2 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Local Argo Workflows environment | ||
|
||
It is possible to install Argo Workflows in a K8s cluster on your local machine. In this documentation we will use [`kind`](https://kind.sigs.k8s.io/). | ||
|
||
## Pre-requisite | ||
|
||
- [Docker](https://docs.docker.com/engine/install/) | ||
- [`kind`](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) | ||
- [`kubectl`](https://kubernetes.io/docs/tasks/tools/#kubectl) | ||
- [Argo CLI](https://argo-workflows.readthedocs.io/en/latest/walk-through/argo-cli/#argo-cli) | ||
|
||
## Cluster | ||
|
||
To create a cluster using `kind`: | ||
|
||
```bash | ||
kind create cluster --name argo | ||
``` | ||
|
||
> **_NOTE:_** The [`kind` Node container](https://hub.docker.com/r/kindest/node/tags) version number matches the Kubernetes version (`kindest/node:vX.Y.Z` uses Kubernetes `vX.Y.Z`). To specify a Kubernetes version for your cluster, use `--image kindest/node:vX.Y.Z`. It is a good idea to use the same version as the production environment (`version` in [`LinzEksCluster` Stack](../infra/eks/cluster.ts)). | ||
## Argo Workflows | ||
|
||
Choose and install the Controller and Server of [a release](https://github.com/argoproj/argo-workflows/releases/) that matches the [production version (`appVersion`)](https://github.com/linz/topo-workflows/blob/master/infra/charts/argo.workflows.ts). The installation process should be described in the Argo Workflow Release page, for example for `v3.5.5`: | ||
|
||
```bash | ||
kubectl create namespace argo | ||
kubectl apply -n argo -f https://github.com/argoproj/argo-workflows/releases/download/v3.5.5/install.yaml | ||
kubectl create rolebinding default-admin --clusterrole=admin --serviceaccount=argo:default --namespace=argo | ||
``` | ||
|
||
You should now be able to run a workflow, for example: | ||
|
||
```bash | ||
argo -n argo submit https://raw.githubusercontent.com/argoproj/argo-workflows/refs/heads/main/examples/hello-world.yaml | ||
``` | ||
|
||
## Limitations | ||
|
||
This documentation is only to install a vanilla version of Argo Workflows. The [Kubernetes components](../docs/infrastructure/components) configured for the production environment are not directly applicable to a local/`kind` environment as they require to run `CDK8s` using some information retrieved from AWS. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters