Skip to content

Commit 6dc8eb0

Browse files
k33gk33g
authored
Merge pull request #234 from bots-garden/dockerize-capsule-cli-capsule-http
Dockerize capsule cli capsule http
2 parents 8d5c270 + 9d95731 commit 6dc8eb0

13 files changed

+278
-5
lines changed

‎Taskfile.yml

+74
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,84 @@ tasks:
5656
env GOOS=linux GOARCH=arm64 go build -o capsule-http-${TAG}-linux-arm64
5757
env GOOS=linux GOARCH=amd64 go build -o capsule-http-${TAG}-linux-amd64
5858
mv capsule-http-${TAG}-* ../release
59+
60+
- |
61+
cd ../relase
62+
chmod +x capsule-http-*
5963
6064
6165
#replace github.com/bots-garden/capsule-host-sdk => ../../capsule-host-sdk
6266
#replace github.com/bots-garden/capsule-module-sdk => ../../capsule-module-sdk
6367

68+
# Build of capsule-http Docker image
69+
build-push-docker-image:
70+
vars:
71+
IMAGE_BASE_NAME: "capsule-http"
72+
IMAGE_TAG: "0.3.6"
73+
cmds:
74+
- echo "👋 {{.IMAGE_BASE_NAME}}-{{.GOOS}}-{{.GOARCH}}:{{.IMAGE_TAG}}"
75+
- |
76+
cd capsule-http
77+
docker login -u ${DOCKER_USER} -p ${DOCKER_PWD}
78+
docker buildx build --platform {{.GOOS}}/{{.GOARCH}} --push -t ${DOCKER_USER}/{{.IMAGE_BASE_NAME}}-{{.GOOS}}-{{.GOARCH}}:{{.IMAGE_TAG}} .
79+
80+
build-capsule-http-for-docker:
81+
cmds:
82+
- |
83+
echo "📦 Building capsule-http..."
84+
cd capsule-http
85+
CGO_ENABLED=0 GOOS={{.GOOS}} GOARCH={{.GOARCH}} go build -a -installsuffix cgo -o capsule-http .
86+
ls -lh capsule-http
6487
88+
build-docker-capsule-http-image-darwin-arm64:
89+
vars:
90+
GOOS: "darwin"
91+
GOARCH: "arm64"
92+
cmds:
93+
- task: build-capsule-http-for-docker
94+
vars: { GOOS: '{{.GOOS}}', GOARCH: '{{.GOARCH}}' }
95+
- task: build-push-docker-image
96+
vars: {
97+
GOOS: '{{.GOOS}}',
98+
GOARCH: '{{.GOARCH}}'
99+
}
100+
101+
build-docker-capsule-http-image-darwin-amd64:
102+
vars:
103+
GOOS: "darwin"
104+
GOARCH: "amd64"
105+
cmds:
106+
- task: build-capsule-http-for-docker
107+
vars: { GOOS: '{{.GOOS}}', GOARCH: '{{.GOARCH}}' }
108+
- task: build-push-docker-image
109+
vars: {
110+
GOOS: '{{.GOOS}}',
111+
GOARCH: '{{.GOARCH}}'
112+
}
113+
114+
build-docker-capsule-http-image-linux-amd64:
115+
vars:
116+
GOOS: "linux"
117+
GOARCH: "amd64"
118+
cmds:
119+
- task: build-capsule-http-for-docker
120+
vars: { GOOS: '{{.GOOS}}', GOARCH: '{{.GOARCH}}' }
121+
- task: build-push-docker-image
122+
vars: {
123+
GOOS: '{{.GOOS}}',
124+
GOARCH: '{{.GOARCH}}'
125+
}
126+
127+
build-docker-capsule-http-image-linux-arm64:
128+
vars:
129+
GOOS: "linux"
130+
GOARCH: "arm64"
131+
cmds:
132+
- task: build-capsule-http-for-docker
133+
vars: { GOOS: '{{.GOOS}}', GOARCH: '{{.GOARCH}}' }
134+
- task: build-push-docker-image
135+
vars: {
136+
GOOS: '{{.GOOS}}',
137+
GOARCH: '{{.GOARCH}}'
138+
}
65139

‎capsule-http/Dockerfile

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
FROM scratch
2+
ADD capsule-http ./

‎capsule-http/Taskfile.yml

+45
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,50 @@ tasks:
5050
-d "${JSON_DATA}"
5151
- killport ${HTTP_PORT}
5252

