Enhancement #21975
openProvide config file samples in rudder-web.properties.d
Description
Now that we have rudder-web.properties.d
, we want to provide a sample configuration file:
- for LDAP
- for OAUTH2
And install them in /opt/rudder/etc/rudder-web.properties.d
so that an user can just edit them to start using the backend.
The hardest part is the documentation generation that need to include these files where they used to be in the README.adoc.
Identified tasks:
- choose a directory for the sample files. Ideas:
- src/main/resources/config-files
- quite logical, but we don't want them packaged in the jar, so it will need an exclusion in maven pom
- packaging/config-files
- or somewhere in packaging so that it works for it immediately
- docs/config-files
if we prefer enforce the "sample file as documentation" path.
- others ?
- create authentication-backend-ldap.properties.sample
and authentication-backend-oidc.properties.sample
in chosen directory from the existing info in README.adoc
- update packaging
to package files in the plugin archive and packaging/postinst
to copy them into /opt/rudder/rudder-web.properties.d
- update documentation generation to include sample files where they used to belong.