feat: add ARGO_DATAFLOW_UNIX_DOMAIN_SOCKET config (#335)

argoproj-labs · Sep 16, 2021 · 84bf124 · 84bf124
1 parent 4cb372e
commit 84bf124
Show file tree

Hide file tree

Showing 9 changed files with 234 additions and 266 deletions.
diff --git a/api/v1alpha1/const.go b/api/v1alpha1/const.go
@@ -18,8 +18,9 @@ const (
 	CtrSidecar = "sidecar"
 	// env vars
 	EnvCluster          = "ARGO_DATAFLOW_CLUSTER"
-	EnvDebug            = "ARGO_DATAFLOW_DEBUG"        // enable default mode, default "false"
-	EnvImagePrefix      = "ARGO_DATAFLOW_IMAGE_PREFIX" // default "quay.io/argoproj"
+	EnvDebug            = "ARGO_DATAFLOW_DEBUG"              // enable default mode, default "false"
+	EnvUnixDomainSocket = "ARGO_DATAFLOW_UNIX_DOMAIN_SOCKET" // use Unix Domain Socket, default "true"
+	EnvImagePrefix      = "ARGO_DATAFLOW_IMAGE_PREFIX"       // default "quay.io/argoproj"
 	EnvNamespace        = "ARGO_DATAFLOW_NAMESPACE"
 	EnvPipelineName     = "ARGO_DATAFLOW_PIPELINE_NAME"
 	EnvPod              = "ARGO_DATAFLOW_POD"

diff --git a/api/v1alpha1/generated.pb.go b/api/v1alpha1/generated.pb.go
diff --git a/api/v1alpha1/generated.proto b/api/v1alpha1/generated.proto
diff --git a/api/v1alpha1/get_pod_req.go b/api/v1alpha1/get_pod_req.go
@@ -8,7 +8,6 @@ import (
 
 type GetPodSpecReq struct {
 	Cluster          string                        `protobuf:"bytes,1,opt,name=cluster"`
-	Debug            bool                          `protobuf:"varint,2,opt,name=debug"`
 	PipelineName     string                        `protobuf:"bytes,3,opt,name=pipelineName"`
 	Replica          int32                         `protobuf:"varint,4,opt,name=replica"`
 	ImageFormat      string                        `protobuf:"bytes,5,opt,name=imageFormat"`

diff --git a/api/v1alpha1/step_types.go b/api/v1alpha1/step_types.go
@@ -100,7 +100,6 @@ func (in Step) GetPodSpec(req GetPodSpecReq) corev1.PodSpec {
 	step, _ := json.Marshal(in.withoutManagedFields())
 	envVars := []corev1.EnvVar{
 		{Name: EnvCluster, Value: req.Cluster},
-		{Name: EnvDebug, Value: strconv.FormatBool(req.Debug)},
 		{Name: EnvNamespace, ValueFrom: &corev1.EnvVarSource{FieldRef: &corev1.ObjectFieldSelector{FieldPath: "metadata.namespace"}}},
 		{Name: EnvPod, ValueFrom: &corev1.EnvVarSource{FieldRef: &corev1.ObjectFieldSelector{FieldPath: "metadata.name"}}},
 		{Name: EnvPipelineName, Value: req.PipelineName},
@@ -110,6 +109,12 @@ func (in Step) GetPodSpec(req GetPodSpecReq) corev1.PodSpec {
 		{Name: "GODEBUG", Value: os.Getenv("GODEBUG")},
 	}
 
+	for _, n := range []string{EnvDebug, EnvUnixDomainSocket} {
+		if value, ok := os.LookupEnv(EnvDebug); ok {
+			envVars = append(envVars, corev1.EnvVar{Name: n, Value: value})
+		}
+	}
+
 	// add all Jaeger envvar
 	for _, kv := range os.Environ() {
 		if strings.HasPrefix(kv, "JAEGER_") {

diff --git a/api/v1alpha1/step_types_test.go b/api/v1alpha1/step_types_test.go
@@ -18,7 +18,6 @@ func TestStep_GetPodSpec(t *testing.T) {
 		t.Run(fmt.Sprintf("Replica%d", replica), func(t *testing.T) {
 			env := []corev1.EnvVar{
 				{Name: "ARGO_DATAFLOW_CLUSTER", Value: "my-cluster"},
-				{Name: "ARGO_DATAFLOW_DEBUG", Value: "false"},
 				{Name: "ARGO_DATAFLOW_NAMESPACE", ValueFrom: &corev1.EnvVarSource{FieldRef: &corev1.ObjectFieldSelector{FieldPath: "metadata.namespace"}}},
 				{Name: "ARGO_DATAFLOW_POD", ValueFrom: &corev1.EnvVarSource{FieldRef: &corev1.ObjectFieldSelector{FieldPath: "metadata.name"}}},
 				{Name: "ARGO_DATAFLOW_PIPELINE_NAME", Value: "my-pl"},

diff --git a/manager/controllers/step_controller.go b/manager/controllers/step_controller.go
@@ -52,7 +52,6 @@ type StepReconciler struct {
 	ContainerKiller  containerkiller.Interface
 	DynamicInterface dynamic.Interface
 	Cluster          string
-	Debug            bool
 }
 
 type hash struct {
@@ -173,7 +172,6 @@ func (r *StepReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 				Spec: step.GetPodSpec(
 					dfv1.GetPodSpecReq{
 						Cluster:          r.Cluster,
-						Debug:            r.Debug,
 						PipelineName:     pipelineName,
 						Replica:          int32(replica),
 						ImageFormat:      imageFormat,

diff --git a/manager/main.go b/manager/main.go
@@ -91,7 +91,6 @@ func main() {
 		ContainerKiller:  containerKiller,
 		DynamicInterface: dynamicInterface,
 		Cluster:          os.Getenv(dfv1.EnvCluster),
-		Debug:            os.Getenv(dfv1.EnvDebug) == "true",
 	}).SetupWithManager(mgr); err != nil {
 		panic(fmt.Errorf("unable to create controller manager: %w", err))
 	}

diff --git a/runner/sidecar/in.go b/runner/sidecar/in.go
@@ -127,7 +127,7 @@ func waitReady(ctx context.Context) error {
 		case <-ctx.Done():
 			return fmt.Errorf("failed to wait for ready: %w", ctx.Err())
 		default:
-			if _, err := os.Stat(ipcSockPath); err == nil {
+			if _, err := os.Stat(ipcSockPath); os.Getenv(dfv1.EnvDebug) != "false" && err == nil {
 				logger.Info("switching to Unix socket", "path", ipcSockPath)
 				httpTransport.DialContext = func(ctx context.Context, network, addr string) (net.Conn, error) {
 					return (&net.Dialer{}).DialContext(ctx, "unix", ipcSockPath)