building-envelope-data / metabase

Metabase of the product data network buildingenvelopedata.org
2 stars 3 forks source link

Create the diagrams of the Technikbriefing #164

Closed christoph-maurer closed 1 year ago

christoph-maurer commented 1 year ago

I have checkout out the branch improve-security. I don't find images. I ran make diagrams, but it stops in between.

christoph@de14278:~/Documents/building-envelope-data/metabase$ make diagrams
docker run -it --rm -p 9090:8080 -v /home/christoph/Documents/building-envelope-data/metabase/diagrams:/usr/local/structurizr structurizr/lite
2023-05-23T08:24:31.994Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Starting StructurizrLite using Java 17.0.5 with PID 1 (/usr/local/structurizr-lite.war started by root in /)
2023-05-23T08:24:31.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : No active profile set, falling back to 1 default profile: "default"
2023-05-23T08:24:35.995Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Started StructurizrLite in 4.407 seconds (process running for 4.931)
2023-05-23T08:24:35.997Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : ***********************************************************************************
2023-05-23T08:24:35.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :   _____ _                   _              _          
2023-05-23T08:24:35.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :  / ____| |                 | |            (_)         
2023-05-23T08:24:35.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : | (___ | |_ _ __ _   _  ___| |_ _   _ _ __ _ _____ __ 
2023-05-23T08:24:35.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :  \___ \| __| '__| | | |/ __| __| | | | '__| |_  / '__|
2023-05-23T08:24:35.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :  ____) | |_| |  | |_| | (__| |_| |_| | |  | |/ /| |   
2023-05-23T08:24:35.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : |_____/ \__|_|   \__,_|\___|\__|\__,_|_|  |_/___|_|   
2023-05-23T08:24:35.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :                                                       
2023-05-23T08:24:35.998Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Structurizr Lite
2023-05-23T08:24:35.999Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :  - build: 3071 (2023-05-22T07:31:48Z
2023-05-23T08:24:36.000Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :  - structurizr-java: v1.24.1
2023-05-23T08:24:36.010Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :  - structurizr-dsl: v1.30.1
2023-05-23T08:24:36.010Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     :  - structurizr-import: v1.4.1
2023-05-23T08:24:36.011Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : 
2023-05-23T08:24:36.011Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Workspace path: /usr/local/structurizr
2023-05-23T08:24:36.011Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Workspace filename: workspace[.dsl|.json]
2023-05-23T08:24:36.011Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : URL: 
2023-05-23T08:24:36.011Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Auto-save interval: 5000ms
2023-05-23T08:24:36.011Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Auto-refresh interval: 0ms
2023-05-23T08:24:36.019Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : dot: available
2023-05-23T08:24:36.019Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : ***********************************************************************************
2023-05-23T08:24:36.019Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : MIT License
2023-05-23T08:24:36.019Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : 
2023-05-23T08:24:36.019Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Copyright (c) 2023 Structurizr Limited
2023-05-23T08:24:36.019Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : 
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : Permission is hereby granted, free of charge, to any person obtaining a copy
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : of this software and associated documentation files (the "Software"), to deal
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : in the Software without restriction, including without limitation the rights
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : copies of the Software, and to permit persons to whom the Software is
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : furnished to do so, subject to the following conditions:
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : 
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : The above copyright notice and this permission notice shall be included in all
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : copies or substantial portions of the Software.
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : 
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : SOFTWARE.
2023-05-23T08:24:36.020Z  INFO 1 --- [           main] com.structurizr.lite.StructurizrLite     : ***********************************************************************************
christoph-maurer commented 1 year ago

I was able to export the plantuml diagrams with the plantuml extension of vscode. I was able to export the structurizr dsl diagram with https://structurizr.com/dsl . I upload the structurizr diagram to the section Technikbriefing of the EQWIN-P file server.

simon-wacker commented 1 year ago

Well, make diagrams does not stop in between. It runs the structurizr light web server and waits for web requests under localhost:9090. So just open that URL in a web browser and you will see the interactive diagrams. It is also possible to export the diagrams in the web app, for example, as PlantUML files. The web app is local light version of the one running under https://structurizr.com/dsl The current set-up still needs to be cleaned-up and documented --- I just made it work for the meeting. Maybe using structurizr is not a good idea in the first place. I like that they support different abstraction levels in the same declarative description of the set-up with the possibilities to add different views following the c4 model. I don't like that the kind of relationships and how they are displayed is very limited compared to PlantUML.

christoph-maurer commented 1 year ago

Thank you, @simon-wacker !