netbox-load-balancing 1.0.0__tar.gz

netbox_load_balancing-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andy Wilson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netbox_load_balancing-1.0.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: netbox-load-balancing
+Version: 1.0.0
+Summary: NetBox Load Balancing is a NetBox plugin that models a Load Balancing service based on the OpenStack SLB modelling
+Author-email: Andy Wilson <andy@shady.org>
+Project-URL: Homepage, https://github.com/andy-shady-org/netbox-load-balancing
+Project-URL: Documentation, https://github.com/andy-shady-org/netbox-load-balancing/blob/main/README.md
+Project-URL: Repository, https://github.com/andy-shady-org/netbox-load-balancing
+Project-URL: Issues, https://github.com/andy-shady-org/netbox-load-balancing/issues
+Keywords: netbox,netbox-plugin,load-balancing
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# NetBox Load Balancing Plugin
+[Netbox](https://github.com/netbox-community/netbox) plugin for Load Balancing related objects documentation.
+
+<div align="center">
+<a href="https://pypi.org/project/netbox-load-balancing/"><img src="https://img.shields.io/pypi/v/netbox-load-balancing" alt="PyPi"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/stargazers"><img src="https://img.shields.io/github/stars/andy-shady-org/netbox-load-balancing?style=flat" alt="Stars Badge"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/network/members"><img src="https://img.shields.io/github/forks/andy-shady-org/netbox-load-balancing?style=flat" alt="Forks Badge"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/issues"><img src="https://img.shields.io/github/issues/andy-shady-org/netbox-load-balancing" alt="Issues Badge"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/pulls"><img src="https://img.shields.io/github/issues-pr/andy-shady-org/netbox-load-balancing" alt="Pull Requests Badge"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/andy-shady-org/netbox-load-balancing?color=2b9348"></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/blob/master/LICENSE"><img src="https://img.shields.io/github/license/andy-shady-org/netbox-load-balancing?color=2b9348" alt="License Badge"/></a>
+<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style Black"/></a>
+<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads" src="https://static.pepy.tech/badge/netbox-load-balancing"></a>
+<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads/Week" src="https://static.pepy.tech/badge/netbox-load-balancing/month"></a>
+<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads/Month" src="https://static.pepy.tech/badge/netbox-load-balancing/week"></a>
+</div>
+
+
+## Features
+
+This plugin is based on the OpenStack modelling of [LBaaS](https://docs.openstack.org/mitaka/networking-guide/config-lbaas.html)
+
+This plugin provides following Models:
+
+* Services
+* Listeners
+* Health Monitors
+* Pools
+* Members
+
+## Compatibility
+
+|            |           |
+|------------|-----------|
+| NetBox 4.2 | \>= 1.0.2 |
+
+## Installation
+
+The plugin is available as a Python package in pypi and can be installed with pip  
+
+```
+pip install netbox-load-balancing
+```
+Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
+```
+PLUGINS = ['netbox_load_balancing']
+```
+Restart NetBox and add `netbox-load-balancing` to your local_requirements.txt
+
+Perform database migrations:
+```bash
+cd /opt/netbox
+source venv/bin/activate
+python ./netbox/manage.py migrate netbox_load_balancing
+python ./netbox/manage.py reindex netbox_load_balancing
+```
+
+Full documentation on using plugins with NetBox: [Using Plugins - NetBox Documentation](https://netbox.readthedocs.io/en/stable/plugins/)
+
+
+## Configuration
+
+The following options are available:
+* `service_ext_page`: String (default left) Service related objects table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
+* `pool_ext_page`: String (default left) Pool related objects table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
+* `member_ext_page`: String (default left) Member related objects table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
+* `monitor_ext_page`: String (default left) Health Monitor related objects table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
+* `top_level_menu`: Boolean (default True) Display plugin menu at the top level. The following values are available: True, False.
+
+
+## Contribute
+
+Contributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)
+
+
+## Documentation
+
+For further information, please refer to the full documentation: [Using NetBox Load Balancer](docs/using_netbox_load_balancing.md)
+
+
+## Credits
+
+- Thanks to Peter Eckel for providing some lovely examples which I've happily borrowed, and for providing excellent guidance.
+- Thanks to Gustavo Martinez for assisting with the high level modeling

netbox_load_balancing-1.0.0/README.md

@@ -0,0 +1,88 @@
+# NetBox Load Balancing Plugin
+[Netbox](https://github.com/netbox-community/netbox) plugin for Load Balancing related objects documentation.
+
+<div align="center">
+<a href="https://pypi.org/project/netbox-load-balancing/"><img src="https://img.shields.io/pypi/v/netbox-load-balancing" alt="PyPi"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/stargazers"><img src="https://img.shields.io/github/stars/andy-shady-org/netbox-load-balancing?style=flat" alt="Stars Badge"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/network/members"><img src="https://img.shields.io/github/forks/andy-shady-org/netbox-load-balancing?style=flat" alt="Forks Badge"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/issues"><img src="https://img.shields.io/github/issues/andy-shady-org/netbox-load-balancing" alt="Issues Badge"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/pulls"><img src="https://img.shields.io/github/issues-pr/andy-shady-org/netbox-load-balancing" alt="Pull Requests Badge"/></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/andy-shady-org/netbox-load-balancing?color=2b9348"></a>
+<a href="https://github.com/andy-shady-org/netbox-load-balancing/blob/master/LICENSE"><img src="https://img.shields.io/github/license/andy-shady-org/netbox-load-balancing?color=2b9348" alt="License Badge"/></a>
+<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style Black"/></a>
+<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads" src="https://static.pepy.tech/badge/netbox-load-balancing"></a>
+<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads/Week" src="https://static.pepy.tech/badge/netbox-load-balancing/month"></a>
+<a href="https://pepy.tech/project/netbox-load-balancing"><img alt="Downloads/Month" src="https://static.pepy.tech/badge/netbox-load-balancing/week"></a>
+</div>
+
+
+## Features
+
+This plugin is based on the OpenStack modelling of [LBaaS](https://docs.openstack.org/mitaka/networking-guide/config-lbaas.html)
+
+This plugin provides following Models:
+
+* Services
+* Listeners
+* Health Monitors
+* Pools
+* Members
+
+## Compatibility
+
+|            |           |
+|------------|-----------|
+| NetBox 4.2 | \>= 1.0.2 |
+
+## Installation
+
+The plugin is available as a Python package in pypi and can be installed with pip  
+
+```
+pip install netbox-load-balancing
+```
+Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
+```
+PLUGINS = ['netbox_load_balancing']
+```
+Restart NetBox and add `netbox-load-balancing` to your local_requirements.txt
+
+Perform database migrations:
+```bash
+cd /opt/netbox
+source venv/bin/activate
+python ./netbox/manage.py migrate netbox_load_balancing
+python ./netbox/manage.py reindex netbox_load_balancing
+```
+
+Full documentation on using plugins with NetBox: [Using Plugins - NetBox Documentation](https://netbox.readthedocs.io/en/stable/plugins/)
+
+
+## Configuration
+
+The following options are available:
+* `service_ext_page`: String (default left) Service related objects table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
+* `pool_ext_page`: String (default left) Pool related objects table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
+* `member_ext_page`: String (default left) Member related objects table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
+* `monitor_ext_page`: String (default left) Health Monitor related objects table position. The following values are available:  
+left, right, full_width. Set empty value for disable.
+* `top_level_menu`: Boolean (default True) Display plugin menu at the top level. The following values are available: True, False.
+
+
+## Contribute
+
+Contributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)
+
+
+## Documentation
+
+For further information, please refer to the full documentation: [Using NetBox Load Balancer](docs/using_netbox_load_balancing.md)
+
+
+## Credits
+
+- Thanks to Peter Eckel for providing some lovely examples which I've happily borrowed, and for providing excellent guidance.
+- Thanks to Gustavo Martinez for assisting with the high level modeling

netbox_load_balancing-1.0.0/netbox_load_balancing/__init__.py

@@ -0,0 +1,25 @@
+from django.utils.translation import gettext_lazy as _
+from netbox.plugins import PluginConfig
+from .version import __version__
+
+
+class LoadBalancingConfig(PluginConfig):
+    name = "netbox_load_balancing"
+    verbose_name = _("Netbox Load Balancing")
+    description = _("Subsystem for tracking Load Balancing Service related objects")
+    version = __version__
+    author = "Andy Wilson"
+    author_email = "andy@shady.org"
+    base_url = "netbox-load-balancing"
+    required_settings = []
+    min_version = "4.2.0"
+    default_settings = {
+        "top_level_menu": True,
+        "service_ext_page": "right",
+        "pool_ext_page": "right",
+        "member_ext_page": "right",
+        "monitor_ext_page": "right",
+    }
+
+
+config = LoadBalancingConfig  # noqa

netbox_load_balancing-1.0.0/netbox_load_balancing/api/serializers.py

@@ -0,0 +1,5 @@
+from .serializsers_.lbservice import *
+from .serializsers_.listener import *
+from .serializsers_.pool import *
+from .serializsers_.health_monitor import *
+from .serializsers_.member import *

netbox_load_balancing-1.0.0/netbox_load_balancing/api/serializsers_/health_monitor.py

@@ -0,0 +1,121 @@
+from django.contrib.contenttypes.models import ContentType
+from django.core.validators import MinValueValidator, MaxValueValidator
+from rest_framework.serializers import (
+    HyperlinkedIdentityField,
+    SerializerMethodField,
+    JSONField,
+    BooleanField,
+    IntegerField,
+    ChoiceField,
+    ListField,
+)
+from drf_spectacular.utils import extend_schema_field
+from netbox.api.fields import ContentTypeField
+from netbox.api.serializers import NetBoxModelSerializer
+from utilities.api import get_serializer_for_model
+
+from netbox_load_balancing.models import HealthMonitor, HealthMonitorAssignment
+from netbox_load_balancing.choices import (
+    HealthMonitorTypeChoices,
+    HealthMonitorHTTPVersionChoices,
+)
+
+
+class HealthMonitorSerializer(NetBoxModelSerializer):
+    url = HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_load_balancing-api:healthmonitor-detail"
+    )
+    type = ChoiceField(choices=HealthMonitorTypeChoices, required=False)
+    monitor_port = IntegerField(
+        required=True, validators=[MinValueValidator(1), MaxValueValidator(65534)]
+    )
+    http_version = ChoiceField(choices=HealthMonitorHTTPVersionChoices, required=False)
+    http_secure = BooleanField(required=False, default=False)
+    http_response_codes = ListField(
+        child=IntegerField(),
+        required=False,
+        allow_empty=True,
+        default=[],
+    )
+    probe_interval = IntegerField(required=False)
+    response_timeout = IntegerField(required=False)
+    disabled = BooleanField(required=False, default=False)
+
+    class Meta:
+        model = HealthMonitor
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "template",
+            "type",
+            "monitor_url",
+            "http_response",
+            "monitor_host",
+            "monitor_port",
+            "http_version",
+            "http_secure",
+            "http_response_codes",
+            "probe_interval",
+            "response_timeout",
+            "disabled",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "description",
+            "display",
+            "disabled",
+            "type",
+            "url",
+            "name",
+        )
+
+
+class HealthMonitorAssignmentSerializer(NetBoxModelSerializer):
+    monitor = HealthMonitorSerializer(nested=True, required=True, allow_null=False)
+    disabled = BooleanField(required=False, default=False)
+    weight = IntegerField(required=False, allow_null=True)
+    assigned_object_type = ContentTypeField(queryset=ContentType.objects.all())
+    assigned_object = SerializerMethodField(read_only=True)
+
+    class Meta:
+        model = HealthMonitorAssignment
+        fields = [
+            "id",
+            "url",
+            "display",
+            "monitor",
+            "weight",
+            "disabled",
+            "assigned_object_type",
+            "assigned_object_id",
+            "assigned_object",
+            "created",
+            "last_updated",
+        ]
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "monitor",
+            "weight",
+            "disabled",
+            "assigned_object_type",
+            "assigned_object_id",
+        )
+
+    @extend_schema_field(JSONField(allow_null=True))
+    def get_assigned_object(self, obj):
+        if obj.assigned_object is None:
+            return None
+        serializer = get_serializer_for_model(obj.assigned_object)
+        context = {"request": self.context["request"]}
+        return serializer(obj.assigned_object, nested=True, context=context).data

netbox_load_balancing-1.0.0/netbox_load_balancing/api/serializsers_/lbservice.py

@@ -0,0 +1,85 @@
+from django.contrib.contenttypes.models import ContentType
+from rest_framework.serializers import (
+    HyperlinkedIdentityField,
+    SerializerMethodField,
+    JSONField,
+    BooleanField,
+)
+from drf_spectacular.utils import extend_schema_field
+from netbox.api.fields import ContentTypeField
+from netbox.api.serializers import NetBoxModelSerializer
+from utilities.api import get_serializer_for_model
+from tenancy.api.serializers import TenantSerializer
+
+from netbox_load_balancing.models import LBService, LBServiceAssignment
+
+
+class LBServiceSerializer(NetBoxModelSerializer):
+    url = HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_load_balancing-api:lbservice-detail"
+    )
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+    disabled = BooleanField(required=False, default=False)
+
+    class Meta:
+        model = LBService
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "disabled",
+            "reference",
+            "description",
+            "tenant",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "description",
+            "display",
+            "disabled",
+            "name",
+            "reference",
+        )
+
+
+class LBServiceAssignmentSerializer(NetBoxModelSerializer):
+    service = LBServiceSerializer(nested=True, required=True, allow_null=False)
+    assigned_object_type = ContentTypeField(queryset=ContentType.objects.all())
+    assigned_object = SerializerMethodField(read_only=True)
+
+    class Meta:
+        model = LBServiceAssignment
+        fields = [
+            "id",
+            "url",
+            "display",
+            "service",
+            "assigned_object_type",
+            "assigned_object_id",
+            "assigned_object",
+            "created",
+            "last_updated",
+        ]
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "service",
+            "assigned_object_type",
+            "assigned_object_id",
+        )
+
+    @extend_schema_field(JSONField(allow_null=True))
+    def get_assigned_object(self, obj):
+        if obj.assigned_object is None:
+            return None
+        serializer = get_serializer_for_model(obj.assigned_object)
+        context = {"request": self.context["request"]}
+        return serializer(obj.assigned_object, nested=True, context=context).data

