docs: fix uml errors
This commit is contained in:
@@ -223,4 +223,4 @@ plugins:
|
|||||||
- redoc-tag
|
- redoc-tag
|
||||||
- redirects:
|
- redirects:
|
||||||
redirect_maps:
|
redirect_maps:
|
||||||
guides/getting-started/secrets.md: concepts/generators.md
|
guides/getting-started/secrets.md: guides/vars-overview.md
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ This guide explains how to manage macOS machines using Clan.
|
|||||||
Currently, Clan supports the following features for macOS:
|
Currently, Clan supports the following features for macOS:
|
||||||
|
|
||||||
- `clan machines update` for existing [nix-darwin](https://github.com/nix-darwin/nix-darwin) installations
|
- `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
|
## Add Your Machine to Your Clan Flake
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
For a high level overview about `vars` see our [blog post](https://clan.lol/blog/vars/).
|
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
|
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
This article provides an overview over the underlying secrets system which is used by [Vars](../concepts/generators.md).
|
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](../concepts/generators.md) directly instead.
|
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.
|
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
|
```plantuml
|
||||||
@startuml
|
@startuml
|
||||||
!include C4_Container.puml
|
|
||||||
|
|
||||||
Person(user, "User", "Someone who manages secrets")
|
actor "User" as user
|
||||||
ContainerDb(secret, "Secret")
|
database "Secret" as secret
|
||||||
Container(machine, "Machine", "A Machine. i.e. Needs the Secret for a given Service." )
|
rectangle "Machine" as machine
|
||||||
|
|
||||||
Rel_R(user, secret, "Encrypt", "", "Pubkeys: User, Machine")
|
user -right-> secret : Encrypt\n(Pubkeys: User, Machine)
|
||||||
Rel_L(secret, user, "Decrypt", "", "user privkey")
|
secret -left-> user : Decrypt\n(user privkey)
|
||||||
Rel_R(secret, machine, "Decrypt", "", "machine privkey" )
|
secret -right-> machine : Decrypt\n(machine privkey)
|
||||||
|
|
||||||
@enduml
|
@enduml
|
||||||
```
|
```
|
||||||
@@ -316,19 +315,18 @@ Common use cases:
|
|||||||
|
|
||||||
```plantuml
|
```plantuml
|
||||||
@startuml
|
@startuml
|
||||||
!include C4_Container.puml
|
|
||||||
|
|
||||||
System_Boundary(c1, "Group") {
|
rectangle "Group" {
|
||||||
Person(user1, "User A", "has access")
|
actor "User A" as user1
|
||||||
Person(user2, "User B", "has access")
|
actor "User B" as user2
|
||||||
}
|
}
|
||||||
|
|
||||||
ContainerDb(secret, "Secret")
|
database "Secret" as secret
|
||||||
Container(machine, "Machine", "A Machine. i.e. Needs the Secret for a given Service." )
|
rectangle "Machine" as machine
|
||||||
|
|
||||||
Rel_R(c1, secret, "Encrypt", "", "Pubkeys: User A, User B, Machine")
|
|
||||||
Rel_R(secret, machine, "Decrypt", "", "machine privkey" )
|
|
||||||
|
|
||||||
|
user1 -right-> secret : Encrypt
|
||||||
|
user2 -right-> secret : (Pubkeys: User A, User B, Machine)
|
||||||
|
secret -right-> machine : Decrypt\n(machine privkey)
|
||||||
|
|
||||||
@enduml
|
@enduml
|
||||||
```
|
```
|
||||||
@@ -347,19 +345,17 @@ Common use cases:
|
|||||||
|
|
||||||
```plantuml
|
```plantuml
|
||||||
@startuml
|
@startuml
|
||||||
!include C4_Container.puml
|
|
||||||
!include C4_Deployment.puml
|
|
||||||
|
|
||||||
Person(user, "User", "Someone who manages secrets")
|
actor "User" as user
|
||||||
ContainerDb(secret, "Secret")
|
database "Secret" as secret
|
||||||
System_Boundary(c1, "Group") {
|
rectangle "Group" {
|
||||||
Container(machine1, "Machine A", "Both machines need the same secret" )
|
rectangle "Machine A" as machine1
|
||||||
Container(machine2, "Machine B", "Both machines need the same secret" )
|
rectangle "Machine B" as machine2
|
||||||
}
|
}
|
||||||
|
|
||||||
Rel_R(user, secret, "Encrypt", "", "Pubkeys: machine A, machine B, User")
|
user -right-> secret : Encrypt\n(Pubkeys: machine A, machine B, User)
|
||||||
Rel(secret, c1, "Decrypt", "", "Both machine A or B can decrypt using their private key" )
|
secret -down-> machine1 : Decrypt
|
||||||
|
secret -down-> machine2 : (Both machines can decrypt\nusing their private key)
|
||||||
|
|
||||||
@enduml
|
@enduml
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -55,7 +55,7 @@ Explore the underlying principles of Clan
|
|||||||
|
|
||||||
<div class="grid cards" markdown>
|
<div class="grid cards" markdown>
|
||||||
|
|
||||||
- [Generators](./concepts/generators.md)
|
- [Vars](./guides/vars-overview.md)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user