towk/partitions
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: added initial file

Browse source
This commit is contained in:
David Allen 2024-11-17 14:30:18 -07:00
parent 6233590bb4
commit 8d1f8e419d
Signed by: towk
GPG key ID: 793B2924A49B3A3F
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md Normal file
View file

@ -0,0 +1,17 @@
# Experimental Partitions
This repository was created to show another way to think about how state management partitioning might be designed. The API is effectively designed as follows:
```mermaid
graph TD
b["groups"] --lookup--> pm
c["tree"] --lookup--> pm
pm["partition manager"] --create--> d(("p1"))
pm --delete--> e(("p2"))
pm --get--> f(("p3"))
```
`Partition`s represent logical separations containing hardware information that are mutually exclusive and are encapsulated (not exported) within the `partition` package. There is no mechanism to interact directly with partitions. Instead, the only way to interact with partitions is through the `PartitionManager`. The `PartitionManager` enforces the mutually exclusivity behavior between the `Partition`s, which can be possibly extended to enforce other rules such as permissions and/or roles.
On the other hand, `Group`s are *completely unrelated to partitions*. A `Group` is simply a collection of labels that have no specific behavior, but can be useful for performing hardware information lookups through the `PartitionManager`. The functionality for `Group`s is built on top of the `PartitionManager`. Similarly, other abstract data structures like a `Tree` can be built using the `PartitionManager` in the same way as `Group`s.