New release Kubernetes Goat 2.0.0

Author: madhuakula

README.md

@@ -40,57 +40,43 @@
 
 [![Kubernetes Goat Home](./kubernetes-goat-home.png)](https://madhuakula.com/kubernetes-goat)
 
-## Recent Kubernetes Goat Presentations
-
-**OWASP Bay Area Meetup**
-
-[![Introducing Kubernetes Goat - OWASP Bay Area Meetup](https://img.youtube.com/vi/DQllxpb46Yw/0.jpg)](https://youtu.be/DQllxpb46Yw)
-
-**DEFCON Red Team Village**
-
-[![Kubernetes Goat - DEFCON Red Team Village](https://img.youtube.com/vi/aEaSZJRbnTo/0.jpg)](https://youtu.be/aEaSZJRbnTo)
-
-## 🎲 Just click and Play in the browser for free using Katacoda Playground - [Try now]((https://katacoda.com/madhuakula/scenarios/kubernetes-goat))
+## 🚀 Free online browser-based playground - [Try now]((https://katacoda.com/madhuakula/scenarios/kubernetes-goat))
 
 [![Katacoda Playground Kubernetes Goat](./kubernetes-goat-katacoda.png)](https://katacoda.com/madhuakula/scenarios/kubernetes-goat)
 
-[https://katacoda.com/madhuakula/scenarios/kubernetes-goat](https://katacoda.com/madhuakula/scenarios/kubernetes-goat)
-
 ## ⚙️ Setting up Kubernetes Goat
 
-* Before we set up the Kubernetes Goat, ensure that you have created and have admin access to the Kubernetes cluster
+* Ensure you have admin access to the Kubernetes cluster and installed `kubectl`. Refer to the [docs for installation](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
+* Ensure you have the `helm` package manager installed. Refer to the [docs for installation](https://helm.sh/docs/intro/install)
+* To set up the Kubernetes Goat resources in your cluster, run the following commands
 
 ```bash
-kubectl version --short
+git clone https://github.com/madhuakula/kubernetes-goat.git
+cd kubernetes-goat
+bash setup-kubernetes-goat.sh
 ```
 
-* Set up the helm version 3 in your path as `helm`. Refer to helm [releases](https://github.com/helm/helm/releases) for more information about setup
+* Ensure the pods are running before running the access script
 
 ```bash
-helm version --short
+kubectl get pods
 ```
 
-* Then finally setup Kubernetes Goat by running the following command
+![all pods running in kubectl get pods](guide/docs/scenarios/images/kubectl-get-pods.png)
 
-```bash
-git clone https://github.com/madhuakula/kubernetes-goat.git
-cd kubernetes-goat
-bash setup-kubernetes-goat.sh
-```
-
-* To export the ports/services locally to start learning, run the following command
+* Access the Kubernetes Goat by exposing the resources to the local system (port-forward) by the following command
 
 ```bash
 bash access-kubernetes-goat.sh
 ```
 
-* Then navigate to [http://127.0.0.1:1234](http://127.0.0.1:1234)
+* Then navigate to [`http://127.0.0.1:1234`](http://127.0.0.1:1234)
 
-### Kubernetes Goat - KIND setup
 
-* If you want to setup Kubernetes Goat using KIND, refer to [kind-setup](kind-setup/README.md)
+> Refer to [https://madhuakula.com/kubernetes-goat/docs/how-to-run](https://madhuakula.com/kubernetes-goat/docs/how-to-run) for setting up Kubernetes Goat in various environments like GKE, EKS, AKS, K3S, KIND, etc.
 
-## 🏁 Scenarios
+
+## 🏆 Scenarios
 
 1. Sensitive keys in codebases
 2. DIND (docker-in-docker) exploitation
@@ -113,39 +99,54 @@ bash access-kubernetes-goat.sh
 19. Popeye - A Kubernetes cluster sanitizer
 20. Secure network boundaries using NSP
 
-## ❤️ Showcase
-
-* Presented at OWASP Bay Area Meetup at [https://youtu.be/DQllxpb46Yw](https://youtu.be/DQllxpb46Yw)
-* Presented at DEF CON RED Team Village [https://youtu.be/aEaSZJRbnTo](https://youtu.be/aEaSZJRbnTo)
-* Presented at OWASP San Diego at [https://www.meetup.com/Open-Web-Application-Security-Project-San-Diego-OWASP-SD/events/hmbbkrybckbvb/](https://www.meetup.com/Open-Web-Application-Security-Project-San-Diego-OWASP-SD/events/hmbbkrybckbvb/)
-* Featured in the official Kubernetes Podcast at [https://kubernetespodcast.com/episode/109-kubermatic](https://kubernetespodcast.com/episode/109-kubermatic/)
-* Featured in tl;dr sec [https://tldrsec.com/blog/tldr-sec-039](https://tldrsec.com/blog/tldr-sec-039/)
-* Featured in CloudSecList [https://cloudseclist.com/issues/issue-42](https://cloudseclist.com/issues/issue-42/)
-* Presented at EkoParty 2020 DevSecOps [https://youtu.be/XqwbVU-gtng](https://youtu.be/XqwbVU-gtng)
-* Presented at c0c0cn 2020 [https://india.c0c0n.org/2020/speakers#madhu_akula](https://india.c0c0n.org/2020/speakers#madhu_akula)
-* Featured in Info Ck YouTube channel [https://youtu.be/5ojho4L6Xfo](https://youtu.be/5ojho4L6Xfo)
-* Presented in Cloud Native Indonesia Meetup [https://youtu.be/pf5jOGWoWU0](https://youtu.be/pf5jOGWoWU0)
-* Presented in [USENIX LISA 2021 Closing Note](https://www.usenix.org/conference/lisa21/presentation/closing)
-* Presented in SANS CloudSecNext Summit 2021
+## 📖 Documentation Guide
 
-## ⚠️ Disclaimer
+Here is the detailed step by step [documentation guide](https://madhuakula.com/kubernetes-goat) for learning and playing around with Kubernetes Goat 🎉
 
-> Kubernetes Goat creates intentionally vulnerable resources into your cluster. DO NOT deploy Kubernetes Goat in a production environment or alongside any sensitive cluster resources.
+[![Kubernetes Goat Documentation Guide](kubernetes-goat-docs.png)](https://madhuakula.com/kubernetes-goat)
 
-> Kubernetes Goat comes with absolutely no warranties whatsoever. By using Kubernetes Goat, you take full responsibility for all outcomes that result.
+**Reference: [https://madhuakula.com/kubernetes-goat](https://madhuakula.com/kubernetes-goat)**
 
-## Show us some ❤️
+## ⚠️ Disclaimer
 
-Please feel free to send us a [PR](https://github.com/madhuakula/kubernetes-goat/blob/master/guide/src/getting-involved/i-use-this-project.md) and show some ❤️
+> Kubernetes Goat has intentionally created vulnerabilities, applications, and configurations to attack and gain access to your cluster and workloads. Please **DO NOT** run alongside your production environments and infrastructure. So we highly recommend running this in a safe and isolated environment.
 
-[![I use this project](images/i-use-this-project.png)](https://github.com/madhuakula/kubernetes-goat/blob/master/guide/src/getting-involved/i-use-this-project.md)
+> Kubernetes Goat is used for educational purposes only, do not test or apply these attacks on any systems without permission. Kubernetes Goat comes with absolutely no warranties, by using it you take full responsibility for all the outcomes.
 
-## License
+## 🪪 License
 
 [MIT](https://github.com/madhuakula/kubernetes-goat/blob/master/LICENSE)
 
 ## ✨ Acknowledgements
 
-Thanks goes to these wonderful people 🎉
-
-<table><tr><td align="center"><a href="https://github.com/madhuakula"><img alt="madhuakula" src="https://avatars.githubusercontent.com/u/6764192?v=4" width="100" /><br />madhuakula</a></td><td align="center"><a href="https://github.com/mkcn"><img alt="mkcn" src="https://avatars.githubusercontent.com/u/7307955?v=4" width="100" /><br />mkcn</a></td><td align="center"><a href="https://github.com/macagr"><img alt="macagr" src="https://avatars.githubusercontent.com/u/2797772?v=4" width="100" /><br />macagr</a></td><td align="center"><a href="https://github.com/rewanthtammana"><img alt="rewanthtammana" src="https://avatars.githubusercontent.com/u/22347290?v=4" width="100" /><br />rewanthtammana</a></td><td align="center"><a href="https://github.com/avicoder"><img alt="avicoder" src="https://avatars.githubusercontent.com/u/2093260?v=4" width="100" /><br />avicoder</a></td><td align="center"><a href="https://github.com/NF997"><img alt="NF997" src="https://avatars.githubusercontent.com/u/23374308?v=4" width="100" /><br />NF997</a></td></tr><tr><td align="center"><a href="https://github.com/smoyer64"><img alt="smoyer64" src="https://avatars.githubusercontent.com/u/328333?v=4" width="100" /><br />smoyer64</a></td><td align="center"><a href="https://github.com/wurstbrot"><img alt="wurstbrot" src="https://avatars.githubusercontent.com/u/955192?v=4" width="100" /><br />wurstbrot</a></td><td align="center"><a href="https://github.com/podjackel"><img alt="podjackel" src="https://avatars.githubusercontent.com/u/5067183?v=4" width="100" /><br />podjackel</a></td><td align="center"><a href="https://github.com/ant4g0nist"><img alt="ant4g0nist" src="https://avatars.githubusercontent.com/u/3500559?v=4" width="100" /><br />ant4g0nist</a></td></tr></table>
+Thanks go to these wonderful people 🎉
+
+<table>
+    <tr>
+        <td align="center"><a href="https://github.com/madhuakula"><img alt="madhuakula"
+                    src="https://avatars.githubusercontent.com/u/6764192?v=4" width="100" /><br />madhuakula</a></td>
+        <td align="center"><a href="https://github.com/apvarun"><img alt="apvarun"
+                    src="https://avatars.githubusercontent.com/u/8411309?v=4" width="100" /><br />apvarun</a></td>
+        <td align="center"><a href="https://github.com/mkcn"><img alt="mkcn"
+                    src="https://avatars.githubusercontent.com/u/7307955?v=4" width="100" /><br />mkcn</a></td>
+        <td align="center"><a href="https://github.com/macagr"><img alt="macagr"
+                    src="https://avatars.githubusercontent.com/u/2797772?v=4" width="100" /><br />macagr</a></td>
+        <td align="center"><a href="https://github.com/rewanthtammana"><img alt="rewanthtammana"
+                    src="https://avatars.githubusercontent.com/u/22347290?v=4" width="100" /><br />rewanthtammana</a>
+        </td>
+        <td align="center"><a href="https://github.com/avicoder"><img alt="avicoder"
+                    src="https://avatars.githubusercontent.com/u/2093260?v=4" width="100" /><br />avicoder</a></td>
+    </tr>
+    <tr>
+        <td align="center"><a href="https://github.com/NF997"><img alt="NF997"
+                    src="https://avatars.githubusercontent.com/u/23374308?v=4" width="100" /><br />NF997</a></td>
+        <td align="center"><a href="https://github.com/smoyer64"><img alt="smoyer64"
+                    src="https://avatars.githubusercontent.com/u/328333?v=4" width="100" /><br />smoyer64</a></td>
+        <td align="center"><a href="https://github.com/wurstbrot"><img alt="wurstbrot"
+                    src="https://avatars.githubusercontent.com/u/955192?v=4" width="100" /><br />wurstbrot</a></td>
+        <td align="center"><a href="https://github.com/podjackel"><img alt="podjackel"
+                    src="https://avatars.githubusercontent.com/u/5067183?v=4" width="100" /><br />podjackel</a></td>
+        <td align="center"><a href="https://github.com/ant4g0nist"><img alt="ant4g0nist"
+                    src="https://avatars.githubusercontent.com/u/3500559?v=4" width="100" /><br />ant4g0nist</a></td>
+    </tr>
+</table>

guide/.gitignore

@@ -1 +1,20 @@
-book
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

guide/README.md

@@ -0,0 +1,67 @@
+<p align="center">
+   <br/>
+   <a href="https://github.com/madhuakula/kubernetes-goat" target="_blank"><img width="150px" src="https://raw.githubusercontent.com/madhuakula/kubernetes-goat/master/kubernetes-goat-logo.png" /></a>
+   <h3 align="center">Kubernetes Goat</h3>
+   <p align="center">Interactive Kubernetes Security Learning Playground</p>
+   <p align="center">
+    The Kubernetes Goat is designed to be an intentionally vulnerable cluster environment to learn and practice Kubernetes security.
+   </p>
+
+   <p align="center">
+        <a href="https://app.netlify.com/sites/kubernetes-goat/deploys">
+            <img alt="Netlify Status" src="https://api.netlify.com/api/v1/badges/e5399be3-9c47-4557-b237-9e6c89f6cada/deploy-status" />
+        </a>    
+        <a href="https://github.com/madhuakula/kubernetes-goat/blob/master/LICENSE">
+            <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg" />
+        </a>    
+        <a href="https://github.com/madhuakula/kubernetes-goat/releases/latest">
+            <img alt="GitHub release" src="https://img.shields.io/github/release/madhuakula/kubernetes-goat.svg" />
+        </a>    
+        <a href="https://github.com/madhuakula/kubernetes-goat/stargazers">
+            <img alt="Github Stars" src="https://img.shields.io/github/stars/madhuakula/kubernetes-goat" />
+        </a>    
+        <a href="https://github.com/madhuakula/kubernetes-goat/pulls">
+            <img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" />
+        </a>    
+        <a href="https://hub.docker.com/r/madhuakula/k8s-goat-system-monitor">
+            <img alt="Docker Pulls Kubernetes Goat" src="https://img.shields.io/docker/pulls/madhuakula/k8s-goat-system-monitor" />
+        </a>    
+        <a href="https://twitter.com/intent/tweet/?text=Kubernetes%20Goat,%20an%20intentionally%20vulnerable%20by%20design%20training%20platform%20to%20learn%20%23Kubernetes%20Security%20by%20%40madhuakula.%20Check%20it%20out%20&url=https://github.com/madhuakula/kubernetes-goat">
+            <img alt="Twitter" src="https://img.shields.io/twitter/url?url=https://github.com/madhuakula/kubernetes-goat" />
+        </a>    
+    </p>
+</p>
+
+## Overview
+
+This is the repository for the documentation page for Kubernetes Goat. This documentation site is based on the [Docusaurus](https://docusaurus.io) framework.
+
+## Getting Started
+
+To start a local environment of this project, please do the following.
+
+1. Clone the repository.
+
+```bash
+git clone https://github.com/madhuakula/kubernetes-goat.git
+```
+
+2. Navigate to the `docs` directory
+
+```bash
+cd docs
+```
+
+3. Install dependencies
+
+```bash
+npm install
+```
+
+3. Start the development server
+
+```bash
+yarn start
+```
+
+4. Navigate to [localhost:3000](http://localhost:3000) for accessing the Kubernetes Goat documentation locally

guide/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

guide/book.toml

@@ -0,0 +1,33 @@
+# 🙏 Acknowledgements
+
+Thanks goes to these wonderful people 🎉
+
+<table>
+    <tr>
+        <td align="center"><a href="https://github.com/madhuakula"><img alt="madhuakula"
+                    src="https://avatars.githubusercontent.com/u/6764192?v=4" width="100" /><br />madhuakula</a></td>
+        <td align="center"><a href="https://github.com/apvarun"><img alt="apvarun"
+                    src="https://avatars.githubusercontent.com/u/8411309?v=4" width="100" /><br />apvarun</a></td>
+        <td align="center"><a href="https://github.com/mkcn"><img alt="mkcn"
+                    src="https://avatars.githubusercontent.com/u/7307955?v=4" width="100" /><br />mkcn</a></td>
+        <td align="center"><a href="https://github.com/macagr"><img alt="macagr"
+                    src="https://avatars.githubusercontent.com/u/2797772?v=4" width="100" /><br />macagr</a></td>
+        <td align="center"><a href="https://github.com/rewanthtammana"><img alt="rewanthtammana"
+                    src="https://avatars.githubusercontent.com/u/22347290?v=4" width="100" /><br />rewanthtammana</a>
+        </td>
+        <td align="center"><a href="https://github.com/avicoder"><img alt="avicoder"
+                    src="https://avatars.githubusercontent.com/u/2093260?v=4" width="100" /><br />avicoder</a></td>
+    </tr>
+    <tr>
+        <td align="center"><a href="https://github.com/NF997"><img alt="NF997"
+                    src="https://avatars.githubusercontent.com/u/23374308?v=4" width="100" /><br />NF997</a></td>
+        <td align="center"><a href="https://github.com/smoyer64"><img alt="smoyer64"
+                    src="https://avatars.githubusercontent.com/u/328333?v=4" width="100" /><br />smoyer64</a></td>
+        <td align="center"><a href="https://github.com/wurstbrot"><img alt="wurstbrot"
+                    src="https://avatars.githubusercontent.com/u/955192?v=4" width="100" /><br />wurstbrot</a></td>
+        <td align="center"><a href="https://github.com/podjackel"><img alt="podjackel"
+                    src="https://avatars.githubusercontent.com/u/5067183?v=4" width="100" /><br />podjackel</a></td>
+        <td align="center"><a href="https://github.com/ant4g0nist"><img alt="ant4g0nist"
+                    src="https://avatars.githubusercontent.com/u/3500559?v=4" width="100" /><br />ant4g0nist</a></td>
+    </tr>
+</table>

guide/docs/acknowledgments.md

@@ -0,0 +1,5 @@
+# 📐 Kubernetes Goat Architecture
+
+The below diagram is a very high-level overview of the Kubernetes Goat architecture and its components generated by Weave scope. Kubernetes Goat contains various resources and components, we will be creating a detailed architecture soon.
+
+![](scenarios/images/kubernetes-goat-architecture.png)