pumpwood-deploy-frontend

Satellite deploy package for the Pumpwood Frontend (React) microservice on Kubernetes. It generates manifests for the frontend secrets and the pumpwood-frontend-react Deployment/Service — then hands them to pumpwood-deploy for apply.

Developed by Murabei Data Science. BSD-3-Clause.

Pumpwood is a native Brazilian tree with a symbiotic relation to ants (Murabei)

What it deploys

The React app is the main Pumpwood UI. It uses the public gateway URL for browser API calls and registers with the platform via the microservice--frontend service user.

flowchart LR
    subgraph pkg [pumpwood-deploy-frontend]
        A[PumpwoodFrontEndMicroservice]
    end
    subgraph core [pumpwood-deploy]
        B[DeployPumpWood]
    end
    subgraph cluster [Cluster]
        S[pumpwood-frontend-react Secret]
        APP[pumpwood-frontend-react]
        LB[load-balancer / Kong]
    end
    A --> B
    B --> S
    B --> APP
    APP --> LB

Prerequisites

This package does not stand alone. Before frontend pods can start, the cluster should already provide:

The pod sets:

• NEXT_PUBLIC_APP_API_URL from gateway_public_ip (public URL)
• API_URL to http://load-balancer:8000/rest (in-cluster Kong)

No Postgres or storage ConfigMap is required for the frontend pod.

Installation

pip install pumpwood-deploy-frontend

Requires pumpwood-deploy.

Quick start

import os
import simplejson as json
from dotenv import load_dotenv
from pumpwood_deploy.deploy import DeployPumpWood
from pumpwood_deploy_frontend import PumpwoodFrontEndMicroservice

with open("secrets/production.json", "r") as file:
    secrets = json.loads(file.read())
load_dotenv()

deploy = DeployPumpWood(
    model_user_password=secrets["microservices--model"],
    rabbitmq_secret=secrets["rabbitmq_secret"],
    hash_salt=secrets["hash_salt"],
    k8_provider="aws",
    k8_deploy_args={
        "region": "us-east-1",
        "cluster_name": "my-cluster",
    },
    k8_namespace="pumpwood",
)

deploy.add_microservice(
    PumpwoodFrontEndMicroservice(
        version=os.getenv("PUMPWOOD_FRONTEND"),
        gateway_public_ip="https://pumpwood.example.com",
        repository="my-registry.example.com",
        microservice_password=secrets["microservice--frontend"],
        debug="FALSE",
    ))

deploy.create_deploy_files()
deploy.deploy_microservices()

Environment variables

PUMPWOOD_FRONTEND=2.1.0

If the rendered manifest matches what is already on the cluster, kubectl apply produces no changes — safe for rolling image updates.

Configuration reference

Required

Optional

Migration note

Older deploy scripts imported from the monolithic package:

# Before
from pumpwood_deploy.microservices.frontend.deploy import (
    PumpwoodFrontEndMicroservice)

# After
from pumpwood_deploy_frontend import PumpwoodFrontEndMicroservice

Related packages

Development

pip install -e ../pumpwood-deploy
pip install -e .

PYTHONPATH="src:../pumpwood-deploy/src" \
  python3 -m unittest discover \
  -s src/pumpwood_deploy_frontend/tests -p "test_*.py" -v

ruff check src/

License

BSD-3-Clause — see LICENSE.