Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

SeeBOM – Deployment Examples

This directory contains ready-to-use example configurations for deploying SeeBOM.

Directory Description
kind/ Local development with Kind (Kubernetes in Docker)
kubernetes/ Production / staging deployment on a real Kubernetes cluster

SBOM Ingestion Methods

Method Config Best For
S3 buckets (default) s3.buckets JSON array Any scale, no PVC needed, AWS/MinIO/GCS
Seed job (alternative) gitSync.enabled: false + seedJob Large Git repos (cncf/sbom ~14 GB), environments without S3
git-sync (alternative) gitSync.enabled: true Small Git repos (< 1 GB), continuous auto-pull
Manual PVC (alternative) gitSync.enabled: false, no seedJob Custom CI, pre-built SBOMs

See kubernetes/README.md for full details on each method.

Quick Start (Kind)

# 1. Copy the example and fill in your secrets
cp examples/kind/secrets.env.example local/secrets.env
vi local/secrets.env

# 2. Deploy
make kind-up

# 3. Open
#    UI:  http://localhost:8090
#    API: http://localhost:8080/healthz

Production Deployment

# 1. Copy and customise values
cp examples/kubernetes/values-production.yaml my-values.yaml
vi my-values.yaml

# 2. Install via Helm
helm install seebom oci://ghcr.io/seebom-labs/seebom/charts/seebom \
  --version 0.1.3 \
  -f my-values.yaml

See docs/DEPLOYMENT_GUIDE.md for the full guide.