Skip to main content

No project description provided

Project description

gooseBit


A simplistic, opinionated remote update server implementing hawkBit™'s DDI API.

Quick Start

Installation

  1. Install dependencies using Poetry:
    poetry install
    
  2. Launch gooseBit:
    python main.py
    

Initial Configuration

Before running gooseBit for the first time, update the default credentials in settings.yaml. The default login for testing purposes is:

  • Username: admin@goosebit.local
  • Password: admin

Assumptions

  • Devices use SWUpdate for managing software updates.

Features

Device Registry

When a device connects to gooseBit for the first time, it is automatically added to the device registry. The server will then request the device's configuration data, including:

  • hw_model and hw_revision: Used to match compatible software.
  • sw_version: Indicates the currently installed software version.

The registry tracks each device's status, including the last online timestamp, installed software version, update state, and more.

Software Repository

Software packages (*.swu files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.

Device Update Modes

Devices can be configured with different update modes. The default mode is Rollout.

1. Manual Update to Specified Software

Assign specific software to a device manually. Once installed, no further updates will be triggered.

2. Automatic Update to Latest Software

Automatically updates the device to the latest compatible software, based on the reported hw_model and hw_revision. Note: versions are interpreted as SemVer versions.

3. Software Rollout

Rollouts target all devices with a specified "feed" value, ensuring that the assigned software is installed on all matching devices. Rollouts also track success and error rates, with future plans for automatic aborts. If multiple rollouts exist for the same feed, the most recent rollout takes precedence.

Pause Updates

Devices can be pinned to their current software version, preventing any updates from being applied.

Real-time Update Logs

While updates are in progress, gooseBit captures real-time logs, which are accessible through the device repository.

Development

Database

Create or upgrade database

poetry run aerich upgrade

After a model change create the migration

poetry run aerich migrate

Code formatting and linting

Code is formatted using different tools

  • black and isort for *.py
  • biomejs for *.js, *.json
  • prettier for *.html, *.md, *.yml, *.yaml

Code is linted using different tools as well

  • flake8 for *.py
  • biomejs for *.js

Best to have pre-commit install git hooks that run all those tools before a commit:

poetry run pre-commit install

To manually apply the hooks to all files use:

pre-commit run --all-files

Testing

Tests are implemented using pytest. To run all tests

poetry run pytest

Structure

The structure of gooseBit is as follows:

  • api: Files for the API.
  • ui: Files for the UI.
    • bff: Backend for frontend API.
    • static: Static files.
    • templates: Jinja2 formatted templates.
    • nav: Navbar handler.
  • updater: DDI API handler and device update manager.
  • updates: SWUpdate file parsing.
  • realtime: Realtime API functionality with websockets.
  • auth: Authentication functions and permission handling.
  • models: Database models.
  • db: Database config and initialization.
  • schema: Pydantic models used for API type hinting.
  • settings: Settings loader and handler.
  • telemetry: Telemetry data handlers.
  • routes: Routes for a giving endpoint, including the router.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

goosebit-0.2.1.tar.gz (47.5 kB view details)

Uploaded Source

Built Distribution

goosebit-0.2.1-py3-none-any.whl (72.7 kB view details)

Uploaded Python 3

File details

Details for the file goosebit-0.2.1.tar.gz.

File metadata

  • Download URL: goosebit-0.2.1.tar.gz
  • Upload date:
  • Size: 47.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.1 Linux/6.5.0-1025-azure

File hashes

Hashes for goosebit-0.2.1.tar.gz
Algorithm Hash digest
SHA256 7b3a31614ce00db1aa95f04482f553bca07348d882707e85c349d709b2f59b31
MD5 ce541225e829604ff35fb6920b3b587d
BLAKE2b-256 a0538f19ddd4f6573060e07e4bfa9b7e8c6307659bc5c75aef66af99a740516b

See more details on using hashes here.

File details

Details for the file goosebit-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: goosebit-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 72.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.1 Linux/6.5.0-1025-azure

File hashes

Hashes for goosebit-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b7d6629f2c9710a642131f7e3ee2565070cd7316933176b15df939e9c8a354f
MD5 e8db0e7843a6bb68c33d39892a6ed2b0
BLAKE2b-256 29f5ba8f9151b5868bce3b6890f45df18d349635b8931406f79911ad12cbe8a9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page