Skip to content

Commit 304d551

Browse files
committed
docs: Update swagger.yml with huge_pages field
Add the huge_pages field to the /machine-config documentation. Signed-off-by: Patrick Roy <[email protected]>
1 parent c548bd1 commit 304d551

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

src/firecracker/swagger/firecracker.yaml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -331,9 +331,10 @@ paths:
331331
The vCPU count is restricted to the [1, 32] range.
332332
With SMT enabled, the vCPU count is required to be either 1 or an even number in the range.
333333
otherwise there are no restrictions regarding the vCPU count.
334+
If 2M hugetlbfs pages are specified, then `mem_size_mib` must be a multiple of 2.
334335
If any of the parameters has an incorrect value, the whole update fails.
335336
All parameters that are optional and are not specified are set to their default values
336-
(smt = false, track_dirty_pages = false, cpu_template = None).
337+
(smt = false, track_dirty_pages = false, cpu_template = None, huge_pages = None).
337338
operationId: putMachineConfiguration
338339
parameters:
339340
- name: body
@@ -1015,7 +1016,7 @@ definitions:
10151016
MachineConfiguration:
10161017
type: object
10171018
description:
1018-
Describes the number of vCPUs, memory size, SMT capabilities and
1019+
Describes the number of vCPUs, memory size, SMT capabilities, huge page configuration and
10191020
the CPU template.
10201021
required:
10211022
- mem_size_mib
@@ -1043,6 +1044,12 @@ definitions:
10431044
minimum: 1
10441045
maximum: 32
10451046
description: Number of vCPUs (either 1 or an even number)
1047+
huge_pages:
1048+
type: string
1049+
enum:
1050+
- None
1051+
- 2M
1052+
description: Which huge pages configuration (if any) should be used to back guest memory.
10461053

10471054
MemoryBackend:
10481055
type: object

0 commit comments

Comments
 (0)