This repository is used for developing the Delivery-Service + Extensions, which are part of the
Open Delivery Gear. It exposes a RESTful API useful for delivery- and compliance-related tasks
for OCM-based software deliveries.
Both Delivery-Service and (optional) Extensions are intended to be deployed into a common Kubernetes cluster.
Delivery-Service and Extensions require a Python runtime environment (see setup.py for details) to
run. Typically, the Python3 version from greatest released version of
Alpine Linux is used/tested (see Dockerfile). Greater or smaller
versions may work, but are typically untested.
For Delivery-Service, use src/app.py as entry point. Check online-help (app.py --help) for further
instructions. Note that most features of Delivery-Service are optional (features are disabled by
default unless explicitly enabled through additional configuration).
Please refer to this guide for a step-by-step description on how to setup the Delivery-Service (and an extension if desired).
If you wish to deploy the Open Delivery Gear (Delivery-Service, Delivery-Dashboard, Delivery-DB, Extensions) in a local Kubernetes cluster using Kind, please refer to this guide.
Delivery-Service exposes generated documentation through the following route: /api/v1/doc
Note
For a full (-> still WIP) documentation, please visit https://open-component-model.github.io/odg-core.
