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

Support configuration of spiffe-helper via environment variables #223

Open
eminwux opened this issue Nov 28, 2024 · 5 comments
Open

Support configuration of spiffe-helper via environment variables #223

eminwux opened this issue Nov 28, 2024 · 5 comments

Comments

@eminwux
Copy link
Contributor

eminwux commented Nov 28, 2024

When using spiffe-helper as a sidecar container, configuring it via environment variables provides greater flexibility and simplifies deployment.

The preliminary consensuated solution is to use the cleanenv library with support for JSON+YAML configuration formats.

To maintain backward compatibility:

  • --config should be added for the new configuration format.
  • --legacy-config should be used for HCL legacy configuration.

Behavior:

  • When using --config, environment variables should override configurations in the new configuration files.
  • When using --legacy-config, environment variables should only affect the HCL configuration file.

Deprecation Plan:

  • Display deprecation warning messages for HCL configuration files in upcoming releases, until the next major version.
  • Completely remove HCL configuration support in next major version.

For more context, see the Slack thread.
For a comparison of options, see pros and cons.

@eminwux
Copy link
Contributor Author

eminwux commented Nov 28, 2024

I’m currently working on this.

@eminwux
Copy link
Contributor Author

eminwux commented Nov 28, 2024

@faisal-memon
Copy link
Collaborator

Thanks @eminwux. Will you be using clean env?

@eminwux
Copy link
Contributor Author

eminwux commented Nov 28, 2024

Thanks @eminwux. Will you be using clean env?

Hi @faisal-memon! Yes, I plan to use cleanenv. I’ll attach a draft PR once I’ve made significant progress.

@faisal-memon
Copy link
Collaborator

Sounds good @eminwux

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

No branches or pull requests

2 participants