Using the wrapper with a specific version of underlying MySQL JDBC Driver #375

dstaviss · 2023-03-28T00:47:38Z

dstaviss
Mar 28, 2023

I can't find anything in the documentation regarding this - where do/can I specify which driver (class) to use as the underlying JDBC Driver?
Also, we are not using DriverManager but have our own implementation that takes care of remote class-loading of the required driver and hence it goes like .connect(...) - will that work for the wrapper?
Thx, David

Answered by karenc-bq

Mar 29, 2023

Hi, @dstaviss,

When you use the wrapper driver you also need to specify the underlying driver you need to use.
Depending on your tech stack you may do this in several ways. For instance if you are using the Gradle build tool you can specify the underlying driver as a dependency, see the documentation for more details. Please feel free to let me know if you would like an example for a specific workflow.
We recommend using the AwsWrapperDataSource with a target data source class of your choice. Here is a simple example. For more configuration properties check out this documentation.

View full answer

karenc-bq · 2023-03-29T18:38:30Z

karenc-bq
Mar 29, 2023
Maintainer

Hi, @dstaviss,

When you use the wrapper driver you also need to specify the underlying driver you need to use.
Depending on your tech stack you may do this in several ways. For instance if you are using the Gradle build tool you can specify the underlying driver as a dependency, see the documentation for more details. Please feel free to let me know if you would like an example for a specific workflow.
We recommend using the AwsWrapperDataSource with a target data source class of your choice. Here is a simple example. For more configuration properties check out this documentation.

1 reply

dstaviss Mar 29, 2023
Author

Oh so you build the wrapper for a specific driver got it! Thanks

Bharathkumarraju · 2023-08-31T07:37:33Z

Bharathkumarraju
Aug 31, 2023

@karenc-bq i build the keycloak image using below build.gradle

apply plugin: 'groovy'

repositories {
    mavenCentral()
}

def jdbcversion = '2.2.2'      // set to latest version of aws-advanced-jdbc-wrapper package
def awsSdkVersion = '2.20.107' // set to latest version of software.amazon.awssdk

dependencies {
    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: jdbcversion
    implementation group: 'software.amazon.awssdk', name: 'apache-client', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'auth', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'aws-core', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'aws-json-protocol', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'aws-query-protocol', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'endpoints-spi', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'http-client-spi', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'json-utils', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'metrics-spi', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'profiles', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'protocol-core', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'rds', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'regions', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'sdk-core', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'sts', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'third-party-jackson-core', version: awsSdkVersion
    implementation group: 'software.amazon.awssdk', name: 'utils', version: awsSdkVersion
}

task copyDependencies(type: Copy) {
    from configurations.runtimeClasspath
    into "lib"
}

and below Dockerfile

➜  build_keycloak cat Dockerfile
FROM gradle:jdk17-focal as lib

WORKDIR /home/gradle

COPY build.gradle /home/gradle

RUN gradle copyDependencies

FROM keycloak/keycloak:21.1 as builder

# Enable health and metrics support
ENV KC_HEALTH_ENABLED=true
ENV KC_METRICS_ENABLED=true

# Configure a database vendor
ENV KC_DB=mysql

COPY --from=lib /home/gradle/lib /opt/keycloak/providers

WORKDIR /opt/keycloak

RUN /opt/keycloak/bin/kc.sh build

FROM keycloak/keycloak:21.1

COPY --from=builder /opt/keycloak/ /opt/keycloak/

ENV KC_DB=mysql

ENTRYPOINT ["/opt/keycloak/bin/kc.sh"]

but unfortunately, when I deploy the keycloak deployment it says that I am still using the 2023-08-31 04:07:41,227 FINE [org.postgresql.Driver] (agroal-11) JDBC URL must start with "jdbc:postgresql:" but was: jdbc:mysql://clarity-aps1-xxxxxxxxxxxxxxxxxxxxxxxxx.ap-southeast-1.rds.amazonaws.com:3306/keycloak?wrapperPlugins=iam

2023-08-31 04:07:40,509 DEBUG [io.quarkus.hibernate.orm.runtime.FastBootHibernatePersistenceProvider] (JPA Startup Thread: keycloak-default) No PersistenceProvider explicitly requested, assuming Hibernate
2023-08-31 04:07:41,227 FINE  [org.postgresql.Driver] (agroal-11) JDBC URL must start with "jdbc:postgresql:" but was: jdbc:mysql://clarity-aps1-xxxxxxxxxxxxxxxxxxxxxxxxx.ap-southeast-1.rds.amazonaws.com:3306/keycloak?wrapperPlugins=iam
2023-08-31 04:07:46,011 WARN  [org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator] (JPA Startup Thread: keycloak-default) HHH000342: Could not obtain connection to query metadata: java.sql.SQLException: Acquisition timeout while waiting for new connection
	at io.agroal.pool.ConnectionPool.handlerFromSharedCache(ConnectionPool.java:321)
	at io.agroal.pool.ConnectionPool.getConnection(ConnectionPool.java:249)
	at io.agroal.pool.DataSource.getConnection(DataSource.java:86)
	at io.quarkus.hibernate.orm.runtime.customized.QuarkusConnectionProvider.getConnection(QuarkusConnectionProvider.java:23)
	at org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator$ConnectionProviderJdbcConnectionAccess.obtainConnection(JdbcEnvironmentInitiator.java:181)
	at org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.initiateService(JdbcEnvironmentInitiator.java:68)
	at org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.initiateService(JdbcEnvironmentInitiator.java:35)
	at org.hibernate.boot.registry.internal.StandardServiceRegistryImpl.initiateService(StandardServiceRegistryImpl.java:101)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.createService(AbstractServiceRegistryImpl.java:263)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.initializeService(AbstractServiceRegistryImpl.java:237)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.getService(AbstractServiceRegistryImpl.java:214)
	at org.hibernate.engine.jdbc.internal.JdbcServicesImpl.configure(JdbcServicesImpl.java:51)
	at org.hibernate.boot.registry.internal.StandardServiceRegistryImpl.configureService(StandardServiceRegistryImpl.java:107)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.initializeService(AbstractServiceRegistryImpl.java:246)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.getService(AbstractServiceRegistryImpl.java:214)
	at org.hibernate.boot.internal.SessionFactoryOptionsBuilder.<init>(SessionFactoryOptionsBuilder.java:272)
	at io.quarkus.hibernate.orm.runtime.recording.PrevalidatedQuarkusMetadata.buildSessionFactoryOptionsBuilder(PrevalidatedQuarkusMetadata.java:68)
	at io.quarkus.hibernate.orm.runtime.boot.FastBootEntityManagerFactoryBuilder.build(FastBootEntityManagerFactoryBuilder.java:72)
	at io.quarkus.hibernate.orm.runtime.FastBootHibernatePersistenceProvider.createEntityManagerFactory(FastBootHibernatePersistenceProvider.java:72)
	at javax.persistence.Persistence.createEntityManagerFactory(Persistence.java:80)
	at javax.persistence.Persistence.createEntityManagerFactory(Persistence.java:55)
	at io.quarkus.hibernate.orm.runtime.JPAConfig$LazyPersistenceUnit.get(JPAConfig.java:165)
	at io.quarkus.hibernate.orm.runtime.JPAConfig$1.run(JPAConfig.java:66)
	at java.base/java.lang.Thread.run(Thread.java:833)
Caused by: java.util.concurrent.TimeoutException

and my deployment.yaml is this

apiVersion: apps/v1
kind: Deployment
metadata:
  annotations:
    meta.helm.sh/release-name: bk
    meta.helm.sh/release-namespace: bk-staging
  creationTimestamp: "2023-08-31T05:40:21Z"
  generation: 1
  labels:
    app: keycloak
    app.kubernetes.io/managed-by: Helm
  name: keycloak
  namespace: bk-staging
  resourceVersion: "488930"
  uid: 57810ae8-1f8c-4491-b2a0-4bd2ad6b38e6
spec:
  progressDeadlineSeconds: 600
  replicas: 1
  revisionHistoryLimit: 10
  selector:
    matchLabels:
      app: keycloak
  strategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
    type: RollingUpdate
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: keycloak
    spec:
      containers:
      - args:
        - start
        - --import-realm
        env:
        - name: KC_DB
          value: mysql
        - name: KC_DB_URL
          value: jdbc:aws-wrapper:mysql://bk-aps1-xxxxxxxxxxxxxxxxx.ap-southeast-1.rds.amazonaws.com:3306/keycloak?wrapperPlugins=iam
        - name: KC_HEALTH_ENABLED
          value: "true"
        - name: KC_PROXY
          value: edge
        - name: KC_HOSTNAME
          value: auth.bharath.net
        - name: KC_DB_DRIVER
          value: software.amazon.jdbc.Driver
        - name: KC_TRANSACTION_XA_ENABLED
          value: "false"
        - name: KEYCLOAK_LOGLEVEL
          value: DEBUG
        - name: KC_LOG_LEVEL
          value: DEBUG
        envFrom:
        - secretRef:
            name: keycloak-admin-secret
        - secretRef:
            name: keycloak-db-creds-secret
        image: keycloak/keycloak:21.1.1-updated
        name: keycloak
        ports:
        - containerPort: 8080
          name: http
          protocol: TCP
        resources:
          limits:
            cpu: "1"
            memory: 1000Mi
          requests:
            cpu: 250m
            memory: 400Mi
        terminationMessagePath: /dev/termination-log
        terminationMessagePolicy: File
        volumeMounts:
        - mountPath: /opt/keycloak/data/import/
          name: keycloak-realm
        - mountPath: /opt/keycloak/themes/
          name: keycloak-themes
      dnsPolicy: ClusterFirst
      restartPolicy: Always
      schedulerName: default-scheduler
      securityContext: {}
      serviceAccount: bk
      serviceAccountName: bk
      terminationGracePeriodSeconds: 30
      volumes:
      - configMap:
          defaultMode: 420
          items:
          - key: theme.properties
            path: bk/login/theme.properties
          - key: bk.css
            path: bk/login/resources/css/bk.css
          - key: bk-logo.png
            path: bk/login/resources/img/bk-logo.png
          - key: template.ftl
            path: bk/login/template.ftl
          name: keycloak-themes-configmap
        name: keycloak-themes
      - configMap:
          defaultMode: 420
          items:
          - key: realm.json
            path: realm.json
          name: keycloak-realm
        name: keycloak-realm

6 replies

davecramer Sep 1, 2023
Maintainer

You shouldn't have to specify the version as it is loaded at runtime.

Bharathkumarraju Sep 3, 2023

@davecramer my observations so far are aws-advanced-jdbc-wrapper it is loading only PostgreSQL driver only

karenc-bq Sep 5, 2023
Maintainer

Hi @Bharathkumarraju, yes, you would need to specify your target driver in the dependency as well. In your case, you need to add the MySQL driver in your build.gradle like the snippet you showed here.

Bharathkumarraju Sep 12, 2023

@karenc-bq thanks for reply now i get below errors

case1: using software.amazon.jdbc.Driver

error as below

2023-09-12 08:57:05,399 FINE  [org.postgresql.Driver] (agroal-11) JDBC URL must start with "jdbc:postgresql:" but was: jdbc:mysql://xxxxxxxxxxxxxx.ap-southeast-1.rds.amazonaws.com:3306/keycloak?serverTimezone=UTC&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&useSSL=true&wrapperPlugins=iam
2023-09-12 08:57:10,203 WARN  [org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator] (JPA Startup Thread: keycloak-default) HHH000342: Could not obtain connection to query metadata: java.sql.SQLException: Acquisition timeout while waiting for new connection
	at io.agroal.pool.ConnectionPool.handlerFromSharedCache(ConnectionPool.java:321)
	at io.agroal.pool.ConnectionPool.getConnection(ConnectionPool.java:249)
	at io.agroal.pool.DataSource.getConnection(DataSource.java:86)
	at io.quarkus.hibernate.orm.runtime.customized.QuarkusConnectionProvider.getConnection(QuarkusConnectionProvider.java:23)
	at org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator$ConnectionProviderJdbcConnectionAccess.obtainConnection(JdbcEnvironmentInitiator.java:181)
	at org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.initiateService(JdbcEnvironmentInitiator.java:68)
	at org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.initiateService(JdbcEnvironmentInitiator.java:35)
	at org.hibernate.boot.registry.internal.StandardServiceRegistryImpl.initiateService(StandardServiceRegistryImpl.java:101)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.createService(AbstractServiceRegistryImpl.java:272)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.initializeService(AbstractServiceRegistryImpl.java:246)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.getService(AbstractServiceRegistryImpl.java:223)
	at org.hibernate.engine.jdbc.internal.JdbcServicesImpl.configure(JdbcServicesImpl.java:51)
	at org.hibernate.boot.registry.internal.StandardServiceRegistryImpl.configureService(StandardServiceRegistryImpl.java:107)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.initializeService(AbstractServiceRegistryImpl.java:255)
	at org.hibernate.service.internal.AbstractServiceRegistryImpl.getService(AbstractServiceRegistryImpl.java:223)
	at org.hibernate.boot.internal.SessionFactoryOptionsBuilder.<init>(SessionFactoryOptionsBuilder.java:272)
	at io.quarkus.hibernate.orm.runtime.recording.PrevalidatedQuarkusMetadata.buildSessionFactoryOptionsBuilder(PrevalidatedQuarkusMetadata.java:68)
	at io.quarkus.hibernate.orm.runtime.boot.FastBootEntityManagerFactoryBuilder.build(FastBootEntityManagerFactoryBuilder.java:72)
	at io.quarkus.hibernate.orm.runtime.FastBootHibernatePersistenceProvider.createEntityManagerFactory(FastBootHibernatePersistenceProvider.java:72)
	at javax.persistence.Persistence.createEntityManagerFactory(Persistence.java:80)
	at javax.persistence.Persistence.createEntityManagerFactory(Persistence.java:55)
	at io.quarkus.hibernate.orm.runtime.JPAConfig$LazyPersistenceUnit.get(JPAConfig.java:165)
	at io.quarkus.hibernate.orm.runtime.JPAConfig$1.run(JPAConfig.java:66)
	at java.base/java.lang.Thread.run(Thread.java:833)
Caused by: java.util.concurrent.TimeoutException
	at java.base/java.util.concurrent.FutureTask.get(FutureTask.java:204)
	at io.agroal.pool.ConnectionPool.handlerFromSharedCache(ConnectionPool.java:298)
	... 23 more

2023-09-12 08:57:46,803 ERROR [org.keycloak.quarkus.runtime.cli.ExecutionExceptionHandler] (main) ERROR: Failed to start server in (production) mode
2023-09-12 08:57:46,803 ERROR [org.keycloak.quarkus.runtime.cli.ExecutionExceptionHandler] (main) ERROR: Failed to obtain JDBC connection

case2: using com.mysql.cj.jdbc.Driver

getting below error...

2023-09-12 09:38:59,560 WARN  [io.agroal.pool] (agroal-11) Datasource '<default>': Driver does not support the provided URL: jdbc:aws-wrapper:mysql://xxxxxxxxxxxxxxxxxx.ap-southeast-1.rds.amazonaws.com:3306/keycloak?serverTimezone=UTC&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&useSSL=true&wrapperPlugins=iam
2023-09-12 09:38:59,561 DEBUG [io.agroal.pool] (agroal-11) Cause: : java.sql.SQLException: Driver does not support the provided URL: jdbc:aws-wrapper:mysql://clarity-aps1-proxy-dev.proxy-cx9rq2vlnygg.ap-southeast-1.rds.amazonaws.com:3306/keycloak?serverTimezone=UTC&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&useSSL=true&wrapperPlugins=iam
	at io.agroal.pool.ConnectionFactory.connectionSetup(ConnectionFactory.java:242)
	at io.agroal.pool.ConnectionFactory.createConnection(ConnectionFactory.java:226)
	at io.agroal.pool.ConnectionPool$CreateConnectionTask.call(ConnectionPool.java:536)
	at io.agroal.pool.ConnectionPool$CreateConnectionTask.call(ConnectionPool.java:517)
	at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
	at io.agroal.pool.util.PriorityScheduledExecutor.beforeExecute(PriorityScheduledExecutor.java:75)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1134)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
	at java.base/java.lang.Thread.run(Thread.java:833)

Bharathkumarraju Sep 12, 2023

@karenc-bq is this driver software.amazon.jdbc.Driver even supports MySQL ?

ruhilrinku · 2024-08-30T08:13:41Z

ruhilrinku
Aug 30, 2024

Do we have any example of using this driver with hibernate panache with quarkus ?

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using the wrapper with a specific version of underlying MySQL JDBC Driver #375

{{title}}

Replies: 3 comments 7 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

Select a reply

Using the wrapper with a specific version of underlying MySQL JDBC Driver #375

dstaviss Mar 28, 2023

Replies: 3 comments · 7 replies

karenc-bq Mar 29, 2023 Maintainer

dstaviss Mar 29, 2023 Author

Bharathkumarraju Aug 31, 2023

davecramer Sep 1, 2023 Maintainer

Bharathkumarraju Sep 3, 2023

karenc-bq Sep 5, 2023 Maintainer

Bharathkumarraju Sep 12, 2023

Bharathkumarraju Sep 12, 2023

ruhilrinku Aug 30, 2024

dstaviss
Mar 28, 2023

Replies: 3 comments 7 replies

karenc-bq
Mar 29, 2023
Maintainer

dstaviss Mar 29, 2023
Author

Bharathkumarraju
Aug 31, 2023

davecramer Sep 1, 2023
Maintainer

karenc-bq Sep 5, 2023
Maintainer

ruhilrinku
Aug 30, 2024