Skip to content

Commit cd8d0be

Browse files
authored
Added basic argo workflow docs and myhub troubleshooting methods (#151)
Signed-off-by: Amit Kumar Das <[email protected]>
1 parent 011aee4 commit cd8d0be

File tree

4 files changed

+49
-1
lines changed

4 files changed

+49
-1
lines changed
181 KB
Loading

website/docs/troubleshooting.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,40 @@ If your problem persists, then delete all the cluster role bindings, PV and PVC
5959
You need to Provide the correct socket path. By default in Portal `CONTAINER_RUNTIME` is set to `docker`,
6060
If Your container runtime is `containerd` then you have to change the `CONTAINER_RUNTIME` to `containerd` and `SOCKET_PATH` to `/var/run/containerd/containerd.sock`.
6161
You can find these in tune experiments part of the tune workflow page.
62+
63+
### We have installed ChaosCenter successfully but the Litmus ChaosHub is in error state and manual cloning of a Git repository does not work.
64+
It is most probably a network issue. Currently the ChaosHub feature is not supported in airgapped environment since it requires cloning of a remote git repository. Make sure you have an active internet connection to clone the git repository. If the issue still persists, you can manually add the git repository in the server pod. Here are the steps for the same:
65+
66+
- Step 1: Exec inside the litmus-portal server pod and graphql-server container
67+
68+
```
69+
kubectl exec -i -t <litmusportal-server> -n litmus --container graphql-server -- sh
70+
```
71+
72+
Check if the Chaos Charts directory is available. The directory structure is like
73+
```
74+
/tmp/version/<project_id>/<hub_name>
75+
```
76+
77+
Create these directories if not present inside /tmp/version/ :
78+
```
79+
mkdir <project_id>
80+
cd <project_id>
81+
mkdir <hub_name>
82+
```
83+
84+
- Step 2: Clone the Chaos-Charts/Hub repository locally
85+
86+
- Step 3: Use this command to copy the hub directory from your local system to the litmus-portal server pod
87+
88+
```
89+
kubectl cp <location to chaos-chart/hub directory> <namespace>/<litmusportal-server-pod-name>:</tmp/version/<project_id>/<hub_name> -c graphql-server
90+
```
91+
92+
93+
Example:
94+
```
95+
kubectl cp /home/amitkrdas/Chaos-Charts/chaos-charts/ litmus/litmusportal-server-6df9c5895d-57xx7:/tmp/version/686c1da2-da9c-4029-9c6a-528a9455a3b3/"Litmus ChaosHub" -c graphql-server
96+
```
97+
98+
- Step 4: Once the chaos charts directory is copied, refresh the ChaosHub page in ChaosCenter.

website/docs/user-guides/observe-workflow.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ The graph consists of useful information such as :
4242
- Total time taken for the nodes to execute.
4343
- Structure of the experiments (Serial or Parallel experiments).
4444

45+
You can also visualize the non Chaos workflows. The logs of individual nodes are also available here.
46+
47+
<figure>
48+
<img src={require('../assets/argo-chaos-workflow.png').default} alt="Workflow run graph of a non chaos workflow" />
49+
<i>Graph of a non Chaos Workflow</i>
50+
</figure>
51+
4552
## View logs of individual nodes
4653

4754
you can click on the nodes to get the logs of that particular step. If the revert-chaos step is disabled, the complete logs are available which include the runner pod logs and the chaos logs.

website/docs/user-guides/schedule-workflow.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@ In this step, you can create a workflow from different methods, these include:
5050

5151
- **Create a new workflow using experiments from MyHub** : With this option, you can create customized workflows from the one of your connected ChaosHubs. With this option you can add multiple experiments from that ChaosHub either serially or in parallel to construct your workflow graphically.
5252

53-
- **Import workflow using YAML** : With this option, you can import a [hand-crafted/constructed chaos workflow](construct-workflow.md) manifest and tune it according to the use-case.
53+
- **Import workflow using YAML** : With this option, you can import a [hand-crafted/constructed chaos workflow](construct-workflow.md) manifest and tune it according to the use-case. You can also import a basic Argo workflow using this functionality.
54+
:::note
55+
For an uploaded workflow, the tune workflow functionality will not be available. The uploaded workflow is completely user-dependent or user-specific.
56+
57+
5458

5559
## 3. Workflow Settings
5660

0 commit comments

Comments
 (0)