netbox_load_balancing-1.0.0/netbox_load_balancing/api/serializsers_/listener.py

@@ -0,0 +1,66 @@
+from rest_framework.serializers import (
+    HyperlinkedIdentityField,
+    BooleanField,
+    IntegerField,
+    ChoiceField,
+)
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_load_balancing.api.serializers import LBServiceSerializer
+from netbox_load_balancing.models import Listener
+from netbox_load_balancing.choices import ListenerProtocolChoices
+
+
+class ListenerSerializer(NetBoxModelSerializer):
+    url = HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_load_balancing-api:listener-detail"
+    )
+    service = LBServiceSerializer(nested=True, required=True, many=False)
+    port = IntegerField(required=True)
+    max_clients = IntegerField(required=False, default=0)
+    max_requests = IntegerField(required=False, default=0)
+    client_timeout = IntegerField(required=False, default=9000)
+    server_timeout = IntegerField(required=False, default=9000)
+    source_nat = BooleanField(required=False, default=True)
+    use_proxy_port = BooleanField(required=False, default=False)
+    client_keepalive = BooleanField(required=False, default=False)
+    surge_protection = BooleanField(required=False, default=False)
+    tcp_buffering = BooleanField(required=False, default=False)
+    compression = BooleanField(required=False, default=False)
+    protocol = ChoiceField(choices=ListenerProtocolChoices, required=False)
+
+    class Meta:
+        model = Listener
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "service",
+            "description",
+            "port",
+            "protocol",
+            "source_nat",
+            "use_proxy_port",
+            "max_clients",
+            "max_requests",
+            "client_timeout",
+            "server_timeout",
+            "client_keepalive",
+            "surge_protection",
+            "tcp_buffering",
+            "compression",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "description",
+            "display",
+            "name",
+            "port",
+        )

