AKS Service Target: Adds optional support for text templating in k8s manifests #2455
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wbreza
requested review from
ellismg,
vhvb1989,
hemarina and
weikanglim
as code owners
ghost
assigned
wbreza
commented
Jun 23, 2023
I think we are going to need to come up with something here sooner rather than later. Looking at your test, it feels like a even if the substitution had succeeded, the resulting k8s manifest that we would apply would be "wrong" according to the user, since we'd end up corrupting the scripts that are stored in the config-map (by evaluating their environment references before sending the data to the API Server). I wonder how disruptive making this behavior opt-in would be. I think long term we might want to support something like using |
wbreza
changed the title
wbreza
commented
Jun 26, 2023
wbreza
changed the title
jongio
reviewed
Jun 27, 2023
This was referenced Jun 28, 2023
vhvb1989
reviewed
Jun 29, 2023
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash: pwsh: WindowsPowerShell install MSI install Standalone Binary
MSIContainerDocumentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
wbreza
added a commit
that referenced
this pull request
Jul 26, 2023
Background Our initial AKS implementation created an azd resource in the target k8s namespace with all the azd environment key/value pairs. These values could then be easily referenced by other resources. With the change in templating in #2455 the new recommended approach would be for apps to create their own config maps as needed and reference azd secrets via templating. This brings azd to a more cloud native state where we aren't creating any resources that haven't been explicitly defined. If users still wanted a config map that contains all azd resources the templating system allows ranging over maps which can be used to achieve the same goal. Breaking Change If users were relying on this automatic secret generation then this would be considered a breaking change for them and users will now need to manually create any config maps that their apps/services need.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #2367
This addresses an issue where a configmap or other k8s resource can contain script files that fails parsing by the
envsubstlibrary.The specific issue that failed in this example was the
envsubstattempting to replace${BASH_REMATCH[1]}in a config map. This is likely a bug in the library since it was throwing anMissingClosingBraceerror.Background
k8s manifests DO NOT support any default templating language out of the box. To support environment variables you would read directly from a configmap / secret to reference those values.
Helm is a very popular package manager for k8s and supports a robust templating language. The templating language uses Go text templating language as its foundation with some additional features built on top.
Kustomize is another very popular way to provide customization on top of k8s manifests without templates.
It previously supported a vars feature that has now been deprecated and replaced by replacements.
Breaking Change
This commit would be considered a breaking change for AKS support. Prior to this update simple environment substitution was being performed on all
*.yamlmanifest files.Blind replacement of any bash style variable could have unintended consequences and cause runtime error when variables are not available within azd environment.
Now, devs must opt-in by renaming there manifests to
*.tmpl.yamland have access to Go text templating within their manifests.This feature would be considered an incremental journey towards a fully featured templating & packaging system like Helm since the syntax is the same. The templating syntax used here is the same as used in Helm)
In addition to the opt-in text templates k8s devs still have the ability to directly pull values from config maps / secrets as needed.
The template root node has the following shape:
This also requires changes to the Todo AKS template available @ #2460