Skip to content

[ENHANCEMENT] remove deprecation note from Web Modeler restapi.externalDatabase.url #4046

@JacobiCamunda

Description

@JacobiCamunda

Describe the use case:

Users setting webModeler.restapi.externalDatabase.url is required for SSL-secured connections, Amazon Aurora PostgreSQL and using other database vendors (Oracle and MSSQL).

Currently, this property is marked as deprecated and users are told to use host, port and database instead. We (Web Modeler) think that this should not be the way how to configure the database connection. Users should just provide the url themselves and not rely on three different properties.

PostgreSQL is now not the default anymore and should not be treated as such. It is one of multiple options to choose from.

See charts.yml:

externalDatabase:
      ## @param webModeler.restapi.externalDatabase.url (DEPRECATED - use host, port, and database instead) defines the JDBC url of the database instance.
      # Note: If url is provided, it takes precedence over individual connection parameters (host, port, database)
      url: ""

and _helpers.tpl:

{{/*
[web-modeler] Get the database JDBC url, depending on whether the postgresql dependency chart is enabled.
*/}}
{{- define "webModeler.restapi.databaseUrl" -}}
  {{- if .Values.webModelerPostgresql.enabled -}}
    {{- printf "jdbc:postgresql://%s:5432/%s"
        (include "webModeler.postgresql.fullname" .)
        (.Values.webModelerPostgresql.auth.database)
      -}}
  {{- else if .Values.webModeler.restapi.externalDatabase.url -}}
    {{- .Values.webModeler.restapi.externalDatabase.url -}}
  {{- else if .Values.webModeler.restapi.externalDatabase.host -}}
    {{- printf "jdbc:postgresql://%s:%s/%s"
        .Values.webModeler.restapi.externalDatabase.host
        (toString (.Values.webModeler.restapi.externalDatabase.port))
        (.Values.webModeler.restapi.externalDatabase.database)
      -}}
  {{- end -}}
{{- end -}}
  • Issue which introduced the change

Describe the enhancement/feature:

  • Remove deprecation note
  • (Discussable) Deprecate the properties host, port and database instead. We need to be backwards compatible with customers currently using this approach. Just removing it may be disrupting.

Desired outcome and acceptance tests:

  • Users can use the webModeler.restapi.externalDatabase.url without having to fear removal in the future and are aware that this is the best way to configure the database connection

Metadata

Metadata

Assignees

Labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions