Skip to content

Commit 63a35ac

Browse files
k33gk33g
committed
📦 updates HDK for v0.3.9
1 parent 311b463 commit 63a35ac

21 files changed

+386
-76
lines changed

‎.gitpod.Dockerfile

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
FROM gitpod/workspace-base:latest
2+
3+
# ------------------------------------
4+
# Install Go
5+
# ------------------------------------
6+
ENV GO_VERSION=1.20
7+
8+
ENV GOPATH=$HOME/go-packages
9+
ENV GOROOT=$HOME/go
10+
ENV PATH=$GOROOT/bin:$GOPATH/bin:$PATH
11+
RUN curl -fsSL https://dl.google.com/go/go${GO_VERSION}.linux-amd64.tar.gz | tar xzs \
12+
&& printf '%s\n' 'export GOPATH=/workspace/go' \
13+
'export PATH=$GOPATH/bin:$PATH' > $HOME/.bashrc.d/300-go
14+
15+
# ------------------------------------
16+
# Install TinyGo
17+
# ------------------------------------
18+
ARG TINYGO_VERSION="0.27.0"
19+
RUN wget https://github.com/tinygo-org/tinygo/releases/download/v${TINYGO_VERSION}/tinygo_${TINYGO_VERSION}_amd64.deb
20+
RUN sudo dpkg -i tinygo_${TINYGO_VERSION}_amd64.deb
21+
RUN rm tinygo_${TINYGO_VERSION}_amd64.deb
22+
23+
RUN go install github.com/go-task/task/v3/cmd/task@latest
24+
RUN go install -v golang.org/x/tools/gopls@latest

‎.gitpod.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
image:
2+
file: .gitpod.Dockerfile

‎Taskfile.yml

+6-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ tasks:
2525
#TAG: "v0.3.5"
2626
#TAG: "v0.3.6" # next release
2727
#TAG: "v0.3.7" # next release (this is a pre-release)
28-
TAG: "v0.3.8"
28+
#TAG: "v0.3.8"
29+
TAG: "v0.3.9"
30+
#TAG: "v0.4.0"
2931

3032
cmds:
3133
- echo "📦 Generating release..."
@@ -36,13 +38,13 @@ tasks:
3638

3739
remove-tag:
3840
env:
39-
TAG: "v0.3.8"
41+
TAG: "v0.3.9"
4042
cmds:
4143
- git tag -d ${TAG}
4244

4345
build-releases:
4446
env:
45-
TAG: "v0.3.8"
47+
TAG: "v0.3.9"
4648
cmds:
4749
- |
4850
cd capsule-cli
@@ -75,7 +77,7 @@ tasks:
7577
build-push-docker-image:
7678
vars:
7779
IMAGE_BASE_NAME: "capsule-http"
78-
IMAGE_TAG: "0.3.8"
80+
IMAGE_TAG: "0.3.9"
7981
cmds:
8082
- echo "👋 {{.IMAGE_BASE_NAME}}-{{.GOOS}}-{{.GOARCH}}:{{.IMAGE_TAG}}"
8183
- |

‎capsule-http/Taskfile.yml

+12-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ tasks:
6363
GOOS: "linux"
6464
GOARCH: "arm64"
6565
IMAGE_BASE_NAME: "capsule-http"
66-
IMAGE_TAG: "0.3.8"
66+
IMAGE_TAG: "0.3.9"
6767
cmds:
6868
- |
6969
IMAGE_NAME="${IMAGE_BASE_NAME}-${GOOS}-${GOARCH}"
@@ -365,6 +365,17 @@ tasks:
365365
-target wasi ./main.go
366366
ls -lh *.wasm
367367
368+
start-index-html:
369+
env:
370+
HTTP_PORT: '7777'
371+
WASM_FILE: './functions/index-html/index.wasm'
372+
cmds:
373+
- |
374+
echo "🚀 Testing hey..."
375+
./capsule-http --wasm=${WASM_FILE} --httpPort=${HTTP_PORT}
376+
377+
378+
368379
test-index-html:
369380
env:
370381
DATA: 'Bob Morane'

