diff --git a/charts/prefect-server/README.md b/charts/prefect-server/README.md index 7fd1aaa4..32d1d8e7 100644 --- a/charts/prefect-server/README.md +++ b/charts/prefect-server/README.md @@ -28,8 +28,14 @@ Note: If you choose to make modifications to either the `server.prefectApiUrl` o ### Handling Connection Secrets -If you are installing the chart as-is (and therefore installing PostgreSQL) - you'll need to update one of two fields: -1. `postgresql.auth.password`: a password you want to set for the prefect user +#### Using the bundled PostgreSQL chart + +By default, Bitnami's PostgreSQL Helm Chart will be deployed. This is **not intended for production use**, and is only +included to provide a functional proof of concept installation. + +In this scenario, you'll need to provide _either one_ of the following fields: + +1. `postgresql.auth.password`: a password you want to set for the prefect user (default: `prefect-rocks`) 2. `postgresql.auth.existingSecret`: name of an existing secret in your cluster with the following field: @@ -38,31 +44,34 @@ If you are installing the chart as-is (and therefore installing PostgreSQL) - yo - hostname = `-postgresql.:` - database = `postgresql.auth.database` +Two secrets are created when not providing an existing secret name: +1. `prefect-server-postgresql-connection`: used by the prefect-server deployment to connect to the postgresql database. + +2. `-postgresql-0`: defines the `postgresql.auth.username`'s password on the postgresql server to allow successful authentication from the prefect server. + +#### Using an external instance of PostgreSQL + If you want to disable the bundled PostgreSQL chart and use an external instance, provide the following configuration: ```yaml prefect-server: postgresql: - # Disable the objects from the bundled PostgreSQL chart enabled: false - auth: - # Option 1: provide the name of an existing secret following the instructions above. - existingSecret: - - # Option 2: provide the connection string details directly - username: myuser - password: mypass - database: mydb + secret: + # Option 1: provide the name of an existing secret following the instructions above. + create: false + name: + + # Option 2: provide the connection string details directly + create: true + username: myuser + password: mypass + host: myhost.com + port: 1234 + database: mydb ``` -Two secrets are created when not providing an existing secret name: -1. `prefect-server-postgresql-connection`: used by the prefect-server deployment to connect to the postgresql database. - -2. `-postgresql-0`: defines the `postgresql.auth.username`'s password on the postgresql server to allow successful authentication from the prefect server. - -No secrets are created when providing an existing secret. - ### Connecting with SSL configured 1. Mount the relevant certificate to `/home/prefect/.postgresql` so that it can be found by `asyncpg`. This is the default location postgresql expects per their [documentation](https://www.postgresql.org/docs/current/libpq-ssl.html). diff --git a/charts/prefect-server/README.md.gotmpl b/charts/prefect-server/README.md.gotmpl index 34e835de..18622fe8 100644 --- a/charts/prefect-server/README.md.gotmpl +++ b/charts/prefect-server/README.md.gotmpl @@ -27,8 +27,14 @@ Note: If you choose to make modifications to either the `server.prefectApiUrl` o ### Handling Connection Secrets -If you are installing the chart as-is (and therefore installing PostgreSQL) - you'll need to update one of two fields: -1. `postgresql.auth.password`: a password you want to set for the prefect user +#### Using the bundled PostgreSQL chart + +By default, Bitnami's PostgreSQL Helm Chart will be deployed. This is **not intended for production use**, and is only +included to provide a functional proof of concept installation. + +In this scenario, you'll need to provide _either one_ of the following fields: + +1. `postgresql.auth.password`: a password you want to set for the prefect user (default: `prefect-rocks`) 2. `postgresql.auth.existingSecret`: name of an existing secret in your cluster with the following field: @@ -37,31 +43,34 @@ If you are installing the chart as-is (and therefore installing PostgreSQL) - yo - hostname = `-postgresql.:` - database = `postgresql.auth.database` +Two secrets are created when not providing an existing secret name: +1. `prefect-server-postgresql-connection`: used by the prefect-server deployment to connect to the postgresql database. + +2. `-postgresql-0`: defines the `postgresql.auth.username`'s password on the postgresql server to allow successful authentication from the prefect server. + +#### Using an external instance of PostgreSQL + If you want to disable the bundled PostgreSQL chart and use an external instance, provide the following configuration: ```yaml prefect-server: postgresql: - # Disable the objects from the bundled PostgreSQL chart enabled: false - auth: - # Option 1: provide the name of an existing secret following the instructions above. - existingSecret: - - # Option 2: provide the connection string details directly - username: myuser - password: mypass - database: mydb + secret: + # Option 1: provide the name of an existing secret following the instructions above. + create: false + name: + + # Option 2: provide the connection string details directly + create: true + username: myuser + password: mypass + host: myhost.com + port: 1234 + database: mydb ``` -Two secrets are created when not providing an existing secret name: -1. `prefect-server-postgresql-connection`: used by the prefect-server deployment to connect to the postgresql database. - -2. `-postgresql-0`: defines the `postgresql.auth.username`'s password on the postgresql server to allow successful authentication from the prefect server. - -No secrets are created when providing an existing secret. - ### Connecting with SSL configured 1. Mount the relevant certificate to `/home/prefect/.postgresql` so that it can be found by `asyncpg`. This is the default location postgresql expects per their [documentation](https://www.postgresql.org/docs/current/libpq-ssl.html).