diff --git a/README.md b/README.md index 47c54e1..a83ff82 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,6 @@ Through KubeInvaders you can stress a Kubernetes cluster in a fun way and check how it is resilient. ## Installation - ### Install to Kubernetes with Helm (v3+) [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/kubeinvaders)](https://artifacthub.io/packages/search?repo=kubeinvaders) @@ -35,51 +34,59 @@ helm install kubeinvaders --set-string target_namespace="namespace1\,namespace2" ## Usage -### Watch YouTube How To -[Video How To of version v1.9](https://www.youtube.com/watch?v=wD7ngPlNEjY) - -### Show Special Keys -Press 'h' or select 'Show Special Keys' from the menu. - -### Zoom In / Out -Press + or - buttons to increase or decrease the game screen. - -### Do Kube-linter Lint -It is possibile using [kube-linter](https://github.com/stackrox/kube-linter) through KubeInvaders in order to scan resources looking for best-practices or improvements to apply. - -[Example from YouTube](https://www.youtube.com/watch?v=n_EuYjq3M-A) - -## Commands and Metrics At the top you will find some metrics as described below: ![Alt Text](https://github.com/lucky-sideburn/KubeInvaders/blob/master/images/metrics_bar.png) -Current Replicas State Delay is a metric that show how much time the cluster takes to coming back at the desired state of pods replicas. +**Current Replicas State Delay** is a metric that show how much time the cluster takes to coming back at the desired state of pods replicas. -This is a control-plane you can use for switch off & on various features +This is a control-plane you can use to switch off & on various features. ![Alt Text](https://github.com/lucky-sideburn/KubeInvaders/blob/master/images/control-plane.png) -### Chaos Start -Press the button "Chaos Start" to start automatic pilot (button changed to "Stop" to disable this feature). +### YouTube HowTo + +[Video How To of version v1.9](https://www.youtube.com/watch?v=wD7ngPlNEjY) +### Start The Chaos Experiment + +Press the button "Start" to start automatic pilot (button changed to "Stop" to disable this feature). ### Enable Shuffle + Press the button "Enable Shuffle" to switch randomly the positions of pods or k8s nodes (button changes to "Disable Shuffle" to disable this feature). ### Enable Auto Jump Between Namespace + Press the button "Auto NS Switch" to switch randomly between namespaces (button changes to "Disable Auto NS Switch" to disable this feature). ### Show / Hide pods name + Press the button "Hide Pods Name" to hide the name of the pods under the aliens (button changes to "Show Pods Name" to disable this feature). ### Information about current status and events -As described below, on the game screen, near the spaceship, there are information about current cluster, namespace and some configurations + +As described below, on the game screen, near the spaceship, there are details about current cluster, namespace and some configurations. ![Alt Text](https://github.com/lucky-sideburn/KubeInvaders/blob/master/images/game-info.png) -Under + and - buttons appears a bar with the latest occurred game events +Under + and - buttons appears a bar with the latest occurred game events. ![Alt Text](https://github.com/lucky-sideburn/KubeInvaders/blob/master/images/game-events.png) +### Do Kube-linter Lint + +It is possibile using [kube-linter](https://github.com/stackrox/kube-linter) through KubeInvaders in order to scan resources looking for best-practices or improvements to apply. + +[Example from YouTube](https://www.youtube.com/watch?v=n_EuYjq3M-A) + +### Show Special Keys + +Press 'h' or select 'Show Special Keys' from the menu. + +### Zoom In / Out + +Press + or - buttons to increase or decrease the game screen. ### Chaos Containers for masters and workers nodes + - Select from the menu "Show Current Chaos Container for nodes" for watching which container start when you fire against a worker node (not an alien, they are pods). + - Select from the menu "Set Custom Chaos Container for nodes" for using your preferred image or configuration against nodes. ## Known problems @@ -130,10 +137,11 @@ nginx.ingress.kubernetes.io/whitelist-source-range: /32 Please reach out for news, bugs, feature requests, and other issues via: -- Following us on Twitter [@kubeinvaders](https://twitter.com/kubeinvaders) & [@luckysideburn](https://twitter.com/luckysideburn) +- On Twitter: [@kubeinvaders](https://twitter.com/kubeinvaders) & [@luckysideburn](https://twitter.com/luckysideburn) - New features are published on YouTube too in [this channel](https://www.youtube.com/channel/UCQ5BQ8R2fDL_WkNAllYRrpQ) ## Community blogs and videos + - Kubernetes.io blog: [KubeInvaders - Gamified Chaos Engineering Tool for Kubernetes](https://kubernetes.io/blog/2020/01/22/kubeinvaders-gamified-chaos-engineering-tool-for-kubernetes/) - DevNation RedHat Developer: [Twitter](https://twitter.com/sebi2706/status/1316681264179613707) - Flant:[Open Source solutions for chaos engineering in Kubernetes](https://blog.flant.com/chaos-engineering-in-kubernetes-open-source-tools/) diff --git a/html5/index.html b/html5/index.html index f9dfc66..3960eaa 100644 --- a/html5/index.html +++ b/html5/index.html @@ -160,7 +160,7 @@