From f5dea4662e61474280a3724c0c4e76cd6df0c675 Mon Sep 17 00:00:00 2001 From: Jacky Jiang Date: Wed, 17 Apr 2024 17:56:19 +1000 Subject: [PATCH] update docs --- README.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 7e61c59..d85f4bd 100644 --- a/README.md +++ b/README.md @@ -31,22 +31,24 @@ Kubernetes: `>= 1.21.0` ## Values -| Key | Type | Default | Description | -| ---------------------------- | ------ | ---------------------------------------- | ----------- | -| cronJobImage.name | string | `"alpine"` | | -| cronJobImage.pullPolicy | string | `"IfNotPresent"` | | -| cronJobImage.pullSecrets | bool | `false` | | -| cronJobImage.repository | string | `"docker.io"` | | -| cronJobImage.tag | string | `"latest"` | | -| defaultAdminUserId | string | `"00000000-0000-4000-8000-000000000000"` | | -| defaultImage.imagePullSecret | bool | `false` | | -| defaultImage.pullPolicy | string | `"IfNotPresent"` | | -| defaultImage.repository | string | `"ghcr.io/magda-io"` | | -| global.image | object | `{}` | | -| global.minions.image | object | `{}` | | -| global.rollingUpdate | object | `{}` | | -| image.name | string | `"magda-minion-broken-link"` | | -| resources.limits.cpu | string | `"200m"` | | -| resources.requests.cpu | string | `"50m"` | | -| resources.requests.memory | string | `"40Mi"` | | -| schedule | string | `"0 0 14,28 * *"` | | +| Key | Type | Default | Description | +| ---------------------------- | ------ | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| cronJobImage.name | string | `"alpine"` | | +| cronJobImage.pullPolicy | string | `"IfNotPresent"` | | +| cronJobImage.pullSecrets | bool | `false` | | +| cronJobImage.repository | string | `"docker.io"` | | +| cronJobImage.tag | string | `"latest"` | | +| datasetBucketName | string | `""` | The name of the storage bucket where all dataset files are stored. Should match storage API config. By default, it will use the value of `global.defaultDatasetBucket` (defined in `magda-core` chart) unless you specify a different value here. | +| defaultAdminUserId | string | `"00000000-0000-4000-8000-000000000000"` | | +| defaultImage.imagePullSecret | bool | `false` | | +| defaultImage.pullPolicy | string | `"IfNotPresent"` | | +| defaultImage.repository | string | `"ghcr.io/magda-io"` | | +| global.image | object | `{}` | | +| global.minions.image | object | `{}` | | +| global.rollingUpdate | object | `{}` | | +| image.name | string | `"magda-minion-broken-link"` | | +| resources.limits.cpu | string | `"200m"` | | +| resources.requests.cpu | string | `"50m"` | | +| resources.requests.memory | string | `"40Mi"` | | +| schedule | string | `"0 0 14,28 * *"` | | +| storageApiBaseUrl | string | `"http://storage-api/v0"` | The base URL of the storage API to use when generating access URLs for MAGDA internal stored resources. |