Update links to JDBC documentation

The link we used for connection parameters and URIs was broken, 404.

Author: cbandy

docs/content/architecture/user-management.md

@@ -20,10 +20,13 @@ When you create a Postgres cluster with PGO and do not specify any additional us
   - `user`: The name of the user account.
   - `password`: The password for the user account.
   - `dbname`: The name of the database that the user has access to by default.
-  - `host`: The name of the host of the database. This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the primary Postgres instance.
+  - `host`: The name of the host of the database.
+    This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the primary Postgres instance.
   - `port`: The port that the database is listening on.
-  - `uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) that provides all the information for logging into the Postgres database.
-  - `jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/head/connect.html) that provides all the information for logging into the Postgres database via the JDBC driver.
+  - `uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING)
+    that provides all the information for logging into the Postgres database.
+  - `jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/use/)
+    that provides all the information for logging into the Postgres database via the JDBC driver.
 
 You can see this default behavior in the [connect to a cluster]({{< relref "tutorial/connect-cluster.md" >}}) portion of the tutorial.
 

docs/content/quickstart/_index.md

@@ -78,17 +78,23 @@ Within this Secret are attributes that provide information to let you log into t
 - `user`: The name of the user account.
 - `password`: The password for the user account.
 - `dbname`: The name of the database that the user has access to by default.
-- `host`: The name of the host of the database. This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the primary Postgres instance.
+- `host`: The name of the host of the database.
+  This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the primary Postgres instance.
 - `port`: The port that the database is listening on.
-- `uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) that provides all the information for logging into the Postgres database.
-- `jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/head/connect.html) that provides all the information for logging into the Postgres database via the JDBC driver.
+- `uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING)
+  that provides all the information for logging into the Postgres database.
+- `jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/use/)
+  that provides all the information for logging into the Postgres database via the JDBC driver.
 
 If you deploy your Postgres cluster with the [PgBouncer](https://www.pgbouncer.org/) connection pooler, there are additional values that are populated in the user Secret, including:
 
-- `pgbouncer-host`: The name of the host of the PgBouncer connection pooler. This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the PgBouncer connection pooler.
+- `pgbouncer-host`: The name of the host of the PgBouncer connection pooler.
+  This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the PgBouncer connection pooler.
 - `pgbouncer-port`: The port that the PgBouncer connection pooler is listening on.
-- `pgbouncer-uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) that provides all the information for logging into the Postgres database via the PgBouncer connection pooler.
-- `pgbouncer-jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/head/connect.html) that provides all the information for logging into the Postgres database via the PgBouncer connection pooler using the JDBC driver.
+- `pgbouncer-uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING)
+  that provides all the information for logging into the Postgres database via the PgBouncer connection pooler.
+- `pgbouncer-jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/use/)
+  that provides all the information for logging into the Postgres database via the PgBouncer connection pooler using the JDBC driver.
 
 Note that **all connections use TLS**. PGO sets up a PKI for your Postgres clusters. You can also choose to bring your own PKI / certificate authority; this is covered later in the documentation.
 

docs/content/tutorial/connect-cluster.md

@@ -33,10 +33,13 @@ When your Postgres cluster is initialized, PGO will bootstrap a database and Pos
 - `user`: The name of the user account.
 - `password`: The password for the user account.
 - `dbname`: The name of the database that the user has access to by default.
-- `host`: The name of the host of the database. This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the primary Postgres instance.
+- `host`: The name of the host of the database.
+  This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the primary Postgres instance.
 - `port`: The port that the database is listening on.
-- `uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) that provides all the information for logging into the Postgres database.
-- `jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/head/connect.html) that provides all the information for logging into the Postgres database via the JDBC driver.
+- `uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING)
+  that provides all the information for logging into the Postgres database.
+- `jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/use/) that provides
+  all the information for logging into the Postgres database via the JDBC driver.
 
 All connections are over TLS. PGO provides its own certificate authority (CA) to allow you to securely connect your applications to your Postgres clusters. This allows you to use the [`verify-full` "SSL mode"](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-SSLMODE-STATEMENTS) of Postgres, which provides eavesdropping protection and prevents MITM attacks. You can also choose to bring your own CA, which is described later in this tutorial in the [Customize Cluster]({{< relref "./customize-cluster.md" >}}) section.
 

docs/content/tutorial/connection-pooling.md