53+
# ----------------------------------------
54+
# 🐳 Testing Docker image of capsule-http
55+
# ----------------------------------------
56+
test-hello-world-with-docker:
57+
env:
58+
JSON_DATA: '{"name":"🤣 Bob Morane","age":42}'
59+
HTTP_PORT: '6666'
60+
DOMAIN: 'localhost'
61+
PROTOCOL: 'http'
62+
WASM_FILE: './functions/hello-world/hello-world.wasm'
63+
GOOS: "linux"
64+
GOARCH: "arm64"
65+
IMAGE_BASE_NAME: "capsule-http"
66+
IMAGE_TAG: "0.3.6"
67+
cmds:
68+
- |
69+
IMAGE_NAME="${IMAGE_BASE_NAME}-${GOOS}-${GOARCH}"
70+
echo "🚀 Testing hello-world with 🐳..."
71+
echo "🖼️ ${IMAGE_NAME}"
72+
docker run \
73+
-p ${HTTP_PORT}:${HTTP_PORT} \
74+
-v $(pwd)/functions/hello-world:/app --rm ${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_TAG} \
75+
/capsule-http \
76+
--wasm=./app/hello-world.wasm \
77+
--httpPort=${HTTP_PORT} &
78+
sleep 1
79+
- |
80+
curl -X POST ${PROTOCOL}://${DOMAIN}:${HTTP_PORT} \
81+
-H 'Content-Type: application/json; charset=utf-8' \
82+
-d "${JSON_DATA}"
83+
- |
84+
IMAGE_NAME="${IMAGE_BASE_NAME}-${GOOS}-${GOARCH}"
85+
docker stop $(docker ps -q --filter ancestor=${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_TAG} )
86+
87+
#Use it with a remote file (to be tested):
88+
#docker run \
89+
# -p 8080:8080 \
90+
# -v $(pwd)/functions/hello-world:/app --rm ${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_TAG} \
91+
# /capsule-http \
92+
# --url=http://172.17.0.1:5000/hello-world.wasm \
93+
# --wasm=./app/hello-world.wasm \
94+
# --httpPort=8080
95+
96+
5397
test-hello-world-remote:
5498
env:
5599
JSON_DATA: '{"name":"Bob Morane","age":42}'
@@ -256,3 +300,4 @@ tasks:
256300
hey -n 300 -c 100 -m GET \
257301
${PROTOCOL}://${DOMAIN}:${HTTP_PORT}
258302
- killport ${HTTP_PORT}
303+

‎capsule-http/build-image.sh

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/bash
2+
IMAGE_NAME="demo-capsule-http"
3+
docker login -u ${DOCKER_USER} -p ${DOCKER_PWD}
4+
docker build -t ${IMAGE_NAME} .
5+
6+
docker images | grep ${IMAGE_NAME}

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

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
FROM botsgarden/capsule-http-linux-arm64:0.3.6
2+
COPY hello-world.wasm .
3+
EXPOSE 8080
4+
CMD ["/capsule-http", "--wasm=./hello-world.wasm", "--httpPort=8080"]
5+

‎capsule-http/functions/hello-world/build-image.sh

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/bash
2+
IMAGE_NAME="demo-capsule-http"
3+
docker login -u ${DOCKER_USER} -p ${DOCKER_PWD}
4+
docker build -t ${IMAGE_NAME} .
5+
6+
docker images | grep ${IMAGE_NAME}

‎capsule-http/functions/hello-world/test-image.sh

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/bash
2+
IMAGE_NAME="demo-capsule-http"
3+
docker run \
4+
-p 8080:8080 \
5+
--rm ${IMAGE_NAME}
6+

‎docs/docker-capsule-http.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# 🐳 Capsule HTTP Docker image
2+
3+
!!! info "Capsule HTTP Docker images v0.3.6 🫐 [blueberries]"
4+
- `botsgarden/capsule-http-linux-arm64:0.3.6`
5+
- `botsgarden/capsule-http-linux-amd64:0.3.6`
6+
- `botsgarden/capsule-http-darwin-arm64:0.3.6`
7+
- `botsgarden/capsule-http-darwin-amd64:0.3.6`
8+
9+
> https://hub.docker.com/repositories/botsgarden
10+
11+
## How to use it
12+
13+
```bash
14+
GOOS="linux"
15+
GOARCH="arm64"
16+
IMAGE_TAG="0.3.6"
17+
IMAGE_NAME="botsgarden/capsule-http-${GOOS}-${GOARCH}"
18+
19+
docker run \
20+
-p 8080:8080 \
21+
-v $(pwd)/functions/hello-world:/app --rm ${IMAGE_NAME}:${IMAGE_TAG} \
22+
/capsule-http \
23+
--wasm=./app/hello-world.wasm \
24+
--httpPort=8080
25+
```
26+
27+
## Dockerize Capsule HTTP and a WASM module
28+
29+
Create a new `Dockerfile`:
30+
31+
```dockerfile
32+
FROM botsgarden/capsule-http-linux-arm64:0.3.6
33+
COPY hello-world.wasm .
34+
EXPOSE 8080
35+
CMD ["/capsule-http", "--wasm=./hello-world.wasm", "--httpPort=8080"]
36+
```
37+
38+
Build the image:
39+
40+
```bash
41+
IMAGE_NAME="demo-capsule-http"
42+
docker login -u ${DOCKER_USER} -p ${DOCKER_PWD}
43+
docker build -t ${IMAGE_NAME} .
44+
45+
docker images | grep ${IMAGE_NAME}
46+
```
47+
48+
Run the container:
49+
50+
```bash
51+
IMAGE_NAME="demo-capsule-http"
52+
docker run \
53+
-p 8080:8080 \
54+
--rm ${IMAGE_NAME}
55+
```
56+
57+
Call the service:
58+
59+
```bash
60+
JSON_DATA='{"name":"Bob Morane","age":42}'
61+
curl -X POST http://localhost:8080 \
62+
-H 'Content-Type: application/json; charset=utf-8' \
63+
-d "${JSON_DATA}"
64+
```
65+
66+
67+
68+
69+

