kovagoadi/hunfabric
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update src/README.md for Network Dashboard (#1060)

Browse Source 
* Update src/README.md for Network Dashboard

Proposing some small updates to src/README.md file for the Network Dashboard

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: Ludovico Magnocavallo <ludomagno@google.com>
This commit is contained in:
Aurélien Legrand
2022-12-21 16:30:09 +01:00
committed by GitHub
parent 0d7243979b
commit 7acb6b3747
1 changed files with 20 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
blueprints/cloud-operations/network-dashboard/src/README.md
View File

@@ -18,21 +18,21 @@ Usage: main.py [OPTIONS]
CLI entry point.
Options:
-dr, --discovery-root TEXT Root node for asset discovery,
organizations/nnn or folders/nnn. [required]
-op, --monitoring-project TEXT GCP monitoring project where metrics will be
stored. [required]
-p, --project TEXT GCP project id, can be specified multiple
times.
-f, --folder INTEGER GCP folder id, can be specified multiple
times.
--custom-quota-file FILENAME Custom quota file in yaml format.
--dump-file FILENAME Export JSON representation of resources to
file.
--load-file FILENAME Load JSON resources from file, skips init and
discovery.
--debug-plugin TEXT Run only core and specified timeseries plugin.
--help Show this message and exit.
-dr, --discovery-root TEXT Root node for asset discovery,
organizations/nnn or folders/nnn. [required]
-mon, --monitoring-project TEXT GCP monitoring project where metrics will be
stored. [required]
-p, --project TEXT GCP project id to be monitored, can be specified multiple
times.
-f, --folder INTEGER GCP folder id to be monitored, can be specified multiple
times.
--custom-quota-file FILENAME Custom quota file in yaml format.
--dump-file FILENAME Export JSON representation of resources to
file.
--load-file FILENAME Load JSON resources from file, skips init and
discovery.
--debug-plugin TEXT Run only core and specified timeseries plugin.
--help Show this message and exit.
```
In normal use three pieces of information need to be passed in:
@@ -75,6 +75,11 @@ The main module cycles through stages, calling stage plugins in succession itera
## Debugging and Troubleshooting
Note that python version > 3.8 is required.
If you run into a `ModuleNotFoundError`, install the required dependencies:
`pip3 install -r requirements.txt`
A few convenience options are provided to simplify development, debugging and troubleshooting:
- the discovery phase results can be dumped to a JSON file, that can then be used to check actual resource representation, or skip the discovery phase entirely to speed up development of timeseries-related functions