Skip to content

Document common function patterns and examples #436

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

Open
welteki wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Document common function patterns and examples #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e9bdba0
Document common function patterns
welteki Sep 1, 2026
52b54c0
Simplify director pattern example
welteki Sep 3, 2026
a8512ae
Simplify singleton pattern example
welteki Sep 3, 2026
d0d3c4e
Simplify fan-out pattern example
welteki Sep 3, 2026
2c9e752
Add fan-in pattern example
welteki Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/languages/go.md → docs/languages/go/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,3 +406,8 @@ func Handle(w http.ResponseWriter, r *http.Request) {
}
```

## Examples

* [The director pattern](/languages/patterns/director/)
* [The fan-out pattern](/languages/patterns/fan-out/)
* [The singleton pattern](/languages/patterns/singleton/)
5 changes: 5 additions & 0 deletions docs/languages/node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,3 +353,8 @@ functions:
- The `NODE_OPTIONS` environment variable needs to have the value `--require @opentelemetry/auto-instrumentations-node/register` to register and initialize the auto instrumentation module.

To see the full range of configuration options, see [Module Configuration](https://opentelemetry.io/docs/zero-code/js/configuration/).

## Examples

* [The director pattern](/languages/patterns/director/)
* [The fan-out pattern](/languages/patterns/fan-out/)
8 changes: 7 additions & 1 deletion docs/languages/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ There are many community templates, of varying levels of support and maintenance

There are a number of official templates maintained and recommended by OpenFaaS Ltd, the following are currently documented:

* [Go](./go.md)
* [Go](./go/index.md)
* [Node](./node.md)
* [Python](./python/index.md)
* [Dockerfile](./dockerfile.md)
Expand All @@ -34,3 +34,9 @@ You can also [create your own custom templates](./custom.md), or fork an existin

You can bring along your own [pre-existing Dockerfiles and container images](/languages/dockerfile), so long as they conform to the [OpenFaaS workloads contract](/reference/workloads). You may need to add a health or readiness endpoint to make sure that no requests are lost during scaling up and down of your function.

### Function patterns

After choosing a language, see the
[common function design patterns](/languages/patterns/) for ways to coordinate
functions into workflows, process work in parallel, or run a function with a
fixed replica count.
Loading