feat(network) use config api for network form help texts and defaults…

…, unify network form key handling WD-7391

Signed-off-by: David Edler <[email protected]>

src/pages/networks/forms/NetworkForm.tsx

@@ -10,6 +10,7 @@ import {
 import {
   LxdNetwork,
   LxdNetworkBridgeDriver,
+  LxdNetworkConfig,
   LxdNetworkDnsMode,
   LxdNetworkType,
 } from "types/network";
@@ -31,9 +32,9 @@ import NetworkFormDns from "pages/networks/forms/NetworkFormDns";
 import NetworkFormIpv4 from "pages/networks/forms/NetworkFormIpv4";
 import NetworkFormIpv6 from "pages/networks/forms/NetworkFormIpv6";
 import { slugify } from "util/slugify";
-import { handleConfigKeys } from "util/networkForm";
 import { useDocs } from "context/useDocs";
 import YamlConfirmation from "components/forms/YamlConfirmation";
+import { getHandledNetworkConfigKeys, getNetworkKey } from "util/networks";
 
 export interface NetworkFormValues {
   readOnly: boolean;
@@ -88,10 +89,12 @@ export const toNetwork = (values: NetworkFormValues): Partial<LxdNetwork> => {
     ),
   );
 
-  const excludeConfigKeys = new Set(handleConfigKeys);
+  const excludeConfigKeys = getHandledNetworkConfigKeys();
   const missingConfigFields = Object.fromEntries(
     Object.entries(values.bareNetwork?.config ?? {}).filter(
-      (e) => !excludeConfigKeys.has(e[0]) && !e[0].startsWith("volatile"),
+      (e) =>
+        !excludeConfigKeys.has(e[0] as keyof LxdNetworkConfig) &&
+        !e[0].startsWith("volatile"),
     ),
   );
 
@@ -102,30 +105,30 @@ export const toNetwork = (values: NetworkFormValues): Partial<LxdNetwork> => {
     type: values.networkType,
     config: {
       ...missingConfigFields,
-      ["bridge.driver"]: values.bridge_driver,
-      ["bridge.hwaddr"]: values.bridge_hwaddr,
-      ["bridge.mtu"]: values.bridge_mtu,
-      ["dns.domain"]: values.dns_domain,
-      ["dns.mode"]: values.dns_mode,
-      ["dns.search"]: values.dns_search,
-      ["ipv4.address"]: values.ipv4_address,
-      ["ipv4.dhcp"]: values.ipv4_dhcp,
-      ["ipv4.dhcp.expiry"]: values.ipv4_dhcp_expiry,
-      ["ipv4.dhcp.ranges"]: values.ipv4_dhcp_ranges,
-      ["ipv4.l3only"]: values.ipv4_l3only,
-      ["ipv4.nat"]: values.ipv4_nat,
-      ["ipv4.nat.address"]: values.ipv4_nat_address,
-      ["ipv4.ovn.ranges"]: values.ipv4_ovn_ranges,
-      ["ipv6.address"]: values.ipv6_address,
-      ["ipv6.dhcp"]: values.ipv6_dhcp,
-      ["ipv6.dhcp.expiry"]: values.ipv6_dhcp_expiry,
-      ["ipv6.dhcp.ranges"]: values.ipv6_dhcp_ranges,
-      ["ipv6.dhcp.stateful"]: values.ipv6_dhcp_stateful,
-      ["ipv6.l3only"]: values.ipv6_l3only,
-      ["ipv6.nat"]: values.ipv6_nat,
-      ["ipv6.nat.address"]: values.ipv6_nat_address,
-      ["ipv6.ovn.ranges"]: values.ipv6_ovn_ranges,
-      ["network"]: values.network,
+      [getNetworkKey("bridge_driver")]: values.bridge_driver,
+      [getNetworkKey("bridge_hwaddr")]: values.bridge_hwaddr,
+      [getNetworkKey("bridge_mtu")]: values.bridge_mtu,
+      [getNetworkKey("dns_domain")]: values.dns_domain,
+      [getNetworkKey("dns_mode")]: values.dns_mode,
+      [getNetworkKey("dns_search")]: values.dns_search,
+      [getNetworkKey("ipv4_address")]: values.ipv4_address,
+      [getNetworkKey("ipv4_dhcp")]: values.ipv4_dhcp,
+      [getNetworkKey("ipv4_dhcp_expiry")]: values.ipv4_dhcp_expiry,
+      [getNetworkKey("ipv4_dhcp_ranges")]: values.ipv4_dhcp_ranges,
+      [getNetworkKey("ipv4_l3only")]: values.ipv4_l3only,
+      [getNetworkKey("ipv4_nat")]: values.ipv4_nat,
+      [getNetworkKey("ipv4_nat_address")]: values.ipv4_nat_address,
+      [getNetworkKey("ipv4_ovn_ranges")]: values.ipv4_ovn_ranges,
+      [getNetworkKey("ipv6_address")]: values.ipv6_address,
+      [getNetworkKey("ipv6_dhcp")]: values.ipv6_dhcp,
+      [getNetworkKey("ipv6_dhcp_expiry")]: values.ipv6_dhcp_expiry,
+      [getNetworkKey("ipv6_dhcp_ranges")]: values.ipv6_dhcp_ranges,
+      [getNetworkKey("ipv6_dhcp_stateful")]: values.ipv6_dhcp_stateful,
+      [getNetworkKey("ipv6_l3only")]: values.ipv6_l3only,
+      [getNetworkKey("ipv6_nat")]: values.ipv6_nat,
+      [getNetworkKey("ipv6_nat_address")]: values.ipv6_nat_address,
+      [getNetworkKey("ipv6_ovn_ranges")]: values.ipv6_ovn_ranges,
+      [getNetworkKey("network")]: values.network,
     },
   };
 };

