Skip to content

Commit 56071e5

Browse files
committed
docs(postgresql): improve SSL docs
1 parent 6097c03 commit 56071e5

File tree

3 files changed

+21
-4
lines changed

3 files changed

+21
-4
lines changed

codefresh/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
apiVersion: v2
22
description: Helm Chart for Codefresh On-Prem
33
name: codefresh
4-
version: 2.8.6
4+
version: 2.8.7
55
keywords:
66
- codefresh
77
home: https://codefresh.io/

codefresh/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Codefresh On-Premises
22

3-
![Version: 2.8.6](https://img.shields.io/badge/Version-2.8.6-informational?style=flat-square) ![AppVersion: 2.8.0](https://img.shields.io/badge/AppVersion-2.8.0-informational?style=flat-square)
3+
![Version: 2.8.7](https://img.shields.io/badge/Version-2.8.7-informational?style=flat-square) ![AppVersion: 2.8.0](https://img.shields.io/badge/AppVersion-2.8.0-informational?style=flat-square)
44

55
Helm chart for deploying [Codefresh On-Premises](https://codefresh.io/docs/docs/getting-started/intro-to-codefresh/) to Kubernetes.
66

@@ -409,18 +409,26 @@ postgresql:
409409
enabled: false
410410
```
411411
412-
Provide the following env vars to enable SSL connection to Postgres:
412+
##### Using SSL with a PostgreSQL
413+
414+
Provide the following env vars to enforce SSL connection to PostgresSQL:
413415
414416
```yaml
415417
global:
416418
env:
419+
# More info in the official docs: https://www.postgresql.org/docs/current/libpq-envars.html
417420
PGSSLMODE: "require"
418421

419422
helm-repo-manager:
420423
env:
421424
POSTGRES_DISABLE_SSL: "false"
422425
```
423426
427+
> ⚠️ **Important!**
428+
> We do not support custom CA configuration for PostgreSQL, including self-signed certificates. This may cause incompatibility with some providers' default configurations.<br />
429+
> In particular, Amazon RDS for PostgreSQL version 15 and later requires SSL encryption by default ([ref](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Concepts.General.SSL.html#PostgreSQL.Concepts.General.SSL.Requiring)).<br />
430+
> We recommend disabling SSL on the provider side in such cases or using the following workaround to mount custom CA certificates: [Mounting private CA certs](#mounting-private-ca-certs)
431+
424432
#### External Redis
425433
426434
```yaml

codefresh/README.md.gotmpl

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,18 +411,27 @@ postgresql:
411411
enabled: false
412412
```
413413

414-
Provide the following env vars to enable SSL connection to Postgres:
414+
##### Using SSL with a PostgreSQL
415+
416+
Provide the following env vars to enforce SSL connection to PostgresSQL:
415417

416418
```yaml
417419
global:
418420
env:
421+
# More info in the official docs: https://www.postgresql.org/docs/current/libpq-envars.html
419422
PGSSLMODE: "require"
420423

421424
helm-repo-manager:
422425
env:
423426
POSTGRES_DISABLE_SSL: "false"
424427
```
425428

429+
> ⚠️ **Important!**
430+
> We do not support custom CA configuration for PostgreSQL, including self-signed certificates. This may cause incompatibility with some providers' default configurations.<br />
431+
> In particular, Amazon RDS for PostgreSQL version 15 and later requires SSL encryption by default ([ref](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Concepts.General.SSL.html#PostgreSQL.Concepts.General.SSL.Requiring)).<br />
432+
> We recommend disabling SSL on the provider side in such cases or using the following workaround to mount custom CA certificates: [Mounting private CA certs](#mounting-private-ca-certs)
433+
434+
426435
#### External Redis
427436

428437
```yaml

0 commit comments

Comments
 (0)