Major changes to align with the official netboxlabs/diode docker-compose: docker-compose.yml: - Upgrade Hydra from v2.2 to v25.4.0 (latest stable) - Fix env var names: drop DIODE_ prefix on ingester/reconciler/auth (DIODE_REDIS_HOST -> REDIS_HOST, DIODE_GRPC_PORT -> removed, etc.) - Remove AUTH_GRPC_TARGET from ingester — auth is handled by nginx via HTTP subrequests to diode-auth, not by the ingester directly - Point DIODE_AUTH_TOKEN_URL to diode-auth:8080/token (not Hydra) - Add Postgres connection vars to reconciler (MIGRATION_ENABLED, etc.) - Mount nginx.conf as /etc/nginx/conf.d/default.conf (not nginx.conf) - Use netboxlabs/diode-auth image for bootstrap (has hydra CLI + jq) - Add Hydra JWT strategy config (STRATEGIES_ACCESS_TOKEN: jwt) - Add orb-agent run command with explicit config path - Expose Hydra ports 4444/4445 for external token requests - Add Hydra DB env vars to Postgres for init script nginx/nginx.conf: - Rewrite to match official Diode nginx architecture - Auth via auth_request subrequests to diode-auth:8080 (HTTP) - gRPC pass to ingester/reconciler on :8081 after auth - Add /diode/auth proxy for token endpoint access - Add error handlers for 401/403 oauth2/client/bootstrap-clients.sh: - Rewrite to use hydra CLI (create/get oauth2-client) instead of raw wget calls to Hydra admin API - Use jq for JSON parsing instead of python3 - Idempotent: checks if client exists before creating setup.sh: - Fix OAuth2 scope: diode:ingester -> diode:ingest - Rewrite orb-agent config to match current agent.yaml schema (config_manager, policies with cron schedules, scope-based targets) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
322 lines
9.2 KiB
Bash
Executable File
322 lines
9.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
|
|
# =============================================================================
|
|
# NetBox Diode Project - Bootstrap Script
|
|
# Generates secrets, writes configs, and prepares all services for startup.
|
|
# =============================================================================
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
NETBOX_DOCKER_DIR="/home/user/netbox-docker"
|
|
HOST_IP="172.19.77.160"
|
|
|
|
echo "==> Generating secrets..."
|
|
|
|
gen_secret() {
|
|
openssl rand -hex 32
|
|
}
|
|
|
|
REDIS_PASSWORD="$(gen_secret)"
|
|
DIODE_DB_PASSWORD="$(gen_secret)"
|
|
HYDRA_DB_PASSWORD="$(gen_secret)"
|
|
HYDRA_SYSTEM_SECRET="$(gen_secret)"
|
|
|
|
# OAuth2 client secrets (used by Diode services and Orb Agent)
|
|
INGESTER_CLIENT_SECRET="$(gen_secret)"
|
|
RECONCILER_CLIENT_SECRET="$(gen_secret)"
|
|
NETBOX_TO_DIODE_CLIENT_SECRET="$(gen_secret)"
|
|
|
|
echo "==> Writing .env file..."
|
|
cat > "${SCRIPT_DIR}/.env" <<EOF
|
|
# =============================================================================
|
|
# Generated by setup.sh — do not edit manually
|
|
# =============================================================================
|
|
|
|
# Host networking
|
|
HOST_IP=${HOST_IP}
|
|
|
|
# Redis
|
|
REDIS_PASSWORD=${REDIS_PASSWORD}
|
|
|
|
# Postgres (Diode)
|
|
DIODE_DB_NAME=diode
|
|
DIODE_DB_USER=diode
|
|
DIODE_DB_PASSWORD=${DIODE_DB_PASSWORD}
|
|
|
|
# Postgres (Hydra)
|
|
HYDRA_DB_NAME=hydra
|
|
HYDRA_DB_USER=hydra
|
|
HYDRA_DB_PASSWORD=${HYDRA_DB_PASSWORD}
|
|
|
|
# Hydra
|
|
HYDRA_SYSTEM_SECRET=${HYDRA_SYSTEM_SECRET}
|
|
|
|
# OAuth2 client IDs (fixed)
|
|
INGESTER_CLIENT_ID=diode-ingester
|
|
RECONCILER_CLIENT_ID=diode-reconciler
|
|
NETBOX_TO_DIODE_CLIENT_ID=netbox-to-diode
|
|
|
|
# OAuth2 client secrets
|
|
INGESTER_CLIENT_SECRET=${INGESTER_CLIENT_SECRET}
|
|
RECONCILER_CLIENT_SECRET=${RECONCILER_CLIENT_SECRET}
|
|
NETBOX_TO_DIODE_CLIENT_SECRET=${NETBOX_TO_DIODE_CLIENT_SECRET}
|
|
|
|
# NetBox connection
|
|
NETBOX_API_URL=http://${HOST_IP}:8000
|
|
NETBOX_API_TOKEN=0123456789abcdef0123456789abcdef01234567
|
|
NETBOX_DIODE_PLUGIN_VERSION=1.7.0
|
|
EOF
|
|
|
|
echo "==> Writing OAuth2 client credentials..."
|
|
cat > "${SCRIPT_DIR}/oauth2/client/client-credentials.json" <<EOF
|
|
[
|
|
{
|
|
"client_id": "diode-ingester",
|
|
"client_secret": "${INGESTER_CLIENT_SECRET}",
|
|
"client_name": "Diode Ingester",
|
|
"grant_types": ["client_credentials"],
|
|
"token_endpoint_auth_method": "client_secret_post",
|
|
"scope": "diode:ingest",
|
|
"audience": ["diode-ingester"]
|
|
},
|
|
{
|
|
"client_id": "diode-reconciler",
|
|
"client_secret": "${RECONCILER_CLIENT_SECRET}",
|
|
"client_name": "Diode Reconciler",
|
|
"grant_types": ["client_credentials"],
|
|
"token_endpoint_auth_method": "client_secret_post",
|
|
"scope": "diode:reconciler",
|
|
"audience": ["diode-reconciler"]
|
|
},
|
|
{
|
|
"client_id": "netbox-to-diode",
|
|
"client_secret": "${NETBOX_TO_DIODE_CLIENT_SECRET}",
|
|
"client_name": "NetBox to Diode",
|
|
"grant_types": ["client_credentials"],
|
|
"token_endpoint_auth_method": "client_secret_post",
|
|
"scope": "diode:netbox-to-diode",
|
|
"audience": ["netbox-to-diode"]
|
|
}
|
|
]
|
|
EOF
|
|
|
|
echo "==> Writing OAuth2 bootstrap script..."
|
|
cat > "${SCRIPT_DIR}/oauth2/client/bootstrap-clients.sh" <<'BOOTSTRAP_EOF'
|
|
#!/usr/bin/env sh
|
|
set -e
|
|
|
|
HYDRA_ADMIN_URL="${HYDRA_ADMIN_URL:-http://hydra:4445}"
|
|
CREDENTIALS_FILE="/client-credentials/client-credentials.json"
|
|
|
|
echo "Waiting for Hydra to be ready..."
|
|
until wget -qO- "${HYDRA_ADMIN_URL}/health/ready" 2>/dev/null | grep -q '"status":"ok"'; do
|
|
echo " Hydra not ready yet, retrying in 3s..."
|
|
sleep 3
|
|
done
|
|
echo "Hydra is ready."
|
|
|
|
CLIENT_COUNT=$(cat "${CREDENTIALS_FILE}" | python3 -c "import sys,json; print(len(json.load(sys.stdin)))")
|
|
|
|
for i in $(seq 0 $((CLIENT_COUNT - 1))); do
|
|
CLIENT_JSON=$(cat "${CREDENTIALS_FILE}" | python3 -c "import sys,json; print(json.dumps(json.load(sys.stdin)[$i]))")
|
|
CLIENT_ID=$(echo "${CLIENT_JSON}" | python3 -c "import sys,json; print(json.load(sys.stdin)['client_id'])")
|
|
|
|
echo "Checking client: ${CLIENT_ID}"
|
|
|
|
# Check if client already exists
|
|
HTTP_CODE=$(wget -qO/dev/null -S "${HYDRA_ADMIN_URL}/admin/clients/${CLIENT_ID}" 2>&1 | grep "HTTP/" | tail -1 | awk '{print $2}')
|
|
if [ "${HTTP_CODE}" = "200" ]; then
|
|
echo " Client '${CLIENT_ID}' already exists, skipping."
|
|
continue
|
|
fi
|
|
|
|
echo " Registering client '${CLIENT_ID}'..."
|
|
wget -qO- --header="Content-Type: application/json" \
|
|
--post-data="${CLIENT_JSON}" \
|
|
"${HYDRA_ADMIN_URL}/admin/clients" || {
|
|
echo " ERROR: Failed to register client '${CLIENT_ID}'"
|
|
exit 1
|
|
}
|
|
echo ""
|
|
echo " Client '${CLIENT_ID}' registered successfully."
|
|
done
|
|
|
|
echo "All OAuth2 clients registered."
|
|
BOOTSTRAP_EOF
|
|
chmod +x "${SCRIPT_DIR}/oauth2/client/bootstrap-clients.sh"
|
|
|
|
echo "==> Writing Orb Agent config..."
|
|
cat > "${SCRIPT_DIR}/orb-agent/agent.yaml" <<EOF
|
|
orb:
|
|
config_manager:
|
|
active: local
|
|
backends:
|
|
network_discovery:
|
|
snmp_discovery:
|
|
common:
|
|
diode:
|
|
target: grpc://${HOST_IP}:8080/diode
|
|
client_id: diode-ingester
|
|
client_secret: ${INGESTER_CLIENT_SECRET}
|
|
agent_name: orb-agent-01
|
|
policies:
|
|
network_discovery:
|
|
nmap_scan:
|
|
config:
|
|
schedule: "*/30 * * * *"
|
|
timeout: 300
|
|
defaults:
|
|
site: "main"
|
|
scope:
|
|
targets:
|
|
- "10.0.0.0/24"
|
|
snmp_discovery:
|
|
snmp_scan:
|
|
config:
|
|
schedule: "0 */6 * * *"
|
|
timeout: 300
|
|
snmp_timeout: 10
|
|
retries: 3
|
|
defaults:
|
|
site: "main"
|
|
scope:
|
|
targets:
|
|
- host: "10.0.0.0/24"
|
|
authentication:
|
|
protocol_version: "SNMPv2c"
|
|
community: "public"
|
|
# device_discovery:
|
|
# napalm_scan:
|
|
# config:
|
|
# schedule: "0 */12 * * *"
|
|
# defaults:
|
|
# site: "main"
|
|
# scope:
|
|
# - driver: ios
|
|
# hostname: 10.0.0.1
|
|
# username: admin
|
|
# password: admin
|
|
EOF
|
|
|
|
echo "==> Writing nginx.conf..."
|
|
mkdir -p "${SCRIPT_DIR}/nginx"
|
|
cat > "${SCRIPT_DIR}/nginx/nginx.conf" <<'NGINX_EOF'
|
|
worker_processes 1;
|
|
|
|
events {
|
|
worker_connections 1024;
|
|
}
|
|
|
|
http {
|
|
log_format main '$remote_addr - $remote_user [$time_local] "$request" '
|
|
'$status $body_bytes_sent "$http_referer" '
|
|
'"$http_user_agent"';
|
|
|
|
access_log /var/log/nginx/access.log main;
|
|
error_log /var/log/nginx/error.log warn;
|
|
|
|
upstream ingester_grpc {
|
|
server diode-ingester:8081;
|
|
}
|
|
|
|
upstream reconciler_grpc {
|
|
server diode-reconciler:8081;
|
|
}
|
|
|
|
upstream auth_grpc {
|
|
server diode-auth:8081;
|
|
}
|
|
|
|
server {
|
|
listen 8080 http2;
|
|
|
|
# Diode Ingester gRPC
|
|
location /diode.v1.IngesterService/ {
|
|
grpc_pass grpc://ingester_grpc;
|
|
}
|
|
|
|
# Diode Reconciler gRPC
|
|
location /diode.v1.ReconcilerService/ {
|
|
grpc_pass grpc://reconciler_grpc;
|
|
}
|
|
|
|
# Diode Auth gRPC
|
|
location /diode.v1.AuthService/ {
|
|
grpc_pass grpc://auth_grpc;
|
|
}
|
|
|
|
# Health check
|
|
location /health {
|
|
return 200 'OK';
|
|
add_header Content-Type text/plain;
|
|
}
|
|
}
|
|
}
|
|
NGINX_EOF
|
|
|
|
echo "==> Updating NetBox plugins.py..."
|
|
PLUGINS_FILE="${NETBOX_DOCKER_DIR}/configuration/plugins.py"
|
|
cat > "${PLUGINS_FILE}" <<EOF
|
|
PLUGINS = ["netbox_diode_plugin"]
|
|
|
|
PLUGINS_CONFIG = {
|
|
"netbox_diode_plugin": {
|
|
"diode_target_override": "grpc://${HOST_IP}:8080",
|
|
"diode_username": "admin",
|
|
"netbox_to_diode_client_secret": "${NETBOX_TO_DIODE_CLIENT_SECRET}",
|
|
}
|
|
}
|
|
EOF
|
|
|
|
echo "==> Creating NetBox Diode plugin Dockerfile..."
|
|
cat > "${NETBOX_DOCKER_DIR}/Dockerfile.diode-plugin" <<'DOCKERFILE_EOF'
|
|
FROM netboxcommunity/netbox:v4.5-4.0.1
|
|
|
|
# Install the Diode NetBox plugin
|
|
RUN /usr/local/bin/uv pip install --python /opt/netbox/venv/bin/python netboxlabs-diode-netbox-plugin==1.7.0
|
|
DOCKERFILE_EOF
|
|
|
|
echo "==> Updating NetBox docker-compose.override.yml..."
|
|
cat > "${NETBOX_DOCKER_DIR}/docker-compose.override.yml" <<'OVERRIDE_EOF'
|
|
services:
|
|
netbox: &netbox-override
|
|
build:
|
|
context: .
|
|
dockerfile: Dockerfile.diode-plugin
|
|
ports:
|
|
- "8000:8080"
|
|
environment:
|
|
SKIP_SUPERUSER: "false"
|
|
SUPERUSER_API_TOKEN: "0123456789abcdef0123456789abcdef01234567"
|
|
SUPERUSER_EMAIL: "admin@example.com"
|
|
SUPERUSER_NAME: "admin"
|
|
SUPERUSER_PASSWORD: "admin"
|
|
ALLOWED_HOSTS: "*"
|
|
extra_hosts:
|
|
- "host.docker.internal:host-gateway"
|
|
netbox-worker:
|
|
<<: *netbox-override
|
|
ports: []
|
|
OVERRIDE_EOF
|
|
|
|
echo ""
|
|
echo "============================================================"
|
|
echo " Setup complete!"
|
|
echo "============================================================"
|
|
echo ""
|
|
echo "Generated files:"
|
|
echo " ${SCRIPT_DIR}/.env"
|
|
echo " ${SCRIPT_DIR}/nginx/nginx.conf"
|
|
echo " ${SCRIPT_DIR}/oauth2/client/client-credentials.json"
|
|
echo " ${SCRIPT_DIR}/oauth2/client/bootstrap-clients.sh"
|
|
echo " ${SCRIPT_DIR}/orb-agent/agent.yaml"
|
|
echo " ${NETBOX_DOCKER_DIR}/Dockerfile.diode-plugin"
|
|
echo " ${NETBOX_DOCKER_DIR}/docker-compose.override.yml"
|
|
echo " ${NETBOX_DOCKER_DIR}/configuration/plugins.py"
|
|
echo ""
|
|
echo "Next steps:"
|
|
echo " 1. cd ${NETBOX_DOCKER_DIR} && docker compose build --no-cache && docker compose up -d"
|
|
echo " 2. docker compose exec netbox python /opt/netbox/netbox/manage.py migrate netbox_diode_plugin"
|
|
echo " 3. cd ${SCRIPT_DIR} && docker compose up -d"
|
|
echo ""
|