Skip to content

Commit

Permalink
Add basic PlantUML style for Foreman
Browse files Browse the repository at this point in the history
  • Loading branch information
Lennonka committed Jun 6, 2024
1 parent 95fc991 commit f9b27c7
Show file tree
Hide file tree
Showing 20 changed files with 118 additions and 26 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guides/common/images/image-workflow-lzap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guides/common/images/pxe-workflow-lzap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 0 additions & 16 deletions guides/common/images/user-data-sequence-satellite.txt

This file was deleted.

43 changes: 43 additions & 0 deletions guides/image-sources/foreman.pstyle
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
' Foreman style for PlantUML diagrams
' This style was created for sequence diagrams and may be incomplete.

skinparam RoundCorner 8
skinparam Shadowing false

' #ffcc32 Foreman yellow
' #025d8c Foreman blue

skinparam sequence {
ArrowColor #025d8c
LifeLineBorderColor #ecf4f8
LifeLineBorderThickness 32
DividerBorderColor #025d8c
DividerFontColor #025d8c
group {
TitleFontColor #025d8c
BorderColor #d2e4ed
FontColor #025d8c
}
groupHeader {
BackgroundColor #d2e4ed
FontColor #025d8c
}
}

skinparam Actor {
BackgroundColor #025d8c
BorderColor #025d8c
FontColor #025d8c
}

skinparam Participant {
BackgroundColor #025d8c
BorderColor #025d8c
FontColor White
}

skinparam Note {
BackgroundColor #d2e4ed
BorderColor #025d8c
FontColor #025d8c
}
2 changes: 2 additions & 0 deletions guides/image-sources/provisioning-image-cloudinit.plantuml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
@startuml

!include foreman.pstyle

title Cloud-based provisioning with Puppet via cloud-init

actor User
Expand Down
2 changes: 2 additions & 0 deletions guides/image-sources/provisioning-image-finish.plantuml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
@startuml

!include foreman.pstyle

title Cloud-based provisioning with Puppet over ssh

actor User
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
@startuml

!include foreman.pstyle

title Installer-based provisioning with full-host bootdisk

' TODO

@enduml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
@startuml

!include foreman.pstyle

title Installer-based provisioning with subnet bootdisk

' TODO

@enduml
9 changes: 9 additions & 0 deletions guides/image-sources/provisioning-installer-httpboot.plantuml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
@startuml

!include foreman.pstyle

title Installer-based provisioning with HTTP boot

' TODO

@enduml
32 changes: 22 additions & 10 deletions guides/image-sources/provisioning-installer-pxeboot.plantuml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
@startuml

!include foreman.pstyle

title Installer-based provisioning with PXE boot

actor User
Expand All @@ -14,7 +16,10 @@ participant "Puppet\nserver" as Puppet

autonumber

note over Host : is powered off
note over Host : powered off

== Create host in Foreman ==

User -> Foreman : clicks **Create Host**
Foreman -> Proxy : requests free IP address
Proxy -> DHCP : reads DHCP cofiguration
Expand All @@ -38,12 +43,12 @@ User -> Host : powers on the machine
Host -> DHCP : requests the reserved IP and PXE details
Host -> TFTP : downloads bootloader
note over Host : bootloader loads
Host -> TFTP : bootloader gets MAC-based config
Host -> TFTP : downloads OS installer image/kernel
Host -> TFTP : gets MAC-based config for bootloader
Host -> TFTP : downloads OS installer kernel and init RAM disk
note over Host : OS installer loads
Host -> Foreman : requests Kickstart
Host -> Foreman : requests Kickstart content
group Template [Kickstart default, Preseed default etc.]
Foreman -> Host : provides Kickstart
Foreman -> Host : provides Kickstart content
note over Host : OS is installed
opt Remote Execution
Host -> Host : authorize SSH key\nof Foreman Proxy
Expand All @@ -53,18 +58,25 @@ group Template [Kickstart default, Preseed default etc.]
end
Host -> Foreman : calls home\n(disables build mode)
end
group NOT HAPPENING? [MAC-based config remains in TFTP dir\nSo which config file is removed?]
Foreman -> Proxy : sends TFTP removal request
Proxy -> TFTP : removes TFTP configuration file
group #ffcc32 NOT HAPPENING? [MAC-based config remains in TFTP dir\nSo which config file is removed?]
Foreman -> Proxy : sends TFTP removal request
Proxy -> TFTP : removes TFTP configuration file
end
note over Host : reboots

== First boot ==
== First local boot ==

Host -> DHCP : requests the reserved IP and PXE details
Host -> TFTP : bootloader is downloaded
Host -> TFTP : bootloader gets MAC-based config
note over Host : bootloader is told to boot from HDD
Foreman -> Host : tells bootloader to boot from HDD
group Ansible??? [when enabled and Ansible roles assigned]
Host -> Proxy : sends initial facts
Proxy -> Foreman : forwards initial facts
note over Host : performs initial configuration
Host -> Proxy : sends initial report
Proxy -> Foreman : forwards initial report
end
group Puppet [when enabled]
Host -> Puppet : sends initial facts
Puppet -> Foreman : forwards initial facts
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
@startuml

!include foreman.pstyle

title VMware Template Provisioning

participant User
participant Satellite
participant vCenter
participant "Capsule X" as Capsule
participant VM

User --> Satellite : Provision VM in network X
Satellite --> vCenter : Create a VM from a template on port 443
vCenter --> VM : Clone VM from template
VM --> Capsule : Call Back to Sat port 80 via Capsule X 8000
Capsule --> Satellite : Forward Userdata on port 80
Satellite --> Satellite : Redirect Userdata to port 443
VM --> Capsule : Registers itself to Satellite
Capsule -->Satellite : Forward VM registration to Satellite

@enduml

0 comments on commit f9b27c7

Please sign in to comment.