Skip to content

Commit 5567de4

Browse files
update README.md
1 parent 58183de commit 5567de4

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ See [Use OCI-based registries](https://helm.sh/docs/topics/registries/)
8181

8282
**Important:** only helm 3.8.0+ is supported
8383

84+
> ⚠️ The default chart configuration with embedded databases is **not intended for production usage**! You should use Cloud PaaS for MongoDB, PostgreSQL, Redis and RabbitMQ.
85+
See [Configuring external services](#configuring-external-services) section for details.
86+
8487
Edit default `values.yaml` or create empty `cf-values.yaml`
8588

8689
- Pass `sa.json` (as a single line) to `.Values.imageCredentials.password`
@@ -224,7 +227,7 @@ The chart contains required dependencies for the corresponding services
224227
- [bitnami/redis](https://github.com/bitnami/charts/tree/main/bitnami/redis)
225228
- [bitnami/rabbitmq](https://github.com/bitnami/charts/tree/main/bitnami/rabbitmq)
226229

227-
However, you might need to use external services like [MongoDB Atlas Database](https://www.mongodb.com/atlas/database) or [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/). In order to use them, adjust the values accordingly:
230+
To use external services like [MongoDB Atlas Database](https://www.mongodb.com/atlas/database) or [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/) you need to adjust the values accordingly:
228231

229232
#### External MongoDB
230233

@@ -2457,7 +2460,7 @@ After platform upgrade, Consul fails with the error `refusing to rejoin cluster
24572460
| argo-platform.runtime-monitor | object | See below | runtime-monitor Don't enable! Not used in onprem! |
24582461
| argo-platform.ui | object | See below | ui |
24592462
| argo-platform.useExternalSecret | bool | `false` | Use regular k8s secret object. Keep `false`! |
2460-
| builder | object | `{"affinity":{},"enabled":true,"imagePullSecrets":[],"initContainers":{"register":{"image":{"registry":"us-docker.pkg.dev/codefresh-inc/public-gcr-io","repository":"codefresh/curl","tag":"8.14.1"}}},"nodeSelector":{},"podSecurityContext":{},"resources":{},"tolerations":[]}` | builder |
2463+
| builder | object | `{"affinity":{},"container":{"image":{"registry":"quay.io","repository":"codefresh/dind","tag":"26.1.4-1.28.8"}},"enabled":true,"imagePullSecrets":[],"initContainers":{"register":{"image":{"registry":"us-docker.pkg.dev/codefresh-inc/public-gcr-io","repository":"codefresh/curl","tag":"8.14.1"}}},"nodeSelector":{},"podSecurityContext":{},"resources":{},"tolerations":[]}` | builder |
24612464
| cf-broadcaster | object | See below | broadcaster |
24622465
| cf-oidc-provider | object | See below | cf-oidc-provider |
24632466
| cf-platform-analytics-etlstarter | object | See below | etl-starter |

README.md.gotmpl

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ See [Use OCI-based registries](https://helm.sh/docs/topics/registries/)
8282

8383
**Important:** only helm 3.8.0+ is supported
8484

85+
> ⚠️ The default chart configuration with embedded databases is **not intended for production usage**! You should use Cloud PaaS for MongoDB, PostgreSQL, Redis and RabbitMQ.
86+
See [Configuring external services](#configuring-external-services) section for details.
87+
8588
Edit default `values.yaml` or create empty `cf-values.yaml`
8689

8790
- Pass `sa.json` (as a single line) to `.Values.imageCredentials.password`
@@ -225,7 +228,7 @@ The chart contains required dependencies for the corresponding services
225228
- [bitnami/redis](https://github.com/bitnami/charts/tree/main/bitnami/redis)
226229
- [bitnami/rabbitmq](https://github.com/bitnami/charts/tree/main/bitnami/rabbitmq)
227230

228-
However, you might need to use external services like [MongoDB Atlas Database](https://www.mongodb.com/atlas/database) or [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/). In order to use them, adjust the values accordingly:
231+
To use external services like [MongoDB Atlas Database](https://www.mongodb.com/atlas/database) or [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/) you need to adjust the values accordingly:
229232

230233
#### External MongoDB
231234

0 commit comments

Comments
 (0)