litmus/litmus-portal

ChaosCenter

ChaosCenter provides console and UI experience for managing, monitoring, and events around chaos workflows. Chaos workflows consist of a sequence of experiments run together to achieve the objective of introducing some kind of fault into an application or the Kubernetes platform.

Platforms Support

• GKE
• EKS
• Okteto Cloud
• AKS
• K3S
• Civo Cloud
• Kublr
• Minikube
• KIND

Pre-requisites

• Kubernetes 1.17 or later.

Installation

Applying k8s manifest

Litmus-3.0.0-beta8 Cluster Scope manifest

kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.0.0-beta8/litmus-3.0.0-beta8.yaml

Or

Litmus-3.0.0-beta8 Namespaced Scope manifest.

#Create a namespace eg: litmus
kubectl create ns litmus
#Install CRDs, if SELF_AGENT env is set to TRUE
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.0.0-beta8/litmus-portal-crds-3.0.0-beta8.yml
#Install ChaosCenter
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.0.0-beta8/litmus-namespaced-3.0.0-beta8.yaml -n litmus

Or

Master (Latest) Cluster scope. Install in litmus namespace by default.

kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml

Or

Master (Latest) Namespaced scope.

#Create a namespace eg: litmus
kubectl create ns litmus
#Install CRDs, if SELF_AGENT env is set to TRUE
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml
#Install ChaosCenter
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/namespace-k8s-manifest.yml -n litmus

Configuration Options for Cluster scope.

• litmus-portal-operations-config configmap.

  AgentNamespace: litmus

• All environment variables.

Retrieving external url to access the litmus portal

GKE/Okteto Cloud/EKS

export NODE_NAME=$(kubectl -n $LITMUS_PORTAL_NAMESPACE get pod  -l "component=litmusportal-frontend" -o=jsonpath='{.items[*].spec.nodeName}')
export EXTERNAL_IP=$(kubectl -n $LITMUS_PORTAL_NAMESPACE get nodes $NODE_NAME -o jsonpath='{.status.addresses[?(@.type=="ExternalIP")].address}')
export NODE_PORT=$(kubectl -n $LITMUS_PORTAL_NAMESPACE get -o jsonpath="{.spec.ports[0].nodePort}" services litmusportal-frontend-service)
echo "URL: http://$EXTERNAL_IP:$NODE_PORT"

Minikube

minikube -n $LITMUS_PORTAL_NAMESPACE --url litmusportal-frontend-service

Note: Default username: admin and password: litmus

User Guide for ChaosCenter

ChaosCenter provides console or UI experience for managing, monitoring, and events round chaos workflows. Chaos workflows consist of a sequence of experiments run together to achieve the objective of introducing some kind of fault into an application or the Kubernetes platform.

View the User Guide here

Local Development Guide for ChaosCenter

Local Development Guide for ChaosCenter can be found here

Upgrade from 3.0.0-beta7 to 3.0.0-beta8

You can upgrade using the steps from section here

Uninstallation

You can uninstall using the steps from section here

• Litmus Portal Design Specification
  
• Litmus Portal Development Guide