Skip to content

Commit

Permalink
docs: fix protocols section in architecture page
Browse files Browse the repository at this point in the history
Mention Slurm internal authentication mechanism (with sackd) and clarify
that munge is not actually involved between Slurm-web agent and
slurmrestd.
  • Loading branch information
rezib committed Aug 30, 2024
1 parent 1c73965 commit dcbe631
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 22 deletions.
9 changes: 6 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
reservations page (#336).
- Hide users disclosure from jobs filters panel when authentication is
disabled (#330).
- docs: Mention requirement of `SLURMRESTD_SECURITY=disable_user_check`
environment variable definition in `slurmrestd` service drop-in configuration
override (#320).
- docs:
- Mention requirement of `SLURMRESTD_SECURITY=disable_user_check` environment
variable in `slurmrestd` service drop-in configuration override (#320).
- Fix protocols section in architecture page to mention Slurm internal
authentication mechanism (with `sackd`) and clarify that `munge` is not
involved between Slurm-web agent and `slurmrestd`.

## [3.1.0] - 2024-07-03

Expand Down
Binary file modified docs/modules/overview/images/arch/slurm-web_protocols.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 31 additions & 13 deletions docs/modules/overview/images/arch/slurm-web_protocols.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 8 additions & 6 deletions docs/modules/overview/pages/architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,18 @@ initial authentication with LDAP directory, users are authenticated between
these components with https://jwt.io/[JSON Web Token] (JWT).

Communications between *agent* component and Slurm `slurmrestd` daemon are
performed with HTTP protocol over a Unix socket.
performed with HTTP protocol over a Unix socket. For security reasons
`slurmrestd` checks the *agent* runs with the same UID/GID as itself with its
`rest_auth/local` plugin.

NOTE: Slurm `slurmrestd` supports incoming connections on TCP/IP sockets but
this configuration is not yet supported by Slurm-web. This is currently a
limitation in Slurm-web that might change in the future (see
NOTE: Slurm `slurmrestd` supports incoming connections on TCP/IP sockets with
`rest_auth/jwt` plugin but this configuration is not yet supported by Slurm-web.
This is currently a limitation in Slurm-web that might change in the future (see
https://github.com/rackslab/Slurm-web/issues/313[#313]).

Slurm components communicates with specific binary RPC protocol over TCP/IP
sockets. Communications between the *agent* and Slurm components are secured
and user are authenticated with https://dun.github.io/munge/[Munge].
sockets, secured by either https://dun.github.io/munge/[Munge] or
https://slurm.schedmd.com/authentication.html#slurm[Slurm internal mechanism].

[#multiclusters]
== Multi-clusters Distribution
Expand Down

0 comments on commit dcbe631

Please sign in to comment.