+ 
+ 
+ **Password:** Enter your LitmusPortal password. ```bash @@ -144,7 +136,6 @@ Next, select the installation mode. In case the selected mode was a Cluster ther Next, enter the details of the new agent. -Fields to filled in: **Agent Name:** Enter the name for the new agent. **Agent Description:** Fill in details about the agent. diff --git a/website/docs/litmus-installation-namespace.md b/website/docs/getting-started-namespace-scope-installation.md similarity index 55% rename from website/docs/litmus-installation-namespace.md rename to website/docs/getting-started-namespace-scope-installation.md index e4a1495..eecec1e 100644 --- a/website/docs/litmus-installation-namespace.md +++ b/website/docs/getting-started-namespace-scope-installation.md @@ -1,29 +1,23 @@ --- -id: litmus-install-namespace-mode -title: Litmus Chaos Control Plane (Namespace Mode) -sidebar_label: Control Plane (Namespace Mode) +id: namespace-scope-installation +title: Litmus Namespace Scope Installation +sidebar_label: Namespace Scope --- --- - +## Prerequisites -## Pre-requisites - -- Kubernetes 1.15 or later. - ​ -- Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purposes as well. This PV is used as persistent storage to store the chaos config and chaos-metrics in the Portal. By default, litmus would use the default storage class to allocate the PV. - -- Helm3 or Kubectl +Before deploying LitmusChaos, make sure the [prerequisites](basic-requirements) are met. ## Installation Installation of Litmus can be done using either of the below methods -- [Helm3](#helm_install) chart or -- [Kubectl](#kubectl_install) yaml spec file +- [Helm3](#install-litmus-using-helm) chart +- [Kubectl](#install-litmus-using-kubectl) yaml spec file -### **Install Litmus using Helm ** +### **Install Litmus using Helm ** The helm chart will install all the required service account configuration and chaos control plane. @@ -36,20 +30,41 @@ helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/ helm repo list ``` -#### Step-2: Create the litmus namespace +#### Step-2: Create the namespace on which you want to install Litmus [Required only if namespace isn't there] -- The litmus infra components will be placed in this namespace. - -**Note**: The chaos control plane can be placed in any namespace, though it is typically placed in "litmus". +The Litmus infra components will be placed in this namespace. ```bash -kubectl create ns litmus +kubectl create ns
+## Resources -## **Setup the Portal** +#### Videos -To setup and login to Litmus Portal expand the available services just created and copy the `PORT` of the `litmusportal-frontend-service` service + -```bash -kubectl get svc -n litmus -``` +#### Blogs -Expected Output +
.default})
+- [Install Litmus in Namespace Scope](namespace-scope-installation)
+- [Setup Endpoints and Access Litmus without Ingress](setup-without-ingress)
+- [Setup Endpoints and Access Litmus with Ingress](setup-with-ingress)
diff --git a/website/docs/getting-started-run-your-first-workflow.md b/website/docs/getting-started-run-your-first-workflow.md
new file mode 100644
index 0000000..157fa8e
--- /dev/null
+++ b/website/docs/getting-started-run-your-first-workflow.md
@@ -0,0 +1,7 @@
+---
+id: run-your-first-workflow
+title: Run your First Chaos Workflow in 5 minutes
+sidebar_label: Run Your First Workflow
+---
+
+## Coming Soon
diff --git a/website/docs/litmus-installation-with-ingress.md b/website/docs/getting-started-setup-with-ingress.md
similarity index 50%
rename from website/docs/litmus-installation-with-ingress.md
rename to website/docs/getting-started-setup-with-ingress.md
index 8b87680..04f2ff7 100644
--- a/website/docs/litmus-installation-with-ingress.md
+++ b/website/docs/getting-started-setup-with-ingress.md
@@ -1,36 +1,36 @@
---
-id: litmus-with-ingress
+id: setup-with-ingress
title: Install LitmusPortal with Ingress
-sidebar_label: Litmus with Ingress
+sidebar_label: Setup With Ingress
---
---
-### Install LitmusPortal with Ingress
+## Prerequisites
+
+Before setting up endpoint with Ingress make sure the [Litmus Chaos Control Plane](chaos-control-plane) is installed in either one of these scopes
+
+- [Cluster Scope](cluster-scope-installation)
+- [Namespace Scope](namespace-scope-installation)
+
+## Install LitmusPortal with Ingress
With Litmus-2.0.0-Beta3, LitmusPortal can be installed with ingress.
In the following doc, we will use the Nginx ingress controller for ingress setup.
-1. Install the litmus chaos control plane
+1. By default, the service type is `NodePort`. For Ingress, we need to change the service type to `ClusterIP` in the following services.
-```bash
-kubectl apply -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Beta.yaml
-```
+- `litmusportal-frontend-service`
+- `litmusportal-server-service`
-2. By default, the service type is NodePort. For Ingress, we need to change the service type to ClusterIP in the following services.
-* litmusportal-frontend-service
-* litmusportal-server-service
+2. Install Nginx Ingress Controller along with Kubernetes RBAC roles and bindings, please refer [here](https://kubernetes.github.io/ingress-nginx/deploy/#installation-guide)
+> - If you're changing ingress name from **litmus-ingress** to a different name, make sure to update the **INGRESS_NAME** environment variable in the litmusportal-server deployment
+> - Set the environment variable **INGRESS** as true in the litmusportal-server deployment.
-3. Install Nginx Ingress Controller along with Kubernetes RBAC roles and bindings, please refer [here](https://kubernetes.github.io/ingress-nginx/deploy/#installation-guide)
+### With HTTP
-**Note:**
-* If you're changing ingress name from **litmus-ingress** to a different name, make sure to update the **INGRESS_NAME** environment variable in the litmusportal-server deployment
-* Set the environment variable **INGRESS** as true in the litmusportal-server deployment.
-
-#### With HTTP
-
-4. Sample litmus ingress manifest With HTTP
+Sample litmus ingress manifest With HTTP
```yaml
apiVersion: extensions/v1beta1
@@ -42,7 +42,7 @@ metadata:
name: litmus-ingress
spec:
rules:
- - host: "
+
+ 
+ +
+ AKS ingress with nginx and Key Vault certificates
+
+
+ |
+
+
+ 
+ +
+ Ingress
+
+
+ |
+
+
+## Resources
+
+|
+
+
+ +
+ NodePort
+
+
+ |
+
+
+
+ +
+ LoadBalancer
+
+
+ |
+
|
+
+
+ +
+ Ingress
+
+
+ |
+
diff --git a/website/sidebars.js b/website/sidebars.js
index 213e937..e705547 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -8,20 +8,31 @@ module.exports = {
// "feature-definition"
],
'Getting Started': [
- 'getstarted',
{
- Installation: [
- 'litmus-install-cluster-mode',
- 'litmus-install-namespace-mode',
- 'agent-install',
- 'litmus-with-ingress'
+ Prerequisites: [
+ 'basic-requirements',
+ {
+ Resources: ['chaos-control-plane', 'agents']
+ }
]
},
- 'create-workflow',
- 'observe-workflow',
{
- Uninstallation: ['agent-uninstall', 'litmus-uninstall']
- }
+ Installation: [
+ {
+ 'Control Plane': [
+ 'cluster-scope-installation',
+ 'namespace-scope-installation',
+ 'setup-without-ingress',
+ 'setup-with-ingress'
+ ]
+ },
+ {
+ 'Chaos Plane': ['agent-install', 'litmusctl']
+ }
+ ]
+ },
+ 'run-your-first-workflow',
+ 'learning-litmus'
],
'User Guide': [
{
diff --git a/website/src/css/global.css b/website/src/css/global.css
index c48fc3f..b2d7180 100644
--- a/website/src/css/global.css
+++ b/website/src/css/global.css
@@ -8,11 +8,11 @@ body {
margin: 0;
padding: 0;
background: #f4f5f7;
+ font-size: 1.05rem;
}
a {
text-decoration: none;
- color: #000;
}
/* SVGs font work differenly than normal HTML elements. So this rule is required. */