1BODHI(1) bodhi BODHI(1)
2
6 bodhi - manage Fedora updates
7
9 bodhi COMMAND SUBCOMMAND [OPTIONS] [ARGS]…
10
12 bodhi is the command line interface to bodhi, Fedora’s update release
13 management system. It can be used to create or modify updates and over‐
14 rides.
15
17 Most of the commands will accept these options:
18 --debug
20 Some commands accept this flag to show extra debug information.
21 --help
23 Show help text and exit.
24 --password <text>
26 A password to authenticate as the user given by --user.
27 --staging
29 Use the staging bodhi instance instead of the production instance.
30 --url <url>
32 Use the Bodhi server at the given URL instead of the default server.
33 This can also be set with the BODHI_URL environment variable. This
34 is ignored if the --staging flag is set.
35 --user <username>
37 Many commands accept this flag to specify a Fedora username to
38 authenticate with. Note that some read operations such as querying
39 updates and overrides use this same flag, but as a search parameter
40 instead of authentication (as authentication is not required for
41 these operations).
42 --version
44 Show version and exit. Not accepted by subcommands.
45
47 There are four commands, composes, overrides, updates and releases.
48 They are described in more detail in their own sections below.
49 bodhi composes <subcommand> [options] [args]
51 Provides an interface to view composes. Supports subcommands list
52 and info, described below.
53 bodhi overrides <subcommand> [options] [args]
55 Provides commands to aid in management of build overrides. Supports
56 subcommands query and save, described below.
57 bodhi updates <subcommand> [options] [args]
59 Provides an interface to manage updates. Supports subcommands com‐
60 ment, download, new, query, and request, described below.
61 bodhi releases <subcommand> [options] [args]
63 Provides an interface to manage releases. Supports subcommands cre‐
64 ate, edit, info and list, described below.
65
67 The composes command allows users to view composes.
68 bodhi composes list [options]
70 The list subcommand allows you to see the current composes on the
71 Bodhi server. It supports the following options:
72 -v, --verbose
74 Print more detail about the composes.
75 bodhi composes info [options] RELEASE REQUEST
77 The info subcommand allows you to see the compose for release with
78 the given request.
79
81 The overrides command allows users to manage build overrides.
82 bodhi overrides query [options]
84 The query subcommand provides an interface for users to query the
85 bodhi server for existing overrides. The query subcommand supports
86 the following options:
87 --mine
89 Show only your overrides.
90 --active
92 Filter for only active overrides
93 --expired
95 Filter for only expired overrides
96 --packages <packagename>
98 Query for overrides related to the given packages, given as a
99 comma-separated list.
100 --releases <releases>
102 Query for overrides related to a list of releases, given as a
103 comma-separated list. <releases> is the release shortname, for
104 example: F26 or F26,F25, or a macro filter (__current__, __pend‐
105 ing__, __archived__) to include all releases in a certain sta‐
106 tus.
107 --builds <builds>
109 Query for overrides for a list of builds, given as a comma-sepa‐
110 rated list. <builds> is the build NVR, for example: core‐
111 bird-1.3-0.fc24
112 --user <username>
114 Filter for overrides by a list of usernames, given as a
115 comma-separated list.
116 --rows <integer>
118 Limits number of results shown per page.
119 --page <integer>
121 Go to page number.
122 bodhi overrides save [options] <nvr>
124 Save the build root given by <nvr> as a buildroot override. The save
125 subcommand supports the following options:
126 --duration <days>
128 The number of days the override should exist, given as an inte‐
129 ger.
130 --notes <text>
132 Notes on why this override is in place.
133 bodhi overrides edit [options] <nvr>
135 Edit the build root given by <nvr> as a buildroot override. The edit
136 subcommand supports the same options than the save command and also
137 the following option:
138 --expire
140 Force an override to the expired state.
141
143 The updates command allows users to interact with bodhi updates.
144 bodhi updates comment [options] <update> <text>
146 Leave the given text as a comment on a bodhi update. The comment
147 subcommand supports the following options:
148 --karma [+1 | 0 | -1]
150 The karma value you wish to contribute to the update.
151 bodhi updates download [options]
153 Download update(s) given by ID(s) or NVR(s). One of --updateid or
154 builds is required. The download subcommand supports the following
155 options:
156 --debuginfo
158 Include debuginfo packages when downloading.
159 --updateid <ids>
161 A comma-separated list of update IDs you would like to download.
162 --builds <nvrs>
164 A comma-separated list of NVRs that identify updates you would
165 like to download.
166 --arch <arch>
168 You can specify an architecture of packages to download. “all”
169 will download packages for all architectures. Omitting this
170 option will download packages for the architecture you are cur‐
171 rently running.
172 bodhi updates new [options] <builds_or_tag>
174 Create a new bodhi update containing the builds, given as a comma
175 separated list of NVRs. The new subcommand supports the following
176 options:
177 --type [security | bugfix | enhancement | newpackage]
179 The type of the new update.
180 --notes <text>
182 The description of the update.
183 --notes-file <path>
185 A path to a file containing a description of the update.
186 --bugs <bugs>
188 A comma separated list of bugs to associate with this update.
189 --close-bugs
191 If given, this flag will cause bodhi to close the referenced
192 bugs automatically when the update reaches stable.
193 --request [testing | stable | upush]
195 The repository requested for this update.
196 --autokarma
198 Enable autokarma for this update.
199 --autotime
201 Enable autotime for this update. Automatically push the update
202 to stable based on the time spent in testing.
203 --stable-karma <integer>
205 Configure the stable karma threshold for the given value.
206 --unstable-karma <integer>
208 Configure the unstable karma threshold for the given value.
209 --stable-days <integer>
211 Configure the number of days an update has to spend in testing
212 before being automatically pushed to stable.
213 --suggest [logout | reboot]
215 Suggest that the user logout or reboot upon applying the update.
216 --file <path>
218 A path to a file containing all the update details.
219 --requirements <Taskotron tasks>
221 A comma or space-separated list of required Taskotron tasks that
222 must pass for this update to reach stable.
223 --display-name <text>
225 The name of the update
226 --from-tag
228 If this flag is provided, <builds_or_tag> will be interpreted as
229 a Koji tag and expand to all latest builds in it. Only a single
230 tag can be provided.
231 bodhi updates edit [options] <update>
233 Edit an existing bodhi update, given an update id or an update
234 title. The edit subcommand supports the following options:
235 --addbuilds <builds>
237 Add a comma separated list of build nvr to this update.
238 --removebuilds <builds>
240 Remove a comma separated list of build nvr from this update.
241 --type [security | bugfix | enhancement | newpackage]
243 The type of the new update.
244 --notes <text>
246 The description of the update.
247 --notes-file <path>
249 A path to a file containing a description of the update.
250 --bugs <bugs>
252 A comma separated list of bugs to associate with this update.
253 --close-bugs
255 If given, this flag will cause bodhi to close the referenced
256 bugs automatically when the update reaches stable.
257 --request [testing | stable | upush]
259 The repository requested for this update.
260 --autokarma
262 Enable autokarma for this update.
263 --stable-karma <integer>
265 Configure the stable karma threshold for the given value.
266 --unstable-karma <integer>
268 Configure the unstable karma threshold for the given value.
269 --suggest [logout | reboot]
271 Suggest that the user logout or reboot upon applying the update.
272 --requirements <Taskotron tasks>
274 A comma or space-separated list of required Taskotron tasks that
275 must pass for this update to reach stable.
276 --display-name <text>
278 The name of the update
279 --from-tag
281 If given, for updates that were created from a Koji tag, this
282 will update the builds to the latest ones in the tag.
283 bodhi updates query [options]
285 Query the bodhi server for updates.
286 If the query returns only one update, a detailed view of the update
288 will be displayed.
289 If more than one update is returned, the command will display a list
291 showing the packages contained in the update, the update con‐
292 tent-type (rpm / module / …), the current status of the update
293 (pushed / testing / …) and the date of the last status change with
294 the number of days passed since. A leading * marks security updates.
295 The query subcommand supports the following options:
297 --updateid <id>
299 Query for the update given by id.
300 --title <title>
302 Query for the update given by title.
303 --alias <alias>
305 Query for the update given by alias.
306 --approved-since <timestamp>
308 Query for updates approved after the given timestamp.
309 --approved-before <timestamp>
311 Query for updates approved before the given timestamp.
312 --modified-since <timestamp>
314 Query for updates modified after the given timestamp.
315 --modified-before <timestamp>
317 Query for updates modified before the given timestamp.
318 --builds <builds>
320 Query for updates containing the given builds, given as a
321 comma-separated list.
322 --bugs <bugs>
324 Query for updates related to the given bugs, given as a
325 comma-separated list.
326 --content-type <content_type>
328 Query for updates of a given content type: either rpm, module,
329 or (in the future) container.
330 --critpath
332 Query for updates submitted for the critical path.
333 --from-side-tag
335 Query for updates created from a side-tag.
336 --not-from-side-tag
338 Query for updates not created from a side-tag.
339 --gating [passed | failed | ignored | waiting | running | queued |
341 greenwave_failed]
342 Query for updates based on test gating status.
343 --mine
345 Show only your updates.
346 --packages <packages>
348 Query for updates related to the given packages, given as a
349 comma-separated list.
350 --pushed
352 Query for updates that have been pushed.
353 --pushed-since <timestamp>
355 Query for updates that have been pushed after the given time‐
356 stamp.
357 --pushed-before <timestamp>
359 Query for updates that have been pushed before the given time‐
360 stamp.
361 --releases <releases>
363 Query for updates related to a list of releases, given as a
364 comma-separated list. It is possible to use the macro filters
365 __current__, __pending__ and __archived__ to include all
366 releases in a certain status.
367 --locked
369 Query for updates that are currently locked.
370 --request [testing | stable | unpush]
372 Query for updates marked with the given request type.
373 --severity [unspecified, urgent, high, medium, low]
375 Query for updates with a specific severity.
376 --submitted-since <timestamp>
378 Query for updates that were submitted since the given timestamp.
379 --submitted-before <timestamp>
381 Query for updates that were submitted before the given time‐
382 stamp.
383 --status [pending | testing | stable | obsolete | unpushed]
385 Filter by status.
386 --suggest [logout | reboot]
388 Filter for updates that suggest logout or reboot to the user.
389 --type [newpackage | security | bugfix | enhancement]
391 Filter by update type.
392 --user <username>
394 Filter for updates by a list of usernames, given as a comma-sep‐
395 arated list.
396 --rows <integer>
398 Limits number of results shown per page.
399 --page <integer>
401 Go to page number.
402 bodhi updates request [options] <update> <state>
404 Request that the given update be changed to the given state. update
405 should be given by update id, and state should be one of testing,
406 stable, unpush, obsolete, or revoke.
407 bodhi updates waive [options] <update> <comment>
409 Show or waive unsatisfied test requirements on an update.
410 The following options are supported:
412 --show
414 List the unsatisfied test requirements.
415 --test TEXT
417 Waive the test specified by name in TEXT. all can be used to
418 waive all unsatisfied tests.
419 --debug
421 Display debugging information.
422 bodhi updates trigger-tests [options] <update>
424 Trigger tests for an update. This update must be in testing state.
425
427 The releases command allows users to manage update releases.
428 bodhi releases create [options]
430 The create command allows administrators to create new releases in
431 Bodhi:
432 --branch TEXT
434 The git branch that corresponds to this release (e.g., f29).
435 --candidate-tag TEXT
437 The Koji tag to use to search for update candidates (e.g.,
438 f29-updates-candidate).
439 --composed-by-bodhi, --not-composed-by-bodhi
441 The flag that indicates whether the release is composed by Bodhi
442 or not.
443 --dist-tag TEXT
445 The Koji dist tag for this release (e.g., f29).
446 --id-prefix TEXT
448 The release’s prefix (e.g., FEDORA).
449 --long-name TEXT
451 The long name of the release (e.g., Fedora 29).
452 --name TEXT
454 The name of the release (e.g., F29).
455 --override-tag TEXT
457 The Koji tag to use for buildroot overrides (e.g., f29-over‐
458 ride).
459 --package-manager [unspecified|dnf|yum]
461 The package manager used by this release. If not specified it
462 defaults to ‘unspecified’.
463 --password TEXT
465 The password to use when authenticating to Bodhi.
466 --pending-stable-tag TEXT
468 The Koji tag to use on updates that are marked stable (e.g.,
469 f29-updates-pending).
470 --pending-testing-tag TEXT
472 The Koji tag to use on updates that are pending testing (e.g.,
473 f29-updates-pending-testing).
474 --stable-tag TEXT
476 The Koji tag to use for stable updates (e.g., f29-updates).
477 --state [disabled|pending|frozen|current|archived]
479 The state of the release.
480 --testing-repository TEXT
482 The name of the testing repository used to test updates. Not
483 required.
484 --testing-tag TEXT
486 The Koji tag to use for testing updates (e.g., f29-updates-test‐
487 ing).
488 --username TEXT
490 The username to use when authenticating to Bodhi.
491 --version TEXT
493 The version of the release (e.g., 29).
494 bodhi releases edit [options]
496 The edit command allows administrators to edit existing releases:
497 --branch TEXT
499 The git branch that corresponds to this release (e.g., f29).
500 --candidate-tag TEXT
502 The Koji tag to use to search for update candidates (e.g.,
503 f29-updates-candidate).
504 --composed-by-bodhi, --not-composed-by-bodhi
506 The flag that indicates whether the release is composed by Bodhi
507 or not.
508 --dist-tag TEXT
510 The Koji dist tag for this release (e.g., f29).
511 --id-prefix TEXT
513 The release’s prefix (e.g., FEDORA).
514 --long-name TEXT
516 The long name of the release (e.g., Fedora 29).
517 --name TEXT
519 The name of the release (e.g., F29).
520 --new-name
522 Change the release’s name to a new value (e.g., F29).
523 --override-tag TEXT
525 The Koji tag to use for buildroot overrides (e.g., f29-over‐
526 ride).
527 --package-manager [unspecified|dnf|yum]
529 The package manager used by this release. If not specified it
530 defaults to ‘unspecified’.
531 --password TEXT
533 The password to use when authenticating to Bodhi.
534 --pending-stable-tag TEXT
536 The Koji tag to use on updates that are marked stable (e.g.,
537 f29-updates-pending).
538 --pending-testing-tag TEXT
540 The Koji tag to use on updates that are pending testing (e.g.,
541 f29-updates-testing-pending).
542 --stable-tag TEXT
544 The Koji tag to use for stable updates (e.g., f29-updates).
545 --state [disabled|pending|frozen|current|archived]
547 The state of the release.
548 --testing-repository TEXT
550 The name of the testing repository used to test updates. Not
551 required.
552 --testing-tag TEXT
554 The Koji tag to use for testing updates (e.g., f29-updates-test‐
555 ing).
556 --username TEXT
558 The username to use when authenticating to Bodhi.
559 --version TEXT
561 The version of the release (e.g., 29).
562 bodhi releases info RELEASE_NAME
564 The info command prints information about the given release.
565 bodhi releases list [options]
567 The list command prints list of releases.
568 --display-archived
570 Display full list, including archived releases.
571 --rows <integer>
573 Limits number of results shown per page.
574 --page <integer>
576 Go to page number.
577
579 Create a new update with multiple builds:
580 $ bodhi updates new --user bowlofeggs --type bugfix --notes "Fix permission issues during startup." --bugs 1393587 --close-bugs --request testing --autokarma --stable-karma 3 --unstable-karma -3 ejabberd-16.09-2.fc25,erlang-esip-1.0.8-1.fc25,erlang-fast_tls-1.0.7-1.fc25,erlang-fast_yaml-1.0.6-1.fc25,erlang-fast_xml-1.1.15-1.fc25,erlang-iconv-1.0.2-1.fc25,erlang-stringprep-1.0.6-1.fc25,erlang-stun-1.0.7-1.fc25
582
584 If you find bugs in bodhi (or in the man page), please feel free to
585 file a bug report or a pull request:
586 https://github.com/fedora-infra/bodhi
588 Bodhi’s documentation is available online:
590 https://bodhi.fedoraproject.org/docs
591
593 Randy Barlow, Luke Macken
594
596 2007-2020, Red Hat, Inc.
5975.6 Nov 30, 2020 BODHI(1)