Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Simplyblock Control Plane Tooling

Simplyblock is a Kubernetes-native, distributed block storage solution. It was designed from the ground up to be high-performance, NVMe over Fabrics end-to-end, highly available, fault-tolerant, and scalable.

Simplyblock is developed and maintained by Simplyblock.

Documentation

The full simplyblock documentation can be found at docs.simplyblock.io.

Installing the Command Line Interface

The sbctl tooling can be installed using our pypi package sbctl.

pip install --upgrade sbctl

Requires Python 3.9 or newer.

Repository Components

This repository contains the source code for the Simplyblock Control Plane core services and the command line interface (sbctl).

Technology stack:

  • Python
  • Docker
  • Kubernetes
  • FoundationDB
  • FastAPI (API v2)
  • Flask (API v1)
  • OpenAPI (Swagger)

The repository is split into the following components:

Simplyblock Core

The simplyblock_core/ directory contains the core logic and controllers for a simplyblock control plane cluster.

Simplyblock CLI

The simplyblock_cli directory contains the sbctl command line interface code. A full list of the available command line interface commands and options can be found in the sbctl reference.

Commands and options in the command line interface are implemented using an automatic generator and a YAML definitions file (simplyblock_cli/sbctl/cli-reference.yaml). For well-conformity of the YAML file, a schema definition is provided in simplyblock_cli/sbctl/cli-reference-schema.json and linked on top of the reference for immediate use in Visual Studio Code and IntelliJ-based platforms.

If commands or options are added, updated, or removed, the YAML file, the generator must be executed to update the startup code of sbctl.

tox run -e generate

Executing this command updates simplyblock_cli/cli.py according to the reference file.

Reference Notes

There are a few implicit rules in the reference file:

  • Positional Argument: Arguments without leading hyphens (-- or -) are considered positional arguments which are always required.
  • Optional Argument: Arguments with leading hyphens (-- or -) are considered optional arguments except marked as required: true.
  • Naming Convention Commands: When commands and subcommands are added, the generator creates the function names according to the following naming convention <command>__<subcommand> which has to be implemented in clibase.py. If the command or subcommand contains a hyphen in the name, it is exchanged for an underscore.

Simplyblock Web API

The simplyblock_web directory contains the source code for the simplyblock control plane API. A full list of the available API endpoints and options can be found in the API reference.

Notes on Local Development

FoundationDB

Simplyblock's control plane uses FoundationDB, which means it requires a FDB client library (libfdb_c.dylib) for the Python bindings to interact with the database.

Depending on the OS architecture, the appropriate version must be installed from their official github repo.

wget https://github.com/apple/foundationdb/releases/download/7.3.3/FoundationDB-7.3.3_arm64.pkg

Docker Compose

A local development environment can be spun up using the Docker compose file: docker-compose-dev.yml.

sudo docker compose -f docker-compose-dev.yml up --build -d

License

Copyright (c) 2021-2025 Simplyblock GmbH. All rights reserved.

Metadata

Release files for sbctl 26.4.0b4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sbctl 26.4.0b4
File Size Uploaded Provenance Actions
sbctl-26.4.0b4.tar.gz 2.0 MB Without provenance Details for sbctl-26.4.0b4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sbctl 26.4.0b4
File Interpreter ABI Platform Actions
sbctl-26.4.0b4-py3-none-any.whl Python 3 none any Details for sbctl-26.4.0b4-py3-none-any.whl

Total release size: 4.2 MB

Release files / sbctl-26.4.0b4.tar.gz

Download URL sbctl-26.4.0b4.tar.gz
Size 2.0 MB
Tags Source
SHA-256 checksum
How to use checksums
cfce4aa8b03b2c3aef0e700ed68e72ad850e39cbbbcc15dcfb22a9a3450dbb3b
BLAKE2b-256 checksum
How to use checksums
e8b5a1ca53b65e693f0cf4d7624180c169d391b794763fe779952171586d6b02
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / sbctl-26.4.0b4-py3-none-any.whl

Download URL sbctl-26.4.0b4-py3-none-any.whl
Size 2.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
1cb836afd0e2c35bb92a5ea703ea97713624b9dc48a7affd77c5aaea06363733
BLAKE2b-256 checksum
How to use checksums
080c95dafb10f1e6f0e4bb7fe207cb2259c94f5d40c254cf74fe92f0b09e3c19
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for sbctl 26.4.0b4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page