Skip to content

docs(postgresql): improve SSL docs #78

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

Merged
merged 7 commits into from
Jun 20, 2025
Merged

docs(postgresql): improve SSL docs #78

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
56071e5
docs(postgresql): improve SSL docs
masontikhonov Jun 15, 2025
f6f1366
docs(postgresql): mention potential SSL issues in “To 2.8” section
masontikhonov Jun 18, 2025
5b7ea47
ci: document chart changes
masontikhonov Jun 18, 2025
13d4a5f
helm dep update
mikhail-klimko Jun 19, 2025
1f81593
helm dep update
mikhail-klimko Jun 19, 2025
051673e
helm dep update
mikhail-klimko Jun 19, 2025
5d083f4
fix: global image registy for runtime images
mikhail-klimko Jun 20, 2025
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
2 changes: 1 addition & 1 deletion codefresh/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: v2
description: Helm Chart for Codefresh On-Prem
name: codefresh
version: 2.8.6
version: 2.8.7
keywords:
- codefresh
home: https://codefresh.io/
Expand Down
16 changes: 14 additions & 2 deletions codefresh/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Codefresh On-Premises

![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)
![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)

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

Expand Down Expand Up @@ -409,18 +409,26 @@ postgresql:
enabled: false
```

Provide the following env vars to enable SSL connection to Postgres:
##### Using SSL with a PostgreSQL

Provide the following env vars to enforce SSL connection to PostgresSQL:

```yaml
global:
env:
# More info in the official docs: https://www.postgresql.org/docs/current/libpq-envars.html
PGSSLMODE: "require"

helm-repo-manager:
env:
POSTGRES_DISABLE_SSL: "false"
```

> ⚠️ **Important!**<br />
> We do not support custom CA configuration for PostgreSQL, including self-signed certificates. This may cause incompatibility with some providers' default configurations.<br />
> 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 />
> We recommend disabling SSL on the provider side in such cases or using the following steps to mount custom CA certificates: [Mounting private CA certs](#mounting-private-ca-certs)

#### External Redis

```yaml
Expand Down Expand Up @@ -2177,6 +2185,10 @@ Default PostgreSQL image is changed from 13.x to 17.x

If you run external PostgreSQL, follow the [official instructions](https://www.postgresql.org/docs/17/upgrading.html) to upgrade to 17.x.

> ⚠️ **Important!**<br />
> The default SSL configuration may change on your provider's side when you upgrade.<br />
> Please read the following section before the upgrade: [Using SSL with a PostgreSQL](#using-ssl-with-a-postgresql)

⚠️ ⚠️ ⚠️ 16.x version is also supported (17.x version of PostgreSQL is still in preview on multiple cloud providers)

⚠️ ⚠️ ⚠️ If you run built-in PostgreSQL `bitnami/postgresql` subchart, direct upgrade is not supported due to **incompatible breaking changes** in the database files. You will see the following error in the logs:
Expand Down
15 changes: 14 additions & 1 deletion codefresh/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,18 +411,27 @@ postgresql:
enabled: false
```

Provide the following env vars to enable SSL connection to Postgres:
##### Using SSL with a PostgreSQL

Provide the following env vars to enforce SSL connection to PostgresSQL:

```yaml
global:
env:
# More info in the official docs: https://www.postgresql.org/docs/current/libpq-envars.html
PGSSLMODE: "require"

helm-repo-manager:
env:
POSTGRES_DISABLE_SSL: "false"
```

> ⚠️ **Important!**<br />
> We do not support custom CA configuration for PostgreSQL, including self-signed certificates. This may cause incompatibility with some providers' default configurations.<br />
> 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 />
> We recommend disabling SSL on the provider side in such cases or using the following steps to mount custom CA certificates: [Mounting private CA certs](#mounting-private-ca-certs)


#### External Redis

```yaml
Expand Down Expand Up @@ -2186,6 +2195,10 @@ Default PostgreSQL image is changed from 13.x to 17.x

If you run external PostgreSQL, follow the [official instructions](https://www.postgresql.org/docs/17/upgrading.html) to upgrade to 17.x.

> ⚠️ **Important!**<br />
> The default SSL configuration may change on your provider's side when you upgrade.<br />
> Please read the following section before the upgrade: [Using SSL with a PostgreSQL](#using-ssl-with-a-postgresql)

⚠️ ⚠️ ⚠️ 16.x version is also supported (17.x version of PostgreSQL is still in preview on multiple cloud providers)

⚠️ ⚠️ ⚠️ If you run built-in PostgreSQL `bitnami/postgresql` subchart, direct upgrade is not supported due to **incompatible breaking changes** in the database files. You will see the following error in the logs:
Expand Down