Skip to content

Commit cd7be88

Browse files
committed
improve docs
1 parent d0ff937 commit cd7be88

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

devlog/2025-03-sandboxing.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,22 @@ Both Docker images were built and tested locally with the `spec` command to veri
7171
### Firejail Test Results
7272

7373
```bash
74-
docker run --rm airbyte/source-declarative-manifest-firejail spec
74+
$ cd docker/sandbox-poc
75+
...
76+
$ docker build -f Dockerfile.firejail -t airbyte/source-declarative-manifest-firejail .
77+
...
78+
$ docker run --rm airbyte/source-declarative-manifest-firejail spec
7579
{"type":"SPEC","spec":{"connectionSpecification":{"$schema":"http://json-schema.org/draft-07/schema#","title":"Low-code source spec","type":"object","required":["__injected_declarative_manifest"],"additionalProperties":true,"properties":{"__injected_declarative_manifest":{"title":"Low-code manifest","type":"object","description":"The low-code manifest that defines the components of the source."}}},"documentationUrl":"https://docs.airbyte.com/integrations/sources/low-code","supportsNormalization":false,"supportsDBT":false}}
7680
```
7781

7882
### gVisor Test Results
7983

8084
```bash
81-
docker run --rm airbyte/source-declarative-manifest-gvisor spec
85+
$ cd docker/sandbox-poc
86+
...
87+
$ docker build -f Dockerfile.gvisor -t airbyte/source-declarative-manifest-gvisor .
88+
...
89+
$ docker run --rm airbyte/source-declarative-manifest-gvisor spec
8290
running container: creating container: creating container root directory "/var/run/runsc": mkdir /var/run/runsc: permission denied
8391
{"type":"SPEC","spec":{"connectionSpecification":{"$schema":"http://json-schema.org/draft-07/schema#","title":"Low-code source spec","type":"object","required":["__injected_declarative_manifest"],"additionalProperties":true,"properties":{"__injected_declarative_manifest":{"title":"Low-code manifest","type":"object","description":"The low-code manifest that defines the components of the source."}}},"documentationUrl":"https://docs.airbyte.com/integrations/sources/low-code","supportsNormalization":false,"supportsDBT":false}}
8492
```

docker/sandbox-poc/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,35 @@ This directory contains Dockerfiles for proof-of-concept (POC) implementations o
77
The `Dockerfile.firejail` adds [Firejail](https://firejail.wordpress.com/) to the source-declarative-manifest image. Firejail is a SUID sandbox program that restricts the running environment of untrusted applications using Linux namespaces and seccomp-bpf.
88

99
To build the image:
10-
```
10+
11+
```bash
12+
cd docker/sandbox-poc
1113
docker build -f Dockerfile.firejail -t airbyte/source-declarative-manifest-firejail .
1214
```
1315

16+
To test the image:
17+
18+
```bash
19+
docker run --rm airbyte/source-declarative-manifest-firejail spec
20+
```
21+
1422
## gVisor
1523

1624
The `Dockerfile.gvisor` adds [gVisor](https://gvisor.dev/) (via runsc) to the source-declarative-manifest image. gVisor is a user-space kernel, written in Go, that implements a substantial portion of the Linux system call interface. It provides an additional layer of isolation between running applications and the host operating system.
1725

1826
To build the image:
19-
```
27+
28+
```bash
29+
cd docker/sandbox-poc
2030
docker build -f Dockerfile.gvisor -t airbyte/source-declarative-manifest-gvisor .
2131
```
2232

33+
To test the image:
34+
35+
```bash
36+
docker run --rm airbyte/source-declarative-manifest-gvisor spec
37+
```
38+
2339
## Usage
2440

2541
Both images wrap the original entry point of the source-declarative-manifest connector with their respective sandboxing solution. The wrapped entry point handles all the same command-line arguments as the original entry point.

0 commit comments

Comments
 (0)