🌱 Add sprig functions to ClusterClass templates #6131

fabriziopandini · 2022-02-15T09:46:01Z

What this PR does / why we need it:
This PR adds sprig functions to ClusterClass templates

Which issue(s) this PR fixes:
Fixes #6091

sbueringer

Looks good, very nice small change :)

I think you got all places. Essentially we have two "template" variables and for each of those we have a validation and a place where it's used during patching.

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

go.mod

killianmuldoon

lgtm with the go.mod update.

I think we should open an issue for more comprehensive patching documentation as this gets more complex. A few examples of valid patches and the functions we're offering here (doesn't have to be exhaustive.) I'll take that as an issue if you'd like.

fabriziopandini · 2022-02-16T17:53:21Z

I think we should open an issue for more comprehensive patching documentation as this gets more complex. A few examples of valid patches and the functions we're offering here (doesn't have to be exhaustive.) I'll take that as an issue if you'd like.

Some examples would be nice, but I would wait for providers to start using this so we can provide real use cases.

sbueringer · 2022-02-16T19:46:19Z

Thx!
/lgtm

killianmuldoon

/lgtm

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

vincepri · 2022-02-17T04:37:13Z

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

@@ -587,6 +587,9 @@ constant default value which can be specified in the schema is not enough.
          # If .vnetName is set, it is used. Otherwise, we will use `{{.builtin.cluster.name}}-vnet`.  
          template: "{{ if .vnetName }}{{.vnetName}}{{else}}{{.builtin.cluster.name}}-vnet{{end}}"
 ```
+When writing templates, a subset of functions from [sprig](http://masterminds.github.io/sprig/) can be used to
+write expressing like e.g. `{{ .name | upper }}`. Only functions that are guaranteed to evaluate to the same result
+for a given input are allowed (e.g. `upper` or `max` can be used, while `now` or `randAlpha` can not be used).



Can we document all the available functions in here?

Can we instead refer to e.g. that documentation page: http://masterminds.github.io/sprig/

I would really prefer not duplicating parts of their docs (even if it's only a list of funcs) as it provides a lot of stuff.

there are over 70 template functions in sprig, I don't think it is doable to document here.

Linking or importing works, from a user experience having them in one place (even if generate) is much more useful when implementing a clusterclass

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

go.mod

sbueringer · 2022-02-21T17:47:53Z

/lgtm

ykakarap

/lgtm

vincepri

/approve

k8s-ci-robot · 2022-02-22T16:05:49Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [vincepri]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

fabriziopandini · 2022-02-22T20:43:55Z

As per #6091 (comment)
/cherry-pick release-1.1

k8s-infra-cherrypick-robot · 2022-02-22T20:44:29Z

@fabriziopandini: #6131 failed to apply on top of branch "release-1.1":

Applying: Add sprig functions to ClusterClass templates
Using index info to reconstruct a base tree...
M	go.mod
M	test/go.mod
M	test/go.sum
Falling back to patching base and 3-way merge...
Auto-merging test/go.sum
Auto-merging test/go.mod
Auto-merging go.mod
CONFLICT (content): Merge conflict in go.mod
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Add sprig functions to ClusterClass templates
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

As per #6091 (comment)
/cherry-pick release-1.1

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

sbueringer · 2022-02-23T07:50:58Z

Manual cherry-pick: #6191

fabriziopandini requested review from sbueringer and killianmuldoon February 15, 2022 09:46

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 15, 2022

k8s-ci-robot requested review from enxebre and JoelSpeed February 15, 2022 09:46

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 15, 2022

sbueringer reviewed Feb 15, 2022

View reviewed changes

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md Outdated Show resolved Hide resolved

go.mod Show resolved Hide resolved

killianmuldoon reviewed Feb 16, 2022

View reviewed changes

killianmuldoon mentioned this pull request Feb 16, 2022

Unexpected behavior in "append" to array patch operation #5944

Closed

fabriziopandini force-pushed the clusterclass-templates-support-sprig branch from a56f24e to 98523a8 Compare February 16, 2022 17:52

k8s-ci-robot assigned sbueringer Feb 16, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 16, 2022

killianmuldoon approved these changes Feb 16, 2022

View reviewed changes

k8s-ci-robot assigned killianmuldoon Feb 16, 2022

vincepri reviewed Feb 17, 2022

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 17, 2022

ykakarap reviewed Feb 17, 2022

View reviewed changes

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md Outdated Show resolved Hide resolved

ykakarap reviewed Feb 17, 2022

View reviewed changes

go.mod Outdated Show resolved Hide resolved

fabriziopandini force-pushed the clusterclass-templates-support-sprig branch from 98523a8 to 7d209df Compare February 18, 2022 19:51

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 18, 2022

fabriziopandini force-pushed the clusterclass-templates-support-sprig branch from 7d209df to 679df25 Compare February 18, 2022 21:04

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 18, 2022

Add sprig functions to ClusterClass templates

d6f7534

fabriziopandini force-pushed the clusterclass-templates-support-sprig branch from 679df25 to d6f7534 Compare February 18, 2022 21:16

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 18, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 21, 2022

ykakarap reviewed Feb 22, 2022

View reviewed changes

k8s-ci-robot assigned ykakarap Feb 22, 2022

vincepri approved these changes Feb 22, 2022

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 22, 2022

k8s-ci-robot merged commit 9cc429d into kubernetes-sigs:main Feb 22, 2022

k8s-ci-robot added this to the v1.2 milestone Feb 22, 2022

sbueringer mentioned this pull request Feb 23, 2022

🌱 Add sprig functions to ClusterClass templates #6191

Merged

fabriziopandini deleted the clusterclass-templates-support-sprig branch March 1, 2022 09:49

apricote mentioned this pull request Mar 2, 2022

📖 Use semverCompare to enable patches based on k8s version #6232

Merged

HanFa mentioned this pull request Jun 29, 2022

Boostrap cluster scripts are using outdate CAPX providers vmware-tanzu/tanzu-framework#2788

Open

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 Add sprig functions to ClusterClass templates #6131

🌱 Add sprig functions to ClusterClass templates #6131

fabriziopandini commented Feb 15, 2022

sbueringer left a comment •

edited

Loading

killianmuldoon left a comment

fabriziopandini commented Feb 16, 2022

sbueringer commented Feb 16, 2022

killianmuldoon left a comment

vincepri Feb 17, 2022

sbueringer Feb 17, 2022 •

edited

Loading

fabriziopandini Feb 18, 2022 •

edited

Loading

vincepri Feb 18, 2022

sbueringer commented Feb 21, 2022

ykakarap left a comment

vincepri left a comment

k8s-ci-robot commented Feb 22, 2022

fabriziopandini commented Feb 22, 2022

k8s-infra-cherrypick-robot commented Feb 22, 2022

sbueringer commented Feb 23, 2022

🌱 Add sprig functions to ClusterClass templates #6131

🌱 Add sprig functions to ClusterClass templates #6131

Conversation

fabriziopandini commented Feb 15, 2022

sbueringer left a comment • edited Loading

Choose a reason for hiding this comment

killianmuldoon left a comment

Choose a reason for hiding this comment

fabriziopandini commented Feb 16, 2022

sbueringer commented Feb 16, 2022

killianmuldoon left a comment

Choose a reason for hiding this comment

vincepri Feb 17, 2022

Choose a reason for hiding this comment

sbueringer Feb 17, 2022 • edited Loading

Choose a reason for hiding this comment

fabriziopandini Feb 18, 2022 • edited Loading

Choose a reason for hiding this comment

vincepri Feb 18, 2022

Choose a reason for hiding this comment

sbueringer commented Feb 21, 2022

ykakarap left a comment

Choose a reason for hiding this comment

vincepri left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 22, 2022

fabriziopandini commented Feb 22, 2022

k8s-infra-cherrypick-robot commented Feb 22, 2022

sbueringer commented Feb 23, 2022

sbueringer left a comment •

edited

Loading

sbueringer Feb 17, 2022 •

edited

Loading

fabriziopandini Feb 18, 2022 •

edited

Loading