install/nomad: Add host network config option.

This enables users to configure the networking of the Waypoint server Nomad job to use a host network other than one named "default", for the gRPC and HTTP (UI) server ports.
hashicorp · Jun 13, 2023 · e2e5b7b · e2e5b7b
1 parent ed4b99d
commit e2e5b7b
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 6 deletions.
diff --git a/.changelog/4804.txt b/.changelog/4804.txt
diff --git a/internal/serverinstall/nomad.go b/internal/serverinstall/nomad.go
@@ -49,6 +49,7 @@ type nomadConfig struct {
 	serviceBackendTags []string `hcl:"service_backend_tags:optional"`
 	serviceAddress     string   `hcl:"service_address,optional"`
 	networkMode        string   `hcl:"network_mode,optional"`
+	hostNetwork        string   `hcl:"host_network,optional"`
 
 	consulService            bool     `hcl:"consul_service,optional"`
 	consulServiceUITags      []string `hcl:"consul_service_ui_tags:optional"`
@@ -908,20 +909,27 @@ func waypointNomadJob(c nomadConfig, rawRunFlags []string, upgrade bool) *api.Jo
 	}
 	tg.Services = services
 
+	hostNetwork := "default"
+	if c.hostNetwork != "" {
+		hostNetwork = c.hostNetwork
+	}
+
 	tg.Networks = []*api.NetworkResource{
 		{
 			Mode: c.networkMode,
 			// currently set to static; when ui command can be dynamic - update this
 			ReservedPorts: []api.Port{
 				{
-					Label: "ui",
-					Value: httpPort,
-					To:    httpPort,
+					Label:       "ui",
+					Value:       httpPort,
+					To:          httpPort,
+					HostNetwork: hostNetwork,
 				},
 				{
-					Label: "server",
-					To:    grpcPort,
-					Value: grpcPort,
+					Label:       "server",
+					To:          grpcPort,
+					Value:       grpcPort,
+					HostNetwork: hostNetwork,
 				},
 			},
 		},
@@ -1178,6 +1186,14 @@ func (i *NomadInstaller) InstallFlags(set *flag.Set) {
 		Default: "host",
 	})
 
+	set.StringVar(&flag.StringVar{
+		Name:   "nomad-host-network",
+		Target: &i.config.hostNetwork,
+		Usage: "Designates the host network name to use when allocating the" +
+			" ports of the Waypoint server.",
+		Default: "default",
+	})
+
 	set.StringVar(&flag.StringVar{
 		Name:   "nomad-odr-image",
 		Target: &i.config.odrImage,
@@ -1466,6 +1482,14 @@ func (i *NomadInstaller) UpgradeFlags(set *flag.Set) {
 		Default: "host",
 	})
 
+	set.StringVar(&flag.StringVar{
+		Name:   "nomad-host-network",
+		Target: &i.config.hostNetwork,
+		Usage: "Designates the host network name to use when allocating the" +
+			" ports of the Waypoint server.",
+		Default: "default",
+	})
+
 	set.StringVar(&flag.StringVar{
 		Name:   "nomad-odr-image",
 		Target: &i.config.odrImage,

diff --git a/website/content/commands/install.mdx b/website/content/commands/install.mdx
@@ -108,6 +108,7 @@ and disable the UI, the command would be:
 - `-nomad-host=<string>` - Hostname of the Nomad server to use, like for launching on-demand tasks. The default is http://localhost:4646.
 - `-nomad-namespace=<string>` - Namespace to install the Waypoint server into for Nomad. The default is default.
 - `-nomad-network-mode=<string>` - Nomad task group network mode. The default is host.
+- `-nomad-host-network=<string>` - Designates the host network name to use when allocating the ports of the Waypoint server. The default is default.
 - `-nomad-odr-image=<string>` - Docker image for the on-demand runners. If not specified, it defaults to the server image name + '-odr' (i.e. 'hashicorp/waypoint-odr:latest').
 - `-nomad-policy-override` - Override the Nomad sentinel policy for enterprise Nomad. The default is false.
 - `-nomad-region=<string>` - Region to install to for Nomad. The default is global.

diff --git a/website/content/commands/server-install.mdx b/website/content/commands/server-install.mdx
@@ -108,6 +108,7 @@ and disable the UI, the command would be:
 - `-nomad-host=<string>` - Hostname of the Nomad server to use, like for launching on-demand tasks. The default is http://localhost:4646.
 - `-nomad-namespace=<string>` - Namespace to install the Waypoint server into for Nomad. The default is default.
 - `-nomad-network-mode=<string>` - Nomad task group network mode. The default is host.
+- `-nomad-host-network=<string>` - Designates the host network name to use when allocating the ports of the Waypoint server. The default is default.
 - `-nomad-odr-image=<string>` - Docker image for the on-demand runners. If not specified, it defaults to the server image name + '-odr' (i.e. 'hashicorp/waypoint-odr:latest').
 - `-nomad-policy-override` - Override the Nomad sentinel policy for enterprise Nomad. The default is false.
 - `-nomad-region=<string>` - Region to install to for Nomad. The default is global.

diff --git a/website/content/commands/server-upgrade.mdx b/website/content/commands/server-upgrade.mdx
@@ -78,6 +78,7 @@ manually installed runners will not be automatically upgraded.
 - `-nomad-host=<string>` - Hostname of the Nomad server to use, like for launching on-demand tasks. The default is http://localhost:4646.
 - `-nomad-namespace=<string>` - Namespace to install the Waypoint server into for Nomad. The default is default.
 - `-nomad-network-mode=<string>` - Nomad task group network mode. The default is host.
+- `-nomad-host-network=<string>` - Designates the host network name to use when allocating the ports of the Waypoint server. The default is default.
 - `-nomad-odr-image=<string>` - Docker image for the on-demand runners. If not specified, it defaults to the server image name + '-odr' (i.e. 'hashicorp/waypoint-odr:latest').
 - `-nomad-policy-override` - Override the Nomad sentinel policy for enterprise Nomad. The default is false.
 - `-nomad-region=<string>` - Region to install to for Nomad. The default is global.