Skip to content
Snippets Groups Projects
Commit e6a820bf authored by Jenkins's avatar Jenkins
Browse files

Finished release 0.5.

parents 966169b9 526905f1
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Changelog.md
+ 3
− 0
View file @ e6a820bf
...@@ -2,6 +2,9 @@ ...@@ -2,6 +2,9 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [0.5] - 2025-07-02
- added some additional doc notes
## [0.4] - 2025-07-02 ## [0.4] - 2025-07-02
- Served svg file in an html page - Served svg file in an html page
- Implemented the map based on Avalability/utilization - Implemented the map based on Avalability/utilization
......
docs/source/planning/background.rst 0 → 100644
+ 10
− 0
View file @ e6a820bf
Background
=====================================
.. toctree::
:maxdepth: 2
:caption: Contents:
survey
hld
planning
docs/source/planning/design.drawio
+ 183
− 1
View file @ e6a820bf
<mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/26.0.9 Chrome/128.0.6613.186 Electron/32.2.5 Safari/537.36" version="26.0.9" pages="3"> <mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/26.0.9 Chrome/128.0.6613.186 Electron/32.2.5 Safari/537.36" version="26.0.9" pages="5">
<diagram name="hl-arch" id="52Qc7nEq3IphXZwXqFKS"> <diagram name="hl-arch" id="52Qc7nEq3IphXZwXqFKS">
<mxGraphModel dx="1841" dy="664" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0"> <mxGraphModel dx="1841" dy="664" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root> <root>
...@@ -263,4 +263,186 @@ ...@@ -263,4 +263,186 @@
</root> </root>
</mxGraphModel> </mxGraphModel>
</diagram> </diagram>
<diagram id="kfA5MR3n9pPgTnvNry2c" name="poc-arch">
<mxGraphModel dx="1841" dy="664" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-1" value="swd-map0x" style="rounded=0;whiteSpace=wrap;html=1;dashed=1;fillColor=#dae8fc;strokeColor=#6c8ebf;verticalAlign=bottom;align=right;spacingRight=5;" vertex="1" parent="1">
<mxGeometry x="110" y="30" width="240" height="240" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-4" value="mapping&lt;div&gt;provider&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="170" y="170" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-5" value="GSO" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="460" y="50" width="110" height="60" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-6" value="" style="endArrow=none;startArrow=classic;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;startFill=1;" edge="1" parent="1" target="ZFyNg1bx-ewA3zWwpM4f-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint y="200" as="sourcePoint" />
<mxPoint x="160" y="210" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-7" value="HTTP" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="50" y="175" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-14" value="" style="endArrow=classic;html=1;rounded=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="ZFyNg1bx-ewA3zWwpM4f-5" target="ZFyNg1bx-ewA3zWwpM4f-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="170" y="230" as="sourcePoint" />
<mxPoint x="480" y="200" as="targetPoint" />
<Array as="points">
<mxPoint x="420" y="80" />
<mxPoint x="420" y="200" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-15" value="Inventory Provider" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="460" y="130" width="110" height="60" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-16" value="Dashboard" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="1">
<mxGeometry x="460" y="205" width="110" height="60" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-17" value="BRIAN (InfluxDB)" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="1">
<mxGeometry x="460" y="280" width="110" height="60" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-18" value="" style="endArrow=classic;html=1;rounded=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="ZFyNg1bx-ewA3zWwpM4f-17" target="ZFyNg1bx-ewA3zWwpM4f-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="470" y="90" as="sourcePoint" />
<mxPoint x="300" y="210" as="targetPoint" />
<Array as="points">
<mxPoint x="420" y="310" />
<mxPoint x="420" y="200" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-19" value="" style="endArrow=classic;html=1;rounded=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="ZFyNg1bx-ewA3zWwpM4f-15" target="ZFyNg1bx-ewA3zWwpM4f-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="470" y="90" as="sourcePoint" />
<mxPoint x="300" y="210" as="targetPoint" />
<Array as="points">
<mxPoint x="420" y="160" />
<mxPoint x="420" y="200" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-20" value="" style="endArrow=classic;html=1;rounded=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="ZFyNg1bx-ewA3zWwpM4f-16" target="ZFyNg1bx-ewA3zWwpM4f-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="470" y="170" as="sourcePoint" />
<mxPoint x="300" y="210" as="targetPoint" />
<Array as="points">
<mxPoint x="420" y="235" />
<mxPoint x="420" y="200" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-21" value="cache/state" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;" vertex="1" parent="1">
<mxGeometry x="170" y="50" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-22" value="" style="endArrow=none;html=1;rounded=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;entryPerimeter=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;fillColor=#0050ef;strokeColor=#001DBC;" edge="1" parent="1" source="ZFyNg1bx-ewA3zWwpM4f-4" target="ZFyNg1bx-ewA3zWwpM4f-21">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="170" y="190" as="sourcePoint" />
<mxPoint x="220" y="140" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-26" value="" style="endArrow=none;startArrow=classic;html=1;rounded=0;startFill=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;endFill=1;dashed=1;" edge="1" parent="1" source="ZFyNg1bx-ewA3zWwpM4f-29" target="ZFyNg1bx-ewA3zWwpM4f-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="-60" y="270" as="sourcePoint" />
<mxPoint x="90" y="320" as="targetPoint" />
<Array as="points">
<mxPoint x="-40" y="310" />
<mxPoint x="230" y="310" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-27" value="HTMX" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="60" y="310" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="ZFyNg1bx-ewA3zWwpM4f-29" value="" style="verticalLabelPosition=bottom;sketch=0;aspect=fixed;html=1;verticalAlign=top;strokeColor=none;align=center;outlineConnect=0;shape=mxgraph.citrix.browser;" vertex="1" parent="1">
<mxGeometry x="-79" y="140" width="78.62" height="120" as="geometry" />
</mxCell>
<mxCell id="6UzafsUfYQoju74TV4en-2" value="" style="sketch=0;pointerEvents=1;shadow=0;dashed=0;html=1;strokeColor=none;fillColor=#505050;labelPosition=center;verticalLabelPosition=bottom;verticalAlign=top;outlineConnect=0;align=center;shape=mxgraph.office.concepts.clock;" vertex="1" parent="1">
<mxGeometry x="-79" y="300" width="30" height="30" as="geometry" />
</mxCell>
<mxCell id="6UzafsUfYQoju74TV4en-3" value="" style="sketch=0;pointerEvents=1;shadow=0;dashed=0;html=1;strokeColor=none;fillColor=#505050;labelPosition=center;verticalLabelPosition=bottom;verticalAlign=top;outlineConnect=0;align=center;shape=mxgraph.office.concepts.clock;" vertex="1" parent="1">
<mxGeometry x="370" y="205" width="30" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
<diagram id="kynwZhUBZVw6visI0Zuu" name="maintenance-flow">
<mxGraphModel dx="1014" dy="664" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="Wferz5sOjQA9AiYDeivi-14" value="" style="rounded=1;whiteSpace=wrap;html=1;dashed=1;dashPattern=8 8;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" vertex="1" parent="1">
<mxGeometry x="120" y="290" width="260" height="170" as="geometry" />
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-3" value="new pop/router/service" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="125" y="130" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-4" value="new version&lt;div&gt;mapping provider&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="265" y="630" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-9" value="SM/NOC/etc" style="shape=umlActor;verticalLabelPosition=bottom;verticalAlign=top;html=1;outlineConnect=0;" vertex="1" parent="1">
<mxGeometry x="170" y="330" width="30" height="60" as="geometry" />
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-12" value="Design" style="shape=umlActor;verticalLabelPosition=bottom;verticalAlign=top;html=1;outlineConnect=0;" vertex="1" parent="1">
<mxGeometry x="310" y="330" width="30" height="60" as="geometry" />
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-15" value="" style="endArrow=classic;html=1;rounded=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;entryPerimeter=0;" edge="1" parent="1" source="Wferz5sOjQA9AiYDeivi-3" target="Wferz5sOjQA9AiYDeivi-9">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="320" y="360" as="sourcePoint" />
<mxPoint x="370" y="310" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-16" value="" style="endArrow=classic;startArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="Wferz5sOjQA9AiYDeivi-12">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="320" y="360" as="sourcePoint" />
<mxPoint x="200" y="360" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-17" value="new&lt;div&gt;svg&lt;/div&gt;" style="whiteSpace=wrap;html=1;shape=mxgraph.basic.document" vertex="1" parent="1">
<mxGeometry x="287" y="500" width="76" height="70" as="geometry" />
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-18" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;entryPerimeter=0;" edge="1" parent="1" target="Wferz5sOjQA9AiYDeivi-17">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="325" y="410" as="sourcePoint" />
<mxPoint x="195" y="340" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-19" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="Wferz5sOjQA9AiYDeivi-17" target="Wferz5sOjQA9AiYDeivi-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="325" y="580" as="sourcePoint" />
<mxPoint x="335" y="525" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-20" value="" style="endArrow=classic;html=1;rounded=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;dashed=1;" edge="1" parent="1" source="Wferz5sOjQA9AiYDeivi-3" target="Wferz5sOjQA9AiYDeivi-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="370" y="470" as="sourcePoint" />
<mxPoint x="420" y="420" as="targetPoint" />
<Array as="points">
<mxPoint x="40" y="160" />
<mxPoint x="40" y="660" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-22" value="" style="endArrow=classic;html=1;rounded=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;dashed=1;" edge="1" parent="1" source="Wferz5sOjQA9AiYDeivi-4" target="Wferz5sOjQA9AiYDeivi-12">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="370" y="460" as="sourcePoint" />
<mxPoint x="350" y="360" as="targetPoint" />
<Array as="points">
<mxPoint x="520" y="660" />
<mxPoint x="520" y="360" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-24" value="&lt;i&gt;topology updates&lt;/i&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="80" y="656" width="120" height="30" as="geometry" />
</mxCell>
<mxCell id="Wferz5sOjQA9AiYDeivi-29" value="&lt;i&gt;map elements/keys&lt;/i&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="400" y="656" width="120" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile> </mxfile>
docs/source/planning/index.rst
+ 2
− 3
View file @ e6a820bf
...@@ -5,6 +5,5 @@ Planning, Design, etc ...@@ -5,6 +5,5 @@ Planning, Design, etc
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
survey poc
hld background
planning
docs/source/planning/poc.rst 0 → 100644
+ 60
− 0
View file @ e6a820bf
POC Design/Approach
=====================================
.. contents:: Contents
:depth: 4
:local:
High-Level Architecture
-------------------------------
.. only:: drawio
.. drawio-image:: design.drawio
:page-name: poc-arch
Mapping Provider updates itself with
static & dynamic data from various sources.
It then serves the baseline
map via HTTP and updates with dynamic overlay data.
Design-based Map Maintenance
-------------------------------------
.. only:: drawio
.. drawio-image:: design.drawio
:page-name: maintenance-flow
SM/NOC/other stakeholders can request map
changes from the design team. SWD can supply
the design team with any new/modified map
keys that must be written into svg elements
for overlay updates. The new baseline SVG is written
into the Mapping Provider service and deployed.
Next Steps ...
-------------------------------------
* Interactivity improvements
* switching between overlays
* details/popups
* others ideas ...
* New Maps
* Other service types, optical, etc.
* Real topology
* routers vs sites?
* sites with multiple equipment
* circuits between equipment, same site\
* ...?
pyproject.toml
+ 1
− 1
View file @ e6a820bf
...@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" ...@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "mapping-provider" name = "mapping-provider"
version = "0.4" version = "0.5"
description = "A webservice providing information for GEANT maps." description = "A webservice providing information for GEANT maps."
authors = [ authors = [
{name = "GÉANT", email = "swd@geant.org"} {name = "GÉANT", email = "swd@geant.org"}
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment