Skip to main content

NetBox SCION Plugin

The NetBox SCION Plugin is a comprehensive NetBox plugin developed by Anapaya for managing SCION infrastructure. This plugin extends NetBox with SCION-specific data models and workflows.

Overview​

The plugin provides management capabilities for SCION networks. It's designed for network operators running SCION-enabled infrastructure who need to:

  • Track and manage SCION infrastructure
  • Document SCION ASes and associated appliances
  • Manage SCION links

Use cases​

The NetBox SCION Plugin serves various operational needs for organizations managing SCION infrastructure:

  • Network documentation: Maintain a single source of truth for your SCION topology, including all ISD-ASes, their relationships, and associated appliances. This simplifies onboarding, network planning, troubleshooting, and compliance tracking.

  • Customer management: Track customer information alongside technical infrastructure and connect SCION links to support tickets

Deployment​

The plugin can be installed using either Docker or a system installation, depending on your NetBox deployment method.

For more detailed information, advanced configuration, and troubleshooting, access the GitHub Repository.

note

For comprehensive API documentation, including authentication methods, request/response examples, and Python code samples, see the API documentation.

Getting started​

Once the plugin is installed, you can access the SCION section from the NetBox sidebar. Here are common workflows to get you started:

Creating your SCION infrastructure​

  1. Create an Organization

    • Navigate to SCION → Organizations
    • Click Add and fill in the organization details (name, description)
    • Save the organization

  2. Add SCION ASes

    • Navigate to SCION → ISD-ASes
    • Click Add to create a new ISD-AS entry
    tip

    You can also click on the Add button from the Organization Details page

    • Specify the ISD-AS identifier, select the organization
    • Save the ISD-AS
    • Add the relevant Anapaya appliances from the Details page

  3. Configure SCION Links

    • Navigate to SCION → SCION Links
    • Click Add to create a new link
    tip

    You can also click on the Add button from the ISD-AS Details page

    • Define the interface details and connection information
    • Optionally add customer information and link to support tickets
    • Save the link

To reserve SCION links for planned deployments:

  1. Navigate to SCION → SCION Links and click Add
  2. Enter the planned link details (interface ID, peer, etc.)
  3. Set the status of the link to Reserved
  4. Add notes in the description field about the planned deployment date or purpose
  5. Update the link status and details once it becomes active

Feedback and Contributions​

We welcome feedback and contributions to improve the NetBox SCION Plugin:

  • Bug reports and Feature requests: If you encounter issues or have ideas for improvements, please open a GitHub Issue. For bugs, include detailed information about the problem, steps to reproduce, and your environment details. For feature requests, describe your use case.

  • Contributions: We accept pull requests! If you'd like to contribute code, documentation, or bug fixes, please submit a Pull Request on GitHub. Review the repository's contribution guidelines before submitting.