Added CLI outputs

Kavinraja-G · Sep 17, 2023 · 57a676e · 57a676e
1 parent 784ed9e
commit 57a676e
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 105 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 # node-gizmo
-A CLI utility for your Kubernetes nodes
+A CLI utility for your Kubernetes nodes.
 
 ### Features
-- Generic node related information
+##### nodegizmo node
+Generic node related information
   - NodeName
   - K8sVersion
   - Image
@@ -11,16 +12,28 @@ A CLI utility for your Kubernetes nodes
   - Taints
   - Node Provider (AWS/Azure/GCP)
   - Topology info (Region & Zone)
-- Node Capacity information
+<p align="center"><img src="/assets/nodegizmo-node.png" alt="Nodegizmo node "/></p>
+
+##### nodegizmo node capacity
+Node Capacity information
   - CPU
   - Memory
   - Disk
   - Ephemeral storage
   - Pod capacities
 - Nodepool related information
+<p align="center"><img src="/assets/nodegizmo-node-cp.png" alt="Nodegizmo node "/></p>
+
+##### nodegizmo nodepool
+Nodepool related information
   - Grouped by NodePool ID
   - Node list
   - Topology info (Region & Zone)
   - Instance type
   - Nodepool provider (supported: EKS/AKS/GKE)
-- Exec into any node by spawning a `nsenter` pod automatically based on the node selection
+<p align="center"><img src="/assets/nodegizmo-nodepool.png" alt="Nodegizmo node "/></p>
+
+##### nodegizmo node exec nodeName
+> Note: This feature is still in beta
+
+Exec into any node by spawning a `nsenter` pod automatically based on the node selection.
diff --git a/assets/nodegizmo-node-cp.png b/assets/nodegizmo-node-cp.png
diff --git a/assets/nodegizmo-node.png b/assets/nodegizmo-node.png
diff --git a/assets/nodegizmo-nodepool.png b/assets/nodegizmo-nodepool.png
diff --git a/docs/nodegizmo.md b/docs/nodegizmo.md
diff --git a/docs/nodegizmo_node.md b/docs/nodegizmo_node.md
diff --git a/docs/nodegizmo_node_capacity.md b/docs/nodegizmo_node_capacity.md
diff --git a/docs/nodegizmo_node_exec.md b/docs/nodegizmo_node_exec.md
diff --git a/docs/nodegizmo_nodepool.md b/docs/nodegizmo_nodepool.md