feat(Tracing): Support tracing devices and their interconnections

Author: EntraptaJ

schemas/IPAM.json

@@ -1 +1 @@
-{"$schema":"http://json-schema.org/draft-07/schema#","definitions":{"community":{"type":"object","additionalProperties":false,"$id":"#community","description":"Community","properties":{"contact":{"type":"string","description":"Community Contact ID"},"name":{"type":"string","description":"Community Friendly Name"},"id":{"type":"string","description":"Short form community code","examples":["sxl"]},"sites":{"type":"array","items":{"$ref":"#/definitions/communitySite"}}},"required":["name","id","sites"]},"communitySite":{"type":"object","additionalProperties":false,"description":"Community Site","properties":{"id":{"type":"string","description":"Site short id"},"name":{"type":"string"},"devices":{"type":"array","items":{"$ref":"#/definitions/device"}}},"required":["id","name"]},"contact":{"type":"object","additionalProperties":false,"$id":"#contact","description":"Community Contact","properties":{"id":{"type":"string","description":"Unique contact ID"},"name":{"type":"string","description":"Contact Full Name"}},"required":["id","name"]},"device":{"type":"object","additionalProperties":false,"$id":"#device","description":"Network Device","properties":{"id":{"type":"string","description":"Chained ID"},"name":{"type":"string","description":"Friendly name"},"type":{"$ref":"#/definitions/networkDeviceType"}},"required":["id","name"]},"networkcircuit":{"type":"object","additionalProperties":false,"description":"NetworkCircuit","properties":{"id":{"type":"string","description":"Circuit Id"},"speed":{"type":"string","description":"Circuit Speed"}},"required":["id"]},"networkDeviceLink":{"type":"object","additionalProperties":false,"description":"Link a Network to a device","properties":{"id":{"type":"string","description":"Device id"},"interface":{"type":"string","description":"Device interface"}},"required":["id"]},"circuitLocation":{"type":"object","description":"Traditional external circuits","additionalProperties":false,"properties":{"id":{"type":"string","description":"External circuit id"},"provider":{"type":"string","description":"External circuit provider"},"communuity":{"type":"string","description":"Community ID"},"address":{"type":"string","description":"Address provided to external provider"},"demarcSpeed":{"type":"string","enum":["10M","100M","200M","300M","500M","1G","5G","10G"]}}},"circuit":{"type":"object","description":"Community Circuit","additionalProperties":false,"properties":{"id":{"type":"string","description":"Circuit ID"},"sideA":{"$ref":"#/definitions/circuitSide"},"sideZ":{"$ref":"#/definitions/circuitSide"},"speed":{"type":"string"}},"required":["id","sideA","sideZ"]},"circuitSide":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Circuit Location Id"}},"required":["id"]},"network":{"type":"object","additionalProperties":false,"description":"Network","properties":{"prefix":{"type":"string","description":"Network Prefix"},"description":{"type":"string"},"circuit":{"$ref":"#/definitions/networkcircuit"},"nsServers":{"type":"array","items":{"type":"string","description":"Reverse DNS NS Server","format":"hostname"}},"contactId":{"type":"string","description":"Contact ID"},"hosts":{"type":"array","items":{"$ref":"#/definitions/networkHost"}},"ranges":{"type":"array","items":{"$ref":"#/definitions/networkRange"}},"networks":{"type":"array","items":{"$ref":"#/definitions/network"},"uniqueItems":true,"description":"Children Networks"}}},"networkHost":{"type":"object","additionalProperties":false,"description":"Indivual Network host","properties":{"ip":{"type":"string","description":"Host IP Address","format":"ipv4"},"hostname":{"type":"string","description":"Hostname for reverse DNS creation","format":"hostname"},"description":{"type":"string"},"device":{"$ref":"#/definitions/networkDeviceLink"}},"required":["ip"]},"networkRange":{"type":"object","additionalProperties":false,"description":"Network Range","properties":{"start":{"type":"string","description":"Start IP for the range","format":"ipv4"},"end":{"type":"string","description":"End IP for the range","format":"ipv4"},"description":{"type":"string"},"type":{"type":"string","enum":["DHCP","RESERVED","STATIC"]}},"required":["start","end"]},"networkDeviceType":{"type":"string","enum":["router","switch","access-point","server","modem","firewall","UPS"]},"networkDeviceInterfaceType":{"type":"string","enum":["FastEthernet","GigabitEthernet","TenGigabitEthernet"]}},"type":"object","additionalProperties":false,"description":"IPAM Configuration File","properties":{"communities":{"type":"array","items":{"$ref":"#/definitions/community"}},"circuits":{"type":"array","items":{"$ref":"#/definitions/circuit"},"uniqueItems":true,"description":"Circuits"},"circuitLocations":{"type":"array","items":{"$ref":"#/definitions/circuitLocation"},"uniqueItems":true,"description":"External Circuits"},"contacts":{"type":"array","items":{"$ref":"#/definitions/contact"},"uniqueItems":true,"description":"Contact Information"},"networks":{"type":"array","items":{"$ref":"#/definitions/network"},"uniqueItems":true,"description":"Networks"}},"required":["communities","circuits","circuitLocations","contacts","networks"]}
+{"$schema":"http://json-schema.org/draft-07/schema#","definitions":{"community":{"type":"object","additionalProperties":false,"$id":"#community","description":"Community","properties":{"contact":{"type":"string","description":"Community Contact ID"},"name":{"type":"string","description":"Community Friendly Name"},"id":{"type":"string","description":"Short form community code","examples":["sxl"]},"sites":{"type":"array","items":{"$ref":"#/definitions/communitySite"}}},"required":["name","id","sites"]},"communitySite":{"type":"object","additionalProperties":false,"description":"Community Site","properties":{"id":{"type":"string","description":"Site short id"},"name":{"type":"string"},"devices":{"type":"array","items":{"$ref":"#/definitions/device"}}},"required":["id","name"]},"contact":{"type":"object","additionalProperties":false,"$id":"#contact","description":"Community Contact","properties":{"id":{"type":"string","description":"Unique contact ID"},"name":{"type":"string","description":"Contact Full Name"}},"required":["id","name"]},"device":{"type":"object","additionalProperties":false,"$id":"#device","description":"Network Device","properties":{"id":{"type":"string","description":"Chained ID"},"name":{"type":"string","description":"Friendly name"},"type":{"$ref":"#/definitions/networkDeviceType"}},"required":["id","name"]},"networkcircuit":{"type":"object","additionalProperties":false,"description":"NetworkCircuit","properties":{"id":{"type":"string","description":"Circuit Id"},"speed":{"type":"string","description":"Circuit Speed"}},"required":["id"]},"networkDeviceLink":{"type":"object","additionalProperties":false,"description":"Link a Network to a device","properties":{"id":{"type":"string","description":"Device id"},"interface":{"type":"string","description":"Device interface"}},"required":["id"]},"circuitLocation":{"type":"object","description":"Traditional external circuits","additionalProperties":false,"properties":{"id":{"type":"string","description":"External circuit id"},"provider":{"type":"string","description":"External circuit provider"},"communuity":{"type":"string","description":"Community ID"},"address":{"type":"string","description":"Address provided to external provider"},"demarcSpeed":{"type":"string","enum":["10M","100M","200M","300M","500M","1G","5G","10G"]}}},"circuit":{"type":"object","description":"Community Circuit","additionalProperties":false,"properties":{"id":{"type":"string","description":"Circuit ID"},"sideA":{"$ref":"#/definitions/circuitSide"},"sideZ":{"$ref":"#/definitions/circuitSide"},"speed":{"type":"string"}},"required":["id","sideA","sideZ"]},"circuitSide":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Circuit Location Id"}},"required":["id"]},"network":{"type":"object","additionalProperties":false,"description":"Network","properties":{"prefix":{"type":"string","description":"Network Prefix"},"description":{"type":"string"},"circuit":{"$ref":"#/definitions/networkcircuit"},"nsServers":{"type":"array","items":{"type":"string","description":"Reverse DNS NS Server","format":"hostname"}},"type":{"type":"string","description":"Network Type","enum":["UNALLOCATED","EXTERNAL"]},"contactId":{"type":"string","description":"Contact ID"},"hosts":{"type":"array","items":{"$ref":"#/definitions/networkHost"}},"ranges":{"type":"array","items":{"$ref":"#/definitions/networkRange"}},"networks":{"type":"array","items":{"$ref":"#/definitions/network"},"uniqueItems":true,"description":"Children Networks"}}},"networkHost":{"type":"object","additionalProperties":false,"description":"Indivual Network host","properties":{"ip":{"type":"string","description":"Host IP Address","format":"ipv4"},"hostname":{"type":"string","description":"Hostname for reverse DNS creation","format":"hostname"},"description":{"type":"string"},"device":{"$ref":"#/definitions/networkDeviceLink"}},"required":["ip"]},"networkRange":{"type":"object","additionalProperties":false,"description":"Network Range","properties":{"start":{"type":"string","description":"Start IP for the range","format":"ipv4"},"end":{"type":"string","description":"End IP for the range","format":"ipv4"},"description":{"type":"string"},"type":{"type":"string","enum":["DHCP","RESERVED","STATIC","FREE","unallocated"]}},"required":["start","end"]},"networkDeviceType":{"type":"string","enum":["router","switch","access-point","server","modem","firewall","UPS"]},"networkDeviceInterfaceType":{"type":"string","enum":["FastEthernet","GigabitEthernet","TenGigabitEthernet"]}},"type":"object","additionalProperties":false,"description":"IPAM Configuration File","properties":{"communities":{"type":"array","items":{"$ref":"#/definitions/community"}},"circuits":{"type":"array","items":{"$ref":"#/definitions/circuit"},"uniqueItems":true,"description":"Circuits"},"circuitLocations":{"type":"array","items":{"$ref":"#/definitions/circuitLocation"},"uniqueItems":true,"description":"External Circuits"},"contacts":{"type":"array","items":{"$ref":"#/definitions/contact"},"uniqueItems":true,"description":"Contact Information"},"networks":{"type":"array","items":{"$ref":"#/definitions/network"},"uniqueItems":true,"description":"Networks"}},"required":["communities","circuits","circuitLocations","contacts","networks"]}

src/Modules/IPAM/IPAMConfig.gen.ts

@@ -136,6 +136,10 @@ export interface Network {
   description?: string;
   circuit?: Networkcircuit;
   nsServers?: string[];
+  /**
+   * Network Type
+   */
+  type?: "UNALLOCATED" | "EXTERNAL";
   /**
    * Contact ID
    */
@@ -201,5 +205,5 @@ export interface NetworkRange {
    */
   end: string;
   description?: string;
-  type?: "DHCP" | "RESERVED" | "STATIC";
+  type?: "DHCP" | "RESERVED" | "STATIC" | "FREE" | "unallocated";
 }

src/Modules/IPAM/IPAMConfigController.ts

@@ -99,9 +99,21 @@ export class IPAMConfigController {
     });
   }
 
-  public processNetworkHosts(networkHosts: IPAMNetworkHost[]): NetworkHost[] {
+  public processNetworkHosts(
+    networkHosts: IPAMNetworkHost[],
+    parentNetwork: Network,
+  ): NetworkHost[] {
     return networkHosts.map((networkHostValue) => {
-      const networkHost = new NetworkHost(networkHostValue);
+      const networkHost = new NetworkHost({
+        ...networkHostValue,
+        parentNetworkId: parentNetwork.prefix,
+      });
+
+      Container.set({
+        id: `networkHost-${parentNetwork.prefix}`,
+        multiple: true,
+        value: networkHost,
+      });
 
       setContainer('NETWORK_HOST', networkHost.ip, networkHost);
 
@@ -121,15 +133,17 @@ export class IPAMConfigController {
           ? this.processNetworks(subNetworksValues)
           : [];
 
-        const hosts = hostsValue ? this.processNetworkHosts(hostsValue) : [];
-
         const network = new Network({
           circuitId: circuit?.id,
           networks: subNetworks,
-          hosts,
           ...networkValues,
         });
 
+        const hosts = hostsValue
+          ? this.processNetworkHosts(hostsValue, network)
+          : [];
+        logger.log(LogMode.DEBUG, 'hosts', hosts);
+
         setContainer('NETWORK', network.prefix, network);
 
         return [network, ...subNetworks];

src/Modules/NetworkDevices/NetworkDevice.ts

@@ -1,9 +1,10 @@
 // src/Modules/NetworkDevices/NetworkDevice.ts
-import { Service } from 'typedi';
+import Container, { Service } from 'typedi';
 import {
   Device as IPAMDevice,
   NetworkDeviceType,
 } from '../IPAM/IPAMConfig.gen';
+import { NetworkHost } from '../Networks/NetworkHost';
 
 @Service()
 export class NetworkDevice implements IPAMDevice {
@@ -13,6 +14,25 @@ export class NetworkDevice implements IPAMDevice {
 
   public type: NetworkDeviceType;
 
+  private deviceHosts: NetworkHost[];
+
+  public getDeviceHosts(): NetworkHost[] {
+    if (!this.deviceHosts) {
+      const deviceHosts = Container.getMany<NetworkHost>('NETWORK_HOST');
+      this.deviceHosts = deviceHosts.filter(
+        (deviceHost) => deviceHost.device?.id === this.id,
+      );
+    }
+
+    return this.deviceHosts;
+  }
+
+  public getAllIPs(): string[] {
+    return this.getDeviceHosts()
+      .map(({ device, ip }) => (device?.id === this.id ? ip : undefined))
+      .filter(Boolean) as string[];
+  }
+
   public constructor(options: Partial<NetworkDevice>) {
     Object.assign(this, options);
   }

src/Modules/Networks/Network.ts

@@ -21,10 +21,14 @@ export class Network implements IPAMNetwork {
 
   public networks?: Network[];
 
-  public hosts: NetworkHost[];
+  public get hosts(): NetworkHost[] {
+    return Container.getMany(`networkHost-${this.prefix}`);
+  }
 
   public contactId?: string;
 
+  public free?: boolean;
+
   public get contact(): Contact | undefined {
     if (this.contactId) {
       return Container.get(createContainerName('CONTACT', this.contactId));

src/Modules/Networks/NetworkHost.ts

@@ -6,6 +6,7 @@ import {
   NetworkHost as IPAMNetworkHost,
 } from '../IPAM/IPAMConfig.gen';
 import { NetworkDevice } from '../NetworkDevices/NetworkDevice';
+import { Network } from './Network';
 
 @Service()
 export class NetworkHost implements IPAMNetworkHost {
@@ -17,6 +18,12 @@ export class NetworkHost implements IPAMNetworkHost {
 
   public hostname?: string;
 
+  public parentNetworkId: string;
+
+  public get parentNetwork(): Network {
+    return Container.get(createContainerName('NETWORK', this.parentNetworkId));
+  }
+
   public get coreDevice(): NetworkDevice | undefined {
     if (this.device?.id) {
       return Container.get(createContainerName('SITE_DEVICE', this.device.id));

src/Modules/Networks/NetworkRangeType.ts

@@ -3,4 +3,6 @@ export enum NetworkRangeType {
   DHCP = 'DHCP',
   RESERVED = 'RESERVED',
   STATIC = 'STATIC',
+  FREE = 'FREE',
+  UNALLOCATED = 'unallocated',
 }

src/Modules/Networks/NetworkSchema.ts

@@ -1,5 +1,6 @@
 // src/Modues/Network/NetworkSchema.ts
 import jsonSchema from 'fluent-json-schema';
+import { NetworkType } from './NetworkType';
 
 export const networkSchema = jsonSchema
   .object()
@@ -19,6 +20,13 @@ export const networkSchema = jsonSchema
           .format(jsonSchema.FORMATS.HOSTNAME),
       ),
   )
+  .prop(
+    'type',
+    jsonSchema
+      .string()
+      .description(`Network Type`)
+      .enum(Object.values(NetworkType)),
+  )
   .prop('contactId', jsonSchema.string().description('Contact ID'))
   .prop(
     'hosts',

src/Modules/Networks/NetworkType.ts

@@ -0,0 +1,5 @@
+// src/Modules/Networks/NetworkType.ts
+export enum NetworkType {
+  UNALLOCATED = 'UNALLOCATED',
+  EXTERNAL = 'EXTERNAL',
+}

src/Utils/Containers.ts

@@ -42,5 +42,13 @@ export function setContainer<T extends keyof typeof ContainerKeys>(
   value: ValueTypes[T],
   container = Container,
 ): void {
+  if (key === 'NETWORK_HOST') {
+    container.set({
+      id: key,
+      value,
+      multiple: true,
+    });
+  }
+
   container.set(createContainerName(key, id), value);
 }