diff --git a/website/docs/getstarted.md b/website/docs/getstarted.md new file mode 100644 index 0000000..f856c5a --- /dev/null +++ b/website/docs/getstarted.md @@ -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) + +
+ +## Join our community + +If you have not joined our community, do join us [here](https://app.slack.com/client/T09NY5SBT/CNXNB0ZTN). diff --git a/website/docs/litmus-installation.md b/website/docs/litmus-installation.md index cc6ab1f..020f629 100644 --- a/website/docs/litmus-installation.md +++ b/website/docs/litmus-installation.md @@ -6,7 +6,6 @@ sidebar_label: Litmus --- - ### Pre-requisites - Kubernetes 1.15 or later. @@ -28,7 +27,8 @@ kubectl create ns litmus To get started you need to clone the **litmuschaos** helm repo ```bash -git clone https://litmuschaos.github.io/litmus-helm/ +git clone https://github.com/litmuschaos/litmus-helm +cd litmus-helm ``` ### **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. ```bash -helm install chaos litmuschaos/litmus-2-0-0-beta --namespace litmus +helm install litmuschaos --namespace litmus ./charts/litmus-2-0-0-beta/ ``` Expected Output @@ -49,7 +49,7 @@ STATUS: deployed REVISION: 1 TEST SUITE: None 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. diff --git a/website/sidebars.js b/website/sidebars.js index 97a5fec..e2e6167 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -6,6 +6,7 @@ module.exports = { // "feature-definition" ], "Getting Started": [ + "getstarted", { Installation: ["litmus-install", "agent-install"], }, diff --git a/website/versioned_docs/version-2.0.0-Beta-1/getstarted.md b/website/versioned_docs/version-2.0.0-Beta-1/getstarted.md new file mode 100644 index 0000000..f856c5a --- /dev/null +++ b/website/versioned_docs/version-2.0.0-Beta-1/getstarted.md @@ -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) + +
+ +## Join our community + +If you have not joined our community, do join us [here](https://app.slack.com/client/T09NY5SBT/CNXNB0ZTN). diff --git a/website/versioned_docs/version-2.0.0-Beta-1/litmus-installation.md b/website/versioned_docs/version-2.0.0-Beta-1/litmus-installation.md index cc6ab1f..8677e86 100644 --- a/website/versioned_docs/version-2.0.0-Beta-1/litmus-installation.md +++ b/website/versioned_docs/version-2.0.0-Beta-1/litmus-installation.md @@ -28,7 +28,8 @@ kubectl create ns litmus To get started you need to clone the **litmuschaos** helm repo ```bash -git clone https://litmuschaos.github.io/litmus-helm/ +git clone https://github.com/litmuschaos/litmus-helm +cd litmus-helm ``` ### **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. ```bash -helm install chaos litmuschaos/litmus-2-0-0-beta --namespace litmus +helm install litmuschaos --namespace litmus ./charts/litmus-2-0-0-beta/ ``` Expected Output @@ -49,7 +50,7 @@ STATUS: deployed REVISION: 1 TEST SUITE: None 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. diff --git a/website/versioned_sidebars/version-2.0.0-Beta-1-sidebars.json b/website/versioned_sidebars/version-2.0.0-Beta-1-sidebars.json index 5a362ac..af3862d 100644 --- a/website/versioned_sidebars/version-2.0.0-Beta-1-sidebars.json +++ b/website/versioned_sidebars/version-2.0.0-Beta-1-sidebars.json @@ -20,6 +20,10 @@ "type": "category", "label": "Getting Started", "items": [ + { + "type": "doc", + "id": "version-2.0.0-Beta-1/getstarted" + }, { "collapsed": true, "type": "category",