src/pages/networks/forms/NetworkFormBridge.tsx

@@ -17,7 +17,6 @@ const NetworkFormBridge: FC<Props> = ({ formik }) => {
           formik,
           name: "bridge_mtu",
           label: "MTU",
-          help: "Bridge MTU (default varies if tunnel or fan setup)",
           defaultValue: "",
           children: <Input type="text" />,
         }),
@@ -26,7 +25,6 @@ const NetworkFormBridge: FC<Props> = ({ formik }) => {
           formik,
           name: "bridge_hwaddr",
           label: "Hardware address",
-          help: "MAC address for the bridge",
           defaultValue: "",
           children: <Input type="text" />,
         }),
@@ -37,7 +35,6 @@ const NetworkFormBridge: FC<Props> = ({ formik }) => {
                 formik,
                 name: "bridge_driver",
                 label: "Bridge driver",
-                help: "Native or openvswitch",
                 defaultValue: "",
                 children: (
                   <Select

src/pages/networks/forms/NetworkFormDns.tsx

@@ -17,7 +17,6 @@ const NetworkFormDns: FC<Props> = ({ formik }) => {
           formik,
           name: "dns_domain",
           label: "DNS domain",
-          help: "Domain to advertise to DHCP clients and use for DNS resolution",
           defaultValue: "",
           children: <Input type="text" />,
         }),
@@ -60,7 +59,6 @@ const NetworkFormDns: FC<Props> = ({ formik }) => {
           formik,
           name: "dns_search",
           label: "DNS search",
-          help: "Full comma-separated domain search list, defaulting to DNS domain value",
           defaultValue: "",
           children: <Textarea />,
         }),

src/pages/networks/forms/NetworkFormIpv4.tsx

@@ -30,7 +30,6 @@ const NetworkFormIpv4: FC<Props> = ({ formik }) => {
                 formik,
                 name: "ipv4_dhcp_expiry",
                 label: "IPv4 DHCP expiry",
-                help: "When to expire DHCP leases",
                 defaultValue: "",
                 children: <Input type="text" />,
               }),
@@ -39,7 +38,6 @@ const NetworkFormIpv4: FC<Props> = ({ formik }) => {
                 formik,
                 name: "ipv4_dhcp_ranges",
                 label: "IPv4 DHCP ranges",
-                help: "Comma-separated list of IP ranges to use for DHCP (FIRST-LAST format)",
                 defaultValue: "",
                 children: <Textarea />,
               }),
@@ -64,7 +62,6 @@ const NetworkFormIpv4: FC<Props> = ({ formik }) => {
                 formik,
                 name: "ipv4_ovn_ranges",
                 label: "IPv4 OVN ranges",
-                help: "Comma-separated list of IPv4 ranges to use for child OVN network routers (FIRST-LAST format)",
                 defaultValue: "",
                 children: <Textarea />,
               }),

src/pages/networks/forms/NetworkFormIpv6.tsx

@@ -30,7 +30,6 @@ const NetworkFormIpv6: FC<Props> = ({ formik }) => {
                 formik,
                 name: "ipv6_dhcp_expiry",
                 label: "IPv6 DHCP expiry",
-                help: "When to expire DHCP leases",
                 defaultValue: "",
                 children: <Input type="text" />,
               }),
@@ -39,7 +38,6 @@ const NetworkFormIpv6: FC<Props> = ({ formik }) => {
                 formik,
                 name: "ipv6_dhcp_ranges",
                 label: "IPv6 DHCP ranges",
-                help: "Comma-separated list of IPv6 ranges to use for DHCP (FIRST-LAST format)",
                 defaultValue: "",
                 children: <Textarea />,
               }),
