doc: Update configs

Signed-off-by: Stéphane Graber <stgraber@stgraber.org> Sponsored-by: Luizalabs (https://luizalabs.com)
lxc · Mar 25, 2024 · 886e616 · 886e616
1 parent 4587f85
commit 886e616
Show file tree

Hide file tree

Showing 2 changed files with 132 additions and 15 deletions.
diff --git a/doc/config_options.txt b/doc/config_options.txt
@@ -993,6 +993,60 @@ It is globally unique across all servers and projects.
 ```
 
 <!-- config group instance-volatile end -->
+<!-- config group network_integration-common start -->
+```{config:option} user.* network_integration-common
+:shortdesc: "Free form user key/value storage"
+:type: "string"
+User keys can be used in search.
+```
+
+<!-- config group network_integration-common end -->
+<!-- config group network_integration-ovn start -->
+```{config:option} ovn.ca_cert network_integration-ovn
+:scope: "global"
+:shortdesc: "OVN SSL certificate authority for the inter-connection database"
+:type: "string"
+
+```
+
+```{config:option} ovn.client_cert network_integration-ovn
+:scope: "global"
+:shortdesc: "OVN SSL client certificate"
+:type: "string"
+
+```
+
+```{config:option} ovn.client_key network_integration-ovn
+:scope: "global"
+:shortdesc: "OVN SSL client key"
+:type: "string"
+
+```
+
+```{config:option} ovn.northbound_connection network_integration-ovn
+:scope: "global"
+:shortdesc: "OVN northbound inter-connection connection string"
+:type: "string"
+
+```
+
+```{config:option} ovn.southbound_connection network_integration-ovn
+:scope: "global"
+:shortdesc: "OVN southbound inter-connection connection string"
+:type: "string"
+
+```
+
+```{config:option} ovn.transit.pattern network_integration-ovn
+:defaultdesc: "`ts-incus-{{ integrationName }}-{{ projectName }}-{{ networkname }}`"
+:shortdesc: "Template for the transit switch name"
+:type: "string"
+Specify a Pongo2 template string that represents the transit switch name.
+This template gets access to the project name (`projectName`), integration name (`integrationName`) and network name (`networkName`).
+
+```
+
+<!-- config group network_integration-ovn end -->
 <!-- config group project-features start -->
 ```{config:option} features.images project-features
 :defaultdesc: "`false`"
@@ -1266,6 +1320,12 @@ If this option is not set, all networks are accessible.
 Note that this setting depends on the {config:option}`project-restricted:restricted.devices.nic` setting.
 ```
 
+```{config:option} restricted.networks.integrations project-restricted
+:shortdesc: "Which network integrations can be used in this project"
+:type: "string"
+Specify a comma-delimited list of network integrations that can be used by networks in this project.
+```
+
 ```{config:option} restricted.networks.subnets project-restricted
 :defaultdesc: "`block`"
 :shortdesc: "Which network subnets are allocated for use in this project"
@@ -1837,11 +1897,4 @@ This value is required by some providers.
 
 ```
 
-```{config:option} openfga.store.model_id server-openfga
-:scope: "global"
-:shortdesc: "ID of the OpenFGA authorization model"
-:type: "string"
-
-```
-
 <!-- config group server-openfga end -->
diff --git a/internal/server/metadata/configuration.json b/internal/server/metadata/configuration.json
@@ -1079,6 +1079,71 @@
 				]
 			}
 		},
+		"network_integration": {
+			"common": {
+				"keys": [
+					{
+						"user.*": {
+							"longdesc": "User keys can be used in search.",
+							"shortdesc": "Free form user key/value storage",
+							"type": "string"
+						}
+					}
+				]
+			},
+			"ovn": {
+				"keys": [
+					{
+						"ovn.ca_cert": {
+							"longdesc": "",
+							"scope": "global",
+							"shortdesc": "OVN SSL certificate authority for the inter-connection database",
+							"type": "string"
+						}
+					},
+					{
+						"ovn.client_cert": {
+							"longdesc": "",
+							"scope": "global",
+							"shortdesc": "OVN SSL client certificate",
+							"type": "string"
+						}
+					},
+					{
+						"ovn.client_key": {
+							"longdesc": "",
+							"scope": "global",
+							"shortdesc": "OVN SSL client key",
+							"type": "string"
+						}
+					},
+					{
+						"ovn.northbound_connection": {
+							"longdesc": "",
+							"scope": "global",
+							"shortdesc": "OVN northbound inter-connection connection string",
+							"type": "string"
+						}
+					},
+					{
+						"ovn.southbound_connection": {
+							"longdesc": "",
+							"scope": "global",
+							"shortdesc": "OVN southbound inter-connection connection string",
+							"type": "string"
+						}
+					},
+					{
+						"ovn.transit.pattern": {
+							"defaultdesc": "`ts-incus-{{ integrationName }}-{{ projectName }}-{{ networkname }}`",
+							"longdesc": "Specify a Pongo2 template string that represents the transit switch name.\nThis template gets access to the project name (`projectName`), integration name (`integrationName`) and network name (`networkName`).\n",
+							"shortdesc": "Template for the transit switch name",
+							"type": "string"
+						}
+					}
+				]
+			}
+		},
 		"project": {
 			"features": {
 				"keys": [
@@ -1371,6 +1436,13 @@
 							"type": "string"
 						}
 					},
+					{
+						"restricted.networks.integrations": {
+							"longdesc": "Specify a comma-delimited list of network integrations that can be used by networks in this project.",
+							"shortdesc": "Which network integrations can be used in this project",
+							"type": "string"
+						}
+					},
 					{
 						"restricted.networks.subnets": {
 							"defaultdesc": "`block`",
@@ -2019,14 +2091,6 @@
 							"shortdesc": "ID of the OpenFGA permission store",
 							"type": "string"
 						}
-					},
-					{
-						"openfga.store.model_id": {
-							"longdesc": "",
-							"scope": "global",
-							"shortdesc": "ID of the OpenFGA authorization model",
-							"type": "string"
-						}
 					}
 				]
 			}