OCPBUGS-61668: Support IPv6 address in rendezvous-host.env template

Previously when agent-tui filled this in as a template, an IPv6
rendezvous IP was not handled correctly.

Also, the Rendezvous IP needs to be canonicalized when the installer
fills in the template.

Author: zaneb

cmd/openshift-install/testdata/agent/unconfigured-ignition/configurations/interactive.txt

@@ -90,11 +90,12 @@ status:
   debugInfo:
     eventsURL: ""
 -- expected/rendezvous-host.env --
+#{{ $$isIPv6 := false }}{{ $$host := .RendezvousIP }}{{ range ( len .RendezvousIP ) }}{{if eq ( index ( slice $$host . ) 0 ) ':'}}{{ $$isIPv6 = true }}{{ end }}{{ end }}
 NODE_ZERO_IP={{.RendezvousIP}}
-SERVICE_BASE_URL=http://{{.RendezvousIP}}:8090/
-IMAGE_SERVICE_BASE_URL=http://{{.RendezvousIP}}:8888/
+SERVICE_BASE_URL=http://{{ if $$isIPv6 }}{{ printf "[%s]" .RendezvousIP }}{{ else }}{{ .RendezvousIP }}{{ end }}:8090/
+IMAGE_SERVICE_BASE_URL=http://{{ if $$isIPv6 }}{{ printf "[%s]" .RendezvousIP }}{{ else }}{{ .RendezvousIP }}{{ end }}:8888/
 PULL_SECRET_TOKEN=
 USER_AUTH_TOKEN=
 WORKFLOW_TYPE=install-interactive-disconnected
-AIUI_APP_API_URL=http://{{.RendezvousIP}}:8090/
-AIUI_URL=http://{{.RendezvousIP}}:3001/
+AIUI_APP_API_URL=http://{{ if $$isIPv6 }}{{ printf "[%s]" .RendezvousIP }}{{ else }}{{ .RendezvousIP }}{{ end }}:8090/
+AIUI_URL=http://{{ if $$isIPv6 }}{{ printf "[%s]" .RendezvousIP }}{{ else }}{{ .RendezvousIP }}{{ end }}:3001/

pkg/asset/agent/image/ignition.go

