-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
379de51
commit f631caa
Showing
22 changed files
with
216 additions
and
168 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
id: teaming | ||
title: Collaborate with teams | ||
title: Team Collaboration | ||
sidebar_label: Teaming | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
id: connecting-git-repo | ||
title: Connecting to a Git Repository | ||
sidebar_label: Connecting Git Repo | ||
--- | ||
|
||
## Prerequisites | ||
|
||
The following are the prerequisites for creating a Chaos Experiment: | ||
|
||
- Fork of [Chaos-Charts](https://github.com/litmuschaos/chaos-charts) repository | ||
|
||
:::note | ||
An active internet connection is required to clone the git repository for the first time installation. | ||
::: | ||
|
||
## Connecting to a Git repository using ChaosHub | ||
|
||
With ChaosHub, you can construct chaos experiments by selecting, tuning and sequencing different faults together from their connected ChaosHubs. | ||
|
||
You can make changes in your forked repositories and sync it with the Portal to get the latest changes from the fork. | ||
|
||
By default, a public ChaosHub is provided when the ChaosCenter is installed for the first time. | ||
|
||
<img src={require('../assets/concepts/chaoshub/chaoshub-default.png').default} width="800" /> | ||
|
||
### 1. Connect a public Git repository | ||
|
||
You can connect to a public Git repository by simply providing the following details: | ||
|
||
- Hub name | ||
- Git URL of the forked repository | ||
- Branch name | ||
|
||
<img src={require('../assets/concepts/chaoshub/chaoshub-add-public.png').default} width="800" /> | ||
|
||
### 2. Connect a private Git repository | ||
|
||
To add a private ChaosHub, you need provide the hub name, Git URL of the forked repository and the branch name similar to that of public hub and the repository can be connected in two ways: | ||
|
||
<img src={require('../assets/concepts/chaoshub/chaoshub-add-private.png').default} width="800" /> | ||
|
||
#### a. Access token | ||
|
||
Personal Access Tokens are used as an alternative to the password for authentication to Git services. | ||
|
||
#### b. SSH key | ||
|
||
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. | ||
SSH link of the repository should be provided if you select this method. | ||
|
||
<img src={require('../assets/concepts/chaoshub/chaoshub-after-add.png').default} width="800" /> | ||
|
||
## Syncing a ChaosHub | ||
|
||
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. | ||
|
||
## Editing a ChaosHub | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
id: removing-chaoshub | ||
title: Removing a ChaosHub | ||
sidebar_label: Removing a ChaosHUb | ||
--- | ||
|
||
To remove a ChaosHub from a project, you can select the **Disconnect Hub** option from the ChaosHub card. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
id: viewing-chaos-faults | ||
title: Viewing Chaos Faults | ||
sidebar_label: Viewing Chaos Faults | ||
--- | ||
|
||
### Viewing Chaos Faults | ||
|
||
After connecting a ChaosHub, you can view the different chaos charts and faults. These charts are categorized into different sections such as generic, AWS, Azure, Kube-Components, etc. | ||
|
||
<img src={require('../assets/concepts/chaoshub/chaoshub-chaos-charts.png').default} width="800" /> | ||
|
||
### View the fault details | ||
|
||
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. | ||
|
||
You can also find the Experiment manifest URL, RBAC URL, and the ChaosEngine URLs of the fault. | ||
These URLs are required for the creation of custom chaos experiments. | ||
|
||
<img src={require('../assets/concepts/chaoshub/chaoshub-exp-details.png').default} width="800" /> |
10 changes: 10 additions & 0 deletions
10
website/docs/user-guides/viewing-predefined-experiments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
id: viewing-predefined-experiments | ||
title: Viewing Predefined Chaos Experiments | ||
sidebar_label: Viewing Predefined Experiments | ||
--- | ||
|
||
|
||
After connecting a ChaosHub, you can view the different pre-defined chaos experiments present in the ChaosHub. | ||
|
||
<img src={require('../assets/concepts/chaoshub/chaoshub-predefined-experiments.png').default} width="800" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
id: teaming | ||
title: Collaborate with teams | ||
title: Team Collaboration | ||
sidebar_label: Teaming | ||
--- | ||
|
||
|
Oops, something went wrong.