Merge pull request #24 from ajeshbaby/aj-dev
[chore] Prerequisite Addition
This commit is contained in:
commit
80d061e763
|
|
@ -0,0 +1,34 @@
|
||||||
|
---
|
||||||
|
id: getstarted
|
||||||
|
title: Getting Started with Litmus
|
||||||
|
sidebar_label: Pre-requisites
|
||||||
|
---
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Pre-requisites
|
||||||
|
|
||||||
|
- Kubernetes 1.15 or later.
|
||||||
|
|
||||||
|
- Persistent volume of 20GB
|
||||||
|
|
||||||
|
Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purpose as well. This PV is used as a persistent storage to store the chaos config and chaos-metrics in the Portal. By default litmus install would use the default storage class to allocate the PV. Provide this value
|
||||||
|
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Running chaos on your application involves the following steps:
|
||||||
|
|
||||||
|
[Install Litmus](litmus-install)
|
||||||
|
|
||||||
|
[How to Create a Workflow](create)
|
||||||
|
|
||||||
|
[Run Chaos](observe)
|
||||||
|
|
||||||
|
[Observe ChaosResults](observe)
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
## Join our community
|
||||||
|
|
||||||
|
If you have not joined our community, do join us [here](https://app.slack.com/client/T09NY5SBT/CNXNB0ZTN).
|
||||||
|
|
@ -6,7 +6,6 @@ sidebar_label: Litmus
|
||||||
|
|
||||||
---
|
---
|
||||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/rOrKegj5ePI" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
<iframe width="560" height="315" src="https://www.youtube.com/embed/rOrKegj5ePI" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||||
|
|
||||||
### Pre-requisites
|
### Pre-requisites
|
||||||
|
|
||||||
- Kubernetes 1.15 or later.
|
- Kubernetes 1.15 or later.
|
||||||
|
|
@ -28,7 +27,8 @@ kubectl create ns litmus
|
||||||
To get started you need to clone the **litmuschaos** helm repo
|
To get started you need to clone the **litmuschaos** helm repo
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://litmuschaos.github.io/litmus-helm/
|
git clone https://github.com/litmuschaos/litmus-helm
|
||||||
|
cd litmus-helm
|
||||||
```
|
```
|
||||||
|
|
||||||
### **Install Litmus**
|
### **Install Litmus**
|
||||||
|
|
@ -36,7 +36,7 @@ git clone https://litmuschaos.github.io/litmus-helm/
|
||||||
The helm chart will install all the CRDs, required service account configuration, and chaos-operator required both for the core services as well as the portal to run.
|
The helm chart will install all the CRDs, required service account configuration, and chaos-operator required both for the core services as well as the portal to run.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm install chaos litmuschaos/litmus-2-0-0-beta --namespace litmus
|
helm install litmuschaos --namespace litmus ./charts/litmus-2-0-0-beta/
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style={{color: 'green'}}><b>Expected Output</b></span>
|
<span style={{color: 'green'}}><b>Expected Output</b></span>
|
||||||
|
|
@ -49,7 +49,7 @@ STATUS: deployed
|
||||||
REVISION: 1
|
REVISION: 1
|
||||||
TEST SUITE: None
|
TEST SUITE: None
|
||||||
NOTES:
|
NOTES:
|
||||||
Thank you for installing litmus-portal 😀
|
Thank you for installing litmus-2-0-0-beta 😀
|
||||||
|
|
||||||
Your release is named chaos and its installed to namespace: litmus.
|
Your release is named chaos and its installed to namespace: litmus.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,7 @@ module.exports = {
|
||||||
// "feature-definition"
|
// "feature-definition"
|
||||||
],
|
],
|
||||||
"Getting Started": [
|
"Getting Started": [
|
||||||
|
"getstarted",
|
||||||
{
|
{
|
||||||
Installation: ["litmus-install", "agent-install"],
|
Installation: ["litmus-install", "agent-install"],
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
---
|
||||||
|
id: getstarted
|
||||||
|
title: Getting Started with Litmus
|
||||||
|
sidebar_label: Pre-requisites
|
||||||
|
---
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Pre-requisites
|
||||||
|
|
||||||
|
- Kubernetes 1.15 or later.
|
||||||
|
|
||||||
|
- Persistent volume of 20GB
|
||||||
|
|
||||||
|
Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purpose as well. This PV is used as a persistent storage to store the chaos config and chaos-metrics in the Portal. By default litmus install would use the default storage class to allocate the PV. Provide this value
|
||||||
|
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Running chaos on your application involves the following steps:
|
||||||
|
|
||||||
|
[Install Litmus](litmus-install)
|
||||||
|
|
||||||
|
[How to Create a Workflow](create)
|
||||||
|
|
||||||
|
[Run Chaos](observe)
|
||||||
|
|
||||||
|
[Observe ChaosResults](observe)
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
## Join our community
|
||||||
|
|
||||||
|
If you have not joined our community, do join us [here](https://app.slack.com/client/T09NY5SBT/CNXNB0ZTN).
|
||||||
|
|
@ -28,7 +28,8 @@ kubectl create ns litmus
|
||||||
To get started you need to clone the **litmuschaos** helm repo
|
To get started you need to clone the **litmuschaos** helm repo
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://litmuschaos.github.io/litmus-helm/
|
git clone https://github.com/litmuschaos/litmus-helm
|
||||||
|
cd litmus-helm
|
||||||
```
|
```
|
||||||
|
|
||||||
### **Install Litmus**
|
### **Install Litmus**
|
||||||
|
|
@ -36,7 +37,7 @@ git clone https://litmuschaos.github.io/litmus-helm/
|
||||||
The helm chart will install all the CRDs, required service account configuration, and chaos-operator required both for the core services as well as the portal to run.
|
The helm chart will install all the CRDs, required service account configuration, and chaos-operator required both for the core services as well as the portal to run.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm install chaos litmuschaos/litmus-2-0-0-beta --namespace litmus
|
helm install litmuschaos --namespace litmus ./charts/litmus-2-0-0-beta/
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style={{color: 'green'}}><b>Expected Output</b></span>
|
<span style={{color: 'green'}}><b>Expected Output</b></span>
|
||||||
|
|
@ -49,7 +50,7 @@ STATUS: deployed
|
||||||
REVISION: 1
|
REVISION: 1
|
||||||
TEST SUITE: None
|
TEST SUITE: None
|
||||||
NOTES:
|
NOTES:
|
||||||
Thank you for installing litmus-portal 😀
|
Thank you for installing litmus-2-0-0-beta 😀
|
||||||
|
|
||||||
Your release is named chaos and its installed to namespace: litmus.
|
Your release is named chaos and its installed to namespace: litmus.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,6 +20,10 @@
|
||||||
"type": "category",
|
"type": "category",
|
||||||
"label": "Getting Started",
|
"label": "Getting Started",
|
||||||
"items": [
|
"items": [
|
||||||
|
{
|
||||||
|
"type": "doc",
|
||||||
|
"id": "version-2.0.0-Beta-1/getstarted"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"collapsed": true,
|
"collapsed": true,
|
||||||
"type": "category",
|
"type": "category",
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue