Skip to content

Commit

Permalink
PR comments
Browse files Browse the repository at this point in the history
  • Loading branch information
bkneis committed Sep 24, 2024
1 parent 86ff95f commit f57769e
Show file tree
Hide file tree
Showing 19 changed files with 43 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/pages/how-it-works/building-workspaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Devpod provides the ability to build workspaces by taking a devcontainer.json an
against using local tools.

<figure>
<img src="/docs/media/docker_build_c4.png" alt="DevPod Architecture" />
<img src="/docs/media/c4_build.png" alt="DevPod Architecture" />
<figcaption>DevPod - Container Diagram</figcaption>
</figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/how-it-works/deploy-k8s.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ DevPod works the same with kubernetes as with Machines, the key difference is th
to be run on the kubernetes node. Instead devpod-provider-kubernetes simply wraps the appropriate `kubectl` commands to start and connect a workspace using a devcontainer.

<figure>
<img src="/docs/media/arch_c4.png" alt="DevPod Architecture" />
<img src="/docs/media/c4_k8s.png" alt="DevPod Architecture" />
<figcaption>DevPod - Container Diagram Kubernetes</figcaption>
</figure>

Expand All @@ -17,6 +17,6 @@ for more details on kaniko) then executes the container's entrypoint in the pod'
existing build layers from the registry to reduce the overall build time.

<figure>
<img src="/docs/media/build_c4.png" alt="DevPod Architecture 2" />
<img src="/docs/media/c4_build_k8s.png" alt="DevPod Architecture 2" />
<figcaption>DevPod - Component Diagram Kubernetes Build Process</figcaption>
</figure>
2 changes: 1 addition & 1 deletion docs/pages/how-it-works/deploy-machines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The dedvpod agent starts a SSH server using the STDIO of the secure tunnel in or
IDE and connects it to the devcontainer via SSH.

<figure>
<img src="/docs/media/arch_c4_machines.png" alt="DevPod Architecture" />
<img src="/docs/media/c4_machines.png" alt="DevPod Architecture" />
<figcaption>DevPod - Component Diagram</figcaption>
</figure>

2 changes: 1 addition & 1 deletion docs/pages/how-it-works/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ and the workspace is tunneled through, ensuring secure communication using the c
Below is a high level overview of how DevPod uses your local environment, a source repo and a devcontainer to deploy your workspace to the cloud.

<figure>
<img src="/docs/media/workspace_c4.png" alt="DevPod Architecture" />
<img src="/docs/media/c4_workspaces.png" alt="DevPod Architecture" />
<figcaption>DevPod - Component Diagram</figcaption>
</figure>

Expand Down
Binary file removed docs/static/media/arch_c4.png
Binary file not shown.
Binary file removed docs/static/media/arch_c4_machines.png
Binary file not shown.
Binary file added docs/static/media/c4_build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added docs/static/media/c4_k8s.png
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 docs/static/media/c4_machines.png
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 docs/static/media/c4_workspaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/static/media/docker_build_c4.png
Binary file not shown.
Binary file removed docs/static/media/workspace_c4.png
Binary file not shown.
19 changes: 12 additions & 7 deletions docs/uml/c4_build.puml
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml

skinparam linetype ortho
skinparam nodesep 100
skinparam ranksep 250
scale 1920x1080

LAYOUT_TOP_DOWN()
HIDE_STEREOTYPE()

Expand All @@ -22,11 +27,11 @@ Boundary(cluster, "Dev Container Spec") {
Component(fb, "Feature B", "git stuff")
}

Rel(repo, user, " 1")
Rel(dc, user, " 2")
Rel(fa, user, " 3")
Rel(fb, user, " 3")
Rel_Right(ctx, user, " 4")
Rel(user, cdf, " 5")
Rel(cdf, reg, " 6")
Rel(repo, user, "")
Rel(dc, user, "")
Rel(fa, user, "")
Rel(fb, user, "")
Rel_Right(ctx, user, "")
Rel(user, cdf, "")
Rel(cdf, reg, "")
@enduml
File renamed without changes.
11 changes: 8 additions & 3 deletions docs/uml/c4_component.puml → docs/uml/c4_k8s.puml
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml

skinparam linetype ortho
skinparam nodesep 150
skinparam ranksep 200
scale 1920x1080

HIDE_STEREOTYPE()
LAYOUT_TOP_DOWN()

Expand Down Expand Up @@ -30,7 +35,7 @@ BiRel(controlPlane, agent, " ")
BiRel_Left(agent, ssh, "Tunnelled STDIO")
Rel(agent, runner, " ")
BiRel(ssh, ide, "SSH port forwarding")
Rel(user, ide, " ")
Rel_Up(user, ctx, " ")
Rel_Left(user, env, " ")
Rel(user, ide, "")
Rel_Up(user, ctx, "")
Rel_Left(user, env, "")
@enduml
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml

skinparam linetype ortho
skinparam nodesep 100
skinparam ranksep 150
scale 1920x1080

HIDE_STEREOTYPE()
LAYOUT_TOP_DOWN()

Expand Down Expand Up @@ -33,5 +38,5 @@ BiRel_Right(ide, ssh, "SSH port forwarding")
Rel(user, ide, "")
Rel(ctx, user, "")
Rel(env, user, "")
BiRel(controlPlane, agent, " SSH")
BiRel(controlPlane, agent, "SSH ")
@enduml
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml

skinparam linetype ortho
skinparam nodesep 150
skinparam ranksep 150
scale 1920x1080

HIDE_STEREOTYPE()
LAYOUT_TOP_DOWN()

Expand All @@ -27,11 +32,11 @@ BiRel(user, prov, "devpod up ...")
BiRel(prov, controlPlane, "")
BiRel(controlPlane, agent, " gRPC")
BiRel_Left(agent, ssh, "Tunnelled STDIO")
Rel(agent, runner, " ")
Rel(agent, runner, "")
BiRel(ssh, ide, "SSH port forwarding")
Rel_Left(ide, user, " ")
Rel(ctx, user, " ")
Rel(env, user, " ")
Rel(git, user, " ")
Rel(dc, user,, " ")
Rel_Left(ide, user, "")
Rel(ctx, user, "")
Rel(env, user, "")
Rel(git, user, "")
Rel(dc, user, "")
@enduml
1 change: 1 addition & 0 deletions docs/uml/up_sequence.puml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
@startuml

alt using machine provider
alt machine doesn't exist
DevPod -> Provider: devpod machine create
Expand Down

0 comments on commit f57769e

Please sign in to comment.