‎capsule-http/functions/hello-world/Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM botsgarden/capsule-http-linux-arm64:0.3.8
1+
FROM botsgarden/capsule-http-linux-arm64:0.3.9
22
COPY hello-world.wasm .
33
EXPOSE 8080
44
CMD ["/capsule-http", "--wasm=./hello-world.wasm", "--httpPort=8080"]

‎capsule-http/functions/index-html/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Serving HTML with Capsule HTTP server
2+
3+
```bash
4+
# build and install capsule-http
5+
task install
6+
# build the wasm module
7+
task build
8+
# serve the wasm module
9+
task serve
10+
```

‎capsule-http/functions/index-html/Taskfile.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
version: '3'
2+
3+
# capsctl usages
4+
tasks:
5+
6+
# build capsule-http and deploy on OVH
7+
install:
8+
cmds:
9+
- |
10+
echo "📦 Building capsule-http..."
11+
cd ../..
12+
pwd
13+
env CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w" -o capsule-http
14+
ls -lh capsule-http
15+
sudo cp capsule-http /usr/local/bin/capsule-http
16+
capsule-http --version
17+
18+
build:
19+
cmds:
20+
- |
21+
echo "📦 Building index.wasm module..."
22+
tinygo build -o index.wasm \
23+
-scheduler=none \
24+
--no-debug \
25+
-target wasi ./main.go
26+
ls -lh *.wasm
27+
28+
serve:
29+
env:
30+
HTTP_PORT: '7070'
31+
WASM_FILE: './index.wasm'
32+
cmds:
33+
- |
34+
capsule-http --wasm=${WASM_FILE} --httpPort=${HTTP_PORT}
35+