@@ -76,7 +74,6 @@ const NetworkFormIpv6: FC<Props> = ({ formik }) => {
                 formik,
                 name: "ipv6_ovn_ranges",
                 label: "IPv6 OVN ranges",
-                help: "Comma-separated list of IPv6 ranges to use for child OVN network routers (FIRST-LAST format)",
                 defaultValue: "",
                 children: <Textarea />,
               }),

src/pages/storage/forms/StorageVolumeFormMain.tsx

@@ -101,7 +101,6 @@ const StorageVolumeFormMain: FC<Props> = ({ formik, project }) => {
               label: "Security shifted",
               name: "security_shifted",
               defaultValue: "",
-              help: "Enable id shifting overlay (allows attach to multiple isolated instances)",
               disabled: formik.values.security_unmapped === "true",
               disabledReason:
                 "This setting can't be changed while security unmapped is set to true",
@@ -113,7 +112,6 @@ const StorageVolumeFormMain: FC<Props> = ({ formik, project }) => {
               label: "Security unmapped",
               name: "security_unmapped",
               defaultValue: "",
-              help: "Disable id mapping for the volume",
               disabled: formik.values.security_shifted === "true",
               disabledReason:
                 "This setting can't be changed while security shifted is set to true",

src/types/config.d.ts

@@ -27,6 +27,8 @@ export interface LxdConfigOptions {
   configs: {
     cluster: LxcConfigOptionCategories;
     instance: LxcConfigOptionCategories;
+    "network-bridge": LxcConfigOptionCategories;
+    "network-ovn": LxcConfigOptionCategories;
     project: LxcConfigOptionCategories;
     server: LxcConfigOptionCategories;
     "storage-btrfs": LxcConfigOptionCategories;

src/util/configInheritance.tsx

@@ -18,10 +18,11 @@ import { getProjectKey } from "util/projectConfigFields";
 import { StorageVolumeFormValues } from "pages/storage/forms/StorageVolumeForm";
 import { fetchStoragePool } from "api/storage-pools";
 import { getVolumeKey } from "util/storageVolume";
-import { getNetworkDefault } from "util/networks";
+import { getNetworkKey, networkFormTypeToOptionKey } from "util/networks";
 import { getPoolKey, storagePoolFormDriverToOptionKey } from "./storagePool";
 import { StoragePoolFormValues } from "pages/storage/forms/StoragePoolForm";
 import { useSupportedFeatures } from "context/useSupportedFeatures";
+import { NetworkFormValues } from "pages/networks/forms/NetworkForm";
 
 export interface ConfigRowMetadata {
   value?: string;
@@ -42,7 +43,7 @@ export const getConfigRowMetadata = (
     case "storageVolume":
       return getStorageVolumeRowMetadata(values, name);
     case "network":
-      return getNetworkRowMetadata(name);
+      return getNetworkRowMetadata(values, name);
     case "storagePool":
       return getStoragePoolRowMetadata(values, name);
   }
@@ -135,8 +136,23 @@ const getStorageVolumeRowMetadata = (
   return { value: lxdDefault, source: "LXD", configField };
 };
 
-const getNetworkRowMetadata = (name: string): ConfigRowMetadata => {
-  return getNetworkDefault(name);
+const getNetworkRowMetadata = (
+  values: NetworkFormValues,
+  name: string,
+): ConfigRowMetadata => {
+  const configOptions = getConfigOptions();
+
+  const optionKey = networkFormTypeToOptionKey(values.networkType);
+  const configFields = toConfigFields(configOptions?.configs[optionKey] ?? {});
+  const configKey = getNetworkKey(name);
+  const configField = configFields.find((item) => item.key === configKey);
+
+  const lxdDefault =
+    configField?.default && configField?.default.length > 0
+      ? configField?.default
+      : "-";
+
+  return { value: lxdDefault, source: "LXD", configField };
 };
 
 // NOTE: this is only relevant for Ceph RBD storage pools at the moment

src/util/networkForm.tsx

@@ -1,5 +1,10 @@
-import { LxdNetwork } from "types/network";
+import {
+  LxdNetwork,
+  LxdNetworkBridgeDriver,
+  LxdNetworkDnsMode,
+} from "types/network";
 import { NetworkFormValues } from "pages/networks/forms/NetworkForm";
+import { getNetworkKey } from "util/networks";
 
 export const toNetworkFormValues = (network: LxdNetwork): NetworkFormValues => {
   return {
@@ -8,62 +13,33 @@ export const toNetworkFormValues = (network: LxdNetwork): NetworkFormValues => {
     name: network.name,
     description: network.description,
     networkType: network.type,
-    bridge_driver: network.config["bridge.driver"],
-    bridge_hwaddr: network.config["bridge.hwaddr"],
-    bridge_mtu: network.config["bridge.mtu"],
-    dns_domain: network.config["dns.domain"],
-    dns_mode: network.config["dns.mode"],
-    dns_search: network.config["dns.search"],
-    ipv4_address: network.config["ipv4.address"],
-    ipv4_dhcp: network.config["ipv4.dhcp"],
-    ipv4_dhcp_expiry: network.config["ipv4.dhcp.expiry"],
-    ipv4_dhcp_ranges: network.config["ipv4.dhcp.ranges"],
-    ipv4_l3only: network.config["ipv4.l3only"],
-    ipv4_nat: network.config["ipv4.nat"],
-    ipv4_nat_address: network.config["ipv4.nat.address"],
-    ipv4_ovn_ranges: network.config["ipv4.ovn.ranges"],
-    ipv6_address: network.config["ipv6.address"],
-    ipv6_dhcp: network.config["ipv6.dhcp"],
-    ipv6_dhcp_expiry: network.config["ipv6.dhcp.expiry"],
-    ipv6_dhcp_ranges: network.config["ipv6.dhcp.ranges"],
-    ipv6_dhcp_stateful: network.config["ipv6.dhcp.stateful"],
-    ipv6_l3only: network.config["ipv6.l3only"],
-    ipv6_nat: network.config["ipv6.nat"],
-    ipv6_nat_address: network.config["ipv6.nat.address"],
-    ipv6_ovn_ranges: network.config["ipv6.ovn.ranges"],
+    bridge_driver: network.config[
+      getNetworkKey("bridge_driver")
+    ] as LxdNetworkBridgeDriver,
+    bridge_hwaddr: network.config[getNetworkKey("bridge_hwaddr")],
+    bridge_mtu: network.config[getNetworkKey("bridge_mtu")],
+    dns_domain: network.config[getNetworkKey("dns_domain")],
+    dns_mode: network.config[getNetworkKey("dns_mode")] as LxdNetworkDnsMode,
+    dns_search: network.config[getNetworkKey("dns_search")],
+    ipv4_address: network.config[getNetworkKey("ipv4_address")],
+    ipv4_dhcp: network.config[getNetworkKey("ipv4_dhcp")],
+    ipv4_dhcp_expiry: network.config[getNetworkKey("ipv4_dhcp_expiry")],
+    ipv4_dhcp_ranges: network.config[getNetworkKey("ipv4_dhcp_ranges")],
+    ipv4_l3only: network.config[getNetworkKey("ipv4_l3only")],
+    ipv4_nat: network.config[getNetworkKey("ipv4_nat")],
+    ipv4_nat_address: network.config[getNetworkKey("ipv4_nat_address")],
+    ipv4_ovn_ranges: network.config[getNetworkKey("ipv4_ovn_ranges")],
+    ipv6_address: network.config[getNetworkKey("ipv6_address")],
+    ipv6_dhcp: network.config[getNetworkKey("ipv6_dhcp")],
+    ipv6_dhcp_expiry: network.config[getNetworkKey("ipv6_dhcp_expiry")],
+    ipv6_dhcp_ranges: network.config[getNetworkKey("ipv6_dhcp_ranges")],
+    ipv6_dhcp_stateful: network.config[getNetworkKey("ipv6_dhcp_stateful")],
+    ipv6_l3only: network.config[getNetworkKey("ipv6_l3only")],
+    ipv6_nat: network.config[getNetworkKey("ipv6_nat")],
+    ipv6_nat_address: network.config[getNetworkKey("ipv6_nat_address")],
+    ipv6_ovn_ranges: network.config[getNetworkKey("ipv6_ovn_ranges")],
     network: network.config.network,
     entityType: "network",
     bareNetwork: network,
   };
 };
-
-export const handleConfigKeys = [
-  "bridge.driver",
-  "bridge.hwaddr",
-  "bridge.mode",
-  "bridge.mtu",
-  "dns.domain",
-  "dns.mode",
-  "dns.search",
-  "fan.type",
-  "fan.overlay_subnet",
-  "fan.underlay_subnet",
-  "ipv4.address",
-  "ipv4.dhcp",
-  "ipv4.dhcp.expiry",
-  "ipv4.dhcp.ranges",
-  "ipv4.l3only",
-  "ipv4.nat",
-  "ipv4.nat.address",
-  "ipv4.ovn.ranges",
-  "ipv6.address",
-  "ipv6.dhcp",
-  "ipv6.dhcpexpiry",
-  "ipv6.dhcp.ranges",
-  "ipv6.dhcp.stateful",
-  "ipv6.l3only",
-  "ipv6.nat",
-  "ipv6.nat.address",
-  "ipv6.ovn.ranges",
-  "network",
-];