From 792c65ca1147a78aec9ece88f81fb2195cde42f0 Mon Sep 17 00:00:00 2001 From: luckysideburn Date: Mon, 30 Dec 2024 17:34:42 +0000 Subject: [PATCH] fixed quick guide --- html/index.html | 76 +++++++++++++++++++++++++++++++------------------ 1 file changed, 48 insertions(+), 28 deletions(-) diff --git a/html/index.html b/html/index.html index 06bce34..1aef20d 100644 --- a/html/index.html +++ b/html/index.html @@ -336,7 +336,7 @@ -
+
h => Enable or disable help
s => Enable or disable shuffle for aliens
n => Change the namespace
@@ -358,36 +358,56 @@

-

-
-Thank you for installing Kubeinvaders! - -This is a chaos engineering tool developed by Luckysideburn and contributors from platformengineering.it for the Kubernetes community, including software developers and admins.

- -Kubeinvaders started in 2019 as a gamified chaos engineering tool, and we are continually evolving it into a more sophisticated instrument :D

- -Here’s how it works:

- -For reports, bugs, or ideas, feel free to open an issue on the project's GitHub repository or contact Luckysideburn at luckysideburn@gmail.com.

- -Game Mode
-Enabling the game console allows you to kill pods and launch workloads to stress cluster nodes (check “Show keys and options” to learn how). You can also switch between namespaces and perform many other tasks.

- -Check HTTP
-Use this to monitor an ingress and generate real-time reports. It’s very useful for understanding what happens to your applications during chaos sessions. Currently, we monitor HTTP call durations and status codes. Additionally, you’ll find some very useful default metrics:

- -Selected Namespace => Indicates the current namespace focused on by the tool. You can switch between selected namespaces during installation.

-Deleted Pods Total => The total number of killed pods.

-Current Chaos Pods => When the node stress test mode is activated, this metric shows the number of jobs stressing your cluster.

-Current Replicas State Delay => An important metric that shows how long your cluster takes to return to the desired state after a chaos engineering session.

- -Programming Mode (Under Development)
-Using 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. +
+

+ Kubeinvaders is a chaos engineering tool (featured in the CNCF landscape) developed by Luckysideburn and contributors from + platformengineering.it for the Kubernetes community, including software developers and administrators. +

+

+ For bug reports, feature requests, or suggestions, feel free to open an issue on the project's + GitHub repository or contact Luckysideburn directly at + luckysideburn@gmail.com. +

+ +

>> Main Modes

+

+ There are three main modes: Game Mode and Programming Mode (which is still under development). +

+ +

>> Game Mode

+

+ In Game Mode, accessible through the sidebar, you can view the list of all commands via the "Controls and Options" section or by pressing "h". +

+ +

>> Some Metrics

+
    +
  • Selected Namespace: Displays the currently focused namespace. You can switch namespaces during operation.
    • +
  • Deleted Pods Total: The total number of pods terminated during the session.
    • +
  • Current Chaos Pods: Shows the number of jobs stressing your cluster when node stress testing is active.
    • +
  • Current Replicas State Delay: Indicates how long it takes for your cluster to return to the desired state after a chaos engineering event.
    • +
+ +

>> The "Check Ingress HTTP during Chaos Experiment" Flag

+

+ This feature allows you to monitor an ingress and generate real-time reports, making it invaluable for observing your applications during chaos engineering sessions. +

+

Currently, it tracks:

+
    +
  • HTTP call durations
    • +
  • HTTP status codes
    • +
+ +

>> Programming Mode (Under Development)

+

+ In Programming Mode, you’ll be able to use YAML to define and execute custom chaos engineering experiments. +

+
@@ -742,7 +762,7 @@ k8s_jobs:
-

version: 2024-12-30 16:38:57

+

version: 2024-12-30 17:32:49