Skip to content

Commit 99dd807

Browse files
dfrdfr
committed
Add FreeBSD as a platform
This uses FreeBSD jails to implement container isolation. Signed-off-by: Doug Rabson <[email protected]>
1 parent 27cb002 commit 99dd807

File tree

10 files changed

+371
-1
lines changed

10 files changed

+371
-1
lines changed

‎config-freebsd.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# <a name="FreeBSDContainerConfiguration" />FreeBSD Container Configuration
2+
3+
This document describes the schema for the [FreeBSD-specific section](config.md#platform-specific-configuration) of the [container configuration](config.md).
4+
5+
## <a name="configFreeBSDDevices" />Devices
6+
7+
Devices in FreeBSD are accessed via the `devfs` filesystem. Typically, each container will have a `devfs` filesystem mounted into its `/dev` directory. Often, a minimal set of devices is exposed to the container using ruleset 4 from `/etc/defaults/devfs.rules` - the ruleset is specified as a mount option.
8+
9+
Optionally, additional devices can be exposed to the container using an array of entries inside the `devices` root field:
10+
11+
* **`path`** _(string, REQUIRED)_ - the device path relative to `/dev`
12+
* **`mode`** _(string, OPTIONAL)_ - device permissions mode string as defined in [`chmod(1)`](https://man.freebsd.org/cgi/man.cgi?query=chmod).
13+
14+
### Example
15+
```json
16+
"devices": [
17+
{
18+
"path": "pf",
19+
"mode": "0700"
20+
}
21+
]
22+
```
23+
24+
## <a name="configFreeBSDJail" />Jail
25+
26+
On FreeBSD, containers are implemented using the platform's jail subsystem. Configuration for the container jail is via fields inside the `jail` root field:
27+
28+
* **`parent`** _(string, OPTIONAL)_ - parent jail.
29+
The value is the name of a jail which should be this container's parent (defaults to none). This can be used to share namespaces such as `vnet` with another container.
30+
* **`host`** _(string, OPTIONAL)_ - allow overriding hostname, domainname, hostuuid and hostid.
31+
The value can be "new" which allows these values to be overridden in the container or "inherit" to use the host values (or parent container values). If set to "new", the values for hostname and domainname are taken from the base config, if present.
32+
* **`ip4`** _(string, OPTIONAL)_ - control the availability of IPv4 addresses.
33+
This is typically left unset if the container has a vnet, set to "inherit" to allow access to host (or parent container) addresses or set to "disable" to stop use of IPv4 entirely.
34+
* **`ip6`** _(string, OPTIONAL)_ - control the availability of IPv6 addresses.
35+
This is typically left unset if the container has a vnet, set to "inherit" to allow access to host (or parent container) addresses or set to "disable" to stop use of IPv6 entirely.
36+
* **`vnet`** _(string, OPTIONAL)_ - control the vnet used for this container.
37+
The value can be "new" which causes a new vnet to be created for the container or "inherit" which shares the vnet for the parent container (or host if there is no parent).
38+
* **`sysvmsg`** _(string, OPTIONAL)_ - allow access to SYSV IPC message primitives.
39+
If set to "inherit", all IPC objects on the system are visible to this container, whether they were created by the container itself, the base system, or other containers. If set to "new", the container will have its own key namespace, and can only see the objects that it has created; the system (or parent container) has access to the container's objects, but not to its keys. If set to "disable", the container cannot perform any sysvmsg-related system calls. Defaults to "new".
40+
* **`sysvsem`** _(string, OPTIONAL)_ - allow access to SYSV IPC semaphore primitives, in the same manner as sysvmsg. Defaults to "new".
41+
* **`sysvshm`** _(string, OPTIONAL)_ - allow access to SYSV IPC shared memory primitives, in the same manner as sysvmsg. Defaults to "new".
42+
* **`enforceStatfs`** _(integer, OPTIONAL)_ - control visibility of mounts in the container.
43+
A value of 0 allows visibility of all host mounts, 1 allows visibility of mounts nested under the container's root and 2 only allows the container root to be visible. If unset, the default value is 2.
44+
* **`allow`** _(object, OPTIONAL)_ - Some restrictions of the container environment may be set on a per-container basis. With the exception of **`setHostname`** and **`reservedPorts`**, these boolean parameters are off by default.
45+
- **`setHostname`** _(bool, OPTIONAL)_ - Allow the container's hostname to be changed. Defaults to `false`.
46+
- **`rawSockets`** _(bool, OPTIONAL)_ - Allow the container to use raw sockets to support network utilities such as ping and traceroute. Defaults to `false`.
47+
- **`chflags`** _(bool, OPTIONAL)_ - Allow the system file flags to be changed. Defaults to `false`.
48+
- **`mount`** _(array of strings, OPTIONAL)_ - Allow the listed filesystem types to be mounted and unmounted in the container.
49+
- **`quotas`** _(bool, OPTIONAL)_ - Allow the filesystem quotas to be changed in the container. Defaults to `false`.
50+
- **`socketAf`** _(bool, OPTIONAL)_ - Allow socket types other than IPv4, IPv6 and unix. Defaults to `false`.
51+
- **`reservedPorts`** _(bool, OPTIONAL)_ - Allow the jail to bind to ports lower than 1024. Defaults to `false`.
52+
- **`suser`** _(bool, OPTIONAL)_ - The value of the jail's security.bsd.suser_enabled sysctl. The super-user will be disabled automatically if its parent system has it disabled. The super-user is enabled by default.
53+
54+
### Mapping from jail(8) config file
55+
56+
This table defines the mappings from a typical `jail(8)` config file to the container configuration:
57+
58+
| Jail parameter | JSON equivalent |
59+
| -------------- | -------------------- |
60+
| `jid` | - |
61+
| `name` | see below |
62+
| `path` | `root.path` |
63+
| `ip4.addr` | - |
64+
| `ip4.saddrsel` | - |
65+
| `ip4` | `freebsd.jail.ip4` |
66+
| `ip6.addr` | - |
67+
| `ip6.saddrsel` | - |
68+
| `ip6` | `freebsd.jail.ip6` |
69+
| `vnet` | `freebsd.jail.vnet` |
70+
| `host.hostname` | `hostname` |
71+
| `host` | `freebsd.jail.host` |
72+
| `sysvmsg` | `freebsd.jail.sysvmsg` |
73+
| `sysvsem` | `freebsd.jail.sysvsem` |
74+
| `sysvshm` | `freebsd.jail.sysvshm` |
75+
| `securelevel` | - |
76+
| `devfs_ruleset` | see below |
77+
| `children.max` | see below |
78+
| `enforce_statfs` | `freebsd.jail.enforceStatfs` |
79+
| `persist` | - |
80+
| `parent` | `freebsd.jail.parent` |
81+
| `osrelease` | - |
82+
| `osreldate` | - |
83+
| `allow.set_hostname` | `freebsd.jail.allow.setHostname` |
84+
| `allow.sysvipc` | `freebsd.jail.allow.sysvipc` |
85+
| `allow.raw_sockets` | `freebsd.jail.allow.rawSockets` |
86+
| `allow.chflags` | `freebsd.jail.allow.chflags` |
87+
| `allow.mount` | `freebsd.jail.allow.mount` |
88+
| `allow.quotas` | `freebsd.jail.allow.quotas` |
89+
| `allow.read_msgbuf` | - |
90+
| `allow.socket_af` | `freebsd.jail.allow.socketAf` |
91+
| `allow.mlock` | - |
92+
| `allow.nfsd` | - |
93+
| `allow.reserved_ports` | `freebsd.jail.allow.reservedPorts` |
94+
| `allow.unprivileged_proc_debug` | - |
95+
| `allow.suser` | `freebsd.jail.allow.suser` |
96+
| `allow.mount.*` | see below |
97+
98+
The jail name SHOULD be set to the create command's `container-id` argument.
99+
100+
Network addresses are typically managed by the host (e.g. using CNI or netavark) so we do not include a mapping for `ip4.addr` or `ip6.addr`.
101+
102+
The `devfs_ruleset` parameter is only required for jails which create new `devfs` mounts - typically OCI runtimes will mount `devfs` on the host. The value is a rule set number - these rule sets are defined on the host, typically via `/etc/defaults/devfs.rules` or using the `devfs` command line utility.
103+
104+
The `children.max` parameter SHOULD be managed by the OCI runtime e.g when a new container shares namespaces with an existing container.
105+
106+
The `allow.mount.*` parameter set is extensible - allowed mount types are listed as an array. As with `devfs`, typically the OCI runtime will manage mounts for the container by performing mount operations on the host.
107+
108+
Jail parameters not supported by this runtime extension are marked with "-". These parameters will have their default values - see the `jail(8)` man page for details.
109+
110+
### Example
111+
```json
112+
"jail": {
113+
"host": "new",
114+
"vnet": "new",
115+
"enforceStatfs": 1,
116+
"allow": {
117+
"rawSockets": true,
118+
"chflags": true,
119+
"mount": [
120+
"tmpfs"
121+
]
122+
}
123+
}
124+
```

‎config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,8 @@ For Windows based systems the user structure has the following fields:
528528
This MAY be set if the target platform and architecture of this spec support hardware virtualization.
529529
* **`zos`** (object, OPTIONAL) [z/OS-specific configuration](config-zos.md).
530530
This MAY be set if the target platform of this spec is `zos`.
531+
* **`freebsd`** (object, OPTIONAL) [FreeBSD-specific configuration](config-freebsd.md).
532+
This MAY be set if the target platform of this spec is `freebsd`.
531533

532534
### Example (Linux)
533535

‎schema/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The layout of the files is as follows:
1010
* [config-linux.json](config-linux.json) - the [Linux-specific configuration sub-structure](../config-linux.md)
1111
* [config-solaris.json](config-solaris.json) - the [Solaris-specific configuration sub-structure](../config-solaris.md)
1212
* [config-windows.json](config-windows.json) - the [Windows-specific configuration sub-structure](../config-windows.md)
13+
* [config-freebsd.json](config-freebsd.json) - the [FreeBSD-specific configuration sub-structure](../config-freebsd.md)
1314
* [state-schema.json](state-schema.json) - the primary entrypoint for the [state JSON](../runtime.md#state) schema
1415
* [defs.json](defs.json) - definitions for general types
1516
* [defs-linux.json](defs-linux.json) - definitions for Linux-specific types

‎schema/config-freebsd.json

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{
2+
"freebsd": {
3+
"description": "FreeBSD platform-specific configurations",
4+
"type": "object",
5+
"properties": {
6+
"devices": {
7+
"type": "array",
8+
"items": {
9+
"$ref": "defs-freebsd.json#/definitions/Device"
10+
}
11+
},
12+
"jail": {
13+
"type": "object",
14+
"properties": {
15+
"parent": {
16+
"type": "string"
17+
},
18+
"host": {
19+
"$ref": "defs-freebsd.json#/definitions/SharingModeNoDisable"
20+
},
21+
"ip4": {
22+
"$ref": "defs-freebsd.json#/definitions/SharingMode"
23+
},
24+
"ip6": {
25+
"$ref": "defs-freebsd.json#/definitions/SharingMode"
26+
},
27+
"vnet": {
28+
"$ref": "defs-freebsd.json#/definitions/SharingModeNoDisable"
29+
},
30+
"sysvmsg": {
31+
"$ref": "defs-freebsd.json#/definitions/SharingMode"
32+
},
33+
"sysvsem": {
34+
"$ref": "defs-freebsd.json#/definitions/SharingMode"
35+
},
36+
"sysvshm": {
37+
"$ref": "defs-freebsd.json#/definitions/SharingMode"
38+
},
39+
"enforceStatfs": {
40+
"$ref": "defs.json#/definitions/uint8"
41+
},
42+
"allow": {
43+
"type": "object",
44+
"properties": {
45+
"setHostname": {
46+
"type": "boolean"
47+
},
48+
"rawSockets": {
49+
"type": "boolean"
50+
},
51+
"chflags": {
52+
"type": "boolean"
53+
},
54+
"mount": {
55+
"$ref": "defs.json#/definitions/ArrayOfStrings"
56+
},
57+
"quotas": {
58+
"type": "boolean"
59+
},
60+
"socketAf": {
61+
"type": "boolean"
62+
},
63+
"reservedPorts": {
64+
"type": "boolean"
65+
},
66+
"suser": {
67+
"type": "boolean"
68+
}
69+
}
70+
}
71+
}
72+
}
73+
}
74+
}
75+
}

‎schema/config-schema.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,9 @@
250250
},
251251
"zos": {
252252
"$ref": "config-zos.json#/zos"
253+
},
254+
"freebsd": {
255+
"$ref": "config-freebsd.json#/freebsd"
253256
}
254257
},
255258
"required": [

‎schema/defs-freebsd.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"definitions": {
3+
"Device": {
4+
"type": "object",
5+
"properties": {
6+
"path": {
7+
"type": "string"
8+
},
9+
"mode": {
10+
"type": "string"
11+
}
12+
}
13+
},
14+
"SharingMode": {
15+
"type": "string",
16+
"enum": [
17+
"disable",
18+
"new",
19+
"inherit"
20+
]
21+
},
22+
"SharingModeNoDisable": {
23+
"type": "string",
24+
"enum": [
25+
"new",
26+
"inherit"
27+
]
28+
}
29+
}
30+
}

‎schema/test/config/bad/freebsd-vnet-disable.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"ociVersion": "1.3.0",
3+
"root": {
4+
"path": "rootfs"
5+
},
6+
"freebsd": {
7+
"jail": {
8+
"vnet": "disable"
9+
}
10+
}
11+
}

