admin/trailofbits-buttercup
1
0
Fork 0
mirror of https://github.com/trailofbits/buttercup synced 2026-06-21 14:11:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup make commands (#191)

Browse Source 
* add 'status' make command to check deployment status
* unify make commands
* rename `make test` to `make send-integration-task`
* add check-crs message
This commit is contained in:
Brad Swain
2025-07-30 02:45:42 -05:00
committed by GitHub
parent 188cd092ed
commit 8be0290a6c
5 changed files with 105 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Makefile
+39 -16
View File
@@ -1,6 +1,6 @@
# Makefile for Trail of Bits AIxCC Finals CRS
.PHONY: help setup-local setup-production validate deploy deploy-local deploy-production test clean
.PHONY: help setup-local setup-azure validate deploy deploy-local deploy-azure test undeploy
# Default target
help:
@@ -8,33 +8,36 @@ help:
@echo ""
@echo "Setup:"
@echo " setup-local - Automated local development setup"
@echo " setup-production - Automated production AKS 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 production)"
@echo " deploy - Deploy to current environment (local or azure)"
@echo " deploy-local - Deploy to local Minikube environment"
@echo " deploy-production - Deploy to production AKS environment"
@echo " deploy-azure - Deploy to production AKS environment"
@echo ""
@echo "Status:"
@echo " status - Check the status of the deployment"
@echo ""
@echo "Testing:"
@echo " test - Run test task"
@echo " send-integration-task - Run integration-test task"
@echo ""
@echo "Development:"
@echo " lint - Lint all Python code"
@echo " lint-component - Lint specific component (e.g., make lint-component COMPONENT=orchestrator)"
@echo ""
@echo "Cleanup:"
@echo " clean - Clean up deployment"
@echo " clean-local - Clean up local environment"
@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-production:
setup-azure:
@echo "Setting up production AKS environment..."
./scripts/setup-production.sh
./scripts/setup-azure.sh
validate:
@echo "Validating setup..."
@@ -63,6 +66,19 @@ wait-crs:
fi \
done
check-crs:
@if ! kubectl get 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 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 crs >/dev/null 2>&1; then \
@@ -81,10 +97,10 @@ deploy-local:
make crs-instance-id
make wait-crs
deploy-production:
deploy-azure:
@echo "Deploying to production AKS environment..."
@if [ ! -f deployment/env ]; then \
echo "Error: Configuration file not found. Run 'make setup-production' first."; \
echo "Error: Configuration file not found. Run 'make setup-azure' first."; \
exit 1; \
fi
cd deployment && make up
@@ -92,14 +108,21 @@ deploy-production:
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
# Testing targets
test:
@echo "Running test task..."
@if ! kubectl get namespace crs >/dev/null 2>&1; then \
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 crs service/buttercup-ui 31323:1323 &
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
@@ -125,7 +148,7 @@ lint-component:
fi
# Cleanup targets
clean:
undeploy:
@echo "Cleaning up deployment..."
cd deployment && make down
QUICK_REFERENCE.md
+2 -2
View File
@@ -16,7 +16,7 @@ cd deployment && make up
### Production AKS
```bash
# Automated setup
./scripts/setup-production.sh
./scripts/setup-azure.sh
# Manual setup
az login --tenant aixcc.tech
@@ -184,7 +184,7 @@ kubectl logs -n crs -l app=fuzzer --tail=-1 --prefix
### Scripts
- `scripts/setup-local.sh` - Local development setup
- `scripts/setup-production.sh` - Production AKS setup
- `scripts/setup-azure.sh` - Production AKS setup
- `orchestrator/scripts/` - Testing and task scripts
### Documentation
README.md
+61 -16
View File
@@ -74,14 +74,56 @@ make deploy-local
2. **Verify deployment:**
```bash
kubectl get pods -n crs
kubectl get services -n crs
make status
```
When the deployment is succesful, you should see something like
```shell
$ make status
----------PODS------------
NAME READY STATUS RESTARTS AGE
buttercup-build-bot-845f5b96d9-7t8bz 1/1 Running 0 5m58s
buttercup-build-bot-845f5b96d9-bfsq9 1/1 Running 0 5m58s
buttercup-build-bot-845f5b96d9-npns4 1/1 Running 0 5m58s
buttercup-build-bot-845f5b96d9-sv5fr 1/1 Running 0 5m58s
buttercup-coverage-bot-6749f57b9d-4gzfd 1/1 Running 0 5m58s
buttercup-dind-452s6 1/1 Running 0 5m58s
buttercup-fuzzer-bot-74bc9b849d-2zkt6 1/1 Running 0 5m58s
buttercup-image-preloader-97nfb 0/1 Completed 0 5m58s
buttercup-litellm-5f87df944-2mq7z 1/1 Running 0 5m58s
buttercup-litellm-migrations-ljjcl 0/1 Completed 0 5m58s
buttercup-merger-bot-fz87v 1/1 Running 0 5m58s
buttercup-patcher-7597c965b8-6968s 1/1 Running 0 5m58s
buttercup-postgresql-0 1/1 Running 0 5m58s
buttercup-pov-reproducer-5f948bd7cc-45rgp 1/1 Running 0 5m58s
buttercup-program-model-67446b5cfc-24zfh 1/1 Running 0 5m58s
buttercup-redis-master-0 1/1 Running 0 5m58s
buttercup-registry-cache-5787f86896-czt9b 1/1 Running 0 5m58s
buttercup-scheduler-7c49bf75c5-swqkb 1/1 Running 0 5m58s
buttercup-scratch-cleaner-hdt6z 1/1 Running 0 5m58s
buttercup-seed-gen-6fdb9c94c9-4xmrp 1/1 Running 0 5m57s
buttercup-task-downloader-54cd9fb577-g4lbg 1/1 Running 0 5m58s
buttercup-task-server-7d8cd7cf49-zkt69 1/1 Running 0 5m58s
buttercup-tracer-bot-5b9fb6c8b5-zcmxd 1/1 Running 0 5m58s
buttercup-ui-5dcf7dfb8-njglh 1/1 Running 0 5m58s
----------SERVICES--------
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
buttercup-litellm ClusterIP 10.96.88.226 <none> 4000/TCP 5m58s
buttercup-postgresql ClusterIP 10.111.161.207 <none> 5432/TCP 5m58s
buttercup-postgresql-hl ClusterIP None <none> 5432/TCP 5m58s
buttercup-redis-headless ClusterIP None <none> 6379/TCP 5m58s
buttercup-redis-master ClusterIP 10.108.61.77 <none> 6379/TCP 5m58s
buttercup-registry-cache ClusterIP 10.103.80.241 <none> 443/TCP 5m58s
buttercup-task-server ClusterIP 10.104.206.197 <none> 8000/TCP 5m58s
buttercup-ui ClusterIP 10.106.49.166 <none> 1323/TCP 5m58s
All CRS pods up and running.
```
3. **Submit the integration-test challenge to the CRS (for 30mins):**
```bash
make test
make send-integration-task
```
**Alternative manual commands:**
@@ -111,7 +153,7 @@ Full production deployment of the **Buttercup CRS** on Azure Kubernetes Service
Use our automated setup script:
```bash
make setup-production
make setup-azure
```
This script will check prerequisites, help create service principals, configure the environment, and validate your setup.
@@ -163,7 +205,7 @@ In particular, set `TF_VAR_*` variables, and `TAILSCALE_*` if used.
**Deploy the cluster and services:**
```bash
make deploy-production
make deploy-azure
```
**Alternative manual command:**
@@ -189,7 +231,7 @@ kubectl port-forward -n crs service/buttercup-ui 31323:1323 &
## Cleanup
```bash
make clean
make undeploy
```
**Alternative manual command:**
@@ -209,25 +251,28 @@ The **Buttercup CRS** project includes a Makefile with convenient shortcuts for
make help
# Setup
make setup-local # Automated local setup
make setup-production # Automated production setup
make validate # Validate current setup
make setup-local # Automated local development setup
make setup-azure # Automated production AKS setup
make validate # Validate current setup and configuration
# Deployment
make deploy # Deploy to current environment
make deploy-local # Deploy to local Minikube
make deploy-production # Deploy to production AKS
make deploy # Deploy to current environment (local or azure)
make deploy-local # Deploy to local Minikube environment
make deploy-azure # Deploy to production AKS environment
# Status
make status # Check the status of the deployment
# Testing
make test # Run test task
make send-integration-task # Run integration test task
# Development
make lint # Lint all Python code
make lint-component COMPONENT=orchestrator # Lint specific component
# Cleanup
make clean # Clean up deployment
make clean-local # Clean up local environment
make undeploy # Remove deployment and clean up resources
make clean-local # Delete Minikube cluster and remove local config
```
### Running Tests
@@ -240,7 +285,7 @@ make lint
make lint-component COMPONENT=orchestrator
# Run test task
make test
make send-integration-task
```
**Alternative manual commands:**
scripts/setup-production.sh → scripts/setup-azure.sh
+2 -2
View File
@@ -142,14 +142,14 @@ deployment_instructions() {
print_success "Production setup completed!"
echo
print_status "Next steps for deployment:"
echo " 1. Run: make deploy-production"
echo " 1. Run: make deploy-azure"
echo " 2. Monitor deployment: kubectl get pods -A"
echo " 3. Get cluster credentials: az aks get-credentials --name <cluster-name> --resource-group <rg-name>"
echo " 4. Access via Tailscale: kubectl get -n crs-webservice ingress"
echo
print_status "Useful commands:"
echo " - View logs: kubectl logs -n crs <pod-name>"
echo " - Scale nodes: Update TF_VAR_usr_node_count and run make deploy-production"
echo " - Scale nodes: Update TF_VAR_usr_node_count and run make deploy-azure"
echo " - Cleanup: make clean"
}
scripts/setup-local.sh
+1 -1
View File
@@ -37,7 +37,7 @@ verify_setup() {
print_success "Setup verification completed successfully!"
print_status "Next steps:"
echo " 1. Run: make deploy-local"
echo " 2. Test with: make test"
echo " 2. Test with: make send-integration-task"
else
print_error "Setup verification failed. Run 'make validate' for details."
exit 1