- Basic Information
- Prerequisites TODO: link to Luke's separate readme
- How To Use
- Function Templates Structure
- Contact
- F&Q
This repository showcases some use-cases for your Knative Functions! It is a collection of function templates. The built-in templates are either http or cloudevents and these are custom template overrides.
Templates in this repository include:
- The easiest Hello World (
hello) - Simple splash screen with referenced .css file and .funcignore (
splash) - Web blog with serverside rendering and import statements (
blog) - A "Contact Us" function with a secret password (
contact-us)
See templates structure to learn about repository and see how to deploy your function.
In order to use Functions, you will need a few things:
You can clone our GitHub repository and build your binary from the source or download it straight from the release pages under Assets.
Alternatively, for your convenience, see if your OS and architecture can be found in the list below for an easy copy&paste and download our latest version.
curl -L -o /usr/local/bin/func https://github.com/knative/func/releases/latest/download/func_linux_amd64curl -L -o /usr/local/bin/func https://github.com/knative/func/releases/latest/download/func_linux_arm64Invoke-WebReqest -Uri "https://github.com/knative/func/releases/latest/download/func_windows_amd64.exe" -OutFile <"C:\path\to\your\destination\func.exe">alternatively if curl is pre-installed
curl -L -o <C:\path\to\your\destination\func.exe> "https://github.com/knative/func/releases/latest/download/func_windows_amd64.exe" NOTE: You need to change the part in <> to your desired destination (don't include the "<>" symbols)
curl -L -o /usr/local/bin/func "https://github.com/knative/func/releases/latest/download/func_darwin_amd64"curl -L -o /usr/local/bin/func "https://github.com/knative/func/releases/latest/download/func_darwin_arm64"NOTE: After downloading on MacOS and Linux, you might need to make the file executable
chmod +x /usr/local/bin/funcThese are some open-source examples of what you can use with Functions. You will need some tools to atleast build and push your images. This list is not exhaustive.
Buildah - CLI tool to build your images.
Podman - complementary to Buildah. Helps you manage and modify your images. Uses Buildah's golang API. Can be installed independently. (You can get this as a standalone tool)
Docker Engine - Helps you build and containerize your applications. (You can get this as a standalone tool)
Please refer to kind installation page or download any other runner that you like.
In order to interact with the objects in k8s, its recommended to get kubectl.
You use these templates by creating your function via --repository flag which
means "create my function with this template".
Create your functions directory and cd into it
mkdir -p ~/testing/myfunc && cd ~/testing/myfunc
- Create a function in golang with hello template within the new (current and empty) directory
func create --repository=https://github.com/gauron99/func-templates --language go --template=hello
- TODO add more examples / explanations
NOTE: Currently, this is under heavy construction and will become the default in the future.
In order to use the Host Builder in the mean time, you will need to enable it via a ENV variable
and specify some flags in func via CLI.
Alternativelly, run this in your terminal, or put in your config file (bashrc etc.)
export FUNC_ENABLE_HOST_BUILDER=1Then simply add --builder=host to build your Function with the Host builder.
If you want to func run your Function locally first, make sure to use --container=false
Alternative built-in builders are pack and s2i (for supported languages).
The way to use them is simple. Just specify which one you want using the
--builder flag (eg. --builder=pack)
NOTE: In order to deploy anything to a cluster, you will need to have one set up and running along with atleast Knative-Serving installed.
You can skip the building step entirely and deploy straight after creating your
function. (building is included in the deploy).
You can deploy your local code (from your machine) to a cluster using a standard
deploy command. func will need to know a registry to use for the image
to be created. You can specify with a flag or wait to be prompted for it.
func deploy --registry=myregistry.com/usernameIf you already have your image you can also specify it via --image flag. Any
standard image will work, either tagged, which will be built or specify a sha
with your image to solely deploy it.
func deploy --image=registry.com/username/myimage@sha256:xxxNOTE: If you know what you want, at any point you can add a --build flag to
your command which will explicitely tell func if you want to build (or not)
your image. (truthy values will work).
You can also utilize a remote deployment, which will use tekton under the hood. (Which will need to be present in your cluster).
You can simply add --remote to your func deploy command.
Directory structure is as follows: root/[language]/[template] where root is
the github repository itself, language is the programming language used and
template is the name of the template. Function is created using templates via
--repository flag when using func create command. More in How-To-Use section.
github.com/gauron99/func-templates <--[root]
├── go <------------------------------[language]
│ ├── hello <-----------------------[template]
│ │ └── <function source files>
│ └── splash-screen
│ └── ...
├── node
│ ├── hello
│ └── splash-screen
├── ...
You can contact us on CNCF Slack knative-functions channel
Error: function may not implement both the static and instanced method signatures simultaneously
-> this happens when func (f *F) Somename(){} is defined as well as
func Handle(){}, these are the 2 signatures supported currently - instanced
and static. You will need to check your source code and remove the signature you
don't want.