make cluster domain configurable (#318)

Author: DeliangFan

controllers/flinkcluster_util.go

@@ -29,6 +29,7 @@ import (
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
+	"os"
 	"strconv"
 	"strings"
 	"time"
@@ -67,10 +68,16 @@ type objectMetaForPatch struct {
 }
 
 func getFlinkAPIBaseURL(cluster *v1beta1.FlinkCluster) string {
+	clusterDomain := os.Getenv("CLUSTER_DOMAIN")
+	if clusterDomain == "" {
+		clusterDomain = "cluster.local"
+	}
+
 	return fmt.Sprintf(
-		"http://%s.%s.svc.cluster.local:%d",
+		"http://%s.%s.svc.%s:%d",
 		getJobManagerServiceName(cluster.ObjectMeta.Name),
 		cluster.ObjectMeta.Namespace,
+		clusterDomain,
 		*cluster.Spec.JobManager.Ports.UI)
 }
 

controllers/flinkcluster_util_test.go

@@ -25,6 +25,7 @@ import (
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
+	"os"
 	"testing"
 	"time"
 
@@ -528,3 +529,27 @@ func TestHasTimeElapsed(t *testing.T) {
 	elapsed = hasTimeElapsed(timeToCheckStr, timeToCompare, 30)
 	assert.Equal(t, elapsed, false)
 }
+
+func TestGetFlinkAPIBaseURL(t *testing.T) {
+	var uiPort int32 = 8004
+	var cluster = v1beta1.FlinkCluster{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "mycluster",
+			Namespace: "default",
+		},
+		Spec: v1beta1.FlinkClusterSpec{
+			JobManager: v1beta1.JobManagerSpec{
+				Ports: v1beta1.JobManagerPorts{
+					UI: &uiPort,
+				},
+			},
+		},
+	}
+
+	var apiBaseURL = getFlinkAPIBaseURL(&cluster)
+	assert.Equal(t, apiBaseURL, "http://mycluster-jobmanager.default.svc.cluster.local:8004")
+
+	os.Setenv("CLUSTER_DOMAIN", "my.domain")
+	apiBaseURL = getFlinkAPIBaseURL(&cluster)
+	assert.Equal(t, apiBaseURL, "http://mycluster-jobmanager.default.svc.my.domain:8004")
+}

docs/user_guide.md

@@ -77,6 +77,8 @@ following 2 ways:
   Follow the [Helm Chart Installation Guide](../helm-chart/flink-operator/README.md) to
   install the operator through Helm Chart.
 
+Note, for kubernetes cluster with private cluster domain, you should add a CLUSTER\_DOMAIN environment to the operator deployment.
+
 ## Verify the deployment
 
 After deploying the operator, you can verify CRD `flinkclusters.flinkoperator.k8s.io`