mart-w/kanidm
1
0
Fork 0
mirror of https://github.com/kanidm/kanidm.git synced 2025-02-23 20:47:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Doc fixes (#1658)

Browse source
This commit is contained in:
Sebastiano Tocci 2023-05-26 02:43:50 +02:00 committed by GitHub
parent 150a064cfa
commit 655a688ceb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
book/src/developers/designs/architecture.md
View file

@ -47,7 +47,7 @@ messages that can become events.
The frontend uses a webserver with a thread-pool to process and decode network I/O operations The frontend uses a webserver with a thread-pool to process and decode network I/O operations
concurrently. This then sends asynchronous messages to a worker (actor) pool for handing. concurrently. This then sends asynchronous messages to a worker (actor) pool for handing.
(2) These search messages in the actors are transformed into "events" - a self contained structure (2) These search messages in the actors are transformed into "events" - a self-contained structure
containing all relevant data related to the operation at hand. This may be the event origin (a user containing all relevant data related to the operation at hand. This may be the event origin (a user
or internal), the requested filter (query), and perhaps even a list of attributes requested. These or internal), the requested filter (query), and perhaps even a list of attributes requested. These
events are designed to ensure correctness. When a search message is transformed to a search event, events are designed to ensure correctness. When a search message is transformed to a search event,
@ -92,7 +92,7 @@ protected from an early stage to guarantee consistency of the operations.
The write path is similar to the search path, but has some subtle differences that are worth paying The write path is similar to the search path, but has some subtle differences that are worth paying
attention to. attention to.
.. image:: diagrams/write-flow.png :width: 800 # ![write flow diagram](diagrams/write-flow.png)
(1), (2) Like search, all client operations come from the REST or raw apis, and are transformed or (1), (2) Like search, all client operations come from the REST or raw apis, and are transformed or
generated into messages. These messages are sent to a single write worker. There is only a single generated into messages. These messages are sent to a single write worker. There is only a single
@ -116,13 +116,13 @@ protected types where another ensures that uuid exists on every entry.
(5) These transformed entries are now returned to the query server. (5) These transformed entries are now returned to the query server.
(6) The backend is sent the list of entries for writing. Indexes are generated (7) as required based (6) The backend is sent the list of entries for writing. Indexes are generated (7) as required based
on the new or modified entries, and the entries themself are written (8) into the core db tables. on the new or modified entries, and the entries themselves are written (8) into the core db tables.
This operation returns a result (9) to the backend, which is then filtered up to the query server This operation returns a result (9) to the backend, which is then filtered up to the query server
(10) (10)
(11) Provided all operations to this point have been successful, we now apply post write plugins (11) Provided all operations to this point have been successful, we now apply post write plugins
which may enforce or generate different properties in the transaction. This is similar to the pre which may enforce or generate different properties in the transaction. This is similar to the pre
plugins, but allows different operations. For example, a post plugin ensurs uuid reference types are plugins, but allows different operations. For example, a post plugin ensures uuid reference types are
consistent and valid across the set of changes in the database. The most critical is memberof, which consistent and valid across the set of changes in the database. The most critical is memberof, which
generates reverse reference links from entries to their group memberships, enabling fast rbac generates reverse reference links from entries to their group memberships, enabling fast rbac
operations. These are done as post plugins because at this point internal searches can now yield and operations. These are done as post plugins because at this point internal searches can now yield and