diode-sdk-python/docs/examples/tunnel.py at develop · netboxlabs/diode-sdk-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
"""
Tunnel entity examples for the Diode Python SDK.

This module demonstrates three patterns for ingesting Tunnel entities:
- tunnel_minimal: Required fields only
- tunnel_extended: Common optional fields
- tunnel_explicit: Fully nested objects with all fields
"""

from netboxlabs.diode.sdk import DiodeClient
from netboxlabs.diode.sdk.ingester import (
    Entity,
    IKEPolicy,
    IPSecPolicy,
    IPSecProfile,
    Owner,
    OwnerGroup,
    Tag,
    Tenant,
    Tunnel,
    TunnelGroup,
)

TARGET = "grpc://localhost:8080/diode"
APP_NAME = "tunnel-example"
APP_VERSION = "1.0.0"
CLIENT_ID = "diode"
CLIENT_SECRET = "changeme"


def main():
    """Main execution - demonstrates ingesting a Tunnel entity."""
    with DiodeClient(
        target=TARGET,
        app_name=APP_NAME,
        app_version=APP_VERSION,
        client_id=CLIENT_ID,
        client_secret=CLIENT_SECRET,
    ) as client:
        # Choose one of the three patterns:
        tunnel = tunnel_minimal()
        # tunnel = tunnel_extended()
        # tunnel = tunnel_explicit()

        response = client.ingest(entities=[Entity(tunnel=tunnel)])
        if response.errors:
            print(f"Errors: {response.errors}")
        else:
            print("Tunnel ingested successfully")


def tunnel_minimal() -> Tunnel:
    """Create a Tunnel with only required fields using flat strings."""
    return Tunnel(
        name="Example Name",
        status="active",
        encapsulation="gre",
        metadata={"source": "example"},
    )


def tunnel_extended() -> Tunnel:
    """Create a Tunnel with common optional fields."""
    return Tunnel(
        name="Example Name",
        status="active",
        encapsulation="gre",
        metadata={"source": "example", "custom_key": "custom_value"},
        description="Example description",
        tenant="Example Tenant",
        tunnel_id=1,
        comments="Example comments",
    )


def tunnel_explicit() -> Tunnel:
    """Create a Tunnel with fully nested objects and all common fields."""
    return Tunnel(
        name="Example Name",
        status="active",
        encapsulation="gre",
        metadata={
            "source": "example",
            "custom_key": "custom_value",
            "collected_at": "2024-01-15T10:30:00Z",
        },
        description="Example description",
        comments="Example comments",
        tunnel_id=1,
        group=TunnelGroup(
            name="Example Name", slug="example-slug", metadata={"source": "example"}
        ),
        ipsec_profile=IPSecProfile(
            name="Example Name",
            mode="ah",
            ike_policy=IKEPolicy(
                name="Example Name", version=1, metadata={"source": "example"}
            ),
            ipsec_policy=IPSecPolicy(
                name="Example Name", metadata={"source": "example"}
            ),
            metadata={"source": "example"},
        ),
        tenant=Tenant(
            name="Example Name", slug="example-slug", metadata={"source": "example"}
        ),
        owner=Owner(
            name="Example Name",
            group=OwnerGroup(name="Example Name", metadata={"source": "example"}),
            metadata={"source": "example"},
        ),
        tags=[Tag(name="production")],
    )


if __name__ == "__main__":
    main()