Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide consistent database configuration capabilities #2171

Open
jonathanlukas opened this issue Aug 1, 2024 · 0 comments
Open

Provide consistent database configuration capabilities #2171

jonathanlukas opened this issue Aug 1, 2024 · 0 comments
Labels
kind/enhancement New feature or request

Comments

@jonathanlukas
Copy link
Contributor

jonathanlukas commented Aug 1, 2024

Describe the use case:

As infrastructure engineer, I have to configure multiple database connections as of now:

  • Identity
  • Web Modeler

These database connections offer different properties:

Identity:

key explanation default value
identity.externalDatabase.enabled   false
identity.externalDatabase.host Database host nil
identity.externalDatabase.port Database port number nil
identity.externalDatabase.username Non-root username nil
identity.externalDatabase.password Password for the non-root username nil
identity.externalDatabase.database The database name nil
identity.externalDatabase.existingSecret Name of an existing secret resource containing the database credentials nil
identity.externalDatabase.existingSecretPasswordKey Name of an existing secret key containing the database credentials nil

web modeler:

key explanation default value
webModeler.restapi.externalDatabase can be used to configure a connection to an external database; will only be applied if the postgresql dependency chart is disabled (with postgresql.enabled=false)  
webModeler.restapi.externalDatabase.url defines the JDBC url of the database instance ""
webModeler.restapi.externalDatabase.user defines the database user ""
webModeler.restapi.externalDatabase.password can be used to provide the database user's password; ignored if webModeler.restapi.externalDatabase.existingSecret is set ""
webModeler.restapi.externalDatabase.existingSecret can be used to provide the name of an existing secret resource containing the database password nil
webModeler.restapi.externalDatabase.existingSecretPasswordKey can be used to provide the name of an existing secret key containing the database password ""

Describe the enhancement/feature:

Please provide a consistent set of keys:

  • enabled (implicit in web modeler as of now, explicit in identity) -> implicit for both OR explicit for both
  • url (allows more flexibility than host-port-database)
  • username (is user for web modeler as of now)
  • password
  • existingSecret
  • existingSecretPasswordKey

Hint: For identity, host, port and database are simply condatinated...

https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform-latest/templates/identity/configmap.yaml#L272

Desired outcome and acceptance tests:

Both sections identity.externalDatabase AND webModeler.restapi.externalDatabase should be configurable in the exact same way.

@jonathanlukas jonathanlukas added the kind/enhancement New feature or request label Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant