WELCOME To Knative Function Templates!

Quick search

1. Basic Information TODO: first done
2. Project Structure TODO: first run
3. How To Use TODO:
   1. Prerequisites TODO:
   2. Build a Function TODO:
      1. Host Builder TODO: describe host builder
      2. Other Builders TODO: mention few builders, custom
   3. Deploy a Function TODO:
      1. Local TODO: describe process - clone repo & use
      2. Remote TODO: describe - deploy using --git-url etc.
4. Configuration TODO: Is this necessary?
5. Tips & Tricks TODO: instanced/static methods?
6. Q&A TODO: Probably get rid of this or tips section
7. License TODO:
8. Contact TODO:

Example Templates for Knative Functions

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 project structure to learn about repository and see how to deploy your function.

Project structure

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
├── ...

How To Use

You use these templates by creating your function via --repository flag which means "create my function with this template".

• Create a function with hello template in golang within the current directory

func create --repository=https://github.com/gauron99/func-templates -t=hello -l go

• TODO add more examples / explanations

Prerequisites

• Download func
• Download docker
• Download local cluster runner (kind)
• Download cli commands for k8s (kubectl)

Build a Function

Using the Host Builder

This is the prefered way

Using Alternative Builders

This is the old way (pack/s2i)

Deploy a Function

Local

Remote

tips

• dont edit func.yaml ?

Divide dirs for each language

go/
|
├ basic/
| ├ template/
| | └ <template to easily fetch>
| └ README.md
|   └ describes how to use, steps to manually (init, deploy -- easy)
└ advanced/
  ├ template/
  | └ <template to easily fetch>
  └ README.md
    └ describes advanced deploy (using build, --image, remote deploy w/ tekton)

- python
  - same as go
- node
  - same as go
- ...

License

something something super license. its free yay

Contact

contact us at super website here or there

possible errors

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(){}`