Update docs as per reviewer suggestion

Signed-off-by: DongYoung Kim <[email protected]>
litmuschaos · Aug 9, 2024 · e42f8e7 · e42f8e7
1 parent 3a26cf8
commit e42f8e7
Show file tree

Hide file tree

Showing 2 changed files with 122 additions and 28 deletions.
diff --git a/website/docs/developer-guide/chaoscenter-developer-guide.md b/website/docs/developer-guide/chaoscenter-developer-guide.md
@@ -8,7 +8,7 @@ sidebar_label: ChaosCenter Developer Guide
 
 ## **Prerequisites**
 :::note
-This document is ietented to be implemented locally. Please do not use in dev or prod environmentss
+This document is intended to be implemented locally. Please do not use in dev or prod environments.
 :::
 
 - Kubernetes 1.17 or later
@@ -20,8 +20,8 @@ This document is ietented to be implemented locally. Please do not use in dev or
 
 ## **Control Plane**
 Backend components consist of three microservices
-1. GraphQL-Server
-2. Authentication-Server
+1. Backend server
+2. Authentication server
 3. MongoDB
 
 Frontend component
@@ -45,7 +45,12 @@ docker run -d --net mongo-cluster -p 27017:27017 --name m3 mongo:4.2 mongod --re
 
 Step-2: Add hosts 
 
-Windows
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows">
+
 ```bash
 # add hosts in hosts 
 notepad C:\Windows\System32\drivers\etc\hosts
@@ -54,7 +59,9 @@ notepad C:\Windows\System32\drivers\etc\hosts
 127.0.0.1       m1 m2 m3
 ```
 
-Linux/Mac
+</TabItem>
+<TabItem value="linux" label="macOS/Linux">
+
 ```bash
 # add hosts in hosts 
 sudo vim /etc/hosts
@@ -63,6 +70,9 @@ sudo vim /etc/hosts
 127.0.0.1       m1 m2 m3
 ```
 
+</TabItem>
+</Tabs>
+
 
 Step-3: Configure the mongoDB replica set
 
@@ -95,20 +105,49 @@ export ADMIN_PASSWORD=litmus
 export DB_SERVER="mongodb://m1:27015,m2:27016,m3:27017/?replicaSet=rs0"
 export DB_USER=admin
 export DB_PASSWORD=1234
+export JWT_SECRET=litmus-portal@123
+export PORTAL_ENDPOINT=http://localhost:8080
+export LITMUS_SVC_ENDPOINT=""
+export SELF_AGENT=false
+export INFRA_SCOPE=cluster
+export INFRA_NAMESPACE=litmus
+export LITMUS_PORTAL_NAMESPACE=litmus
+export PORTAL_SCOPE=namespace
+export SUBSCRIBER_IMAGE=litmuschaos/litmusportal-subscriber:ci
+export EVENT_TRACKER_IMAGE=litmuschaos/litmusportal-event-tracker:ci
+export CONTAINER_RUNTIME_EXECUTOR=k8sapi
+export ARGO_WORKFLOW_CONTROLLER_IMAGE=argoproj/workflow-controller:v2.11.0
+export ARGO_WORKFLOW_EXECUTOR_IMAGE=argoproj/argoexec:v2.11.0
+export CHAOS_CENTER_SCOPE=cluster
+export WORKFLOW_HELPER_IMAGE_VERSION=3.0.0
+export LITMUS_CHAOS_OPERATOR_IMAGE=litmuschaos/chaos-operator:3.0.0
+export LITMUS_CHAOS_RUNNER_IMAGE=litmuschaos/chaos-runner:3.0.0
+export LITMUS_CHAOS_EXPORTER_IMAGE=litmuschaos/chaos-exporter:3.0.0
+export VERSION=ci
+export HUB_BRANCH_NAME=v2.0.x
+export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]"                                                                         
+export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]'
+export DEFAULT_HUB_BRANCH_NAME=master
+export ENABLE_INTERNAL_TLS=false
 export REST_PORT=3000
 export GRPC_PORT=3030
 ```
 
-Windows  
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows">
+
 Docker or Hyper-V is reserving that port range. You can use 3030 ports by running the command below
 
-```shell
+```bash
 netsh interface ipv4 show excludedportrange protocol=tcp
 net stop winnat
 netsh int ipv4 add excludedportrange protocol=tcp startport=3030 numberofports=1
 net start winnat
 ```
 
