Developer guide

Build blockstor, run its tests, and find your way around the code.

This section is for people who work on blockstor itself. If you want to run blockstor, the Documentation is the place to start.

  • Building: binaries, images and the local dev stand.
  • Testing: the test tiers, from unit tests to the operator CLI matrix.
  • Repository layout: where each part of the code lives.
  • Internals: the rules the code relies on, with references to it.
  • Contributing: licensing rules, commits and pull requests.

Design notes and audits that are useful background but not part of this guide live in the repository’s docs/ directory.


Building

Build the binaries and images, and bring up the dev stand.

Testing

The test tiers and how to run each of them.

Repository layout

Where each part of blockstor lives.

Internals

The rules the code relies on, with pointers into it.

Contributing

Licensing rules, and what a change needs before it merges.