Skip to content

Commit 3ab2705

Browse files
dhrgitacatangiu
authored andcommitted
microVM ID: document user-facing changes
Updated CHANGELOG.md and jailer.md, describing the user-facing changes introduced by the microVM ID feature. Also reformatted CHANGELOG.md to max 80 chars per line.
1 parent 89a70e6 commit 3ab2705

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
- Each Firecracker process has an associated microVM Metadata Store (MMDS). Its
88
contents can be configured using the `/mmds` API resource.
9+
- New firecracker command line argument (--id), allowing the user to specify a
10+
microVM ID.
911

1012
### Changed
1113

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,11 +141,12 @@ security.
141141
Firecracker can be started outside the jail as well. To do this, run:
142142

143143
``` bash
144-
./firecracker --api-sock </path/to/unix/socket>
144+
./firecracker --api-sock </path/to/unix/socket> --id <microvm-id>
145145
```
146146

147147
If the api socket is not specified at startup, Firecracker will create
148-
`/tmp/firecracker.socket`.
148+
`/tmp/firecracker.socket`. Similarly, the `--id` parameter can be omitted,
149+
in which case, Firecracker will use `anonymous-instance` as an ID.
149150

150151
### Configure the MicroVM
151152

docs/jailer.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,10 @@ After starting, the Jailer goes through the following operations:
7676
- If `--daemonize` is specified, call `setsid()` and redirect `STDIN`,
7777
`STDOUT`, and `STDERR` to `/dev/null`.
7878
- Drop privileges via setting the provided `uid` and `gid`.
79-
- Exec into `<exec_file_name> --jailed`. The `--jailed` command line argument
80-
to the target binary is then interpreted by Firecracker, that realizes it’s
81-
running inside a jail, and continues the execution accordingly.
79+
- Exec into `<exec_file_name> --jailed --id <id>`. The `--jailed` command line
80+
argument to the target binary is then interpreted by Firecracker, that
81+
realizes it’s running inside a jail, and continues the execution
82+
accordingly.
8283

8384
## Example Run and Notes
8485

0 commit comments

Comments
 (0)