diff --git a/docs/source/index.rst b/docs/source/index.rst index 9c2aca8206114c6708ef485b1ba1de22cf9cf27e..0c9837ac08cab04aeb2560d2931eb881aaee8d07 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,5 +12,5 @@ GÉANT Mapping Provider documentation :caption: Contents: api - planning + planning/index diff --git a/docs/source/diagrams.drawio b/docs/source/planning/design.drawio similarity index 100% rename from docs/source/diagrams.drawio rename to docs/source/planning/design.drawio diff --git a/docs/source/planning.rst b/docs/source/planning/hld.rst similarity index 56% rename from docs/source/planning.rst rename to docs/source/planning/hld.rst index 9b8be646e58b65e90260a07234704a78c168f85f..e4daf0c21f0af52da8ed29c7432d25e37c8ddda1 100644 --- a/docs/source/planning.rst +++ b/docs/source/planning/hld.rst @@ -1,4 +1,4 @@ -Planning, Design, etc +High-Level Design ===================================== .. contents:: Contents @@ -34,80 +34,13 @@ Ideas - For the Geant-managed heat maps: maybe nice to agree upon a simple grid-locked geo-node/edge approach -Some R&E Samples ----------------- - -- ESNet - Netsage - - - https://portal.netsage.global - - https://www.netsage.global - - https://github.com/GlobalNOC/globalnoc-networkmap-panel - - https://grafana.com/grafana/plugins/esnet-networkmap-panel/ - - https://github.com/esnet/grafana-esnet-networkmap-panel/tree/main - -- Jisc - Netsight3 - - - https://www.jisc.ac.uk/netsight - - https://netsight3.ja.net/help/ - -- SURF Netwerk Dashboard - - - https://netwerkdashboard.surfnet.nl/ - -- Reannz weathermap: - - - https://weathermap.reannz.co.nz/ - -- Funet network load map: - - - https://netmap.funet.fi/ - -- NORDUnet: - - - https://stats.nordu.net/stat-q/load-map/ndn-map,,traffic,peak - -- Pionier/PSNC: - - - https://pionier.net.pl/en/about-pionier/#interaktywna_mapa_sieci_pionier - -- Timemap (WP6, mainly GARR) - - - https://timemap.geant.org/ - - https://gitlab.geant.org/fabio.farina/timemap (New link https://gitlab.software.geant.org/fabio.farina/timemap ) - -Misc Internal things --------------------- - -- IS/IS-driven: http://netdash.geant.net:8080/static/isis/geantISIS.svg -- Intermapper - - - https://weathermap.geant.org/g59bce200/document/_/!index.html?REFRESH=10+Seconds - -- ULAKBIM - - - https://stat.ulakbim.gov.tr/ulaknet/ - - -NRENS with their network info ------------------------------- - -.. include:: nren-maps.html - - -FrontEnd Technologies worth exploring --------------------------------------- - -- Openlayers : https://openlayers.org/ -- Leaflet : https://leafletjs.com/ -- GeoJson : https://geojson.io/#map=3.53/43.52/6.81 - High-Level Architecture ------------------------- .. only:: drawio - .. drawio-image:: diagrams.drawio + .. drawio-image:: design.drawio :page-name: hl-arch Design/Edit concerns for subway map @@ -135,7 +68,9 @@ Design/Edit concerns for subway map - front end will update svg based on mapping-provider overlay data +FrontEnd Technologies worth exploring +-------------------------------------- - - - +- Openlayers : https://openlayers.org/ +- Leaflet : https://leafletjs.com/ +- GeoJson : https://geojson.io/#map=3.53/43.52/6.81 diff --git a/docs/source/planning/index.rst b/docs/source/planning/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..61ebd9f82ca52713a9f7a6a8a9fe25efb59dd866 --- /dev/null +++ b/docs/source/planning/index.rst @@ -0,0 +1,10 @@ +Planning, Design, etc +===================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + survey + hld + planning diff --git a/docs/source/nren-maps.html b/docs/source/planning/nren-maps.html similarity index 100% rename from docs/source/nren-maps.html rename to docs/source/planning/nren-maps.html diff --git a/docs/source/planning/planning.rst b/docs/source/planning/planning.rst new file mode 100644 index 0000000000000000000000000000000000000000..551107606f665dca39812c99e4a2fd04ef2e7226 --- /dev/null +++ b/docs/source/planning/planning.rst @@ -0,0 +1,20 @@ +Planning Milestones +===================================== + +.. contents:: Contents + :depth: 4 + :local: + + +Availability POC +--------------------- + +- mapping provider should + + - be deployed on test, uat, prod with a standard release pipeline + - serve some api's that give lists of routers, sites, trunks + - serve some api that gives availabilituy of each trunk + +- some mapping between human-readable trunk names and scid's +- some simple svg that allows edge styles to be updated based on availability +- Jira Version: `AVAILABILITY_POC <https://jira.software.geant.org/secure/RapidBoard.jspa?rapidView=126&projectKey=NGM&view=planning.nodetail&versions=visible&issueLimit=100&selectedVersion=12800#>`_ diff --git a/docs/source/planning/survey.rst b/docs/source/planning/survey.rst new file mode 100644 index 0000000000000000000000000000000000000000..b396e4a7560a91303c74f7099ac56e9d9dc5c797 --- /dev/null +++ b/docs/source/planning/survey.rst @@ -0,0 +1,65 @@ +Surveys of Existing Projects +===================================== + +.. contents:: Contents + :depth: 4 + :local: + +Some R&E Samples +---------------- + +- ESNet - Netsage + + - https://portal.netsage.global + - https://www.netsage.global + - https://github.com/GlobalNOC/globalnoc-networkmap-panel + - https://grafana.com/grafana/plugins/esnet-networkmap-panel/ + - https://github.com/esnet/grafana-esnet-networkmap-panel/tree/main + +- Jisc - Netsight3 + + - https://www.jisc.ac.uk/netsight + - https://netsight3.ja.net/help/ + +- SURF Netwerk Dashboard + + - https://netwerkdashboard.surfnet.nl/ + +- Reannz weathermap: + + - https://weathermap.reannz.co.nz/ + +- Funet network load map: + + - https://netmap.funet.fi/ + +- NORDUnet: + + - https://stats.nordu.net/stat-q/load-map/ndn-map,,traffic,peak + +- Pionier/PSNC: + + - https://pionier.net.pl/en/about-pionier/#interaktywna_mapa_sieci_pionier + +- Timemap (WP6, mainly GARR) + + - https://timemap.geant.org/ + - https://gitlab.geant.org/fabio.farina/timemap (New link https://gitlab.software.geant.org/fabio.farina/timemap ) + +Misc Internal things +-------------------- + +- IS/IS-driven: http://netdash.geant.net:8080/static/isis/geantISIS.svg +- Intermapper + + - https://weathermap.geant.org/g59bce200/document/_/!index.html?REFRESH=10+Seconds + +- ULAKBIM + + - https://stat.ulakbim.gov.tr/ulaknet/ + + +NRENS with their network info +------------------------------ + +.. include:: nren-maps.html