feat: use webui API in NMS (#619)

canonical · Aug 2, 2024 · 672d7f5 · 672d7f5
1 parent 9d699a0
commit 672d7f5
Show file tree

Hide file tree

Showing 41 changed files with 359 additions and 1,198 deletions.
diff --git a/README.md b/README.md
@@ -1,21 +1,17 @@
-# SD-Core NMS
+# Aether SD-Core NMS
 
-A Network Management System for managing the SD-Core 5G core network.
+A Network Management System for managing the Aether SD-Core 5G core network.
 
 ![Screenshot](images/nms_screenshot.png)
 
 ## Usage
 
 NMS needs to be configured with the following environment variables:
-- `WEBUI_ENDPOINT`: The endpoint of the webui. This is used to redirect the user to the webui.
-- `UPF_CONFIG_PATH`: The path to the UPF configuration file. An example of this file can be seen in the `examples/` directory.
-- `GNB_CONFIG_PATH`: The path to the gNodeB configuration file. An example of this file can be seen in the `examples/` directory.
+- `WEBUI_ENDPOINT`: The endpoint of the webui. This is used to redirect the swagger operations to the webui.
 
 ```console
-export WEBUI_ENDPOINT=http://10.1.182.28:5000
-export UPF_CONFIG_PATH=/path/to/upf_config.json
-export GNB_CONFIG_PATH=/path/to/gnb_config.json
+export WEBUI_ENDPOINT=10.1.182.28:5000
 
 docker pull ghcr.io/canonical/sdcore-nms:0.2.0
-docker run -it --env UPF_CONFIG_PATH --env GNB_CONFIG_PATH --env WEBUI_ENDPOINT ghcr.io/canonical/sdcore-nms:0.2.0
+docker run -it --env WEBUI_ENDPOINT ghcr.io/canonical/sdcore-nms:0.2.0
 ```
diff --git a/app/(api)/api/page.tsx b/app/(api)/api/page.tsx
@@ -13,7 +13,7 @@ export default function IndexPage() {
 
   useEffect(() => {
     async function fetchSpecs() {
-      const response = await fetch("/api/getSwaggerDocs");
+      const response = await fetch("swagger/doc.json");
 
       if (response.ok) {
         const fetchedSpec = await response.json();

diff --git a/app/(network)/layout.tsx b/app/(network)/layout.tsx
@@ -34,7 +34,7 @@ export default function RootLayout({
   return (
     <html lang="en">
       <head>
-        <title>SD Core</title>
+        <title>Aether SD-Core</title>
         <link
           rel="shortcut icon"
           href="https://assets.ubuntu.com/v1/49a1a858-favicon-32x32.png"

diff --git a/app/layout.tsx b/app/layout.tsx
@@ -1,8 +1,8 @@
 import type { Metadata } from "next";
 
 export const metadata: Metadata = {
-  title: "SD Core",
-  description: "SD Core NMS",
+  title: "Aether SD-Core",
+  description: "Aether SD-Core NMS",
 };
 
 export default function RootLayout({

diff --git a/app/page.tsx b/app/page.tsx
@@ -1 +1,14 @@
-export default function Page() {}
+'use client';
+
+import { useEffect } from 'react';
+import { useRouter } from 'next/navigation';
+
+export default function Home() {
+  const router = useRouter();
+
+  useEffect(() => {
+    router.replace('/network-configuration');
+  }, [router]);
+
+  return null;
+}
diff --git a/components/DeleteSubscriberButton.tsx b/components/DeleteSubscriberButton.tsx
diff --git a/components/Navigation.tsx b/components/Navigation.tsx
@@ -1,4 +1,4 @@
-import React, { FC, MouseEvent, useEffect, useState } from "react";
+import React, { FC, MouseEvent, useState } from "react";
 import { Button, Icon } from "@canonical/react-components";
 import classnames from "classnames";
 import Logo from "./Logo";
@@ -103,8 +103,7 @@ const Navigation: FC = () => {
                   <li className="p-side-navigation__item">
                     <a
                       className="p-side-navigation__link"
-                      href="/api"
-                      target="_blank"
+                      href="#"
                       rel="noreferrer"
                       title="API"
                     >

diff --git a/examples/gnb_config.json b/examples/gnb_config.json
diff --git a/examples/upf_config.json b/examples/upf_config.json
diff --git a/next.config.js b/next.config.js
@@ -1,16 +1,6 @@
-module.exports = {
-  async redirects() {
-    return [
-      {
-        source: '/',
-        destination: '/network-configuration',
-        permanent: true,
-      },
-    ];
-  },
-  env: {
-    UPF_CONFIG_PATH: process.env.UPF_CONFIG_PATH,
-    GNB_CONFIG_PATH: process.env.GNB_CONFIG_PATH,
-    WEBUI_ENDPOINT: process.env.WEBUI_ENDPOINT,
-  },
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  output: 'export',
 };
+
+module.exports = nextConfig;
diff --git a/pages/api/device-group/[name].ts b/pages/api/device-group/[name].ts
diff --git a/pages/api/device-group/index.ts b/pages/api/device-group/index.ts
diff --git a/pages/api/getSwaggerDocs.ts b/pages/api/getSwaggerDocs.ts