litmuschaos
/
litmus
mirror of https://github.com/litmuschaos/litmus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
litmus/litmus-portal
History
Saswata Mukherjee fa688e9c02
chore(litmus-portal): Add unit testing setup using `@testing-library/react` (#2622) 
* Add test setup
* Remove styleMock
* Refactor test
* Remove toBeTruthy tests

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
 		2021-04-05 14:38:17 +05:30
..
authentication Added edit git config feature and fixed authserver no role bug 2021-03-04 14:26:32 +05:30
cluster-agents Added Kubernetes Objects API with dynamic client (#2625) 2021-04-05 13:25:17 +05:30
frontend chore(litmus-portal): Add unit testing setup using `@testing-library/react` (#2622) 2021-04-05 14:38:17 +05:30
graphql-server Added Kubernetes Objects API with dynamic client (#2625) 2021-04-05 13:25:17 +05:30
platforms/okteto Converting mongodb deployment to statefulset (#2531) 2021-03-11 22:07:17 +05:30
Makefile event tracker deps 2021-02-01 17:31:57 +05:30
README.md Upgrading litmusportal image tags, docs to v2.0.0-Beta1 (#2614) 2021-03-30 14:07:16 +05:30
cluster-k8s-manifest.yml Converting mongodb deployment to statefulset (#2531) 2021-03-11 22:07:17 +05:30
litmus-portal-crds.yml fix(crds): Removing maxProperties field validator (#2465) 2021-02-24 18:52:33 +05:30
namespaced-K8s-template.yml Add manifesh for namespace mode of litmus portal (#2588) 2021-03-24 15:49:11 +05:30
run.sh upgrade version to 1.13.0 (#2473) 2021-02-25 16:46:56 +05:30

README.md

Litmus Portal

Litmus-Portal 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

  • Minikube
  • GKE
  • KIND
  • EKS
  • Okteto Cloud

Pre-requisites

  • Kubernetes 1.11 or later.

Installation

Applying k8s manifest

Litmus-2.0.0-Beta2 (Stable)

kubectl apply -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Beta.yaml

Or

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

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

Or

Master (Latest) Namespaced scope. Replace <namespace> with the desired namespace.

export LITMUS_PORTAL_NAMESPACE="<namespace>"
kubectl create ns ${LITMUS_PORTAL_NAMESPACE}
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml
curl https://raw.githubusercontent.com/litmuschaos/litmus/master/docs/2.0.0-Beta/litmus-namespaced-2.0.0-Beta.yaml --output litmus-portal-namespaced-K8s-template.yml
envsubst < litmus-portal-namespaced-K8s-template.yml > ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml
kubectl apply -f ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml -n ${LITMUS_PORTAL_NAMESPACE}
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/platforms/okteto/hello-world-AUT.yml -n ${LITMUS_PORTAL_NAMESPACE}

Configuration Options for Cluster scope.

  • litmus-portal-operations-config configmap.

    AgentNamespace: litmus

  • All environment variables.

Configuration Options for Namespace scope.

  • litmus-portal-operations-config configmap.

    AgentNamespace: ${LITMUS_PORTAL_NAMESPACE}

  • 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 Litmus Portal

Litmus-Portal 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

Uninstallation

Litmus-2.0.0-Beta2 (Stable)

kubectl delete -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Beta.yaml

Or

Master (Latest) Cluster scope. Uninstall in litmus namespace by default. (Only deleting litmus portal components)

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

Or

Master (Latest) Namespaced scope. Replace <namespace> with the desired namespace.

export LITMUS_PORTAL_NAMESPACE="<namespace>"
kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml
kubectl delete -f ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml -n ${LITMUS_PORTAL_NAMESPACE}
kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/platforms/okteto/hello-world-AUT.yml -n ${LITMUS_PORTAL_NAMESPACE}

Tech Stack

  • Frontend
    • TypeScript
    • JavaScript
    • ReactJS
    • Apollo GraphQL client
    • MaterialUI
  • Backend
    • GoLang
    • GQLGEN GraphQL Server
  • Database
    • MongoDB
Additional information