MINI-BUILDD-API
Section: User Commands (1)
Updated: April 2024
Index
Return to Main Contents
NAME
mini-buildd-api - Run API calls against a mini-buildd instance
DESCRIPTION
usage: mini-buildd-api [-h] [--version]
- [-l {CRITICAL,ERROR,WARNING,INFO,DEBUG}] [-v] [-q] [-J]
-
[--auto-confirm] [--auto-save-passwords]
[--script-mode]
<call> [options] ...
Run API calls against a mini-buildd instance
options:
- -h, --help
-
show this help message and exit
- --version
-
show program's version number and exit
- -l {CRITICAL,ERROR,WARNING,INFO,DEBUG}, --log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}
-
set log level (DEBUG will enable exception tracebacks and python warnings) (default: INFO)
- -v, --verbose
-
DEPRECATED (use --log-level): increase log level. Give twice for max logs (default: 0)
- -q, --quiet
-
DEPRECATED (use --log-level): decrease log level. Give twice for min logs (default: 0)
- -J, --json
-
use parsable json output (default: False)
- --auto-confirm
-
force-bypass extra confirmation (for confirmable calls) (default: False)
- --auto-save-passwords
-
don't ask before saving passwords (via python3-keyring) (default: False)
- --script-mode
-
force not to be interactive (default: False)
API calls (run 'mini-buildd-api <call> --help' for full single call help):
-
<call> [options]
- status
-
Get status of this instance
-
JSON result description:
- {
-
"version": mini-buildd's version
"identity": Instance identity
"url": Instance URL (HTTP)
"incoming_url": Incoming URL (currently FTP)
"load": Instance's (0 =< load <= 1). If negative, the instance is stopped
"chroots": List of active chroots
"remotes": Active or auto-reactivatable remotes
["repositories": Simplified structural representation of all repositories]
-
}
- Authorization: NONE
-
.
- pub_key
-
Get public key
-
Get ASCII-armored GnuPG public key of this instance.
-
Used to sign the apt repositories (apt key) and for authorization across instances.
- Authorization: NONE
-
.
- dput_conf
-
Get recommended dput config snippet
-
Usually, this is for integration in your personal ``~/.dput.cf``.
- Authorization: NONE
-
.
- sources_list
-
Get sources.list (apt lines)
-
Usually, this output is put to a file like ``/etc/apt/sources.list.d/mini-buildd-xyz.list``.
- Authorization: NONE
-
.
- ls
-
List source package
- Authorization: NONE
-
.
- show
-
Show source package
- Authorization: NONE
-
.
- debdiff
-
Compare two internal source packages
- Authorization: NONE
-
.
- migrate
-
Migrate source package
- Migrates a source package along with all its binary packages. If
-
run for a rollback distribution, this will perform a rollback
restore.
- Authorization: STAFF
-
.
- remove
-
Remove source package
-
Removes a source package along with all its binary packages.
- Authorization: ADMIN
-
.
- port
-
Port internal source package
- An internal 'port' is a no-changes (i.e., only the changelog will be adapted)
-
rebuild of the given locally-installed package.
-
When ``from_distribution`` equals ``to_distribution``, a rebuild will be done.
- Authorization: STAFF
-
.
- port_ext
-
Port external source package
- An external 'port' is a no-changes (i.e., only the changelog will be adapted)
-
rebuild of any given source package.
- Authorization: STAFF
-
.
- retry
-
Retry a previously failed source package
-
JSON result description:
-
Changes file name that has been re-uploaded
- Authorization: STAFF
-
.
- cancel
-
Cancel an ongoing package build
- Authorization: STAFF
-
.
- set_user_key
-
Set a user's GnuPG public key
- Authorization: LOGIN
-
.
- subscribe
-
Subscribe to (email) notifications
- Authorization: LOGIN
-
.
- unsubscribe
-
Unsubscribe from (email) notifications
- Authorization: LOGIN
-
.
- remake_chroots
-
Remake chroots
-
Run actions 'remove', 'prepare', 'check' and 'activate'.
-
Note that Daemon will be stopped before running, cancelling ongoing events (``BUILDING``, ``PACKAGING``).
- Authorization: ADMIN
-
.
- start
-
Start Daemon (accept incoming)
-
Does nothing if already started; will fail if Daemon instance is not activated.
- Authorization: ADMIN
-
.
- stop
-
Stop Daemon (stop accepting incoming)
-
Does nothing if already stopped. Any possibly running builds will be cancelled.
-
This state is *not persisted*. Please *deactivate* the Daemon instance via :mbdpage:`setup` to persist over *mini-buildd service* restarts.
- Authorization: ADMIN
-
.
- wake
-
Wake a remote instance
- Authorization: STAFF
-
.
- handshake
-
Check if signed message matches a remote, reply our signed message on success
-
This is for internal use only.
- Authorization: NONE
-
.
- cronjob
-
Run a cron job now (out of schedule)
- Authorization: ADMIN
-
.
- uploaders
-
Get upload permissions for repositories
- Authorization: ADMIN
-
.
- snapshot_ls
-
Get list of repository snapshots for a distribution
- Authorization: NONE
-
.
- snapshot_create
-
Create a repository snapshot
- Authorization: ADMIN
-
.
- snapshot_delete
-
Delete a repository snapshot
- Authorization: ADMIN
-
.
- debmirror
-
Make local partial repository mirror via :debpkg:`debmirror`
- This may be useful if you plan on publishing a stripped-down (f.e., only certain repos,
-
only ``stable``, omit rollbacks) variant of your repo somewhere remote.
-
.. error:: debmirror: ``apt update`` fails on ``experimental`` suites (contents not mirrored) (:debbug:`819925`)
- This happens only on systems where APT is configured to download contents, most likely just because
-
``apt-file`` is installed. So, the easiest workaround is::
-
apt purge apt-file
- Closest to an actual fix is to install debmirror variant '+abfixes' from
-
``Hellfield Archive``, where the "bug" has been fixed (June 2023: at least
available for bullseye and bookworm).
- Authorization: ADMIN
-
.
- keyring_packages
-
Build keyring packages
-
.. note:: **keyring-packages**: No compat for urold (``apt-key add``)
-
Since ``2.x``, keyring packages will use ``/etc/apt/trusted.gpg.d/<foo>.gpg``, not deprecated ``apt-key add <foo>``.
-
In Debian, this is supported since ``wheezy (2013)``.
-
For distributions ``<= squeeze`` (apt versions ``~<= 0.8.x``), you would manually have to run ``apt-key add ,/etc/apt/trusted.gpg/.d/<foo>.gpg`` after installation of the keyring package.
- Authorization: ADMIN
-
.
- test_packages
-
Build test packages
- Authorization: ADMIN
-
.
- setup
-
Create, update or inspect your setup
-
Note that Daemon will be stopped before running, cancelling ongoing events (``BUILDING``, ``PACKAGING``).
- Authorization: ADMIN
-
.
Note: Uses ``python3-keyring`` to persist passwords (see ``man 1 keyring``)
Index
- NAME
-
- DESCRIPTION
-
- options:
-
- API calls (run 'mini-buildd-api <call> --help' for full single call help):
-
This document was created by
man2html,
using the manual pages.
Time: 19:46:06 GMT, April 29, 2024