+</TabItem>
+</Tabs>
+
 Step-2: Run the go application
 
 ```bash
@@ -172,20 +211,27 @@ yarn
 ```
 
 Step-2: Generate the ssl certificate
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows">
 
-Linux/Mac
-```bash
-yarn generate-certificate
-```
-
-Windows  
 The command you run is in the script/generate-certificate.sh file, but it doesn't work in a Windows environment, so please run the script below instead
+
 ```bash
 mkdir -p certificates
 
 openssl req -x509 -newkey rsa:4096 -keyout certificates/localhost-key.pem -out certificates/localhost.pem -days 365 -nodes -subj '//C=US'
 ```
 
+</TabItem>
+<TabItem value="linux" label="macOS/Linux">
+
+```bash
+yarn generate-certificate
+```
+
+</TabItem>
+</Tabs>
+
 Step-3: Run the frontend project
 
 ```bash
@@ -211,7 +257,7 @@ Use [litmusctl](https://github.com/litmuschaos/litmusctl) on the same box/loca
 ### Using Chaoscenter
 Use Chaoscenter to connect an Infrastructure, download the manifest and apply it on k3d/minikube. Once the pods are up(except the subscriber), run the following command:
 
-```shell
+```bash
 cd subscriber
 
 INFRA_ID=<INFRA_ID> ACCESS_KEY=<ACCESS_KEY> INFRA_SCOPE=cluster SERVER_ADDR=http://localhost:8080/query INFRA_NAMESPACE=litmus IS_INFRA_CONFIRMED="false" COMPONENTS="DEPLOYMENTS: ["app=chaos-exporter", "name=chaos-operator", "app=workflow-controller"]"  START_TIME=1631089756 VERSION="ci" AGENT_POD="subscriber-78f6bd4db5-ck5d9" SKIP_

diff --git a/...ite/versioned_docs/version-3.9.1/developer-guide/chaoscenter-developer-guide.md b/...ite/versioned_docs/version-3.9.1/developer-guide/chaoscenter-developer-guide.md
@@ -8,7 +8,7 @@ sidebar_label: ChaosCenter Developer Guide
 
 ## **Prerequisites**
 :::note
-This document is ietented to be implemented locally. Please do not use in dev or prod environmentss
+This document is intended to be implemented locally. Please do not use in dev or prod environments.
 :::
 
 - Kubernetes 1.17 or later
@@ -20,8 +20,8 @@ This document is ietented to be implemented locally. Please do not use in dev or
 
 ## **Control Plane**
 Backend components consist of three microservices
-1. GraphQL-Server
-2. Authentication-Server
+1. Backend server
+2. Authentication server
 3. MongoDB
 
 Frontend component
@@ -45,7 +45,12 @@ docker run -d --net mongo-cluster -p 27017:27017 --name m3 mongo:4.2 mongod --re
 
 Step-2: Add hosts 
 
-Windows
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows">
+
 ```bash
 # add hosts in hosts 
 notepad C:\Windows\System32\drivers\etc\hosts
@@ -54,7 +59,9 @@ notepad C:\Windows\System32\drivers\etc\hosts
 127.0.0.1       m1 m2 m3
 ```
 
-Linux/Mac
+</TabItem>
+<TabItem value="linux" label="macOS/Linux">
+
 ```bash
 # add hosts in hosts 
 sudo vim /etc/hosts
