From 447b0bf8ace2ce298893e3b136f65045ca347619 Mon Sep 17 00:00:00 2001 From: Qubasa Date: Fri, 12 Sep 2025 12:42:41 +0200 Subject: [PATCH] docs: fix uml errors --- docs/mkdocs.yml | 2 +- docs/site/guides/macos.md | 2 +- .../guides/migrations/migration-facts-vars.md | 2 +- docs/site/guides/secrets.md | 52 +++++++++---------- docs/site/index.md | 2 +- 5 files changed, 28 insertions(+), 32 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2787d32bf..168c13e92 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -223,4 +223,4 @@ plugins: - redoc-tag - redirects: redirect_maps: - guides/getting-started/secrets.md: concepts/generators.md + guides/getting-started/secrets.md: guides/vars-overview.md diff --git a/docs/site/guides/macos.md b/docs/site/guides/macos.md index fce5ac2dd..13c98a83b 100644 --- a/docs/site/guides/macos.md +++ b/docs/site/guides/macos.md @@ -7,7 +7,7 @@ This guide explains how to manage macOS machines using Clan. Currently, Clan supports the following features for macOS: - `clan machines update` for existing [nix-darwin](https://github.com/nix-darwin/nix-darwin) installations -- Support for [vars](../concepts/generators.md) +- Support for [vars](../guides/vars-overview.md) ## Add Your Machine to Your Clan Flake diff --git a/docs/site/guides/migrations/migration-facts-vars.md b/docs/site/guides/migrations/migration-facts-vars.md index 6dcde4dbe..e6cc98bba 100644 --- a/docs/site/guides/migrations/migration-facts-vars.md +++ b/docs/site/guides/migrations/migration-facts-vars.md @@ -3,7 +3,7 @@ For a high level overview about `vars` see our [blog post](https://clan.lol/blog/vars/). This guide will help you migrate your modules that still use our [`facts`](../../guides/secrets.md) backend -to the [`vars`](../../concepts/generators.md) backend. +to the [`vars`](../../guides/vars-overview.md) backend. The `vars` [module](../../reference/clan.core/vars.md) and the clan [command](../../reference/cli/vars.md) work in tandem, they should ideally be kept in sync. diff --git a/docs/site/guides/secrets.md b/docs/site/guides/secrets.md index 7507a0f20..63b87aef5 100644 --- a/docs/site/guides/secrets.md +++ b/docs/site/guides/secrets.md @@ -1,5 +1,5 @@ -This article provides an overview over the underlying secrets system which is used by [Vars](../concepts/generators.md). -Under most circumstances you should use [Vars](../concepts/generators.md) directly instead. +This article provides an overview over the underlying secrets system which is used by [Vars](../guides/vars-overview.md). +Under most circumstances you should use [Vars](../guides/vars-overview.md) directly instead. Consider using `clan secrets` only for managing admin users and groups, as well as a debugging tool. @@ -292,15 +292,14 @@ The following diagrams illustrates how a user can provide a secret (i.e. a Passw ```plantuml @startuml -!include C4_Container.puml -Person(user, "User", "Someone who manages secrets") -ContainerDb(secret, "Secret") -Container(machine, "Machine", "A Machine. i.e. Needs the Secret for a given Service." ) +actor "User" as user +database "Secret" as secret +rectangle "Machine" as machine -Rel_R(user, secret, "Encrypt", "", "Pubkeys: User, Machine") -Rel_L(secret, user, "Decrypt", "", "user privkey") -Rel_R(secret, machine, "Decrypt", "", "machine privkey" ) +user -right-> secret : Encrypt\n(Pubkeys: User, Machine) +secret -left-> user : Decrypt\n(user privkey) +secret -right-> machine : Decrypt\n(machine privkey) @enduml ``` @@ -316,19 +315,18 @@ Common use cases: ```plantuml @startuml -!include C4_Container.puml -System_Boundary(c1, "Group") { - Person(user1, "User A", "has access") - Person(user2, "User B", "has access") +rectangle "Group" { + actor "User A" as user1 + actor "User B" as user2 } -ContainerDb(secret, "Secret") -Container(machine, "Machine", "A Machine. i.e. Needs the Secret for a given Service." ) - -Rel_R(c1, secret, "Encrypt", "", "Pubkeys: User A, User B, Machine") -Rel_R(secret, machine, "Decrypt", "", "machine privkey" ) +database "Secret" as secret +rectangle "Machine" as machine +user1 -right-> secret : Encrypt +user2 -right-> secret : (Pubkeys: User A, User B, Machine) +secret -right-> machine : Decrypt\n(machine privkey) @enduml ``` @@ -347,19 +345,17 @@ Common use cases: ```plantuml @startuml -!include C4_Container.puml -!include C4_Deployment.puml -Person(user, "User", "Someone who manages secrets") -ContainerDb(secret, "Secret") -System_Boundary(c1, "Group") { - Container(machine1, "Machine A", "Both machines need the same secret" ) - Container(machine2, "Machine B", "Both machines need the same secret" ) +actor "User" as user +database "Secret" as secret +rectangle "Group" { + rectangle "Machine A" as machine1 + rectangle "Machine B" as machine2 } -Rel_R(user, secret, "Encrypt", "", "Pubkeys: machine A, machine B, User") -Rel(secret, c1, "Decrypt", "", "Both machine A or B can decrypt using their private key" ) - +user -right-> secret : Encrypt\n(Pubkeys: machine A, machine B, User) +secret -down-> machine1 : Decrypt +secret -down-> machine2 : (Both machines can decrypt\nusing their private key) @enduml ``` diff --git a/docs/site/index.md b/docs/site/index.md index 0609518f6..532064957 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -55,7 +55,7 @@ Explore the underlying principles of Clan
-- [Generators](./concepts/generators.md) +- [Vars](./guides/vars-overview.md) ---