@@ -45,10 +45,15 @@ kubectl -n postgres-operator describe secrets keycloakdb-pguser-keycloakdb
 
 You should see that there are several new attributes included in this Secret that allow for you to connect to your Postgres instance via the connection pooler:
 
-- `pgbouncer-host`: The name of the host of the PgBouncer connection pooler. This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the PgBouncer connection pooler.
+- `pgbouncer-host`: The name of the host of the PgBouncer connection pooler.
+  This references the [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of the PgBouncer connection pooler.
 - `pgbouncer-port`: The port that the PgBouncer connection pooler is listening on.
-- `pgbouncer-uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) that provides all the information for logging into the Postgres database via the PgBouncer connection pooler.
-- `pgbouncer-jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/head/connect.html) that provides all the information for logging into the Postgres database via the PgBouncer connection pooler using the JDBC driver. Note that by default, the connection string disable JDBC managing prepared transactions for [optimal use with PgBouncer](https://www.pgbouncer.org/faq.html#how-to-use-prepared-statements-with-transaction-pooling).
+- `pgbouncer-uri`: A [PostgreSQL connection URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING)
+  that provides all the information for logging into the Postgres database via the PgBouncer connection pooler.
+- `pgbouncer-jdbc-uri`: A [PostgreSQL JDBC connection URI](https://jdbc.postgresql.org/documentation/use/) that provides
+  all the information for logging into the Postgres database via the PgBouncer connection pooler using the JDBC driver.
+  Note that by default, the connection string disable JDBC managing prepared transactions for
+  [optimal use with PgBouncer](https://www.pgbouncer.org/faq.html#how-to-use-prepared-statements-with-transaction-pooling).
 
 Open up the file in `kustomize/keycloak/keycloak.yaml`. Update the `DB_ADDR` and `DB_PORT` values to be the following:
 

internal/controller/postgrescluster/postgres.go

@@ -117,16 +117,16 @@ func (r *Reconciler) generatePostgresUserSecret(
 			Path:   database,
 		}).String())
 
-		// Reference to the PostgreSQL JDBC URI:
-		// https://jdbc.postgresql.org/documentation/head/connect.html
-		jdbc_query := url.Values{}
-		jdbc_query.Set("user", username)
-		jdbc_query.Set("password", string(intent.Data["password"]))
+		// The JDBC driver requires a different URI scheme and query component.
+		// - https://jdbc.postgresql.org/documentation/use/#connection-parameters
+		query := url.Values{}
+		query.Set("user", username)
+		query.Set("password", string(intent.Data["password"]))
 		intent.Data["jdbc-uri"] = []byte((&url.URL{
 			Scheme:   "jdbc:postgresql",
 			Host:     net.JoinHostPort(hostname, port),
 			Path:     database,
-			RawQuery: jdbc_query.Encode(),
+			RawQuery: query.Encode(),
 		}).String())
 	}
 
@@ -149,21 +149,20 @@ func (r *Reconciler) generatePostgresUserSecret(
 				Path:   database,
 			}).String())
 
-			// Reference to the PostgreSQL JDBC URI:
-			// https://jdbc.postgresql.org/documentation/head/connect.html
-			jdbc_query := url.Values{}
-			jdbc_query.Set("user", username)
-			jdbc_query.Set("password", string(intent.Data["password"]))
-			// Prepared statements to be disabled to use transaction pooling. Speaking
-			// with JDBC maintainers, we can just set this to disabled in general when
-			// connecting to pgBouncer
-			// https://www.pgbouncer.org/faq.html#how-to-use-prepared-statements-with-transaction-pooling
-			jdbc_query.Set("prepareThreshold", "0")
+			// The JDBC driver requires a different URI scheme and query component.
+			// Disable prepared statements to be compatible with PgBouncer's
+			// transaction pooling.
+			// - https://jdbc.postgresql.org/documentation/use/#connection-parameters
+			// - https://www.pgbouncer.org/faq.html#how-to-use-prepared-statements-with-transaction-pooling
+			query := url.Values{}
+			query.Set("user", username)
+			query.Set("password", string(intent.Data["password"]))
+			query.Set("prepareThreshold", "0")
 			intent.Data["pgbouncer-jdbc-uri"] = []byte((&url.URL{
 				Scheme:   "jdbc:postgresql",
 				Host:     net.JoinHostPort(hostname, port),
 				Path:     database,
-				RawQuery: jdbc_query.Encode(),
+				RawQuery: query.Encode(),
 			}).String())
 		}
 	}