@@ -63,6 +70,9 @@ sudo vim /etc/hosts
 127.0.0.1       m1 m2 m3
 ```
 
+</TabItem>
+</Tabs>
+
 
 Step-3: Configure the mongoDB replica set
 
@@ -95,20 +105,51 @@ export ADMIN_PASSWORD=litmus
 export DB_SERVER="mongodb://m1:27015,m2:27016,m3:27017/?replicaSet=rs0"
 export DB_USER=admin
 export DB_PASSWORD=1234
+export JWT_SECRET=litmus-portal@123
+export PORTAL_ENDPOINT=http://localhost:8080
+export LITMUS_SVC_ENDPOINT=""
+export SELF_AGENT=false
+export INFRA_SCOPE=cluster
+export INFRA_NAMESPACE=litmus
+export LITMUS_PORTAL_NAMESPACE=litmus
+export PORTAL_SCOPE=namespace
+export SUBSCRIBER_IMAGE=litmuschaos/litmusportal-subscriber:ci
+export EVENT_TRACKER_IMAGE=litmuschaos/litmusportal-event-tracker:ci
+export CONTAINER_RUNTIME_EXECUTOR=k8sapi
+export ARGO_WORKFLOW_CONTROLLER_IMAGE=argoproj/workflow-controller:v2.11.0
+export ARGO_WORKFLOW_EXECUTOR_IMAGE=argoproj/argoexec:v2.11.0
+export CHAOS_CENTER_SCOPE=cluster
+export WORKFLOW_HELPER_IMAGE_VERSION=3.0.0
+export LITMUS_CHAOS_OPERATOR_IMAGE=litmuschaos/chaos-operator:3.0.0
+export LITMUS_CHAOS_RUNNER_IMAGE=litmuschaos/chaos-runner:3.0.0
+export LITMUS_CHAOS_EXPORTER_IMAGE=litmuschaos/chaos-exporter:3.0.0
+export ADMIN_USERNAME=admin
+export ADMIN_PASSWORD=litmus
+export VERSION=ci
+export HUB_BRANCH_NAME=v2.0.x
+export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]"                                                                         
+export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]'
+export DEFAULT_HUB_BRANCH_NAME=master
+export ENABLE_INTERNAL_TLS=false
 export REST_PORT=3000
 export GRPC_PORT=3030
 ```
 
-Windows  
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows">
+
 Docker or Hyper-V is reserving that port range. You can use 3030 ports by running the command below
 
-```shell
+```bash
 netsh interface ipv4 show excludedportrange protocol=tcp
 net stop winnat
 netsh int ipv4 add excludedportrange protocol=tcp startport=3030 numberofports=1
 net start winnat
 ```
 
+</TabItem>
+</Tabs>
+
 Step-2: Run the go application
 
 ```bash
@@ -172,20 +213,27 @@ yarn
 ```
 
 Step-2: Generate the ssl certificate
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows">
 
-Linux/Mac
-```bash
-yarn generate-certificate
-```
-
-Windows  
 The command you run is in the script/generate-certificate.sh file, but it doesn't work in a Windows environment, so please run the script below instead
+
 ```bash
 mkdir -p certificates
 
 openssl req -x509 -newkey rsa:4096 -keyout certificates/localhost-key.pem -out certificates/localhost.pem -days 365 -nodes -subj '//C=US'
 ```
 
+</TabItem>
+<TabItem value="linux" label="macOS/Linux">
+
+```bash
+yarn generate-certificate
+```
+
+</TabItem>
+</Tabs>
+
 Step-3: Run the frontend project
 
 ```bash
@@ -211,7 +259,7 @@ Use [litmusctl](https://github.com/litmuschaos/litmusctl) on the same box/loca
 ### Using Chaoscenter
 Use Chaoscenter to connect an Infrastructure, download the manifest and apply it on k3d/minikube. Once the pods are up(except the subscriber), run the following command:
 
-```shell
+```bash
 cd subscriber
 
 INFRA_ID=<INFRA_ID> ACCESS_KEY=<ACCESS_KEY> INFRA_SCOPE=cluster SERVER_ADDR=http://localhost:8080/query INFRA_NAMESPACE=litmus IS_INFRA_CONFIRMED="false" COMPONENTS="DEPLOYMENTS: ["app=chaos-exporter", "name=chaos-operator", "app=workflow-controller"]"  START_TIME=1631089756 VERSION="ci" AGENT_POD="subscriber-78f6bd4db5-ck5d9" SKIP_