Skip to content

docs: standard-conform env var names for RDS IAM authentication - #217

Open
ReuDa wants to merge 1 commit into
mainfrom
docs/standard-env-vars-iam-auth
Open

ReuDa wants to merge 1 commit into
mainfrom
docs/standard-env-vars-iam-auth

Conversation

@ReuDa

@ReuDa ReuDa commented Sep 22, 2026

Copy link
Copy Markdown
Member

Ticket: https://steadybitgmbh.kanbanize.com/ctrl_board/2/cards/13919
Platform PR: https://github.com/steadybit/platform/pull/2046 (merged)

Why

The "AWS RDS IAM Authentication" section told on-prem readers to set an environment variable named literally spring.datasource.hikari.data-source-properties.wrapperPlugins, and documented wrapperDialect the same way. Dots and mixed case are not valid in a POSIX environment variable name, and some deployment tooling refuses to pass such a variable through — which is what the ticket was raised for.

The platform now accepts STEADYBIT_DB_AWS_JDBC_WRAPPER_<UPPER_SNAKE> for any wrapper parameter and translates it back to the camel-cased property the wrapper reads.

What changed

Only install-and-configure/install-on-prem-platform/advanced-configuration.md:

  • The configuration table and the example YAML use STEADYBIT_DB_AWS_JDBC_WRAPPER_WRAPPER_PLUGINS and STEADYBIT_DB_AWS_JDBC_WRAPPER_WRAPPER_DIALECT.
  • Added the general rule, so readers can set any wrapper parameter from the AWS list without us enumerating it: upper snake case after the prefix, e.g. wrapperLoggerLevel becomes STEADYBIT_DB_AWS_JDBC_WRAPPER_WRAPPER_LOGGER_LEVEL.
  • Added that the old spelling still works and still takes precedence where both are set, so nobody has to change a working configuration.
  • Added that parameters the wrapper does not own but forwards to the PostgreSQL driver, such as logServerErrorDetail, are not covered by the prefix and keep the dotted spelling.

The table is re-padded to the new column width, per the repo's table convention.

Please check the version number

The note says "Before platform 2.8.8". That is inferred, not confirmed: releases bump with DEFAULT_BUMP: patch on push to main and the latest release is 2.8.7, so the fix: commits give 2.8.8 — but if a feat: merges before the release is cut it becomes 2.9.0. Worth correcting before this merges.

Checks

python3 .github/scripts/docs_lint.py --base origin/main — 0 errors, 0 warnings (106 pre-existing findings ignored, none introduced).

The AWS RDS IAM section told readers to set an environment variable named
literally `spring.datasource.hikari.data-source-properties.wrapperPlugins`.
That is not a valid POSIX environment variable name, and some deployment
tooling refuses to pass it through.

Platform 2.8.8 accepts `STEADYBIT_DB_AWS_JDBC_WRAPPER_<UPPER_SNAKE>` for any
wrapper parameter, so the table and the example use that spelling now. Added a
note that the old spelling still works and still wins where both are set, and
that parameters the wrapper merely forwards to the PostgreSQL driver, such as
`logServerErrorDetail`, keep the dotted spelling.

(ticket 13919)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant