Skip to content

Commit c12505a

Browse files
committed
Update intro, and build with Go 1.22
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent ffac406 commit c12505a

39 files changed

+1618
-720
lines changed

.github/workflows/build.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ jobs:
1616
with:
1717
fetch-depth: 1
1818
- name: Install Go
19-
uses: actions/setup-go@v2
19+
uses: actions/setup-go@v5.0.0
2020
with:
21-
go-version: 1.21.x
21+
go-version: 1.22.x
2222

2323
- name: test
2424
run: make test

.github/workflows/publish.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ jobs:
1313
with:
1414
fetch-depth: 1
1515
- name: Install Go
16-
uses: actions/setup-go@v2
16+
uses: actions/setup-go@v5.0.0
1717
with:
18-
go-version: 1.21.x
18+
go-version: 1.22.x
1919
- name: Make publish
2020
run: make publish
2121
- name: Upload release binaries
22-
uses: alexellis/upload-assets@0.4.0
22+
uses: alexellis/upload-assets@0.4.1
2323
env:
2424
GITHUB_TOKEN: ${{ github.token }}
2525
with:

.github/workflows/verify-images.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111

1212
steps:
1313
- uses: actions/checkout@master
14-
- uses: alexellis/setup-arkade@v2
14+
- uses: alexellis/setup-arkade@v3
1515
- name: Verify chart images
1616
id: verify_images
1717
run: |

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,18 @@ Use-cases and tutorials:
2929

3030
Additional resources:
3131

