Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve framework documentation #5551

Merged
merged 6 commits into from Mar 6, 2024
Merged

Improve framework documentation #5551

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e25f99e
Fix broken example
colinodell Feb 21, 2024
6088692
Fix incorrect command name
colinodell Feb 23, 2024
9d66eb1
Add import statements to help users get up-and-running faster
colinodell Feb 23, 2024
facabde
Fix other command reference
colinodell Feb 23, 2024
2252fd9
Fix lint violations
colinodell Mar 5, 2024
cc410bc
Update the example to match what kustomize fn expects
colinodell Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 12 additions & 4 deletions kyaml/fn/framework/doc.go
View file
Open in desktop
Expand Up @@ -13,6 +13,13 @@
//
// Example function implementation using framework.SimpleProcessor with a struct input
//
// import (
// "sigs.k8s.io/kustomize/kyaml/errors"
// "sigs.k8s.io/kustomize/kyaml/fn/framework"
// "sigs.k8s.io/kustomize/kyaml/kio"
// "sigs.k8s.io/kustomize/kyaml/yaml"
// )
//
// type Spec struct {
// Value string `yaml:"value,omitempty"`
// }
Expand All @@ -24,7 +31,7 @@
// functionConfig := &Example{}
//
// fn := func(items []*yaml.RNode) ([]*yaml.RNode, error) {
// for i := range rl.Items {
// for i := range items {
// // modify the items...
// }
// return items, nil
Expand Down Expand Up @@ -56,7 +63,7 @@
//
// The functionConfig may be specified declaratively and run with
//
// config run DIR/
// kustomize fn run DIR/
//
// Declarative function declaration:
//
Expand All @@ -66,7 +73,8 @@
// # run the function by creating this container and providing this
// # Example as the functionConfig
// config.kubernetes.io/function: |
// image: image/containing/function:impl
// container:
// image: image/containing/function:impl
// spec:
// value: foo
//
Expand All @@ -75,7 +83,7 @@
// Generated ResourceList.functionConfig -- ConfigMaps
// Functions may also be specified imperatively and run using:
//
// kpt fn run DIR/ --image image/containing/function:impl -- value=foo
// kustomize fn run DIR/ --image image/containing/function:impl -- value=foo
//
// When run imperatively, a ConfigMap is generated for the functionConfig, and the command
// arguments are set as ConfigMap data entries.
Expand Down