Skip to content
Snippets Groups Projects
Commit aacb1e57 authored by Robert Drab's avatar Robert Drab Committed by Zbigniew Bodek
Browse files

Changing from graphics to embedded plantuml code


Leveraging diagrams auto generation from embedded plantuml code

Signed-off-by: default avatarRobert Drab <robert.drab@huawei.com>
parent 925b0ae5
No related branches found
No related tags found
No related merge requests found
...@@ -117,5 +117,26 @@ Decisions are discussed within MR of a given decision md file. ...@@ -117,5 +117,26 @@ Decisions are discussed within MR of a given decision md file.
## meta-ohos overview ## meta-ohos overview
![meta-ohos system context diagram](./diagrams/meta-ohos_system_context_diagram.svg) **OpenHarmony** is a distributed OS that is designed to run atop variety of OS kernels
ranging from RTOSs to Linux.
**meta-ohos** is a _umbrella_ meta layer containing all layers required to build
**OpenHarmony** Image basing on existing kernel meta-layers.
```plantuml
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/release/1-0/C4_Context.puml
Person(dev, "Developer", "Anyone willing to build the OHOS based image")
System(meta_ohos, "meta-ohos", "Open Harmony OS umbrella bitbake meta-layer")
System_Ext(yocto, "yocto-poky", "distro scaffolding: predefined meta-data, bitbake build system")
System_Ext(meta_zephyr, "meta-zephyr", "ZephyrOS meta-layer")
System_Ext(meta_freertos, "meta-freertos", "FreeRTOS meta-layer")
Rel(dev, yocto, "selects configuration, initiates the build, deploys image to the target")
Rel(yocto, meta_ohos, "incorporates meta-layers relevant for selected kernel / configuration")
Rel(yocto, yocto, "Using meta-poky for OHOS on Poky build")
Rel(yocto, meta_zephyr, "incorporates for OHOS on Zephyr build")
Rel(yocto, meta_freertos, "incorporates for OHOS on FreeRTOS build")
```
@startuml 0001-meta-openharmony-zephyr-build-sequence-diagram
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/release/1-0/C4_Container.puml
LAYOUT_AS_SKETCH()
Person(dev, "Developer", "Anyone willing to build the OHOS based image")
System_Boundary(meta_openharmonyn, "meta-openharmony") {
Container(meta_ohos_zephyr, "meta-ohos-zephyr", "meta-layer", "OHOS configuration / adaptation layer for Zephyr")
Container(meta_ohos_poky, "meta-ohos-poky", "meta-layer", "OHOS configuration / adaptation layer for Poky")
Container(meta_ohos_init, "meta-ohos-init", "meta-layer", "OHOS initialisation services for application devices")
Container(meta_ohos_init_lite, "meta-ohos-init-lite", "meta-layer", "OHOS initialisation services for uC-based devices")
Container(meta_ohos_softbus, "meta-ohos-softbus", "meta-layer", "OHOS softbus service for application devices")
Container(meta_ohos_softbus_lite, "meta-ohos-softbus-lite", "meta-layer", "OHOS softbus service for uC-based devices")
}
Container(meta_zephyr, "meta-zephyr", "meta-layer", "ZephyrOS meta-layer")
System_Ext(yocto, "yocto-poky", "distro scaffolding: predefined meta-data, bitbake build system")
Rel(dev, meta_ohos_zephyr, "1. selects OHOS Zephyr distribution", "environment shell script")
Rel(meta_ohos_zephyr, yocto, "2. sets up bitbake environment for OHOS Zephyr", "local.conf.sample, bblayers.conf.sample")
Rel(dev, yocto, "3. initiates the build", "bitbake")
Rel(yocto, meta_ohos_init_lite, "4. incorporates Zephyr-compatible OHOS layers")
Rel(yocto, meta_ohos_softbus_lite, "4. incorporates Zephyr-compatible OHOS layers")
Rel(yocto, meta_zephyr, "4. incorporates")
Lay_D(dev, yocto)
Lay_D(dev, meta_openharmonyn)
Lay_D(meta_ohos_zephyr, meta_ohos_init_lite)
Lay_D(meta_ohos_init_lite, meta_ohos_softbus_lite)
Lay_D(meta_zephyr, yocto)
@enduml
\ No newline at end of file
This diff is collapsed.
@startuml meta-ohos_system_context_diagram
!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/release/1-0/C4_Context.puml
Person(dev, "Developer", "Anyone willing to build the OHOS based image")
System(meta_openharmony, "meta-openharmony", "Open Harmony OS umbrella bitbake layer")
System_Ext(yocto, "yocto-poky", "distro scaffolding: predefined meta-data, bitbake build system")
Rel(dev, yocto, "selects configuration, initiates the build, deploys image to the target")
Rel(yocto, meta_openharmony, "incorporates")
@enduml
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="553px" preserveAspectRatio="none" style="width:266px;height:553px;" version="1.1" viewBox="0 0 266 553" width="266px" zoomAndPan="magnify"><defs/><g><!--entity dev--><rect fill="#08427B" height="101.4844" style="stroke: #073B6F; stroke-width: 1.5;" width="203" x="11.5" y="8"/><text fill="#FFFFFF" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="57" x="84.5" y="29.1387">«person»</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="90" x="68" y="46.8203">Developer</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="0" x="115" y="63.5889"/><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="179" x="21.5" y="79.8857">Anyone willing to build the</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="134" x="46" y="96.1826">OHOS based image</text><!--entity meta_openharmony--><rect fill="#1168BD" height="101.4844" style="stroke: #3C7FC0; stroke-width: 1.5;" width="214" x="6" y="441"/><text fill="#FFFFFF" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="57" x="84.5" y="462.1387">«system»</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="173" x="26.5" y="479.8203">meta-openharmony</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="0" x="115" y="496.5889"/><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="190" x="16" y="512.8857">Open Harmony OS umbrella</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="87" x="69.5" y="529.1826">bitbake layer</text><!--entity yocto--><rect fill="#999999" height="117.7813" style="stroke: #8A8A8A; stroke-width: 1.5;" width="177" x="24.5" y="246"/><text fill="#FFFFFF" font-family="sans-serif" font-size="12" font-style="italic" lengthAdjust="spacingAndGlyphs" textLength="115" x="55.5" y="267.1387">«external_system»</text><text fill="#FFFFFF" font-family="sans-serif" font-size="16" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="100" x="63" y="284.8203">yocto-poky</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="0" x="115" y="301.5889"/><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="122" x="50" y="317.8857">distro scaffolding:</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="153" x="34.5" y="334.1826">predefined meta-data,</text><text fill="#FFFFFF" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="142" x="42" y="350.4795">bitbake build system</text><!--link dev to yocto--><path d="M113,109.27 C113,147.09 113,199.39 113,240.26 " fill="none" id="dev-yocto" style="stroke: #666666; stroke-width: 1.0;"/><polygon fill="#666666" points="113,245.7,117,236.7,113,240.7,109,236.7,113,245.7" style="stroke: #666666; stroke-width: 1.0;"/><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="52" x="155.5" y="152.0669">selects</text><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="103" x="130" y="167.1997">configuration,</text><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="135" x="114" y="182.3325">initiates the build,</text><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="129" x="117" y="197.4653">deploys image to</text><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="75" x="146.5" y="212.5981">the target</text><!--link yocto to meta_openharmony--><path d="M113,364.12 C113,387 113,413.15 113,435.69 " fill="none" id="yocto-meta_openharmony" style="stroke: #666666; stroke-width: 1.0;"/><polygon fill="#666666" points="113,440.74,117,431.74,113,435.74,109,431.74,113,440.74" style="stroke: #666666; stroke-width: 1.0;"/><text fill="#666666" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="93" x="114" y="407.0669">incorporates</text><!--
@startuml meta-ohos_system_context_diagram
skinparam defaultTextAlignment center
skinparam wrapWidth 200
skinparam maxMessageSize 150
skinparam rectangle {
StereotypeFontSize 12
shadowing false
}
skinparam database {
StereotypeFontSize 12
shadowing false
}
skinparam Arrow {
Color #666666
FontColor #666666
FontSize 12
}
skinparam rectangle<<boundary>> {
Shadowing false
StereotypeFontSize 0
FontColor #444444
BorderColor #444444
BorderStyle dashed
}
skinparam rectangle<<person>> {
StereotypeFontColor #FFFFFF
FontColor #FFFFFF
BackgroundColor #08427B
BorderColor #073B6F
}
skinparam rectangle<<external_person>> {
StereotypeFontColor #FFFFFF
FontColor #FFFFFF
BackgroundColor #686868
BorderColor #8A8A8A
}
skinparam rectangle<<system>> {
StereotypeFontColor #FFFFFF
FontColor #FFFFFF
BackgroundColor #1168BD
BorderColor #3C7FC0
}
skinparam rectangle<<external_system>> {
StereotypeFontColor #FFFFFF
FontColor #FFFFFF
BackgroundColor #999999
BorderColor #8A8A8A
}
skinparam database<<system>> {
StereotypeFontColor #FFFFFF
FontColor #FFFFFF
BackgroundColor #1168BD
BorderColor #3C7FC0
}
skinparam database<<external_system>> {
StereotypeFontColor #FFFFFF
FontColor #FFFFFF
BackgroundColor #999999
BorderColor #8A8A8A
}
rectangle "==Developer\n\n Anyone willing to build the OHOS based image" <<person>> as dev
rectangle "==meta-openharmony\n\n Open Harmony OS umbrella bitbake layer" <<system>> as meta_openharmony
rectangle "==yocto-poky\n\n distro scaffolding: predefined meta-data, bitbake build system" <<external_system>> as yocto
dev - -> yocto : "===selects configuration, initiates the build, deploys image to the target"
yocto - -> meta_openharmony : "===incorporates"
@enduml
PlantUML version 1.2018.13(Mon Nov 26 18:11:51 CET 2018)
(GPL source distribution)
Java Runtime: OpenJDK Runtime Environment
JVM: OpenJDK 64-Bit Server VM
Java Version: 11.0.9.1+1-Ubuntu-0ubuntu1.20.04
Operating System: Linux
OS Version: 5.4.0-53-generic
Default Encoding: UTF-8
Language: en
Country: US
--></g></svg>
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment