Skip to content

Commit

Permalink
added TODOs to remove dataSource from config docs after 4.4 support ends
Browse files Browse the repository at this point in the history
  • Loading branch information
virgo47 committed May 20, 2022
1 parent 923ed4f commit f4243bd
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/deployment/clustering-ha/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@ The jdbcUrl from repository config will be used.
As a result, Quartz tables will be stored in the same database instance as midPoint tables.)


// TODO remove when 4.4 support ends
| dataSource
| Uses specified data source to obtain DB connections.
(See xref:/midpoint/reference/repository/configuration/[Repository Configuration]).
Expand Down
1 change: 1 addition & 0 deletions docs/legacy/repo-ninja.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ Use options:

=== Known problems

// TODO remove when 4.4 support ends
. Repository validation fails when MidPoint configuration uses <dataSource> and doesn't contain simple JDBC connection parameters.
It's because JNDI data source is not available outside tomcat container so Repo Ninja can't see it and therefore can't initialize Repository service.

Expand Down
3 changes: 2 additions & 1 deletion docs/repository/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The following table lists the basic configuration options for the `repository` e

| `jdbcUrl`
| URL for JDBC connection.
This must be used (unless non-recommended `dataSource` is present) and can optionally conatain username and password.
This must be used and can optionally conatain username and password.
See https://jdbc.postgresql.org/documentation/head/connect.html[Connecting to the Database] from PostgreSQL JDBC Driver documentation for more.
| `jdbc:postgresql://localhost:5432/midpoint`

Expand All @@ -87,6 +87,7 @@ Example: `password`
| Ignored by the Native repository and cannot be changed - do not use it.
| `org.postgresql.Driver`

// TODO remove when 4.4 support ends
| `dataSource`
| Uses JNDI DataSource loading, when this option is defined in configuration.
This is only relevant for WAR deployment which is not recommended anyway.
Expand Down
2 changes: 2 additions & 0 deletions docs/repository/generic/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ Please see *Schema creation and updating* section later.
| SQL dialect based on chosen DB link:http://docs.jboss.org/hibernate/orm/4.1/manual/en-US/html_single/#sql-dialects[Supported hibernate dialects].
| org.hibernate.dialect.H2Dialect

// TODO remove when 4.4 support ends
| dataSource
| Uses JNDI DataSource loading, when this option is defined in configuration, then *jdbcUsername*, *jdbcPassword*, *jdbcUrl* and *driverClassName* don't need to be present.

Expand Down Expand Up @@ -264,6 +265,7 @@ SQL schema scripts for all supported databases are located in midPoint distribut

For current unreleased MidPoint SQL scripts are located in our link:https://github.com/Evolveum/midpoint/tree/master/config/sql/_all[git].

// TODO remove when 4.4 support ends
== Data source configuration

Instead of putting JDBC configuration to *config.xml*, you can use data source of the application server.
Expand Down
2 changes: 2 additions & 0 deletions docs/repository/generic/generic-audit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Example: `password`
| Ignored by the Native repository and cannot be changed - do not use it.
| `org.postgresql.Driver`

// TODO remove when 4.4 support ends
| `dataSource`
| Uses JNDI DataSource loading, when this option is defined in configuration.
This is only relevant for WAR deployment which is not recommended anyway.
Expand Down Expand Up @@ -425,6 +426,7 @@ Configuration element *auditService* for *SqlAuditServiceFactory* can contain an

* The recommended way is to use *jdbcUrl* with *jdbcUsername*, *jdbcPassword* and *driverClassName* and *database*.

// TODO remove when 4.4 support ends
* Preconfigured *dataSource* for WAR deployment on application server or Tomcat is also possible - but this is not recommended anymore and not officially supported.

* In both cases the right value for *database* element should be used, e.g. *postgresql*.
Expand Down
1 change: 1 addition & 0 deletions docs/repository/generic/implementation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,5 @@ todo

* SqlRepositoryConfiguration - sql repository configuration, handles config.xml and such

// TODO remove when 4.4 support ends
* DataSourceFactory - connection pool initialisation and configuration
3 changes: 2 additions & 1 deletion docs/repository/native-audit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ for both main repository and the SQL audit - this is perfectly acceptable soluti

| `jdbcUrl`
| URL for JDBC connection.
When this (or non-recommended `dataSource`) is present, separate connection pool will be initialized for the SQL audit.
When this is present, separate connection pool will be initialized for the SQL audit.
See https://jdbc.postgresql.org/documentation/head/connect.html[Connecting to the Database] from PostgreSQL JDBC Driver documentation for more.
| `jdbc:postgresql://localhost:5432/midpoint`

Expand All @@ -106,6 +106,7 @@ Example: `password`
| Ignored by the Native repository and cannot be changed - do not use it.
| `org.postgresql.Driver`

// TODO remove when 4.4 support ends
| `dataSource`
| Uses JNDI DataSource loading, when this option is defined in configuration.
This is only relevant for WAR deployment which is not recommended anyway.
Expand Down
1 change: 1 addition & 0 deletions docs/tasks/task-manager/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ Configuration parameters related to JDBC job store:
| Credentials used to connect to the database.
| the value from repository configuration

// TODO remove when 4.4 support ends
| `dataSource`
| Alternative way of obtaining the connection.
| the value from repository configuration
Expand Down

0 comments on commit f4243bd

Please sign in to comment.