Skip to content

Commit 9edd821

Browse files
committed
feat: add upgrade instructions for transitioning to K3s + gVisor
1 parent 2eb62f4 commit 9edd821

3 files changed

Lines changed: 38 additions & 1 deletion

File tree

deploy/docker/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,18 @@ This installs the execution sandbox, creates the `supercheck-execution` namespac
124124
125125
---
126126

127+
## Upgrading
128+
129+
```bash
130+
docker compose pull && \
131+
KUBECONFIG_FILE=/etc/rancher/k3s/supercheck-worker.kubeconfig \
132+
docker compose up -d
133+
```
134+
135+
> **Upgrading to 1.3.3 from earlier versions:** This release replaces Docker socket-based execution with K3s + gVisor. Before upgrading, back up your database and run `sudo bash setup-k3s.sh` to install the execution sandbox. See the [deployment guide](https://supercheck.io/docs/app/deployment/self-hosted) for details.
136+
137+
---
138+
127139
## Backups
128140

129141
```bash

deploy/docker/setup-k3s.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# chmod +x setup-k3s.sh && sudo ./setup-k3s.sh
1212
#
1313
# Prerequisites:
14-
# - Ubuntu 22.04+ or Debian 12+ (amd64)
14+
# - Ubuntu 22.04+ or Debian 12+ (amd64/arm64)
1515
# - Root/sudo access
1616
# - Internet connectivity
1717
#

docs/content/docs/app/deployment/self-hosted.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,31 @@ KUBECONFIG_FILE=/etc/rancher/k3s/supercheck-worker.kubeconfig \
317317
docker compose -f docker-compose-secure.yml up -d
318318
```
319319

320+
<Callout type="error">
321+
**Upgrading to 1.3.3 from earlier versions** — Version 1.3.3 replaces Docker socket-based test execution with a sandboxed model powered by K3s and gVisor. Before upgrading, you must run the setup script:
322+
323+
```bash
324+
# 1. Back up your database first
325+
docker compose exec postgres pg_dump -U postgres supercheck > backup-pre-133.sql
326+
327+
# 2. Install K3s + gVisor execution sandbox
328+
sudo bash setup-k3s.sh
329+
330+
# 3. Pull new images and restart with kubeconfig
331+
# Quick Start (HTTP):
332+
docker compose pull && \
333+
KUBECONFIG_FILE=/etc/rancher/k3s/supercheck-worker.kubeconfig \
334+
docker compose up -d
335+
336+
# Production (HTTPS):
337+
docker compose -f docker-compose-secure.yml pull && \
338+
KUBECONFIG_FILE=/etc/rancher/k3s/supercheck-worker.kubeconfig \
339+
docker compose -f docker-compose-secure.yml up -d
340+
```
341+
342+
The worker container no longer requires the Docker socket. Existing tests and monitors continue to work without modification. If you have remote workers ([Multi-Location](/docs/app/deployment/multi-location)), run `setup-k3s.sh` on each remote server as well.
343+
</Callout>
344+
320345
---
321346

322347
## Architecture

0 commit comments

Comments
 (0)