https://github.com/open-component-model/delivery-service

Delivery-Service (part of the "Open Delivery Gear")
https://github.com/open-component-model/delivery-service

compliance delivery ocm ocm-gear odg open-delivery-gear python toolkit

Last synced: about 2 months ago
JSON representation

Delivery-Service (part of the "Open Delivery Gear")

• Host: GitHub
• URL: https://github.com/open-component-model/delivery-service
• Owner: open-component-model
• License: apache-2.0
• Created: 2024-04-03T18:35:53.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2026-02-26T07:25:44.000Z (4 months ago)
• Last Synced: 2026-02-26T12:31:02.381Z (4 months ago)
• Topics: compliance, delivery, ocm, ocm-gear, odg, open-delivery-gear, python, toolkit
• Language: Python
• Homepage: https://open-component-model.github.io/delivery-service/
• Size: 16.3 MB
• Stars: 5
• Watchers: 2
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# Delivery-Service

[![REUSE status](https://api.reuse.software/badge/github.com/open-component-model/delivery-service)](https://api.reuse.software/info/github.com/open-component-model/delivery-service)

![tests](https://github.com/open-component-model/delivery-service/actions/workflows/non-release.yaml/badge.svg)

![release](https://github.com/open-component-model/delivery-service/actions/workflows/release.yaml/badge.svg)

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.

# Local Development

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](https://endoflife.date/alpine) Linux is used/tested (see `Dockerfile.*`). Greater or smaller

versions _may_ work, but are typically untested.

For Delivery-Service, use `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](https://open-component-model.github.io/delivery-service/local_setup.html)

for a step-by-step description on how to setup the Delivery-Service (and an extension if desired).

## Getting Started using Kind

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](https://github.com/open-component-model/delivery-service/blob/master/local-setup/local-setup.md).

# REST-API-Documentation

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/delivery-service.