Skip to content

Commit 415cda1

Browse files
authored
feat: add Pod Security Standard reference (#418)
Signed-off-by: SdgJlbl <[email protected]>
1 parent 49a113b commit 415cda1

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,12 @@ Some quick links:
100100
.. toctree::
101101
:glob:
102102
:maxdepth: 2
103-
:caption: API Reference
103+
:caption: Reference guides
104104
:hidden:
105105

106106
substrafl_doc/api/index.rst
107107
documentation/api_reference.rst
108+
reference/index.rst
108109

109110

110111
.. toctree::

docs/source/reference/index.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Kubernetes deployment reference
2+
===============================
3+
4+
For a step-by-step guide on how to deploy the application on Kubernetes, please refer to the
5+
`the deployment how-to <how-to/deploying-substra/index>`_.
6+
7+
This section provides a reference of how various Kubernetes resources should look like once deployed with the default settings.
8+
Substra is distributed as Helm charts, and most values can be customized to accommodate the requirements of your environment.
9+
10+
Pod Security Standards
11+
----------------------
12+
13+
All pods in a Substra deployment are compliant with the *baseline* policy of the
14+
`Pod Security Standards <https://kubernetes.io/docs/concepts/security/pod-security-standards>`_.
15+
16+
All pods can run as non-root, with two exceptions:
17+
18+
* If the builder feature is enabled (at least one backend per network must have the ability to build images), Kaniko pods used for building images run as root.
19+
* If the private CA feature is used, the initContainer `add-cert` runs as root.
20+
21+
We are working on ensuring that all pods except the two listed above are compliant with the *restricted* policy.

0 commit comments

Comments
 (0)