@@ -1,12 +1,12 @@
 package image
 
 import (
+	"bytes"
 	"context"
 	"encoding/json"
 	"fmt"
 	"html/template"
 	"net"
-	"net/url"
 	"path"
 	"path/filepath"
 	"strings"
@@ -449,7 +449,7 @@ func getTemplateData(name, pullSecret, releaseImageList, releaseImage, releaseIm
 }
 
 func getRendezvousHostEnvTemplate(serviceProtocol, agentAuthtoken, userAuthToken string, workflowType workflow.AgentWorkflowType) string {
-	host := "{{.RendezvousIP}}"
+	host := "{{ if $isIPv6 }}{{ printf \"[%s]\" .RendezvousIP }}{{ else }}{{ .RendezvousIP }}{{ end }}"
 	serviceBaseURL := fmt.Sprintf("%s://%s:8090/", serviceProtocol, host)
 	imageServiceBaseURL := fmt.Sprintf("%s://%s:8888/", serviceProtocol, host)
 	uiBaseURL := fmt.Sprintf("%s://%s:3001/", serviceProtocol, host)
@@ -466,7 +466,8 @@ func getRendezvousHostEnvTemplate(serviceProtocol, agentAuthtoken, userAuthToken
 	// and ensure successful authentication.
 	// In the absence of PULL_SECRET_TOKEN, the cluster installation will wait forever.
 
-	rendezvousHostEnvTemplate := fmt.Sprintf(`NODE_ZERO_IP={{.RendezvousIP}}
+	rendezvousHostEnvTemplate := fmt.Sprintf(`#{{ $isIPv6 := false }}{{ $host := .RendezvousIP }}{{ range ( len .RendezvousIP ) }}{{if eq ( index ( slice $host . ) 0 ) ':'}}{{ $isIPv6 = true }}{{ end }}{{ end }}
+NODE_ZERO_IP={{.RendezvousIP}}
 SERVICE_BASE_URL=%s
 IMAGE_SERVICE_BASE_URL=%s
 PULL_SECRET_TOKEN=%s
@@ -479,45 +480,26 @@ AIUI_URL=%s
 	return rendezvousHostEnvTemplate
 }
 
-func getRendezvousHostEnv(serviceProtocol, nodeZeroIP, agentAuthtoken, userAuthToken string, workflowType workflow.AgentWorkflowType) string {
-	serviceBaseURL := url.URL{
-		Scheme: serviceProtocol,
-		Host:   net.JoinHostPort(nodeZeroIP, "8090"),
-		Path:   "/",
-	}
-	imageServiceBaseURL := url.URL{
-		Scheme: serviceProtocol,
-		Host:   net.JoinHostPort(nodeZeroIP, "8888"),
-		Path:   "/",
+func getRendezvousHostEnvFromTemplate(hostEnvTemplate, nodeZeroIP string) (string, error) {
+	tmpl, err := template.New("rendezvous-host.env").Parse(hostEnvTemplate)
+	if err != nil {
+		return "", err
 	}
-	uiBaseURL := url.URL{
-		Scheme: serviceProtocol,
-		Host:   net.JoinHostPort(nodeZeroIP, "3001"),
-		Path:   "/",
+	buf := &bytes.Buffer{}
+	if err := tmpl.Execute(buf, struct{ RendezvousIP string }{nodeZeroIP}); err != nil {
+		return "", err
 	}
-	// USER_AUTH_TOKEN is required to authenticate API requests against agent-installer-local auth type
-	// and for the endpoints marked with userAuth security definition in assisted-service swagger.yaml.
-	// PULL_SECRET_TOKEN contains the AGENT_AUTH_TOKEN and is required for the endpoints marked with agentAuth security definition in assisted-service swagger.yaml.
-	// The name PULL_SECRET_TOKEN is used in
-	// assisted-installer-agent, which is responsible for authenticating API requests related to agents.
-	// Historically, PULL_SECRET_TOKEN was used solely to store the pull secrets.
-	// However, as the authentication mechanisms have evolved, PULL_SECRET_TOKEN now
-	// stores a JWT (JSON Web Token) in the context of local authentication.
-	// Consequently, PULL_SECRET_TOKEN must be set with the value of AGENT_AUTH_TOKEN to maintain compatibility
-	// and ensure successful authentication.
-	// In the absence of PULL_SECRET_TOKEN, the cluster installation will wait forever.
-
-	rendezvousHostEnv := fmt.Sprintf(`NODE_ZERO_IP=%s
-SERVICE_BASE_URL=%s
-IMAGE_SERVICE_BASE_URL=%s
-PULL_SECRET_TOKEN=%s
-USER_AUTH_TOKEN=%s
-WORKFLOW_TYPE=%s
-AIUI_APP_API_URL=%s
-AIUI_URL=%s
-`, nodeZeroIP, serviceBaseURL.String(), imageServiceBaseURL.String(), agentAuthtoken, userAuthToken, workflowType, serviceBaseURL.String(), uiBaseURL.String())
+	return buf.String(), nil
+}
 
-	return rendezvousHostEnv
+func getRendezvousHostEnv(serviceProtocol, nodeZeroIP, agentAuthtoken, userAuthToken string, workflowType workflow.AgentWorkflowType) string {
+	env, err := getRendezvousHostEnvFromTemplate(
+		getRendezvousHostEnvTemplate(serviceProtocol, agentAuthtoken, userAuthToken, workflowType),
+		nodeZeroIP)
+	if err != nil {
+		panic(err)
+	}
+	return env
 }
 
 func getAddNodesEnv(clusterInfo joiner.ClusterInfo, authTokenExpiry string) string {

pkg/asset/agent/image/ignition_test.go

@@ -126,7 +126,7 @@ func TestIgnition_getRendezvousHostEnv(t *testing.T) {
 	userAuthToken := "userAuthToken"
 	rendezvousHostEnv := getRendezvousHostEnv("http", nodeZeroIP, agentAuthtoken, userAuthToken, workflow.AgentWorkflowTypeInstall)
 	assert.Equal(t,
-		"NODE_ZERO_IP="+nodeZeroIP+"\nSERVICE_BASE_URL=http://["+nodeZeroIP+"]:8090/\nIMAGE_SERVICE_BASE_URL=http://["+nodeZeroIP+"]:8888/\nPULL_SECRET_TOKEN="+agentAuthtoken+"\nUSER_AUTH_TOKEN="+userAuthToken+"\nWORKFLOW_TYPE=install\nAIUI_APP_API_URL=http://["+nodeZeroIP+"]:8090/\nAIUI_URL=http://["+nodeZeroIP+"]:3001/\n",
+		"#\nNODE_ZERO_IP="+nodeZeroIP+"\nSERVICE_BASE_URL=http://["+nodeZeroIP+"]:8090/\nIMAGE_SERVICE_BASE_URL=http://["+nodeZeroIP+"]:8888/\nPULL_SECRET_TOKEN="+agentAuthtoken+"\nUSER_AUTH_TOKEN="+userAuthToken+"\nWORKFLOW_TYPE=install\nAIUI_APP_API_URL=http://["+nodeZeroIP+"]:8090/\nAIUI_URL=http://["+nodeZeroIP+"]:3001/\n",
 		rendezvousHostEnv)
 }
 

pkg/asset/agent/image/unconfigured_ignition.go

@@ -178,12 +178,9 @@ func (a *UnconfiguredIgnition) Generate(_ context.Context, dependencies asset.Pa
 	case workflow.AgentWorkflowTypeInstallInteractiveDisconnected:
 		// Add the rendezvous host file. Agent TUI will interact with that file in case
 		// the rendezvous IP wasn't previously configured, by managing it as a template file.
-		var rendezvousIP, rendezvousHostData string
-		if agentConfig.Config != nil {
-			rendezvousIP = agentConfig.Config.RendezvousIP
-		}
-		if rendezvousIP != "" {
-			rendezvousHostData, err := getRendezvousHostEnv("http", rendezvousIP, "", "", agentWorkflow.Workflow)
+		var rendezvousHostData string
+		if rendezvousIP, err := RetrieveRendezvousIP(agentConfig.Config, nil, nil); err == nil {
+			rendezvousHostData, err := getRendezvousHostEnvFromTemplate(rendezvousHostTemplateData, rendezvousIP)
 			if err != nil {
 				return err
 			}