schnauzer: add v1->v2 template guide, resolve migration bugs #3488
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
7 tasks
webern
approved these changes
Sep 25, 2023
Comment on lines
+54
to
+59
| The setting generator allows the user to specify any template requirements via the CLI, rather | ||
| than requiring frontmatter, e.g. |
There was a problem hiding this comment.
Is "rather than requiring frontmatter" something that should also be mentioned where frontmatter is introduced above?
There was a problem hiding this comment.
Good idea, I'll add this in a separate commit.
cbgbt
force-pushed
the
migration-guide
branch
from
558f4c7
to
83003c8
Compare
foersleo
approved these changes
Sep 26, 2023
bcressey
approved these changes
Sep 26, 2023
sources/api/schnauzer/README.md
Outdated
| # The rest of the template now goes after the `+++` frontmatter delimiter. | ||
| ``` | ||
|
|
||
| NOTE: `schnauzer-v2` was merged into Bottlerocket prior to the complete introduciton of settings |
There was a problem hiding this comment.
Suggested change
| NOTE: `schnauzer-v2` was merged into Bottlerocket prior to the complete introduciton of settings | |
| NOTE: `schnauzer-v2` was merged into Bottlerocket prior to the complete introduction of settings |
The container versions in the previously merged migrations were not updated on rebase. Additionally, one of the migrations was missing a '=' character in the helper specification.
cbgbt
force-pushed
the
migration-guide
branch
from
83003c8
to
865d658
Compare
|
Fix typo pointed out by @bcressey |
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.
Issue number:
#3133
Description of changes:
As part of moving to the new template system, this adds a guide to help folks rewrite templates to be schnauzer v2 compatible.
This also resolves two bugs in the migrations:
=character when specifying helpers.Testing done:
aws-k8s-1.28After the migration, I ran
$ apiclient raw -u '/metadata/setting-generators' | jq:{ "settings.kubernetes.pod-infra-container-image": "schnauzer-v2 render --requires 'aws@v1' --requires 'kubernetes@v1(helpers=[pause-prefix])' --template '{{ pause-prefix settings.aws.region }}/eks/pause:3.1-eksbuild.1'", "settings.host-containers.admin.source": "schnauzer-v2 render --requires 'aws@v1(helpers=[ecr-prefix])' --template '{{ ecr-prefix settings.aws.region }}/bottlerocket-admin:v0.11.0'", "settings.host-containers.control.source": "schnauzer-v2 render --requires 'aws@v1(helpers=[ecr-prefix])' --template '{{ ecr-prefix settings.aws.region }}/bottlerocket-control:v0.7.4'", "settings.updates.metadata-base-url": "schnauzer-v2 render --requires 'aws@v1' --requires 'updates@v1(helpers=[metadata-prefix, tuf-prefix])' --template '{{ tuf-prefix settings.aws.region }}{{ metadata-prefix settings.aws.region }}/2020-07-07/{{ os.variant_id }}/{{ os.arch }}/'", "settings.updates.targets-base-url": "schnauzer-v2 render --requires 'aws@v1' --requires 'updates@v1(helpers=[tuf-prefix])' --template '{{ tuf-prefix settings.aws.region }}/targets/'", }Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.