docs(README.md): add README.md

heumsi · Jan 27, 2023 · 175587b · 175587b
1 parent 97bbe44
commit 175587b
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Hollys
+
+Web UI for node discovery in Kubernetes
+
+## Motivation
+
+There are too many nodes in the cluster. There are also too many labels and taints attached to each node.
+
+How to easily find nodes with specific labels and taints? How can you share these discovered nodes with other members of your team?
+
+I started developing Hollys to solve this problem.
+
+## Features
+
+- You can retrieve a list of nodes based on labels and taints.
+- You can save the list of nodes searched in this way.
+
+![1.png](assets/1.png)
+
+![2.png](assets/2.png)
+
+## Installation
+
+```bash
+$ git clone [email protected]:heumsi/hollys.git
+$ cd chart
+$ helm install hollys . --set ingress.host.ui="YOUR_UI_DOMAIN" --set ingress.host.api="YOUR_API_DOMAIN"
+```
diff --git a/assets/1.png b/assets/1.png
diff --git a/assets/2.png b/assets/2.png
diff --git a/poetry.lock b/poetry.lock
diff --git a/requirements.txt b/requirements.txt
@@ -44,5 +44,5 @@ typer==0.4.2 ; python_version >= "3.11" and python_version < "4.0"
 typing-extensions==4.4.0 ; python_version >= "3.11" and python_version < "4.0"
 urllib3==1.26.14 ; python_version >= "3.11" and python_version < "4.0"
 uvicorn==0.20.0 ; python_version >= "3.11" and python_version < "4.0"
-websocket-client==1.4.2 ; python_version >= "3.11" and python_version < "4.0"
+websocket-client==1.5.0 ; python_version >= "3.11" and python_version < "4.0"
 websockets==10.4 ; python_version >= "3.11" and python_version < "4.0"