Merge pull request #113 from solo-io/improved-parsing

Improved parsing

Author: willowmck

README.md

@@ -25,7 +25,7 @@ Each section below contains it's own README and associated links, please feel fr
 
 - [Useful Tools](tools/)
     - [Image List for Air-gap Install of Gloo Mesh Enterprise](tools/airgap-install/README.md)
-    - [Istio Bug-report CRD Parser](tools/crd_parser/README.md)
+    - [Istio Bug-report CRD Parser](tools/ibrp/README.md)
     - [Datadog Integration](tools/datadog/README.md)
     - [Istio Performance Grafana Dashboard Example](tools/grafana/README.md)
     - [Bombardier Load Generator](tools/loadgenerator/bombardier-loadgen)

tools/README.md

@@ -3,7 +3,7 @@
 Tooling that can ease/assist with Gloo Mesh onboarding and troubleshooting as well as Day 2 tasks
 
 - Air-gap Installation Image List
-- Istio bug-report crd parser
+- [Istio bug-report parser](ibrp/README.md)
 - Datadog Integration
 - Istio Performance Grafana Dashboard Example
 - Load Generator tools

tools/crd_parser/.gitignore

@@ -0,0 +1 @@
+_version.py export-subst

tools/crd_parser/README.md

@@ -0,0 +1,5 @@
+venv
+.idea
+build
+dist
+*.spec

tools/crd_parser/crd_parser.py

@@ -0,0 +1,7 @@
+Copyright 2023 Solo, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tools/crd_parser/requirements.txt

@@ -0,0 +1,30 @@
+# Istio Bug Report Parser
+
+A simple Python script to assist with parsing various aspects of the istioctl bug-report output.
+
+Currently, this script can parse custom resources and nodes.
+
+To parse CRs, this script depends on the standard input of a list of CRs under the heading 'items'.  If this is not 
+found, the script will fail.
+
+## Dependencies
+Make sure you have Python3 enabled in your path.
+
+You will need to `pip install pyyaml`.
+
+## Running 
+
+```commandline
+python3 ibrp.py <operation> <path-to-your-crd-file>
+```
+
+Operation will be either 'crparse' or 'nodeparse'.  
+
+### Parsing CRs
+Output will go to the crs directory as a child of the current directory.  Each type of custom resource will be created
+in a directory named by the type of CR.
+
+Note that for production workloads, parsing can take a few minutes.  The script will provide output on progress.
+
+### Parsing Nodes
+Nodes will be parsed to capture the name, roles and cpus.  Output will be sent to stdout.