Skip to content

Commit dc90bdc

Browse files
author
charlotte kefeletswe
committed
Restore chaoshub.md after accidental deletion
1 parent 9dcf0ab commit dc90bdc

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

website/docs/concepts/chaoshub.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
id: chaoshub
3+
title: ChaosHub
4+
sidebar_label: ChaosHub
5+
---
6+
7+
---
8+
9+
A ChaosHub is a collection of experiment templates and faults that you can use to create and launch chaos experiments. Both experiments and faults are stored as manifests in an appropriate directory structure. This way, new experiment templates and faults can be added directly to the repository as files. In addition, the experiment templates can be derived from the existing experiments to be saved in ChaosHub from the web UI.
10+
11+
- ChaosHub is accessed using a Git service provider such as GitHub, where ChaosHub exists as a repository. This allows native version control and management of the faults and experiment artifacts.
12+
13+
- Chaos experiments can be created from the public [ChaosHub](http://hub.litmuschaos.io/) which is already connected to your ChaosCenter, or a custom ChaosHub which is a [fork](https://github.com/litmuschaos/chaos-charts) of the public ChaosHub where custom faults can be stored.
14+
15+
## Prerequisites
16+
17+
The following are the prerequisites for creating a Chaos Experiment:
18+
19+
- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository
20+
21+
:::note
22+
An active internet connection is required to clone the git repository for the first time installation.
23+
:::
24+
25+
## Connecting to a Git repository using ChaosHub
26+
27+
With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs.
28+
29+
You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork.
30+
31+
By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time.
32+
33+
<img src={require('../assets/concepts/chaoshub/chaoshub-default.png').default} width="800" />
34+
35+
### 1. Connect a public and private Git repository
36+
37+
You can connect to a public or private Git repository by simply providing the following details:
38+
39+
- Hub name
40+
- Git URL of the forked repository
41+
- Branch name
42+
43+
<img src={require('../assets/concepts/chaoshub/chaoshub-add-public.png').default} width="800" />
44+
45+
#### a. Access token
46+
47+
Personal Access Tokens are used as an alternative to the password for authentication to Git services.
48+
49+
#### b. SSH key
50+
51+
Just like the Access Token , SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored with you.
52+
SSH link of the repository should be provided if you select this method.
53+
54+
<img src={require('../assets/concepts/chaoshub/chaoshub-after-add.png').default} width="800" />
55+
56+
## Syncing a ChaosHub
57+
58+
If some changes are made into the Git repository, you can reflect these changes in the hub by selecting the **Refresh Hub** option from the ChaosHub card.
59+
60+
## Editing a ChaosHub
61+
62+
To make changes in a hub like changing the name, branch, access token etc, you can select the **Edit Hub** option from the ChaosHub card.
63+
64+
## Chaos experiments and experiments in a ChaosHub
65+
66+
### 1. View the PreDefined Chaos Experiments
67+
68+
After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub.
69+
70+
<img src={require('../assets/concepts/chaoshub/chaoshub-predefined-experiments.png').default} width="800" />
71+
72+
### 2. View the Chaos Faults
73+
74+
Similarly, you can view the different charts and the fault. These charts are sorted according to different categories like generic, AWS, Azure, Kube-Components etc.
75+
76+
<img src={require('../assets/concepts/chaoshub/chaoshub-chaos-charts.png').default} width="800" />
77+
78+
### 3. View the fault details
79+
80+
You can select one of the chaos faults and can examine the fault details. The fault page consists of all the important details like the description of the fault, a tutorial video, the maintainer of the fault, etc.
81+
82+
You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault.
83+
These URLs are required for the creation of custom chaos experiments.
84+
85+
<img src={require('../assets/concepts/chaoshub/chaoshub-exp-details.png').default} width="800" />
86+
87+
## Disconnect a ChaosHub
88+
89+
To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card.
90+
91+
## Summary
92+
93+
You can select one of the chaos faults and can examine the fault details.The fault page consists of all the important details like the description of the fault, a tutorial video, the maintainer of the fault, etc.
94+
You can also find the Experiment URL URL, RBAC URL, and the ChaosEngine yaml URL of the fault.
95+
These yaml URLs are required for the creation of Custom Chaos Experiments.
96+
97+
## Learn More
98+
99+
- [What is a Chaos Experiment](chaos-workflow.md)

0 commit comments

Comments
 (0)