mirror of
https://github.com/trailofbits/buttercup
synced 2026-06-21 14:11:39 +00:00
Riccardo Schirone
a8ed0ccbbe
* feat: Add simplified SigNoz integration using official Helm chart - Add SigNoz as a Helm dependency with conditional deployment - Enable SigNoz by default for minikube environments - Auto-configure OTEL to use internal SigNoz when enabled - Update Docker Compose to include existing SigNoz stack - Minimal configuration following the official chart approach Co-authored-by: Riccardo Schirone <ret2libc@users.noreply.github.com> * Configure local signoz * do not deploy signoz in ci * makefile: ensure signoz is available * feat: Simplify SigNoz integration for improved user experience - Remove external SigNoz configuration prompts from setup-local script - Make local SigNoz deployment the default for quickstart experience - Move external SigNoz configuration to MANUAL_SETUP.md for advanced users - Streamline README log access section to focus on local SigNoz UI - Relocate kubectl commands to QUICK_REFERENCE.md as alternative method - Improve documentation structure for better user onboarding Addresses feedback from @michaelbrownuc to simplify the integration before merging. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Riccardo Schirone <ret2libc@users.noreply.github.com> * Update MANUAL_SETUP.md --------- Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com> Co-authored-by: Riccardo Schirone <ret2libc@users.noreply.github.com>
252 lines
9.0 KiB
Makefile
252 lines
9.0 KiB
Makefile
# Makefile for Trail of Bits AIxCC Finals CRS
|
|
|
|
.PHONY: help setup-local setup-azure validate deploy deploy-local deploy-azure test undeploy install-cscope lint lint-component clean-local wait-crs check-crs crs-instance-id status send-integration-task
|
|
|
|
# Default target
|
|
help:
|
|
@echo "Trail of Bits AIxCC Finals CRS - Available Commands:"
|
|
@echo ""
|
|
@echo "Setup:"
|
|
@echo " setup-local - Automated local development setup"
|
|
@echo " setup-azure - Automated production AKS setup"
|
|
@echo " validate - Validate current setup and configuration"
|
|
@echo ""
|
|
@echo "Deployment:"
|
|
@echo " deploy - Deploy to current environment (local or azure)"
|
|
@echo " deploy-local - Deploy to local Minikube environment"
|
|
@echo " deploy-azure - Deploy to production AKS environment"
|
|
@echo ""
|
|
@echo "Status:"
|
|
@echo " status - Check the status of the deployment"
|
|
@echo " crs-instance-id - Get the CRS instance ID"
|
|
@echo " download-artifacts - Download submitted artifacts from the CRS"
|
|
@echo " signoz-ui - Open the SigNoz UI"
|
|
@echo ""
|
|
@echo "Testing:"
|
|
@echo " send-integration-task - Run integration-test task"
|
|
@echo " send-libpng-task - Run libpng task"
|
|
@echo ""
|
|
@echo "Development:"
|
|
@echo " install-cscope - Install cscope tool"
|
|
@echo " lint - Lint all Python code"
|
|
@echo " lint-component - Lint specific component (e.g., make lint-component COMPONENT=orchestrator)"
|
|
@echo ""
|
|
@echo "Cleanup:"
|
|
@echo " undeploy - Remove deployment and clean up resources"
|
|
@echo " clean-local - Delete Minikube cluster and remove local config"
|
|
|
|
# Setup targets
|
|
setup-local:
|
|
@echo "Setting up local development environment..."
|
|
./scripts/setup-local.sh
|
|
|
|
setup-azure:
|
|
@echo "Setting up production AKS environment..."
|
|
./scripts/setup-azure.sh
|
|
|
|
validate:
|
|
@echo "Validating setup..."
|
|
./scripts/validate-setup.sh
|
|
|
|
# Deployment targets
|
|
deploy:
|
|
@echo "Deploying to current environment..."
|
|
@if [ ! -f external/aixcc-cscope/configure.ac ]; then \
|
|
echo "Error: The git submodules have not been initialized. Run 'git submodule update --init --recursive' first."; \
|
|
exit 1; \
|
|
fi
|
|
cd deployment && make up
|
|
make wait-crs
|
|
|
|
wait-crs:
|
|
@echo "Waiting for CRS deployment to be ready..."
|
|
@if ! kubectl get namespace $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: CRS namespace not found. Deploy first with 'make deploy'."; \
|
|
exit 1; \
|
|
fi
|
|
@while true; do \
|
|
PENDING=$$(kubectl get pods -n $${BUTTERCUP_NAMESPACE:-crs} --no-headers 2>/dev/null | grep -v 'Completed' | grep -v 'Running' | wc -l); \
|
|
if [ "$$PENDING" -eq 0 ]; then \
|
|
echo "All CRS pods are running."; \
|
|
break; \
|
|
else \
|
|
echo "$$PENDING pods are not yet running. Waiting..."; \
|
|
sleep 5; \
|
|
fi \
|
|
done
|
|
|
|
check-crs:
|
|
@if ! kubectl get namespace $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: CRS namespace not found. Deploy first with 'make deploy'."; \
|
|
exit 1; \
|
|
fi
|
|
@PENDING=$$(kubectl get pods -n $${BUTTERCUP_NAMESPACE:-crs} --no-headers 2>/dev/null | grep -v 'Completed' | grep -v 'Running' | wc -l); \
|
|
if [ "$$PENDING" -eq 0 ]; then \
|
|
echo "All CRS pods up and running."; \
|
|
else \
|
|
echo "$$PENDING pods are not yet running."; \
|
|
fi
|
|
|
|
|
|
crs-instance-id:
|
|
@echo "Getting CRS instance ID..."
|
|
@if ! kubectl get namespace $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: CRS namespace not found. Deploy first with 'make deploy'."; \
|
|
exit 1; \
|
|
fi
|
|
echo "CRS instance ID: $$(kubectl get configmap -n $${BUTTERCUP_NAMESPACE:-crs} crs-instance-id -o jsonpath='{.data.crs-instance-id}')"
|
|
|
|
deploy-local:
|
|
@echo "Deploying to local Minikube environment..."
|
|
@if [ ! -f deployment/env ]; then \
|
|
echo "Error: Configuration file not found. Run 'make setup-local' first."; \
|
|
exit 1; \
|
|
fi
|
|
@if [ ! -f external/aixcc-cscope/configure.ac ]; then \
|
|
echo "Error: The git submodules have not been initialized. Run 'git submodule update --init --recursive' first."; \
|
|
exit 1; \
|
|
fi
|
|
cd deployment && make up
|
|
make crs-instance-id
|
|
make wait-crs
|
|
|
|
deploy-azure:
|
|
@echo "Deploying to production AKS environment..."
|
|
@if [ ! -f deployment/env ]; then \
|
|
echo "Error: Configuration file not found. Run 'make setup-azure' first."; \
|
|
exit 1; \
|
|
fi
|
|
@if [ ! -f external/aixcc-cscope/configure.ac ]; then \
|
|
echo "Error: The git submodules have not been initialized. Run 'git submodule update --init --recursive' first."; \
|
|
exit 1; \
|
|
fi
|
|
cd deployment && make up
|
|
crs_instance_id=$$(make crs-instance-id)
|
|
echo "CRS instance ID: $$crs_instance_id"
|
|
make wait-crs
|
|
|
|
status:
|
|
@echo "----------PODS------------"
|
|
@kubectl get pods -n $${BUTTERCUP_NAMESPACE:-crs}
|
|
@echo "----------SERVICES--------"
|
|
@kubectl get services -n $${BUTTERCUP_NAMESPACE:-crs}
|
|
@make --no-print-directory check-crs
|
|
|
|
download-artifacts:
|
|
@echo "Downloading artifacts from the CRS..."
|
|
@if ! kubectl get namespace $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: CRS namespace not found. Deploy first with 'make deploy'."; \
|
|
exit 1; \
|
|
fi
|
|
./scripts/download_artifacts.sh
|
|
|
|
# Testing targets
|
|
send-integration-task:
|
|
@echo "Running integration test task..."
|
|
@if ! kubectl get namespace $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: CRS namespace not found. Deploy first with 'make deploy'."; \
|
|
exit 1; \
|
|
fi
|
|
kubectl port-forward -n $${BUTTERCUP_NAMESPACE:-crs} service/buttercup-ui 31323:1323 &
|
|
@sleep 3
|
|
./orchestrator/scripts/task_integration_test.sh
|
|
pkill -f "kubectl port-forward" || true
|
|
exit 0
|
|
|
|
send-libpng-task:
|
|
@echo "Running libpng task..."
|
|
@if ! kubectl get namespace $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: CRS namespace not found. Deploy first with 'make deploy'."; \
|
|
exit 1; \
|
|
fi
|
|
kubectl port-forward -n $${BUTTERCUP_NAMESPACE:-crs} service/buttercup-ui 31323:1323 &
|
|
@sleep 3
|
|
./orchestrator/scripts/task_crs.sh
|
|
pkill -f "kubectl port-forward" || true
|
|
exit 0
|
|
|
|
# Development targets
|
|
lint:
|
|
@echo "Linting all Python code..."
|
|
@set -e; for component in common orchestrator fuzzer program-model seed-gen patcher; do \
|
|
make --no-print-directory lint-component COMPONENT=$$component; \
|
|
done
|
|
|
|
# Note: common, patcher, orchestrator, program-model, seed-gen run mypy
|
|
lint-component:
|
|
@if [ -z "$(COMPONENT)" ]; then \
|
|
echo "Error: COMPONENT not specified. Usage: make lint-component COMPONENT=<component>"; \
|
|
echo "Available components: common, fuzzer, orchestrator, patcher, program-model, seed-gen"; \
|
|
exit 1; \
|
|
fi
|
|
@echo "Linting $(COMPONENT)..."
|
|
@cd $(COMPONENT) && uv sync -q --all-extras && uv run ruff format --check && uv run ruff check
|
|
@if [ "$(COMPONENT)" = "common" ] || [ "$(COMPONENT)" = "patcher" ] || [ "$(COMPONENT)" = "orchestrator" ] || [ "$(COMPONENT)" = "program-model" ] || [ "$(COMPONENT)" = "seed-gen" ] || [ "$(COMPONENT)" = "fuzzer" ]; then \
|
|
cd $(COMPONENT) && uv run mypy; \
|
|
fi
|
|
|
|
reformat:
|
|
@echo "Reformatting all Python code..."
|
|
@for component in common orchestrator fuzzer program-model seed-gen patcher; do \
|
|
make --no-print-directory reformat-component COMPONENT=$$component; \
|
|
done
|
|
|
|
reformat-component:
|
|
@if [ -z "$(COMPONENT)" ]; then \
|
|
echo "Error: COMPONENT not specified. Usage: make reformat-component COMPONENT=<component>"; \
|
|
echo "Available components: common, fuzzer, orchestrator, patcher, program-model, seed-gen"; \
|
|
exit 1; \
|
|
fi
|
|
@echo "Reformatting $(COMPONENT)..."
|
|
@cd $(COMPONENT) && uv sync -q --all-extras && uv run ruff format && uv run ruff check --fix
|
|
|
|
# Cleanup targets
|
|
undeploy:
|
|
@echo "Cleaning up deployment..."
|
|
cd deployment && make down
|
|
|
|
clean-local:
|
|
@echo "Cleaning up local environment..."
|
|
minikube delete || true
|
|
rm -f deployment/env
|
|
|
|
# Additional targets migrated from justfile
|
|
install-cscope:
|
|
cd external/aixcc-cscope/ && autoreconf -i -s && ./configure && make && sudo make install
|
|
|
|
signoz-ui:
|
|
@echo "Opening SigNoz UI..."
|
|
@if ! kubectl get namespace $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: CRS namespace not found. Deploy first with 'make deploy'."; \
|
|
exit 1; \
|
|
fi
|
|
@if ! kubectl get service/buttercup-signoz-frontend -n $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: SigNoz is not deployed. Set DEPLOY_SIGNOZ=true in deployment/env and redeploy."; \
|
|
exit 1; \
|
|
fi
|
|
kubectl port-forward -n $${BUTTERCUP_NAMESPACE:-crs} service/buttercup-signoz-frontend 33301:3301 &
|
|
@sleep 3
|
|
@if command -v xdg-open >/dev/null 2>&1; then \
|
|
xdg-open http://localhost:33301; \
|
|
elif command -v open >/dev/null 2>&1; then \
|
|
open http://localhost:33301; \
|
|
else \
|
|
echo "Please open http://localhost:33301 in your browser."; \
|
|
fi
|
|
|
|
web-ui:
|
|
@echo "Opening web UI (https://localhost:31323/)..."
|
|
@if ! kubectl get namespace $${BUTTERCUP_NAMESPACE:-crs} >/dev/null 2>&1; then \
|
|
echo "Error: CRS namespace not found. Deploy first with 'make deploy'."; \
|
|
exit 1; \
|
|
fi
|
|
kubectl port-forward -n $${BUTTERCUP_NAMESPACE:-crs} service/buttercup-ui 31323:1323 &
|
|
@sleep 3
|
|
@if command -v xdg-open >/dev/null 2>&1; then \
|
|
xdg-open http://localhost:31323; \
|
|
elif command -v open >/dev/null 2>&1; then \
|
|
open http://localhost:31323; \
|
|
else \
|
|
echo "Please open http://localhost:31323 in your browser."; \
|
|
fi
|