Skip to content

Commit f345213

Browse files
committed
balloon: updated documentation with API change
Signed-off-by: George Pisaltu <[email protected]>
1 parent 88fe8e5 commit f345213

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/ballooning.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Here is an example command on how to install the balloon through the API:
103103

104104
```
105105
socket_location=...
106-
amount_mb=...
106+
amount_mib=...
107107
deflate_on_oom=...
108108
polling_interval=...
109109
@@ -112,15 +112,15 @@ curl --unix-socket $socket_location -i \
112112
-H 'Accept: application/json' \
113113
-H 'Content-Type: application/json' \
114114
-d "{
115-
\"amount_mb\": $amount_mb, \
115+
\"amount_mib\": $amount_mib, \
116116
\"deflate_on_oom\": $deflate_on_oom, \
117117
\"stats_polling_interval_s\": $polling_interval \
118118
}"
119119
```
120120

121121
To use this, set `socket_location` to the location of the firecracker socket
122-
(by default, at `/run/firecracker.socket`. Then, set `amount_mb`,
123-
`deflate_on_oom` and `stats_polling_interval_s` as desired: `amount_mb`
122+
(by default, at `/run/firecracker.socket`. Then, set `amount_mib`,
123+
`deflate_on_oom` and `stats_polling_interval_s` as desired: `amount_mib`
124124
represents the target size of the balloon, and `deflate_on_oom` and
125125
`stats_polling_interval_s` represent the options mentioned before.
126126

@@ -129,7 +129,7 @@ object into your configuration file:
129129

130130
```
131131
"balloon": {
132-
"amount_mb": 0,
132+
"amount_mib": 0,
133133
"deflate_on_oom": false,
134134
"stats_polling_interval_s": 1
135135
},
@@ -157,20 +157,20 @@ API through the following command:
157157

158158
```
159159
socket_location=...
160-
amount_mb=...
160+
amount_mib=...
161161
polling_interval=...
162162
163163
curl --unix-socket $socket_location -i \
164164
-X PATCH 'http://localhost/balloon' \
165165
-H 'Accept: application/json' \
166166
-H 'Content-Type: application/json' \
167167
-d "{
168-
\"amount_mb\": $amount_mb, \
168+
\"amount_mib\": $amount_mib, \
169169
\"stats_polling_interval_s\": $polling_interval \
170170
}"
171171
```
172172

173-
This will update the target size of the balloon to `amount_mb` and the
173+
This will update the target size of the balloon to `amount_mib` and the
174174
statistics polling interval to `polling_interval`.
175175

176176
## Virtio balloon statistics
@@ -196,8 +196,8 @@ The target and actual sizes of the balloon are expressed as follows:
196196

197197
* `target_pages`: The target size of the balloon, in 4K pages.
198198
* `actual_pages`: The number of 4K pages the device is currently holding.
199-
* `target_mb`: The target size of the balloon, in MiB.
200-
* `actual_mb`: The number of MiB the device is currently holding.
199+
* `target_mib`: The target size of the balloon, in MiB.
200+
* `actual_mib`: The number of MiB the device is currently holding.
201201

202202
These values are taken directly from the config space of the device and are
203203
always up to date, in the sense that they are exactly what the Firecracker

0 commit comments

Comments
 (0)