feat: define skaffold.env file for loading environment variables#8395
feat: define skaffold.env file for loading environment variables#8395aaron-prindle merged 2 commits intoGoogleContainerTools:mainfrom
skaffold.env file for loading environment variables#8395Conversation
gsquared94
added
docs-modifications
|
Please visit http://34.69.85.167:1313 to view changes to the docs. |
container-tools-bot
removed
the
docs-modifications-v2
|
Error creating deployment, please see controller logs for details. |
container-tools-bot
removed
the
docs-modifications
|
Error creating deployment, please see controller logs for details. |
|
Please visit http://34.69.85.167:1313 to view changes to the docs. |
|
Error creating deployment, please see controller logs for details. |
|
Error creating deployment docs-controller-deployment-8395, please visit https://storage.googleapis.com/webhook-logs/logs-8395-1675212566638854513 to view logs. |
|
Error creating deployment, please see controller logs for details. |
|
Please visit http://35.193.234.120:1313 to view changes to the docs. |
|
Error creating deployment, please see controller logs for details. |
Codecov Report
@@ Coverage Diff @@
## main #8395 +/- ##
==========================================
- Coverage 70.48% 65.89% -4.60%
==========================================
Files 515 605 +90
Lines 23150 29825 +6675
==========================================
+ Hits 16317 19652 +3335
- Misses 5776 8699 +2923
- Partials 1057 1474 +417
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Can we add 1 integration tests that has a |
|
Additionally once this is merged, we might need to coordinate w/ parter teams, etc. as some bundle all relevant skaffold files for their pipeline's. We might need to add this to set of files to be tracked |
3 participants
Fixes: #1545, #7913
Description
In Skaffold, a
skaffold.envfile can be defined in the project root directory to specify environment variables that Skaffold will load into the process. This provides a more organized and manageable way of setting environment variables, rather than passing them as command line arguments.The
skaffold.envfile should be in the format ofKEY=valuepairs, with one pair per line. Skaffold will automatically load these variables into the environment before running any commands.Here is an example
skaffold.envfile:Setting Skaffold Flags with Environment Variables
In addition to loading environment variables from the
skaffold.envfile, Skaffold also allows users to set flags using environment variables. To set a flag using an environment variable, use theSKAFFOLD_prefix and convert the flag name to uppercase.For example, to set the
--cache-artifactsflag totrue, the equivalent environment variable would beSKAFFOLD_CACHE_ARTIFACTS=true.Here is an example usage in the
skaffold.envfile:Reasons for not adding it as a
skaffold.yamlfieldThere's no obvious way to incorporate the flags like
default-repoand others in the skaffold configuration definition. It only make sense to have a single value per run for these parameters. But right now even as a top level parameter in theskaffold.yamlfile, due to multi-module support Skaffold would need to enforce that all the skaffold pipelines define the same value for these flags, and also decide how to resolve conflicts. We avoid that by allowing a singleskaffold.envfile that can define these flags along with other env variables that will only have a single resolved value despite the number of skaffold modules involved.