Skip to content

Commit

Permalink
Fix PR comments: Improve FAQ details for instanceID label #290
Browse files Browse the repository at this point in the history
Signed-off-by: Thiha Min Thant <[email protected]>
  • Loading branch information
thiha-min-thant committed Oct 2, 2024
1 parent 3f1d3e6 commit c165f0e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions website/versioned_docs/version-3.10.0/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<project-id>/<chaos-experiment-name>.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
Expand All @@ -90,9 +90,9 @@ The `instanceID` value can be found in the `workflow-controller-configmap`. Here
kubectl get configmap workflow-controller-configmap -n <namespace> -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit c165f0e

Please sign in to comment.