[misc] Add support for NETBIRD_STORE_ENGINE_POSTGRES_DSN environment variable in setup.env

[arosberg]

Describe your changes

Updated the configure script and docker-compose templates to better support deployment with postgres. Prevents the need to manually add the NETBIRD_STORE_ENGINE_POSTGRES_DSN environment variable to the docker-compose file after the configuration script is run (https://docs.netbird.io/selfhosted/postgres-store). Also provides warning to the user if the NETBIRD_STORE_CONFIG_ENGINE=postgres and NETBIRD_STORE_ENGINE_POSTGRES_DSN is not set.

Issue ticket number and link

Checklist

• Is it a bug fix
• Is a typo/documentation fix
• Is a feature enhancement
• It is a refactor
• Created tests that fail without the change (if possible)
• Extended the README / documentation, if necessary

[CLAassistant]

All committers have signed the CLA.

[mlsmaycon]

Hello @arosberg, thanks for the contribution. Can you add tests to validate the environment variable setting?

You can check these files for that:
https://github.com/netbirdio/netbird/blob/c61cb00f40a2b94c27932312535bfd8498f4757a/infrastructure_files/tests/setup.env

netbird/.github/workflows/test-infrastructure-files.yml

Line 19 in 059fc7c

test-docker-compose:

[arosberg]

Hello @mlsmaycon

The way I wrote the script the environment variable will only be exported if NETBIRD_STORE_CONFIG_ENGINE=postgres and in the test cases NETBIRD_STORE_CONFIG_ENGINE=sqlite so it will not be exported by the script (And therefore not substituted in the compose template). One thing I could do is always export the NETBIRD_STORE_ENGINE_POSTGRES_DSN variable by adding it to the base.setup.env exports

netbird/infrastructure_files/base.setup.env

Lines 74 to 78 in 059fc7c

	# exports
	export NETBIRD_DOMAIN
	export NETBIRD_TURN_DOMAIN
	export NETBIRD_AUTH_CLIENT_ID
	export NETBIRD_AUTH_CLIENT_SECRET

Then it would substitute even if NETBIRD_STORE_CONFIG_ENGINE=sqlite (Then I would be able to add test cases). Another option is adding a new test just for postgres but this seems a bit heavy to me. What do you think?

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[mlsmaycon]

Hello @mlsmaycon

The way I wrote the script the environment variable will only be exported if NETBIRD_STORE_CONFIG_ENGINE=postgres and in the test cases NETBIRD_STORE_CONFIG_ENGINE=sqlite so it will not be exported by the script (And therefore not substituted in the compose template). One thing I could do is always export the NETBIRD_STORE_ENGINE_POSTGRES_DSN variable by adding it to the base.setup.env exports

netbird/infrastructure_files/base.setup.env

Lines 74 to 78 in 059fc7c

	# exports
	export NETBIRD_DOMAIN
	export NETBIRD_TURN_DOMAIN
	export NETBIRD_AUTH_CLIENT_ID
	export NETBIRD_AUTH_CLIENT_SECRET

Then it would substitute even if NETBIRD_STORE_CONFIG_ENGINE=sqlite (Then I would be able to add test cases). Another option is adding a new test just for postgres but this seems a bit heavy to me. What do you think?

that's true, we will add a matrix and a service for that.