backstage icon indicating copy to clipboard operation
backstage copied to clipboard

Add support for disabling app-config validation at build time

Open SoccerBoyMalloy opened this issue 3 years ago • 2 comments

We're deploying Backstage to several k8s environments and we're using kustomize to define per-environment entrypoints that each include their own app-config.<environment>.yaml config files. In an effort to reduce duplicate configuration, we're consolidating all common configuration into app-config.yaml - this common config includes references to environment variables. Now when we yarn build, it validates app-config.yaml and throws an error if any of the environment variables are missing (which they often are at build time). This means we have to move any common configuration that relies on environment variables back into the environment-specific configs so that app-config.yaml has no environment variables, and then only specify app-config.yaml at build time.

This poses a few questions:

  1. Is this build time validation necessary?
  2. We currently don't specify our app-config.<environment>.yaml configs during build time and things seem to work - that means much of our config already isn't being validated at build time. Should we be specifying them at build time?

Feature Suggestion

Add some kind of --disable-validation flag at build time.

Context

SoccerBoyMalloy avatar Jul 18 '22 15:07 SoccerBoyMalloy

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Sep 16 '22 15:09 github-actions[bot]

Until we have some way of loading the config from the backend for the frontend, then this needs to be built into the bundle so it needs to be at build time. Think we need to revisit how we're going to do that rather than adding this option. Will come back with an update on a possible way forward! :pray:

benjdlambert avatar Sep 19 '22 08:09 benjdlambert

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Nov 21 '22 08:11 github-actions[bot]