Skip to content

Commit 8e165a3

Browse files
author
Eugenio Marzo
committed
fix
1 parent b8106e3 commit 8e165a3

File tree

1 file changed

+13
-24
lines changed

1 file changed

+13
-24
lines changed

README.md

+13-24
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22

33
**Gamified Chaos Engineering and Educational Tool for Kubernetes**
44

5-
As recommended by the CNCF (https://github.com/cncf/sandbox/issues/124), this project has a strong following and significant educational value. Therefore, in addition to being a chaos engineering tool, it is recommended for studying Kubernetes and resilience topics.
5+
This project, recommended by the CNCF (https://github.com/cncf/sandbox/issues/124), has a strong following and significant educational value. It's a chaos engineering tool, but it's also recommended for studying Kubernetes and resilience topics.
66

7-
This project is part of landscape of [Cloud Native Computing Foudation](https://landscape.cncf.io/) in the Observability and Analysis - Chaos Engineering section.
7+
It is part of the Cloud Native Computing Foundation's (CNCF) landscape in the Observability and Analysis - Chaos Engineering section (https://landscape.cncf.io/).
88

9-
- Launch the demo at this link [https://kubeinvaders.platformengineering.it](https://kubeinvaders.platformengineering.it/)
10-
- Monitor the pod status here [https://kubeopsview.platformengineering.it](https://kubeopsview.platformengineering.it)
9+
Launch the demo at this link: https://kubeinvaders.platformengineering.it/
1110

12-
Backed by the teams at [platformengineering.it](https://platformengineering.it) and [devopstribe.it](https://devopstribe.it), which provides enterprise-grade features and certified resilience services for your Kubernetes infrastructure.
11+
The teams at Platform Engineering (https://platformengineering.it/) and DevOps Tribe (https://devopstribe.it/) back this project. They provide enterprise-grade features and SRE experts to help customers verify the resilience of their Kubernetes infrastructure.
1312

14-
[Here are the slides](https://www.slideshare.net/EugenioMarzo/kubeinvaders-chaos-engineering-practices-for-kubernetes1pdf) from the Chaos Engineering speech I prepared for FOSDEM 2023. Unfortunately, I could not be present at my talk, but I would still like to share them with the community.
13+
Here are the slides (https://www.slideshare.net/EugenioMarzo/kubeinvaders-chaos-engineering-practices-for-kubernetes1pdf) from the Chaos Engineering speech I prepared for FOSDEM 2023. Unfortunately, I couldn't be present at my talk, but I still wanted to share them with the community."
1514

1615
# Table of Contents
1716

@@ -33,7 +32,7 @@ Backed by the teams at [platformengineering.it](https://platformengineering.it)
3332

3433
## Description
3534

36-
With **k-inv**, you can stress a K8s cluster in a fun way and check how resilient it is.
35+
Inspired by the classic Space Invaders game, Kubeinvaders offers a playful and engaging way to learn about Kubernetes resilience by stressing a cluster and observing its behavior under pressure. This open-source project, built without relying on any external frameworks, provides a fun and educational experience for developers to explore the limits and strengths of their Kubernetes deployments
3736

3837
## Installation-default
3938

@@ -162,6 +161,7 @@ spec:
162161
- containerPort: 81
163162
EOF
164163
```
164+
165165
Apply Nginx Deployment in namespace1 and namespace2
166166
```bash
167167
sudo kubectl apply -f deployment.yaml -n namespace1
@@ -170,28 +170,16 @@ sudo kubectl apply -f deployment.yaml -n namespace2
170170

171171
## Installation-nodeport
172172

173-
Let's say we have a Layer4 or Layer7 Load Balancer that redirect traffic directly to the KubeInvaders Service Node Port.
173+
Let's say we have a Layer 4 or Layer 7 Load Balancer that redirects traffic directly to the KubeInvaders Service Node Port.
174174

175-
For example this HaProxy configuration and we don't want use TLS (no secure just for experiment)
175+
For example, consider this HaProxy configuration. We don't want to use TLS in this scenario (just for experimentation).
176176

177-
Please remember to disable TLS: **kubectl set env deployment/kubeinvaders DISABLE_TLS=true -n kubeinvaders**
177+
Remember to disable TLS: **kubectl set env deployment/kubeinvaders DISABLE_TLS=true -n kubeinvaders**
178178
(TODO: put this into values of the Helm)
179179

180+
**HaProxy Configuration**
180181
```bash
181182
global
182-
# to have these messages end up in /var/log/haproxy.log you will
183-
# need to:
184-
#
185-
# 1) configure syslog to accept network log events. This is done
186-
# by adding the '-r' option to the SYSLOGD_OPTIONS in
187-
# /etc/sysconfig/syslog
188-
#
189-
# 2) configure local2 events to go to the /var/log/haproxy.log
190-
# file. A line like the following can be added to
191-
# /etc/sysconfig/syslog
192-
#
193-
# local2.* /var/log/haproxy.log
194-
#
195183
log 127.0.0.1 local2
196184

197185
chroot /var/lib/haproxy
@@ -233,7 +221,8 @@ frontend mylb
233221
backend mynodeport
234222
balance roundrobin
235223
```
236-
Follow these steps:
224+
225+
**Installation steps using NodePort**
237226

238227
```bash
239228

0 commit comments

Comments
 (0)