From 50bc3c69621bb962db119f426c9e6d12fb15c17d Mon Sep 17 00:00:00 2001 From: luckysideburn Date: Sun, 3 Mar 2024 20:32:17 +0000 Subject: [PATCH] add guide and special keys recap --- html5/index.html | 61 ++++++++++++++++++++++++++++++++++++++++++ html5/mode_controls.js | 1 + 2 files changed, 62 insertions(+) diff --git a/html5/index.html b/html5/index.html index 8eadb50..bfd89b5 100644 --- a/html5/index.html +++ b/html5/index.html @@ -225,6 +225,46 @@ + + +
+
+

+ +

+
+
+Dear user, thank you for installing kubeinvaders!
+
+This is a chaos engineering tool written by luckysideburn and friends from https://platformengineering.it for the community of kubernetes users, software developers, and admins.
+It was born in 2019 as a gamified chaos engineering tool, and we are evolving it into a more serious instrument :d
+here's how it works
+ +For reports, bugs, ideas you can open issue on the project github repo https://github.com/lucky-sideburn/kubeinvaders or write to luckysideburn [at] gmail [dot] com
+ +
+[[game mode button]]
+Enabling the game console allows you to kill pods and launch workloads to stress cluster nodes (check "show keys and options" to understand how to do it). You can also jump between namespace and many other things.
+
+[[add http check & chaos report checkbox]]
+Use it to activate the monitoring of an ingress and generate real-time reporting. it's very useful to know what happens to your applications during chaos sessions. for now, we monitor the elapsed time of http calls and status codes. also, you have some very useful default metrics:
+
+Selected namespace => indicates the current namespace focused on by the tool. you can jump between selected namespaces during installation.
+
+>Deleted pods total => total number of killed pods.
+
+Current chaos pods => when the node stress test mode is activated, this metric indicates the number of jobs stressing your cluster.
+
+Current replicas state delay => a very important metric, indicates how long your cluster takes to return to the desired state that was before the chaos engineering session.
+
+[[enable prog. mode button (under development)]]
+Through yaml programming, you can define your own chaos engineering experiments and execute them. we have preloaded some presets for various open-source tools to stress test (this feature is still in development, so contributions are welcome).
+
+
+
+
@@ -264,6 +304,27 @@
+ +
+
+

+ +

+
+
+ h => Activate or deactivate help
+ s => Activate or deactivate shuffle for aliens
+ n => Change namespace
+ p => Activate or deactivate chaos engineering against pods
+ c => Activate or deactivate chaos engineering against nodes +
+
+
+
+ + diff --git a/html5/mode_controls.js b/html5/mode_controls.js index 3f7062c..6384b29 100644 --- a/html5/mode_controls.js +++ b/html5/mode_controls.js @@ -25,6 +25,7 @@ function startGameMode() { } chaos_program_screen.style.display = "none"; programming_mode_buttons.style.display = "none"; + resizeCharts(); } function startProgrammingMode() {