32-
* The official handbook - [Serverless For Everyone Else](https://gumroad.com/l/serverless-for-everyone-else)
32+
* The official handbook - [Serverless For Everyone Else](https://openfaas.gumroad.com/l/serverless-for-everyone-else)
3333
* For reference: [OpenFaaS docs](https://docs.openfaas.com)
3434
* For use-cases and tutorials: [OpenFaaS blog](https://openfaas.com/blog/)
3535
* For self-paced learning: [OpenFaaS workshop](https://github.com/openfaas/workshop/)
3636

3737
### About faasd
3838

39-
* faasd is a static Golang binary
39+
* faasd is a single static Golang binary, which runs on Linux with systemd
4040
* uses the same core components and ecosystem of OpenFaaS
4141
* uses containerd for its runtime and CNI for networking
42-
* is multi-arch, so works on Intel `x86_64` and ARM out the box
43-
* can run almost any other stateful container through its `docker-compose.yaml` file
42+
* is multi-arch, so works on Intel `x86_64` and Arm out the box
43+
* runs stateful containers through its `docker-compose.yaml` file like Grafana, MongoDB, InfluxDB, or Postgres, etc
4444

4545
Most importantly, it's easy to manage so you can set it up and leave it alone to run your functions.
4646

@@ -54,10 +54,12 @@ Watch the video: [faasd walk-through with cloud-init and Multipass](https://www.
5454

5555
* faasd - itself, and its [faas-provider](https://github.com/openfaas/faas-provider) for containerd - CRUD for functions and services, implements the OpenFaaS REST API
5656
* [Prometheus](https://github.com/prometheus/prometheus) - for monitoring of services, metrics, scaling and dashboards
57-
* [OpenFaaS Gateway](https://github.com/openfaas/faas/tree/master/gateway) - the UI portal, CLI, and other OpenFaaS tooling can talk to this.
58-
* [OpenFaaS queue-worker for NATS](https://github.com/openfaas/nats-queue-worker) - run your invocations in the background without adding any code. See also: [asynchronous invocations](https://docs.openfaas.com/reference/triggers/#async-nats-streaming)
57+
* [OpenFaaS CE Gateway](https://github.com/openfaas/faas/tree/master/gateway) - the UI portal, CLI, and other OpenFaaS tooling can talk to this.
58+
* [OpenFaaS CE queue-worker for NATS Streaming](https://github.com/openfaas/nats-queue-worker) - run your invocations in the background without adding any code. See also: [asynchronous invocations](https://docs.openfaas.com/reference/triggers/#async-nats-streaming)
5959
* [NATS](https://nats.io) for asynchronous processing and queues
6060

61+
> By default faasd comes with the Community Edition (CE) components, but if you like, you can purchase a license to upgrade to OpenFaaS Standard with scale to zero and rich support for async use-cases through the JetStream queue worker.
62+
6163
faasd relies on industry-standard tools for running containers:
6264

6365
* [CNI](https://github.com/containernetworking/plugins)
@@ -83,11 +85,11 @@ You can learn more about supported OpenFaaS features in the [ROADMAP.md](/docs/R
8385

8486
The faasd project is MIT licensed and open source, and you will find some documentation, blog posts and videos for free.
8587

86-
However, "Serverless For Everyone Else" is the official handbook and was written to contribute funds towards the upkeep and maintenance of the project.
88+
["Serverless For Everyone Else"](https://openfaas.gumroad.com/l/serverless-for-everyone-else) is the official handbook and was written to contribute funds towards the upkeep and maintenance of the project.
8789

8890
### The official handbook and docs for faasd
8991

90-
<a href="https://gumroad.com/l/serverless-for-everyone-else">
92+
<a href="https://openfaas.gumroad.com/l/serverless-for-everyone-else">
9193
<img src="https://www.alexellis.io/serverless.png" width="40%"></a>
9294

9395
You'll learn how to deploy code in any language, lift and shift Dockerfiles, run requests in queues, write background jobs and to integrate with databases. faasd packages the same code as OpenFaaS, so you get built-in metrics for your HTTP endpoints, a user-friendly CLI, pre-packaged functions and templates from the store and a UI.
@@ -114,7 +116,7 @@ Topics include:
114116

115117
View sample pages, reviews and testimonials on Gumroad:
116118

117-
["Serverless For Everyone Else"](https://gumroad.com/l/serverless-for-everyone-else)
119+
["Serverless For Everyone Else"](https://openfaas.gumroad.com/l/serverless-for-everyone-else)
118120

119121
### Deploy faasd
120122

cmd/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ faasd - Serverless For Everyone Else
5151
Learn how to build, secure, and monitor functions with faasd with
5252
the eBook:
5353
54-
https://gumroad.com/l/serverless-for-everyone-else
54+
https://openfaas.gumroad.com/l/serverless-for-everyone-else
5555
`,
5656
RunE: runRootCommand,
5757
SilenceUsage: true,

docs/PATCHES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,5 @@ See the testing instructions on the PR and run through those steps.
8484

8585
Post your results on GitHub to assist the creator of the pull request.
8686

87-
You can see how to get the logs for various components using the [eBook Serverless For Everyone Else](https://gumroad.com/l/serverless-for-everyone-else), or by consulting the [DEV.md](/docs/DEV.md) guide.
87+
You can see how to get the logs for various components using the [eBook Serverless For Everyone Else](https://openfaas.gumroad.com/l/serverless-for-everyone-else), or by consulting the [DEV.md](/docs/DEV.md) guide.
8888

go.mod

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ module github.com/openfaas/faasd
33
go 1.21
44

55
require (
6-
github.com/alexellis/arkade v0.0.0-20240315144638-acb1bd999ac8
6+
github.com/alexellis/arkade v0.0.0-20240320084407-6cf4a641c415
77
github.com/compose-spec/compose-go v0.0.0-20200528042322-36d8ce368e05
88
github.com/containerd/containerd v1.7.0
99
github.com/containerd/go-cni v1.1.9
@@ -80,10 +80,10 @@ require (
8080
github.com/opencontainers/runc v1.1.12 // indirect
8181
github.com/opencontainers/selinux v1.11.0 // indirect
8282
github.com/otiai10/copy v1.14.0 // indirect
83-
github.com/prometheus/client_golang v1.18.0 // indirect
84-
github.com/prometheus/client_model v0.5.0 // indirect
85-
github.com/prometheus/common v0.45.0 // indirect
86-
github.com/prometheus/procfs v0.12.0 // indirect
83+
github.com/prometheus/client_golang v1.19.0 // indirect
84+
github.com/prometheus/client_model v0.6.0 // indirect
85+
github.com/prometheus/common v0.51.1 // indirect
86+
github.com/prometheus/procfs v0.13.0 // indirect
8787
github.com/rivo/uniseg v0.4.4 // indirect
8888
github.com/sirupsen/logrus v1.9.3 // indirect
8989
github.com/vbatts/tar-split v0.11.5 // indirect

go.sum

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ github.com/alexellis/arkade v0.0.0-20240124171646-67314ef9f9c3 h1:JoyZaLGeoRWsJI
1616
github.com/alexellis/arkade v0.0.0-20240124171646-67314ef9f9c3/go.mod h1:Uqijd3uJORh9Q9MxCeER7IynU8kuXkCTnkLvFwr3XNE=
1717
github.com/alexellis/arkade v0.0.0-20240315144638-acb1bd999ac8 h1:e1tdmytMtXycabpumDRN5/24AXyzJRY9yUwZ0IsMSdo=
1818
github.com/alexellis/arkade v0.0.0-20240315144638-acb1bd999ac8/go.mod h1:3sT9Gq9WUFG9Wwz9dFbRRc/2L3yepsA4p272aG2DR6w=
19+
github.com/alexellis/arkade v0.0.0-20240320084407-6cf4a641c415 h1:mLD1eSfXbmXcwKMP1AsFl01G2U16aC9E22Tcjehyyrw=
20+
github.com/alexellis/arkade v0.0.0-20240320084407-6cf4a641c415/go.mod h1:3sT9Gq9WUFG9Wwz9dFbRRc/2L3yepsA4p272aG2DR6w=
1921
github.com/alexellis/go-execute/v2 v2.2.1 h1:4Ye3jiCKQarstODOEmqDSRCqxMHLkC92Bhse743RdOI=
2022
github.com/alexellis/go-execute/v2 v2.2.1/go.mod h1:FMdRnUTiFAmYXcv23txrp3VYZfLo24nMpiIneWgKHTQ=
2123
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
@@ -220,14 +222,23 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
220222
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
221223
github.com/prometheus/client_golang v1.18.0 h1:HzFfmkOzH5Q8L8G+kSJKUx5dtG87sewO+FoDDqP5Tbk=
222224
github.com/prometheus/client_golang v1.18.0/go.mod h1:T+GXkCk5wSJyOqMIzVgvvjFDlkOQntgjkJWKrN5txjA=
225+
github.com/prometheus/client_golang v1.19.0 h1:ygXvpU1AoN1MhdzckN+PyD9QJOSD4x7kmXYlnfbA6JU=
226+
github.com/prometheus/client_golang v1.19.0/go.mod h1:ZRM9uEAypZakd+q/x7+gmsvXdURP+DABIEIjnmDdp+k=
223227
github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
224228
github.com/prometheus/client_model v0.5.0 h1:VQw1hfvPvk3Uv6Qf29VrPF32JB6rtbgI6cYPYQjL0Qw=
225229
github.com/prometheus/client_model v0.5.0/go.mod h1:dTiFglRmd66nLR9Pv9f0mZi7B7fk5Pm3gvsjB5tr+kI=
230+
github.com/prometheus/client_model v0.6.0 h1:k1v3CzpSRUTrKMppY35TLwPvxHqBu0bYgxZzqGIgaos=
231+
github.com/prometheus/client_model v0.6.0/go.mod h1:NTQHnmxFpouOD0DpvP4XujX3CdOAGQPoaGhyTchlyt8=
226232
github.com/prometheus/common v0.45.0 h1:2BGz0eBc2hdMDLnO/8n0jeB3oPrt2D08CekT0lneoxM=
227233
github.com/prometheus/common v0.45.0/go.mod h1:YJmSTw9BoKxJplESWWxlbyttQR4uaEcGyv9MZjVOJsY=
234+
github.com/prometheus/common v0.48.0/go.mod h1:0/KsvlIEfPQCQ5I2iNSAWKPZziNCvRs5EC6ILDTlAPc=
235+
github.com/prometheus/common v0.51.1 h1:eIjN50Bwglz6a/c3hAgSMcofL3nD+nFQkV6Dd4DsQCw=
236+
github.com/prometheus/common v0.51.1/go.mod h1:lrWtQx+iDfn2mbH5GUzlH9TSHyfZpHkSiG1W7y3sF2Q=
228237
github.com/prometheus/procfs v0.6.0/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA=
229238
github.com/prometheus/procfs v0.12.0 h1:jluTpSng7V9hY0O2R9DzzJHYb2xULk9VTR1V1R/k6Bo=
230239
github.com/prometheus/procfs v0.12.0/go.mod h1:pcuDEFsWDnvcgNzo4EEweacyhjeA9Zk3cnaOZAZEfOo=
240+
github.com/prometheus/procfs v0.13.0 h1:GqzLlQyfsPbaEHaQkO7tbDlriv/4o5Hudv6OXHGKX7o=
241+
github.com/prometheus/procfs v0.13.0/go.mod h1:cd4PFCR54QLnGKPaKGA6l+cfuNXtht43ZKY6tow0Y1g=
231242
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
232243
github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis=
233244
github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=

0 commit comments

Comments
 (0)