From c303f217fa3a4056f3b2f9cb0c5cb77bd18782a8 Mon Sep 17 00:00:00 2001 From: ajeshbaby Date: Tue, 16 Mar 2021 07:18:10 +0530 Subject: [PATCH] Pre-requisite Addition Signed-off-by: ajeshbaby --- website/docs/getstarted.md | 34 +++++++++++++++++++ website/sidebars.js | 1 + .../version-2.0.0-Beta-1/getstarted.md | 34 +++++++++++++++++++ .../version-2.0.0-Beta-1-sidebars.json | 4 +++ 4 files changed, 73 insertions(+) create mode 100644 website/docs/getstarted.md create mode 100644 website/versioned_docs/version-2.0.0-Beta-1/getstarted.md 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/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_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",