From c165f0ead33e6ddcda51790ef44463827e228599 Mon Sep 17 00:00:00 2001 From: Thiha Min Thant Date: Thu, 3 Oct 2024 01:11:11 +0800 Subject: [PATCH] Fix PR comments: Improve FAQ details for instanceID label #290 Signed-off-by: Thiha Min Thant --- website/versioned_docs/version-3.10.0/faq.md | 10 +++++----- .../version-3.10.0/user-guides/construct-experiment.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/website/versioned_docs/version-3.10.0/faq.md b/website/versioned_docs/version-3.10.0/faq.md index c2246753..8b938e12 100644 --- a/website/versioned_docs/version-3.10.0/faq.md +++ b/website/versioned_docs/version-3.10.0/faq.md @@ -70,11 +70,11 @@ To configure a git repo the user must provide the Git URL of the repository and Once GitOps is enabled, any new chaos experiments created will be stored in the configured repo in the path `litmus//.yaml`. -### Why is my Argo Workflow not being picked up by the Workflow controller? +### Why is my Argo Workflow not being picked up by the Workflow controller upon applying it manually? -If your Argo Workflow is not being picked up by the Workflow controller after applying it, you may be missing the `workflows.argoproj.io/controller-instanceid` label in your Workflow YAML file. This label is required for the Workflow controller to manage the Workflow properly. +If your Argo Workflow is not being picked up by the Workflow controller after applying it, you may be missing the `workflows.argoproj.io/controller-instanceid` label in your Workflow manifest. This label is required for the Workflow controller to reconcile the Workflow upon its creation. -To fix this, ensure the following label is added under metadata.labels in your Workflow YAML: +To fix this, ensure the following label is added under `metadata.labels` field in the Workflow manifest: ```yaml apiVersion: argoproj.io/v1alpha1 @@ -90,9 +90,9 @@ The `instanceID` value can be found in the `workflow-controller-configmap`. Here kubectl get configmap workflow-controller-configmap -n -o yaml ``` -Look for the `instanceID` key in the configmap and use that value in your Workflow YAML. +Look for the `instanceID` key in the configmap and use that value in your Workflow manifest. -Without this label, the Workflow controller will not recognize or manage the Workflow. +Without this label, the Workflow controller will not be able to reconcile the Workflow. ## Litmusctl diff --git a/website/versioned_docs/version-3.10.0/user-guides/construct-experiment.md b/website/versioned_docs/version-3.10.0/user-guides/construct-experiment.md index 328bfab9..071fb2b6 100644 --- a/website/versioned_docs/version-3.10.0/user-guides/construct-experiment.md +++ b/website/versioned_docs/version-3.10.0/user-guides/construct-experiment.md @@ -80,7 +80,7 @@ Here, the template with the name `custom-chaos` will be executed first. ### Ensuring Your Workflow is Recognized by the Argo Workflow Controller -When applying a Workflow manually without ChaosCenter, it's crucial to include the `workflows.argoproj.io/controller-instanceid` label in your YAML file. This label helps the controller identify and manage your Workflow correctly. +When applying a Workflow manually without ChaosCenter, it's crucial to include the `workflows.argoproj.io/controller-instanceid` label in the manifest. This label helps Argo Workflow controller identify and reconcile the Workflow upon its creation. The instanceID value can be found in the `workflow-controller-configmap` under the instanceID key. Once the chaos scenario is constructed, it should look like this: