Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add volumes in references #424

Merged
merged 7 commits into from
Jul 9, 2024
Merged

feat: add volumes in references #424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7c07ab7
doc: add volume tables
guilhem-barthes Jun 25, 2024
4cafd99
doc: include volume table in reference
guilhem-barthes Jun 25, 2024
3e8fae8
doc: improve information about `docker-registry`
guilhem-barthes Jun 25, 2024
4e48156
doc: add some sentences about the volumes
guilhem-barthes Jun 25, 2024
2b1dd19
fix: apply feedback on tables
guilhem-barthes Jul 9, 2024
792b931
fix: change description volumes in substra backend
guilhem-barthes Jul 9, 2024
2ab5c1d
fix: capitalization
guilhem-barthes Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ Substra is distributed as Helm charts, and most values can be customized to acco

.. include:: pss.rst
.. include:: netpol.rst
.. include:: volumes.rst
47 changes: 47 additions & 0 deletions docs/source/reference/volumes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
Volumes
-------

This section lists the different persistent volume claims that are created during a standard deployment of Substra in a cluster.

Orchestrator
************

The orchestrator claims are only linked with its database. This database (and the underlying volume) is important has it is where we store all the events that happen in the network.

+--------------+--------------+----------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+
| PVC name | Component | Pod | access mode | Volume Size default (Gi) | storage class | reclaim policy | Can be reused | How to re use |
+==============+==============+==========+=================================+==========================+===============+================+===============+==============================================+
| Postgres PVC | orchestrator | postgres | ReadWriteOnce (can be modified) | 8 | <empty> | default | yes | postgresql.primary.persistence.existingClaim |
+--------------+--------------+----------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+


Backend
*******

The backend is the most complex component and it requires different volumes for functioning. Volumes that should be persisted on the long term can be created outside of the deployment of the Substra stack. It is not currently possible to re-use existing volumes for the other ones (acting as cache).

+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+
| PVC name | Component | Pod | access mode | Volume Size default (Gi) | storage class | reclaim policy | Can be reused | How to re use | Comment |
SdgJlbl marked this conversation as resolved.
Show resolved Hide resolved
+=====================+===========+============+=================================+==========================+===============+================+===============+==============================================+====================================================+
| Postgres PVC | backend | postgres | ReadWriteOnce (can be modified) | 8 | <empty> | default | yes | postgresql.primary.persistence.existingClaim | |
+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+
| Localstack PVC | backend | localstack | ReadWriteOnce (can be modified) | 5 | <empty> | default | yes | localstack.persistence.existingClaim | Only created when `localstack.enabled = true` |
+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+
| Minio PVC | backend | minio | ReadWriteOnce (can be modified) | 8 | <empty> | default | yes | minio.persistence.existingClaim | Only created when `minio.enabled = true` |
+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+
| Redis PVC | backend | redis | ReadWriteOnce (can be modified) | 8 | <empty> | default | yes | redis.master.persistence.existingClaim | |
+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+
| Kaniko cache warmer | backend | builder | ReadWriteOnce | 10 | <empty> | default | no | | |
+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+
| Builder PVC | backend | builder | ReadWriteOnce | 10 | <empty> | default | no | | |
+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+
| Worker subtuple | backend | worker | ReadWriteOnce (can be modified) | 10 | <empty> | default | no | | |
+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+
| Docker registry | backend | registry | ReadWriteOnce (can be modified) | 10 | <empty> | default | yes | docker-registry.persistence.existingClaim | Only created when `docker-registry.enabled = true` |
+---------------------+-----------+------------+---------------------------------+--------------------------+---------------+----------------+---------------+----------------------------------------------+----------------------------------------------------+


Frontend
********

The frontend does not need any persistent volume claim.
Loading