Skip to content

Commit ed6f016

Browse files
committed
runtime: remove "console" field from documentation
The console field was already removed, but stale documentation continued to reference it. This commit removes the stale documentation. Related: firecracker-microvm#59 Signed-off-by: Samuel Karp <[email protected]>
1 parent 489a7b0 commit ed6f016

File tree

5 files changed

+0
-10
lines changed

5 files changed

+0
-10
lines changed

docs/getting-started.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,9 +223,6 @@ configuration file has the following fields:
223223
* `cpu_template` (required) - The Firecracker CPU emulation template. Supported
224224
values are "C3" and "T2".
225225
* `additional_drives` (unused)
226-
* `console` (optional) - How the console device should be handled. Supported
227-
values are "" (blank), "stdio", and "xterm". Setting "xterm" will launch a
228-
new xterm instance and requires a running X server.
229226
* `log_fifo` (optional) - Named pipe where Firecracker logs should be delivered.
230227
* `log_level` (optional) - Log level for the Firecracker logs
231228
* `metrics_fifo` (optional) - Named pipe where Firecracker metrics should be
@@ -244,7 +241,6 @@ configuration file has the following fields:
244241
"root_drive": "/var/lib/firecracker-containerd/runtime/hello-rootfs.ext4",
245242
"cpu_count": 1,
246243
"cpu_template": "T2",
247-
"console": "stdio",
248244
"log_fifo": "/tmp/fc-logs.fifo",
249245
"log_level": "Debug",
250246
"metrics_fifo": "/tmp/fc-metrics.fifo"

docs/quickstart.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,6 @@ sudo tee -a /etc/containerd/firecracker-runtime.json <<EOF
142142
"root_drive": "/var/lib/firecracker-containerd/runtime/hello-rootfs.ext4",
143143
"cpu_count": 1,
144144
"cpu_template": "T2",
145-
"console": "stdio",
146145
"log_fifo": "/tmp/fc-logs.fifo",
147146
"log_level": "Debug",
148147
"metrics_fifo": "/tmp/fc-metrics.fifo"

runtime/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,6 @@ configuration file has the following fields:
4949
* `cpu_template` (required) - The Firecracker CPU emulation template. Supported
5050
values are "C3" and "T2".
5151
* `additional_drives` (unused)
52-
* `console` (optional) - How the console device should be handled. Supported
53-
values are "" (blank), "stdio", and "xterm". Setting "xterm" will launch a
54-
new xterm instance and requires a running X server.
5552
* `log_fifo` (optional) - Named pipe where Firecracker logs should be delivered.
5653
* `log_level` (optional) - Log level for the Firecracker logs
5754
* `metrics_fifo` (optional) - Named pipe where Firecracker metrics should be

runtime/config.json.example

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
"additional_drives": {
99
"./shim.img": "rw"
1010
},
11-
"console": "stdio",
1211
"log_fifo": "/tmp/fc-logs.fifo",
1312
"log_level": "Debug",
1413
"metrics_fifo": "/tmp/fc-metrics.fifo",

tools/docker/firecracker-runtime.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
"root_drive": "/var/lib/firecracker-containerd/runtime/hello-rootfs.ext4",
66
"cpu_count": 1,
77
"cpu_template": "T2",
8-
"console": "stdio",
98
"log_fifo": "/tmp/fc-logs.fifo",
109
"log_level": "Debug",
1110
"metrics_fifo": "/tmp/fc-metrics.fifo"

0 commit comments

Comments
 (0)