DATAGO-78232: Add new spring variable to override the use of user.home #189
Conversation
…me variable since it is not set in k8s
gregmeldrum
changed the title
|
SonarQube Quality Gate
|
| @@ -7,6 +7,6 @@ | |||
| @Service | |||
| @Data | |||
| public class TerraformProperties { | |||
| @Value("${COMMAND_PATH:${user.home}${file.separator}tfcommands}") | |||
| @Value("${app.commandroot:${user.home}}${file.separator}tfcommands") | |||
There was a problem hiding this comment.
Do we need to update README instructions to include this new variable for those running EMA locally as a docker container?
There was a problem hiding this comment.
This issue seems to be specific to the way we are deploying the container in k8s. I'm not sure if it's a rootless deployment or something, but this issue does not occur when running the docker container using the commands in the README. If you don't specify the app.commandroot Spring variable, it defaults to the previous behaviour of using the user.home as the root for the command and tfcommand directories so a user following instructions from our README will see no change.
If you'd like, I can add a section explaining how the new app.commandroot spring variable works and how they can use it to customize where the logs and terraform artifacts are created. Let me know and I can add it.
There was a problem hiding this comment.
I see, ok let's leave things this level of flexibility is not needed for local users. If some asks for it we can update the readme of how to do it.
What is the purpose of this change?
When running the docker image in k8s, the user.home get's set to '?' which causes the EMA to fail to load
How was this change implemented?
Anywhere that we use user.home, we add another variable that can be set on the command line (or via an env var) that overrides the use of user.home, so the "command" and "tfcommand" directories get created as expected.
I was able to test this in docker using the following command:
The "magic" here is setting the environment variable
JAVA_OPTSto be-Dapp.commandroot=/opt. This overrides the use ofuser.home. For the kubernetes deployment, we must add theJAVA_OPTSenv var via sidekick.How was this change tested?
Tested with jar from the command line and with docker container.
Tested with and without the new 'app.commandroot' variable set. With app.commandroot set, it as used as the root directory instead of the user's home directory.
Tested with config push and scan
Is there anything the reviewers should focus on/be aware of?
None