‎capsule-http/functions/index-html/index.html

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<html>
2+
<head>
3+
<meta charset="utf-8">
4+
<title>Capsule 💜 Wasm & Wazero</title>
5+
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
<style>
7+
.container { min-height: 100vh; display: flex; justify-content: center; align-items: center; text-align: center; }
8+
.title { font-family: "Source Sans Pro", "Helvetica Neue", Arial, sans-serif; display: block; font-weight: 300; font-size: 80px; color: #35495e; letter-spacing: 1px; }
9+
.subtitle { font-family: "Source Sans Pro", "Helvetica Neue", Arial, sans-serif; font-weight: 300; font-size: 32px; color: #526488; word-spacing: 5px; padding-bottom: 15px; }
10+
.links { padding-top: 15px; }
11+
</style>
12+
</head>
13+
14+
<body>
15+
<section class="container">
16+
<div>
17+
<h1 class="title">👋 Hello World 🌍</h1>
18+
<h2 class="subtitle">Served with 💜 by Capsule [HTTP] v0.3.9 🥒 [cucumber] 💊</h2>
19+
<h2 class="subtitle">🎉 Happily built thanks to Wazero</h2>
20+
</div>
21+
</section>
22+
</body>
23+
24+
</html>

‎capsule-http/functions/index-html/main.go

+19-15
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
1-
// Package main
1+
// Package main, this module is serving HTML
22
package main
33

44
import (
5+
_ "embed"
56
capsule "github.com/bots-garden/capsule-module-sdk"
67
)
78

9+
var (
10+
//go:embed index.html
11+
html []byte
12+
)
13+
814
func main() {
9-
capsule.SetHandleHTTP(Handle)
15+
capsule.SetHandleHTTP(func (param capsule.HTTPRequest) (capsule.HTTPResponse, error) {
16+
return capsule.HTTPResponse{
17+
TextBody: string(html),
18+
Headers: `{
19+
"Content-Type": "text/html; charset=utf-8",
20+
"Cache-Control": "no-cache",
21+
"X-Powered-By": "capsule-module-sdk"
22+
}`,
23+
StatusCode: 200,
24+
}, nil
25+
})
1026
}
1127

12-
// Handle function
13-
func Handle(param capsule.HTTPRequest) (capsule.HTTPResponse, error) {
14-
15-
return capsule.HTTPResponse{
16-
TextBody: "<h1>👋 Hello World! 🌍</h1>",
17-
Headers: `{
18-
"Content-Type": "text/html; charset=utf-8",
19-
"Cache-Control": "no-cache",
20-
"X-Powered-By": "capsule-module-sdk"
21-
}`,
22-
StatusCode: 200,
23-
}, nil
24-
}
28+

‎docs/capsule-http-faas-mode.md

+68-17
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A Capsule HTTP server can start/spawn other Capsule HTTP server processes.
1010
### Install the last version of Capsule HTTP
1111

1212
```bash
13-
VERSION="v0.3.8" OS="linux" ARCH="arm64"
13+
VERSION="v0.3.9" OS="linux" ARCH="arm64"
1414
wget -O capsule-http https://github.com/bots-garden/capsule/releases/download/${VERSION}/capsule-http-${VERSION}-${OS}-${ARCH}
1515
chmod +x capsule-http
1616
sudo cp capsule-http /usr/local/bin/capsule-http
@@ -24,7 +24,7 @@ capsule-http --version
2424
**CapsCtl** is a CLI to send commands to the Capsule HTTP server when it is unning in **FaaS** mode.
2525

2626
```bash
27-
VERSION="v0.3.8" OS="linux" ARCH="arm64"
27+
VERSION="v0.3.9" OS="linux" ARCH="arm64"
2828
wget -O capsctl https://github.com/bots-garden/capsule/releases/download/${VERSION}/capsctl-${VERSION}-${OS}-${ARCH}
2929
chmod +x capsctl
3030
sudo cp capsctl /usr/local/bin/capsctl
@@ -35,25 +35,33 @@ capsctl --version
3535
## Start Capsule HTTP FaaS mode
3636

3737
```bash
38-
CAPSULE_DOMAIN="http://localhost" \
3938
CAPSULE_FAAS_TOKEN="ILOVEPANDAS" \
4039
capsule-http \
4140
--wasm=./functions/index-page/index-page.wasm \
4241
--httpPort=8080 \
4342
--faas=true
4443
```
4544

45+
> **Remarks:**: if you use SSL certificates, use these options:
46+
> - `--crt=faas.capsule.foundation.crt`
47+
> - `--key=faas.capsule.foundation.key`
48+
49+
4650
You should get an output like this:
4751
```
4852
2023/05/29 15:12:18 🚀 faas mode activated!
4953
2023/05/29 15:12:18 📦 wasm module loaded: ./functions/index-page/index-page.wasm
50-
2023/05/29 15:12:18 💊 Capsule [HTTP] v0.3.8 🥬 [leafy greens]
54+
2023/05/29 15:12:18 💊 Capsule [HTTP] v0.3.9 🥒 [cucumber]
5155
http server is listening on: 8080 🌍
5256
```
5357

54-
> In a future version, the wasm file won't be mandatory anymore.
58+
> **Remarks:**
59+
> - the wasm file (`--wasm`) is optional (a default message is served if not specified)
60+
> - `CAPSULE_FAAS_TOKEN` is used to authenticate the `capsctl` CLI
61+
62+
## Start a function
5563

56-
## Launch another Capsule HTTP server
64+
With the FaaS mode activated, you can start functions. It' like running another **Capsule HTTP** processes (one wasm function == one Capsule HTTP process).
5765

5866
```bash
5967
export CAPSULE_FAAS_TOKEN="ILOVEPANDAS"
@@ -67,13 +75,14 @@ capsctl \
6775
--revision=green \
6876
--description="this the hello module, green revision" \
6977
--env='["MESSAGE=🟢","GREETING=🤗"]' \
70-
--path="/usr/local/bin/capsule-http" \
7178
--wasm=./functions/hello-green/hello-green.wasm
7279
```
73-
> - `--stopAfter=10` this will stop the Capsule HTTP server process after 10 seconds
80+
> - `--stopAfter=10` this will stop the Capsule HTTP server process after 10 seconds ()optional
7481
> - `--stopAfter` is not mandatory (then the Capsule HTTP server process will never stop)
75-
> - if the process is stopped, the Capsule HTTP server will be restarted at every call
76-
> - `--path` means you can use various version of Capsule HTTP
82+
> - if the process is stopped, the Capsule HTTP server will be restarted at next call
83+
> - `--description=` is optional
84+
> - `--env='["MESSAGE=🟢","GREETING=🤗"]'` allows to pass environment variables to the function (optional)
85+
> - `--wasm`: where to find the wasm file
7786
7887
**Now you can use this URL `http://localhost:8080/functions/hello/green` to call the hello green function**
7988

@@ -85,20 +94,36 @@ curl -X POST http://localhost:8080/functions/hello/green \
8594
-d "Bob Morane"
8695
```
8796

88-
## Launch another Capsule HTTP server process
97+
### Default revision
98+
99+
If you don't specify a revision, the default revision is called **default**, then you can call the function like this:
100+
101+
```bash
102+
curl -X POST http://localhost:8080/functions/hello \
103+
-H 'Content-Type: text/plain; charset=utf-8' \
104+
-d "Bob Morane"
105+
```
106+
107+
Or like this:
108+
109+
```bash
110+
curl -X POST http://localhost:8080/functions/hello/default \
111+
-H 'Content-Type: text/plain; charset=utf-8' \
112+
-d "Bob Morane"
113+
```
114+
115+
> 👋 the revision concept is useful to handle several version of a wasm module/function.
116+
117+
## Launch another function
89118

90119
```bash
91120
export CAPSULE_FAAS_TOKEN="ILOVEPANDAS"
92-
export CAPSULE_INSTALL_PATH="/usr/local/bin/capsule-http"
121+
export CAPSULE_MAIN_PROCESS_URL="http://localhost:8080"
93122

94123
capsctl \
95124
--cmd=start \
96-
--stopAfter=10 \
97125
--name=hello \
98126
--revision=blue \
99-
--description="this the hello module, blue revision" \
100-
--env='["MESSAGE=🔵","GREETING=🎉"]'\
101-
--path="/usr/local/bin/capsule-http" \
102127
--wasm=./functions/hello-blue/hello-blue.wasm
103128
```
104129

@@ -112,7 +137,7 @@ curl -X POST http://localhost:8080/functions/hello/blue \
112137
-d "Bob Morane"
113138
```
114139

115-
## Stop and remove a running Capsule HTTP server process
140+
## Drop: stop and remove a running function
116141

117142
```bash
118143
export CAPSULE_FAAS_TOKEN="ILOVEPANDAS"
@@ -149,3 +174,29 @@ curl -X POST http://localhost:8080/functions/hello/green \
149174
-H 'Content-Type: text/plain; charset=utf-8' \
150175
-d "Bob Morane"
151176
```
177+
178+
## Download the wasm module before starting the function
179+
180+
You can specify to the Capsule HTTP process with the `--url` option, where to download the wasm file and where to save it before starting with the `--wasm` option:
181+
182+
```bash
183+
export CAPSULE_FAAS_TOKEN="ILOVEPANDAS"
184+
export CAPSULE_MAIN_PROCESS_URL="http://localhost:8080"
185+
186+
capsctl \
187+
--cmd=start \
188+
--name=hello \
189+
--revision=0.0.1 \
190+
--wasm= ./store/hello.0.0.1.wasm \
191+
--url=http://wasm.files.com/hello/0.0.1/hello.0.0.1.wasm
192+
```
193+
194+
### Authentication of the downlad
195+
196+
If you need to provide an authentication token, you can use these options:
197+
198+
```bash
199+
--authHeaderName="PRIVATE-TOKEN" \
200+
--authHeaderValue="${GITLAB_WASM_TOKEN}" \
201+
```
202+

0 commit comments

Comments
 (0)