Skip to content

Commit

Permalink
feat: add Pod Security Standard reference
Browse files Browse the repository at this point in the history
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
  • Loading branch information
SdgJlbl committed May 23, 2024
1 parent 49a113b commit 1d95a3d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ Some quick links:

substrafl_doc/api/index.rst
documentation/api_reference.rst
reference/index.rst


.. toctree::
Expand Down
21 changes: 21 additions & 0 deletions docs/source/reference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Kubernetes deployment reference
===============================

For a step-by-step guide on how to deploy the application on Kubernetes, please refer to the
`the deployment how-to <how-to/deploying-substra/index>`_.

This section provides a reference of how various Kubernetes resources should look like once deployed with the default settings.
Substra is distributed as Helm charts, and most values can be customized to accommodate the requirements of your environment.

Pod Security Standards
----------------------

All pods in a Substra deployment are compliant with the *baseline* policy of the
`Pod Security Standards <https://kubernetes.io/docs/concepts/security/pod-security-standards>`_.

All pods can run as non-root, with two exceptions:

* 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.
* If the private CA feature is used, the initContainer `add-cert` runs as root.

We are working on ensuring that all pods except the two listed above are compliant with the *restricted* policy.

0 comments on commit 1d95a3d

Please sign in to comment.