‎schema/test/config/good/freebsd-example.json

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
"ociVersion": "1.3.0",
3+
"process": {
4+
"terminal": true,
5+
"args": [
6+
"sh"
7+
],
8+
"env": [
9+
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
10+
"TERM=xterm"
11+
],
12+
"cwd": "/"
13+
},
14+
"root": {
15+
"path": "rootfs"
16+
},
17+
"hostname": "slartibartfast",
18+
"mounts": [
19+
{
20+
"destination": "/dev",
21+
"type": "devfs",
22+
"source": "devfs",
23+
"options": [
24+
"ruleset=4"
25+
]
26+
},
27+
{
28+
"destination": "/dev/fd",
29+
"type": "fdescfs",
30+
"source": "fdescfs",
31+
"options": []
32+
}
33+
],
34+
"freebsd": {
35+
"devices": [
36+
{
37+
"path": "pf",
38+
"mode": "0700"
39+
}
40+
],
41+
"jail": {
42+
"host": "new",
43+
"vnet": "new",
44+
"enforceStatfs": 1,
45+
"allow": {
46+
"rawSockets": true,
47+
"chflags": true,
48+
"mount": [
49+
"tmpfs"
50+
]
51+
}
52+
}
53+
}
54+
}

‎schema/test/config/good/freebsd-minimal.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"ociVersion": "1.3.0",
3+
"root": {
4+
"path": "rootfs"
5+
},
6+
"freebsd": {}
7+
}

0 commit comments

Comments
 (0)