diff --git a/argo/workflow/README.md b/argo/workflow/README.md index 3732f2b..2cee0e9 100644 --- a/argo/workflow/README.md +++ b/argo/workflow/README.md @@ -1,13 +1,14 @@ # Configuration of Argo Workflow entities -## Prerequisites: +## Prerequisites + - Minikube - `kubectl` command-line tool installed and configured to connect to your Kubernetes cluster. -- Helm version 3.x installed. +- Helm version `3.x` installed. -## Preparation steps: +## Preparation steps -### 1. Start minikube and install Argo Workflows using Helm: +### 1. Start Minikube and install Argo Workflows using Helm ```bash minikube start @@ -17,7 +18,7 @@ helm install argo-workflows argo/argo-workflows This command installs Argo Workflows in the default namespace of your Kubernetes cluster. -### 2. Verify the Installation: +### 2. Verify the Installation To check if the installation was successful, you can run: @@ -27,11 +28,11 @@ kubectl get pods -n argo You should see a list of pods running with names prefixed with `workflow-controller` and `argo-server`. -### 3. Patch argo-server authentication¶ +### 3. Patch argo-server authentication As reported on the official documentation: https://argo-workflows.readthedocs.io/en/latest/quick-start/#patch-argo-server-authentication -The argo-server (and thus the UI) defaults to client authentication, which requires clients to provide their Kubernetes bearer token to authenticate. For more information, refer to the Argo Server Auth Mode documentation. We will switch the authentication mode to server so that we can bypass the UI login for now: +The argo-server (and thus the UI) defaults to client authentication, which requires clients to provide their Kubernetes bearer token to authenticate. For more information, refer to the Argo Server Auth Mode documentation. We will switch the authentication mode to `server` so that we can bypass the UI login for now: ```bash kubectl patch deployment \ @@ -44,7 +45,7 @@ kubectl patch deployment \ ]}]' ``` -### 4. Access Argo Workflows UI (Optional): +### 4. Access Argo Workflows UI (Optional) Argo Workflows provides a web-based UI for managing and monitoring workflows. To access the UI, you need to expose it as a service: @@ -58,7 +59,7 @@ Now you can access the Argo Workflows UI by navigating to `http://localhost:2746 > Add this privileges to the Argo service accounts are recommended only for demo purposes. **IT'S STRONGLY NOT RECOMMENDED TO REPLICATE THIS CONFIGURATION IN PRODUCTION EVINRONMENTS.** -This command adds `cluster-admin` clusterrole to `argo:argo-server` and `argo:default`. In this way Argo Workflow can managed every kind of resources in every namespaces of the cluster. +This command adds `cluster-admin` clusterrole to `argo:argo-server` and `argo:default`. In this way, Argo Workflow can manage every kind of resource in every namespace of the cluster. ```bash kubectl create clusterrolebinding argo-admin-server --clusterrole=cluster-admin --serviceaccount=argo:argo-server -n argo @@ -68,13 +69,13 @@ kubectl create clusterrolebinding argo-admin-default --clusterrole=cluster-admin ### 6. Prepare secrets required by the pipelines -Just in case of private Git repository you can run this command to allow the clone command executed by the pipeline `ci.yaml`: +Just in case of a private Git repository you can run this command to allow the clone command executed by the pipeline `ci.yaml`: ```bash kubectl create secret generic github-token -n argo --from-literal=token=......... ``` -This command create the secret that contains the credentials to push the Docker image to the registry: +This command creates the secret that contains the credentials to push the Docker image to the registry: ```bash export DOCKER_USERNAME=****** @@ -92,7 +93,8 @@ kubectl apply -f ci.yaml kubectl apply -f lang/go.yaml kubectl apply -f cd.yaml ``` -## Execution steps: + +## Execution steps With all prerequisites met and Argo Workflows successfully deployed and configured, you dive into the execution steps to start creating and managing workflows. @@ -104,7 +106,7 @@ To submit the CI pipeline, you can use the [official APIs](https://argo-workflow /api/v1/workflows/{namespace}/submit ``` -Or, alternatively, you can submit the workflow using the UI: +Alternatively, you can submit the workflow using the UI: ![Submit CI workflow via UI](images/1_ci_submit.png) @@ -114,11 +116,11 @@ The CI pipeline performs these steps: 2. **Building Application**: Utilizes the GoLang template to compile the Go application. 3. **Building and Pushing Docker Image**: Packages the application into a Docker image and pushes it to the registry. -After the completion of all steps you can check the correct status of every step: +After the completion of all steps, you can check the correct status of every step: ![CI workflow graph](images/2_ci_graph.png) -If all steps have been successfully completed, you can find a new version of the Docker image in your registry. +If all steps have been completed, you can find a new version of the Docker image in your registry. ### 9. Submit the CD pipeline @@ -137,15 +139,15 @@ The CD pipeline performs these steps: 1. **Preparing an ephemeral environment**: Prepares an ephemeral environment using vCluster where the user can test the application inside an isolated Kubernetes cluster 2. **Deploy the application**: Deploy the application Helm chart on the vCluster just created -After the completion of all steps you can check the correct status of every step: +After the completion of all steps, you can check the correct status of every step: ![CD workflow graph](images/4_cd_graph.png) -If all steps have been successfully completed, you can check the status of your application deployed on the vCluster just created +If all steps have been completed, you can check the status of your application deployed on the vCluster just created ### 10. Access to the application -To check how to access to the application deployed on vCluster, you can run this commands to list all vCluster and to access it: +To check how to access the application deployed on vCluster, you can run these commands to list all vCluster and to access it: ```bash $ vcluster list @@ -160,7 +162,7 @@ NAME READY STATUS RESTARTS AGE demo-pr-request-hello-world-7f6d78645f-bjmjc 1/1 Running 0 7s ``` -As reported [here](https://www.vcluster.com/docs/using-vclusters/access) you can expose in different way the ephemeral vCluster created. +As reported [here](https://www.vcluster.com/docs/using-vclusters/access) you can expose in different ways the ephemeral vCluster created. - **Via Ingress**: An Ingress Controller with SSL passthrough support will provide the best user experience, but there is a workaround if this feature is not natively supported. @@ -169,9 +171,9 @@ As reported [here](https://www.vcluster.com/docs/using-vclusters/access) you can - Emissary Make sure your ingress controller is installed and healthy on the cluster that will host your virtual clusters. More details [here](https://www.vcluster.com/docs/using-vclusters/access#via-ingress) -- **Via LoadBalancer service**: The easiest way is to use the flag `--expose` in vcluster create to tell vCluster to use a LoadBalancer service. It depens on the specific implementation of host kubernetes cluster. -- **Via NodePort service**: You can also expose the vCluster via a NodePort service. In this case you have to create a NodePort service and change the `values.yaml` file to use for creation of the vCluster. More details [here](https://www.vcluster.com/docs/using-vclusters/access#via-nodeport-service) -- **From Host Cluster**: In order to access the virtual cluster from within the host cluster, you can directly connect to the vCluster service. Make sure you can access that service and then create a kube config in the following form: +- **Via LoadBalancer service**: The easiest way is to use the flag `--expose` in vcluster create to tell vCluster to use a LoadBalancer service. It depends on the specific implementation of the host Kubernetes cluster. +- **Via NodePort service**: You can also expose the vCluster via a NodePort service. In this case, you have to create a NodePort service and change the `values.yaml` file to use for the creation of the vCluster. More details [here](https://www.vcluster.com/docs/using-vclusters/access#via-nodeport-service) +- **From Host **Cluster**: To access the virtual cluster from within the host cluster, you can directly connect to the vCluster service. Make sure you can access that service and then create a kube config in the following form: ```bash vcluster connect my-vcluster -n my-vcluster --server=my-vcluster.my-vcluster --insecure --update-current=false diff --git a/argo/workflow/images/1_ci_submit.png b/argo/workflow/images/1_ci_submit.png index 533a456..c841f46 100644 Binary files a/argo/workflow/images/1_ci_submit.png and b/argo/workflow/images/1_ci_submit.png differ diff --git a/argo/workflow/images/2_ci_graph.png b/argo/workflow/images/2_ci_graph.png index 323804f..ad5ac85 100644 Binary files a/argo/workflow/images/2_ci_graph.png and b/argo/workflow/images/2_ci_graph.png differ diff --git a/argo/workflow/images/3_cd_submit.png b/argo/workflow/images/3_cd_submit.png index 2793c7b..00e731e 100644 Binary files a/argo/workflow/images/3_cd_submit.png and b/argo/workflow/images/3_cd_submit.png differ diff --git a/argo/workflow/images/4_cd_graph.png b/argo/workflow/images/4_cd_graph.png index 052c341..00b72fe 100644 Binary files a/argo/workflow/images/4_cd_graph.png and b/argo/workflow/images/4_cd_graph.png differ