netbox_load_balancing-1.0.0/netbox_load_balancing/api/serializsers_/member.py

@@ -0,0 +1,92 @@
+from django.contrib.contenttypes.models import ContentType
+from rest_framework.serializers import (
+    HyperlinkedIdentityField,
+    SerializerMethodField,
+    JSONField,
+    BooleanField,
+    IntegerField,
+)
+from drf_spectacular.utils import extend_schema_field
+from netbox.api.fields import ContentTypeField
+from netbox.api.serializers import NetBoxModelSerializer
+from utilities.api import get_serializer_for_model
+from ipam.api.serializers import IPAddressSerializer
+
+from netbox_load_balancing.models import Member, MemberAssignment
+
+
+class MemberSerializer(NetBoxModelSerializer):
+    url = HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_load_balancing-api:member-detail"
+    )
+    ip_address = IPAddressSerializer(nested=True, required=True, many=False)
+    disabled = BooleanField(required=False, default=False)
+
+    class Meta:
+        model = Member
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "ip_address",
+            "description",
+            "reference",
+            "disabled",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "description",
+            "display",
+            "disabled",
+            "name",
+            "reference",
+        )
+
+
+class MemberAssignmentSerializer(NetBoxModelSerializer):
+    member = MemberSerializer(nested=True, required=True, allow_null=False)
+    disabled = BooleanField(required=False, default=False)
+    weight = IntegerField(required=False, allow_null=True)
+    assigned_object_type = ContentTypeField(queryset=ContentType.objects.all())
+    assigned_object = SerializerMethodField(read_only=True)
+
+    class Meta:
+        model = MemberAssignment
+        fields = [
+            "id",
+            "url",
+            "display",
+            "member",
+            "weight",
+            "disabled",
+            "assigned_object_type",
+            "assigned_object_id",
+            "assigned_object",
+            "created",
+            "last_updated",
+        ]
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "member",
+            "weight",
+            "disabled",
+            "assigned_object_type",
+            "assigned_object_id",
+        )
+
+    @extend_schema_field(JSONField(allow_null=True))
+    def get_assigned_object(self, obj):
+        if obj.assigned_object is None:
+            return None
+        serializer = get_serializer_for_model(obj.assigned_object)
+        context = {"request": self.context["request"]}
+        return serializer(obj.assigned_object, nested=True, context=context).data