Skip to content

Commit

Permalink
chore: chart doc
Browse files Browse the repository at this point in the history 
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
  • Loading branch information
@ThibaultFy
ThibaultFy committed Apr 24, 2024
1 parent 5768b41 commit cc964bd
Showing 1 changed file with 1 addition and 20 deletions.
21 changes: 1 addition & 20 deletions charts/substra-backend/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ See [UPGRADE.md](https://github.com/Substra/substra-backend/blob/main/charts/sub
| Name | Description | Value |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `settings` | The settings to use for substra (`prod` or `dev`) | `prod` |
| `requestsResources` | Activate or not the resources requests for the pods (true or false) | `false` |
| `config` | The configuration to use for substra | `{}` |
| `organizationName` | Current organization name | `owkin` |
| `DataSampleStorageInServerMedia` | If set to true, Datasamples which are registered by a "path" are kept on the "servermedias" volume. If set to `false` (default value), the datasample will be duplicated to MinIO. | `false` |
Expand Down Expand Up @@ -72,10 +73,6 @@ See [UPGRADE.md](https://github.com/Substra/substra-backend/blob/main/charts/sub
| `server.ingress.extraHosts` | The list of additional hostnames to be covered with this ingress record | `[]` |
| `server.ingress.extraTls` | The tls configuration for hostnames to be coverred by the ingress | `[]` |
| `server.ingress.ingressClassName` | _IngressClass_ that will be used to implement the Ingress | `nil` |
| `server.resources.requests.cpu` | Server container cpu request | `1000m` |
| `server.resources.requests.memory` | Server container memory request | `6Gi` |
| `server.resources.limits.cpu` | Server container cpu limit | `2000m` |
| `server.resources.limits.memory` | Server container memory limit | `12Gi` |
| `server.persistence.storageClass` | Specify the _StorageClass_ used to provision the volume. Or the default _StorageClass_ will be used. Set it to `-` to disable dynamic provisioning | `""` |
| `server.persistence.servermedias.size` | Servermedias volume size | `10Gi` |
| `server.persistence.servermedias.existingClaim` | use this PVC rather than creating a new one | `nil` |
Expand Down Expand Up @@ -122,10 +119,6 @@ See [UPGRADE.md](https://github.com/Substra/substra-backend/blob/main/charts/sub
| `worker.podSecurityContext.runAsUser` | User ID for the pod | `1001` |
| `worker.podSecurityContext.runAsGroup` | Group ID for the pod | `1001` |
| `worker.podSecurityContext.fsGroup` | FileSystem group ID for the pod | `1001` |
| `worker.resources.requests.cpu` | Worker container cpu request | `1000m` |
| `worker.resources.requests.memory` | Worker container memory request | `4Gi` |
| `worker.resources.limits.cpu` | Worker container cpu limit | `2000m` |
| `worker.resources.limits.memory` | Worker container memory limit | `8Gi` |
| `worker.nodeSelector` | Node labels for pod assignment | `{}` |
| `worker.tolerations` | Toleration labels for pod assignment | `[]` |
| `worker.affinity` | Affinity settings for pod assignment, ignored if `DataSampleStorageInServerMedia` is `true` | `{}` |
Expand Down Expand Up @@ -169,10 +162,6 @@ See [UPGRADE.md](https://github.com/Substra/substra-backend/blob/main/charts/sub
| `schedulerWorker.nodeSelector` | Node labels for pod assignment | `{}` |
| `schedulerWorker.tolerations` | Toleration labels for pod assignment | `[]` |
| `schedulerWorker.affinity` | Affinity settings for pod assignment | `{}` |
| `schedulerWorker.resources.requests.cpu` | Scheduler container cpu request | `250m` |
| `schedulerWorker.resources.requests.memory` | Scheduler container memory request | `200Mi` |
| `schedulerWorker.resources.limits.cpu` | Scheduler container cpu limit | `250m` |
| `schedulerWorker.resources.limits.memory` | Scheduler container memory limit | `400Mi` |
| `schedulerWorker.podSecurityContext.enabled` | Enable security context | `true` |
| `schedulerWorker.podSecurityContext.runAsUser` | User ID for the pod | `1001` |
| `schedulerWorker.podSecurityContext.runAsGroup` | Group ID for the pod | `1001` |
Expand All @@ -189,10 +178,6 @@ See [UPGRADE.md](https://github.com/Substra/substra-backend/blob/main/charts/sub
| `scheduler.image.tag` | Substra backend tasks scheduler image tag (defaults to AppVersion) | `nil` |
| `scheduler.image.pullPolicy` | Substra backend task scheduler image pull policy | `IfNotPresent` |
| `scheduler.image.pullSecrets` | Specify image pull secrets | `[]` |
| `scheduler.resources.requests.cpu` | Scheduler container cpu request | `250m` |
| `scheduler.resources.requests.memory` | Scheduler container memory request | `200Mi` |
| `scheduler.resources.limits.cpu` | Scheduler container cpu limit | `250m` |
| `scheduler.resources.limits.memory` | Scheduler container memory limit | `400Mi` |
| `scheduler.nodeSelector` | Node labels for pod assignment | `{}` |
| `scheduler.tolerations` | Toleration labels for pod assignment | `[]` |
| `scheduler.affinity` | Affinity settings for pod assignment | `{}` |
Expand All @@ -218,10 +203,6 @@ See [UPGRADE.md](https://github.com/Substra/substra-backend/blob/main/charts/sub
| `builder.podSecurityContext.runAsUser` | User ID for the pod | `1001` |
| `builder.podSecurityContext.runAsGroup` | Group ID for the pod | `1001` |
| `builder.podSecurityContext.fsGroup` | FileSystem group ID for the pod | `1001` |
| `builder.resources.requests.cpu` | Builder container cpu request | `2000m` |
| `builder.resources.requests.memory` | Builder container memory request | `4Gi` |
| `builder.resources.limits.cpu` | Builder container cpu limit | `2000m` |
| `builder.resources.limits.memory` | Builder container memory limit | `8Gi` |
| `builder.nodeSelector` | Node labels for pod assignment | `{}` |
| `builder.tolerations` | Toleration labels for pod assignment | `[]` |
| `builder.affinity` | Affinity settings for pod assignment, ignored if `DataSampleStorageInServerMedia` is `true` | `{}` |
Expand Down

0 comments on commit cc964bd

Please sign in to comment.