Debusine: a software factory for Debian-based distributions

Debusine is a general-purpose software factory tailored to the needs of a Debian-based distribution. It manages the scheduling and distribution of tasks to distributed worker machines.

The documentation is structured by following the Diátaxis principles: tutorials and explanation are mainly useful to discover and learn, howtos and reference are more useful when you are familiar with debusine already and you have some specific action to perform or goal to achieve.

If you are new to debusine, you will want to read Introduction to Debusine first.

Tutorials

• Install your first debusine instance
  • Configure the hypervisor to host the debusine instance (with Incus)
  • Install the debusine virtual machine
  • Install the packages
  • Configure the webserver
  • Test the access to the web interface
  • Configure the worker
  • Configure the signing worker
  • Next steps
• Getting started with debusine
  • Pre-requisites
  • Install the client and configure it
  • Create a build environment
  • Create an artifact by uploading a source package
  • Submit a work request to build binary packages

Explanations

• Introduction to Debusine
  • What is Debusine
  • Debusine for Debian development
  • Next generation Debian infrastructure
  • Run distribution-wide QA experiments
  • Current development plan
  • Learn more
• Why this project
  • A central place for tasks processing the Debian archive
  • Including package building
  • With custom workflows
  • And GitLab integration
  • Conclusion
• Debusine concepts
  • Artifacts
  • Collections
  • Tasks
  • Work requests
  • Workflows
  • Scopes
  • Workspaces
  • Workers
• Lookups
• Work request scheduling
  • Lifecycle of a user-submitted work request
  • Lifecycle of a work request inside a workflow
  • Priorities
  • Ordering of work request
  • Matching of workers and work requests
  • Management of architecture-specific tasks
• Expiration of data
  • Artifacts
  • Work requests and workflows
  • Collection items
• Signing service
  • Signing workflows
  • Signing key management
  • Key protection
  • Signature methods

Todo

Add new explanation pages to cover:

• architecture (server, worker, client)

How-to guides

• Set up debusine-client
  • Introduction
  • Initial setup
  • Test the configuration
• Create an API token
  • As a debusine user
  • As a debusine administrator
  • Next steps
• Tasks for administrators
  • Set up a debusine server
  • Set up a debusine worker
  • Set up a debusine signing worker
  • Set up Incus for Debusine Task Execution
  • Add a new worker
  • Add a new user
  • Configure and manage a worker
  • Enable logins with GitLab accounts
  • Enable notifications for work requests
  • Set up APT mirroring
  • Generate signing keys
  • Configure an HSM for use with debusine
• Contribute to debusine
  • Join the community
  • Where to start?
  • How to contribute
  • Test latest devel branch code
  • Write access to the git repository
  • Django Debug Toolbar

Reference

• Building blocks
  • Artifacts
  • Collections
  • Tasks
  • Workflows
• Deployment
  • Runtime environment
  • Package repositories
• Miscellaneous
  • Lookup syntax
  • Frequently Asked Questions about Debusine
• Command line tools
  • The debusine-admin command
  • The debusine command
  • The debusine-signing command
  • The debusine-worker command
  • The debusine client configuration file
• Python client API
  • The Debusine class
  • Associated data models
  • Representation of artifacts
• Debusine internals
  • Work Requests
  • Signing service details
• Reference for debusine contributors
  • Design goals
  • Team organization
  • Design practices
  • Coding practices
  • Updating release notes
  • Documentation practices
  • Internal API
• Development blueprints
  • Permission management
  • Permission predicates
  • Restricting use of signing keys
  • UI views
  • Uploading packages
  • Task configuration
  • Task statistics
  • Build instructions
  • Transitioning to scoped URLs
  • Debian pipeline
  • User interface to monitor workflows
  • URL redesign
• Release history
  • 0.7.2 (2024-11-13)
  • 0.7.1 (2024-11-12)
  • 0.7.0 (2024-11-12)
  • 0.6.0 (2024-10-10)
  • 0.5.0 (2024-09-03)
  • 0.4.1 (2024-06-28)
  • 0.4.0 (2024-06-24)
  • 0.3.2 (2024-06-03)
  • 0.3.1 (2024-05-28)
  • 0.3.0 (2024-05-23)
  • 0.2.1 (2024-03-07)
  • 0.2.0 (2024-02-29)
  • 0.1.0 (2022-09-09)

Todo

Add new reference pages to cover:

• debusine-server configuration file

• debusine-worker configuration file

Indices and tables

• TODO to fix in the documentation

• Index

• Module Index