netbox-scion 1.0.0

NetBox plugin for managing SCION Links Assignment

NetBox SCION Plugin

A comprehensive NetBox plugin for managing SCION (Scalability, Control, and Isolation On Next-generation networks) infrastructure.

🚀 Quick Start

Prerequisites

• NetBox deployment using netbox-docker
• Docker and Docker Compose

Installation

1. Copy the deployment files to your netbox-docker directory:

cp -r deployment/* /path/to/your/netbox-docker/

2. Update your docker-compose.yml to use the custom Dockerfile:

services:
  netbox:
    build:
      context: .
      dockerfile: Dockerfile.netbox-fixed

3. Add to your NetBox plugins.py file:

PLUGINS = [
    'netbox_scion',
    # Your existing plugins...
]

4. Add to your env/netbox.env:

PLUGINS_REQUIREMENTS=netbox_scion

5. Deploy:

cd /path/to/your/netbox-docker
docker-compose down
docker-compose build --no-cache netbox
docker-compose up -d

See deployment/README.md for detailed instructions.

🏗️ Features

Organizations

• Manage SCION organizations with short and full names
• Description and metadata fields
• REST API and export capabilities

ISD-ASes (Isolation Domain - Autonomous System)

• ISD-AS identifier management with regex validation (^\d+-[0-9a-f]{1,4}:[0-9a-f]{1,4}:[0-9a-f]{1,4}$)
• Organization association
• Core nodes list support
• Detailed descriptions

SCION Link Assignments

• Interface assignment management (interface_id per ISD-AS must be unique)
• Customer information (ID and name)
• Zendesk ticket integration
• Advanced filtering and search capabilities

🎯 Navigation

Plugin appears under the "Plugins" section in NetBox sidebar with:

• Organizations
• ISD-ASes
• SCION Link Assignments

🔧 API Endpoints

• Organizations: /api/plugins/scion/organizations/
• ISD-ASes: /api/plugins/scion/isd-ases/
• Link Assignments: /api/plugins/scion/link-assignments/

All endpoints support full CRUD operations with filtering, pagination, and export.

📁 Development

Project Structure

netbox_scion/
├── __init__.py              # Plugin configuration
├── models.py                # Data models
├── forms.py                 # Web forms
├── views.py                 # Web views
├── urls.py                  # URL routing
├── api/                     # REST API
├── templates/               # HTML templates
├── migrations/              # Database migrations
└── static/                  # CSS/JS assets

Local Development

# Install in development mode
pip install -e .

# Run migrations
python manage.py migrate

# Create wheel package
python setup.py bdist_wheel

🐛 Support

For issues, please check:

1. Plugin installation: docker exec netbox /opt/netbox/venv/bin/pip list | grep netbox-scion
2. Configuration: Plugin in PLUGINS list and PLUGINS_REQUIREMENTS
3. Migrations: Auto-handled by custom entrypoint script
4. Restart NetBox container if needed

📝 License

Apache License 2.0