‎docs/getting-started-cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Use the Capsule CLI
44

5-
First, download the last version of the Capsule CLI for the appropriate OS & ARCH:
5+
First, download the last version of the Capsule CLI for the appropriate OS & ARCH (and release version):
66

77
```bash
88
VERSION="v0.3.5" OS="linux" ARCH="arm64"

‎docs/getting-started-http.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
## Use the Capsule HTTP server
44

5-
First, download the last version of the Capsule HTTP server for the appropriate OS & ARCH:
5+
First, download the last version of the Capsule HTTP server for the appropriate OS & ARCH (and release version):
66

77
```bash
8-
VERSION="v0.3.5" OS="linux" ARCH="arm64"
8+
VERSION="v0.3.6" OS="linux" ARCH="arm64"
99
wget -O capsule-http https://github.com/bots-garden/capsule/releases/download/${VERSION}/capsule-http-${VERSION}-${OS}-${ARCH}
1010
chmod +x capsule-http
1111
```

‎docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Capsule Project: the nano wasm runners
22

33
!!! info "What's new?"
4-
- `v0.3.6 🫐 [blueberries]`: Prometheus metrics
4+
- `v0.3.6 🫐 [blueberries]`: Prometheus metrics + 🐳 Docker images
55
- `v0.3.5 🍓 [strawberry]`: Update with HDK & MDK `v0.0.2`
66
- `v0.3.4 🍋 [lemon]`: Capsule next generation (performances: x 10 🚀)
77
- 🌍 Downloads: [https://github.com/bots-garden/capsule/releases/tag/v0.3.5](https://github.com/bots-garden/capsule/releases/tag/v0.3.5)

‎mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ nav:
1717
- Capsule CLI and modules: getting-started-cli.md
1818
- Capsule HTTP and modules: getting-started-http.md
1919
- 🛠️ Host functions: host-functions-intro.md
20-
20+
- 🐳 Capsule HTTP Docker image: docker-capsule-http.md
2121

2222
theme:
2323
name: material

‎release/README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Release process
2+
3+
> Right now, it's a manual release process.
4+
5+
## Prerequisites
6+
7+
👋 **be on the main branch**
8+
9+
### Update documentation content with the new tag
10+
11+
- `docs/getting-started-cli.md`
12+
- `docs/getting-started-http.md`
13+
- `docs/index.md`
14+
- `docs/docker-capsule-http.md`
15+
16+
### Update version number in Go source
17+
18+
- `capsule-http/main.go`
19+
- `capsule-cli/main.go`
20+
21+
### Update version tag in Dockerfile
22+
23+
- `capsule-http/functions/hello-world/Dockerfile`
24+
25+
### Update version tag in Taskfile
26+
27+
- `capsule-http/Taskfile.yml` (`IMAGE_TAG: "N.N.N"`)
28+
29+
### Update the main Taskfile
30+
31+
Go to `./Taskfile.yml`
32+
33+
- Update `TAG` of the `release` task (`TAG: "vN.N.N"`)
34+
- Update `TAG` of the `remove-tag` task
35+
- Update `TAG` of the `build-releases` task
36+
- Update `IMAGE_TAG` of the `build-push-docker-image` task (`IMAGE_TAG: "N.N.N"`)
37+
38+
## Publish the release
39+
40+
Run:
41+
42+
```bash
43+
task release
44+
task build-releases
45+
task build-docker-capsule-http-image-darwin-arm64
46+
task build-docker-capsule-http-image-darwin-amd64
47+
task build-docker-capsule-http-image-linux-amd64
48+
task build-docker-capsule-http-image-linux-arm64
49+
```
50+
51+
- Create the release on GitHub
52+
- Upload the files
53+
54+
Publish the website:
55+
56+
```bash
57+
task publish-mkdocs
58+
```
59+
60+
🎉

0 commit comments

Comments
 (0)