diff --git a/README.md b/README.md index a19ae9d..a6fd6fd 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,14 @@ *Gamified chaos engineering tool for Kubernetes. It is like Space Invaders but the aliens are pods or worker nodes.* -![Alt Text](https://github.com/lucky-sideburn/KubeInvaders/blob/master/images/new_gui.png) +![Alt Text](https://github.com/lucky-sideburn/KubeInvaders/blob/master/images/metrics.png) # Table of Contents 1. [Description](#Description) -2. [New Version](#new-version) -3. [Special Input Keys and features](#Special-Input-Keys-and-features) -4. [Prometheus metrics and Grafana](#Metrics) -5. [Installation](#Installation) -6. [Notes for large clusters](#Notes-for-large-clusters) -7. [Configuration](#Configuration) - +2. [Installation](#Installation) +3. [Known Problems](#Known-problems) +4. [Metrics](#Metrics) +6. [Security](#Security) ## Description @@ -19,12 +16,6 @@ Through KubeInvaders you can stress a Kubernetes cluster in a fun way and check Just released the version v1.7. How is "Replicas State Delay" of your cluster? Just play and watch metrics. -![Alt Text](https://github.com/lucky-sideburn/KubeInvaders/blob/master/images/metrics.png) - -## New Version - -KubeInvaders is now fully open-source. However, it is still possibile to use the legacy version made with Defold. - ## Installation ### Install to Kubernetes with Helm (v3+) @@ -36,14 +27,7 @@ helm repo add kubeinvaders https://lucky-sideburn.github.io/helm-charts/ kubectl create namespace kubeinvaders helm install kubeinvaders --set-string target_namespace="namespace1\,namespace2" \ --n kubeinvaders kubeinvaders/kubeinvaders --set ingress.hostName=kubeinvaders.io --set image.tag=v1.4 -``` - -### Install legacy version - -```bash -helm install kubeinvaders --set-string target_namespace="namespace1\,namespace2" \ --n kubeinvaders kubeinvaders/kubeinvaders --set ingress.hostName=kubeinvaders.io --set image.tag=legacy +-n kubeinvaders kubeinvaders/kubeinvaders --set ingress.hostName=kubeinvaders.io --set image.tag=v1.7 ``` ## Known problems @@ -85,7 +69,7 @@ Example of metrics ![Alt Text](https://github.com/lucky-sideburn/KubeInvaders/blob/master/images/grafana2.png) -### Security Notes +## Security In order to restrict the access to the Kubeinvaders endpoint add this annotation into the ingress.