Skip to content

justenstall/function-krm-function

 
 

Repository files navigation

function-krm-function

CI

A template for writing a composition function in Go.

To learn how to use this template:

If you just want to jump in and get started:

  1. Replace function-template-go with your function's name in go.mod, package/crossplane.yaml, and any Go imports
  2. Update input/v1beta1/ to reflect your desired input (and run go generate)
  3. Add your logic to RunFunction in fn.go
  4. Add tests for your logic in fn_test.go
  5. Update this file, README.md, to be about your function!

This template uses Go, Docker, and the Crossplane CLI to build functions.

# Run code generation - see input/generate.go
go generate ./...

# Run tests - see fn_test.go
go test ./...

# Build the function's runtime image - see Dockerfile
docker build . --tag=runtime

# Build a function package - see package/crossplane.yaml
crossplane xpkg build -f package --embed-runtime-image=runtime

About

A composition function for running a KRM function

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 73.4%
  • Dockerfile 26.6%