NE-2117: Add httpsLogFormat and tcpLogFormat to API

rohara · rohara · commit fa41c9dd2b8e · 2026-03-19T18:22:14.000-05:00
diff --git a/features.md b/features.md
@@ -64,6 +64,7 @@
 | GCPCustomAPIEndpointsInstall| | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span>  |
 | GCPDualStackInstall| | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span>  |
 | GatewayAPIWithoutOLM| | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span>  |
+| HTTPSLogFormat| | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span>  |
 | HyperShiftOnlyDynamicResourceAllocation| <span style="background-color: #519450">Enabled</span> | | <span style="background-color: #519450">Enabled</span> | | <span style="background-color: #519450">Enabled</span> | | <span style="background-color: #519450">Enabled</span> |  |
 | ImageModeStatusReporting| | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span>  |
 | IngressControllerDynamicConfigurationManager| | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span> | | | <span style="background-color: #519450">Enabled</span> | <span style="background-color: #519450">Enabled</span>  |
diff --git a/features/features.go b/features/features.go
@@ -1020,4 +1020,12 @@ var (
 				enhancementPR("https://github.com/openshift/enhancements/pull/1910").
 				enable(inDevPreviewNoUpgrade(), inTechPreviewNoUpgrade()).
 				mustRegister()
+
+	FeatureGateHTTPSLogFormat = newFeatureGate("HTTPSLogFormat").
+				  reportProblemsToJiraComponent("Networking/router").
+				  contactPerson("rohara").
+		                  productScope(ocpSpecific).
+		                  enhancementPR("https://github.com/openshift/enhancements/pull/1832").
+				  enable(inDevPreviewNoUpgrade(), inTechPreviewNoUpgrade()).
+		                  mustRegister()
 )
diff --git a/openapi/generated_openapi/zz_generated.openapi.go b/openapi/generated_openapi/zz_generated.openapi.go
diff --git a/operator/v1/types_ingress.go b/operator/v1/types_ingress.go
@@ -1495,13 +1495,29 @@ type AccessLogging struct {
 	// +required
 	Destination LoggingDestination `json:"destination"`
 
+	// tcpLogFormat specifies the format of the log message for a TCP
+        // request.
+        //
+        // If this field is empty, log messages use the implementation's default
+        // TCP log format.  For HAProxy's default TCP log format, see the
+	// HAProxy documentation:
+        // http//docs.haproxy.org/2.8/configuration.html#8.2.2
+        //
+        // Note that this format only applies to TCP connections.  It only affects
+        // the log format for TLS passthrough connections.
+        //
+	// +kubebuilder:validation:MinLength=1
+        // +kubebuilder:validation:MaxLength=1024
+        // +optional
+        TcpLogFormat string `json:"tcpLogFormat,omitempty"`
+
 	// httpLogFormat specifies the format of the log message for an HTTP
 	// request.
 	//
 	// If this field is empty, log messages use the implementation's default
 	// HTTP log format.  For HAProxy's default HTTP log format, see the
 	// HAProxy documentation:
-	// http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3
+	// http//docs.haproxy.org/2.8/configuration.html#8.2.3
 	//
 	// Note that this format only applies to cleartext HTTP connections
 	// and to secure HTTP connections for which the ingress controller
@@ -1512,6 +1528,24 @@ type AccessLogging struct {
 	// +optional
 	HttpLogFormat string `json:"httpLogFormat,omitempty"`
 
+	// httpsLogFormat specifies the format of the log messsage for an HTTPS
+        // request.
+        //
+        // If this field is empty, log messages use the implementation's default
+        // HTTPS log format.  For HAProxy's default HTTPS log format, see the
+        // HAProxy documentation:
+        // http://docs.haproxy.org/2.8/configuration.html#8.2.4
+        //
+        // Note that this format only applies to HTTPS connections for which the
+        // ingress controller terminates encryption (that is, edge-terminated or
+        // reencrypt connections).  It does not affect the log format for TLS
+        // passthrough connections.
+        //
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=1024
+        // +optional
+        HttpsLogFormat string `json:"httpsLogFormat,omitempty"`
+	
 	// httpCaptureHeaders defines HTTP headers that should be captured in
 	// access logs.  If this field is empty, no headers are captured.
 	//
diff --git a/operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers.crd.yaml b/operator/v1/zz_generated.crd-manifests/0000_50_ingress_00_ingresscontrollers.crd.yaml
@@ -1660,14 +1660,31 @@ spec:
                           If this field is empty, log messages use the implementation's default
                           HTTP log format.  For HAProxy's default HTTP log format, see the
                           HAProxy documentation:
-                          http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3
+                          http//docs.haproxy.org/2.8/configuration.html#8.2.3
 
                           Note that this format only applies to cleartext HTTP connections
                           and to secure HTTP connections for which the ingress controller
                           terminates encryption (that is, edge-terminated or reencrypt
                           connections).  It does not affect the log format for TLS passthrough
                           connections.
                         type: string
+                      httpsLogFormat:
+                        description: |-
+                          httpsLogFormat specifies the format of the log messsage for an HTTPS
+                          request.
+
+                          If this field is empty, log messages use the implementation's default
+                          HTTPS log format.  For HAProxy's default HTTPS log format, see the
+                          HAProxy documentation:
+                          http://docs.haproxy.org/2.8/configuration.html#8.2.4
+
+                          Note that this format only applies to HTTPS connections for which the
+                          ingress controller terminates encryption (that is, edge-terminated or
+                          reencrypt connections).  It does not affect the log format for TLS
+                          passthrough connections.
+                        maxLength: 1024
+                        minLength: 1
+                        type: string
                       logEmptyRequests:
                         default: Log
                         description: |-
@@ -1685,6 +1702,21 @@ spec:
                         - Log
                         - Ignore
                         type: string
+                      tcpLogFormat:
+                        description: |-
+                          tcpLogFormat specifies the format of the log message for a TCP
+                          request.
+
+                          If this field is empty, log messages use the implementation's default
+                          TCP log format.  For HAProxy's default TCP log format, see the
+                          HAProxy documentation:
+                          http//docs.haproxy.org/2.8/configuration.html#8.2.2
+
+                          Note that this format only applies to TCP connections.  It only affects
+                          the log format for TLS passthrough connections.
+                        maxLength: 1024
+                        minLength: 1
+                        type: string
                     required:
                     - destination
                     type: object
diff --git a/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/AAA_ungated.yaml b/operator/v1/zz_generated.featuregated-crd-manifests/ingresscontrollers.operator.openshift.io/AAA_ungated.yaml
@@ -1654,14 +1654,31 @@ spec:
                           If this field is empty, log messages use the implementation's default
                           HTTP log format.  For HAProxy's default HTTP log format, see the
                           HAProxy documentation:
-                          http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3
+                          http//docs.haproxy.org/2.8/configuration.html#8.2.3
 
                           Note that this format only applies to cleartext HTTP connections
                           and to secure HTTP connections for which the ingress controller
                           terminates encryption (that is, edge-terminated or reencrypt
                           connections).  It does not affect the log format for TLS passthrough
                           connections.
                         type: string
+                      httpsLogFormat:
+                        description: |-
+                          httpsLogFormat specifies the format of the log messsage for an HTTPS
+                          request.
+
+                          If this field is empty, log messages use the implementation's default
+                          HTTPS log format.  For HAProxy's default HTTPS log format, see the
+                          HAProxy documentation:
+                          http://docs.haproxy.org/2.8/configuration.html#8.2.4
+
+                          Note that this format only applies to HTTPS connections for which the
+                          ingress controller terminates encryption (that is, edge-terminated or
+                          reencrypt connections).  It does not affect the log format for TLS
+                          passthrough connections.
+                        maxLength: 1024
+                        minLength: 1
+                        type: string
                       logEmptyRequests:
                         default: Log
                         description: |-
@@ -1679,6 +1696,21 @@ spec:
                         - Log
                         - Ignore
                         type: string
+                      tcpLogFormat:
+                        description: |-
+                          tcpLogFormat specifies the format of the log message for a TCP
+                          request.
+
+                          If this field is empty, log messages use the implementation's default
+                          TCP log format.  For HAProxy's default TCP log format, see the
+                          HAProxy documentation:
+                          http//docs.haproxy.org/2.8/configuration.html#8.2.2
+
+                          Note that this format only applies to TCP connections.  It only affects
+                          the log format for TLS passthrough connections.
+                        maxLength: 1024
+                        minLength: 1
+                        type: string
                     required:
                     - destination
                     type: object
diff --git a/operator/v1/zz_generated.swagger_doc_generated.go b/operator/v1/zz_generated.swagger_doc_generated.go
diff --git a/payload-manifests/featuregates/featureGate-4-10-Hypershift-Default.yaml b/payload-manifests/featuregates/featureGate-4-10-Hypershift-Default.yaml
@@ -173,6 +173,9 @@
                     {
                         "name": "GatewayAPIWithoutOLM"
                     },
+                    {
+                        "name": "HTTPSLogFormat"
+                    },
                     {
                         "name": "ImageModeStatusReporting"
                     },
diff --git a/payload-manifests/featuregates/featureGate-4-10-Hypershift-DevPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-4-10-Hypershift-DevPreviewNoUpgrade.yaml
@@ -231,6 +231,9 @@
                     {
                         "name": "GatewayAPIWithoutOLM"
                     },
+                    {
+                        "name": "HTTPSLogFormat"
+                    },
                     {
                         "name": "HighlyAvailableArbiter"
                     },
diff --git a/payload-manifests/featuregates/featureGate-4-10-Hypershift-OKD.yaml b/payload-manifests/featuregates/featureGate-4-10-Hypershift-OKD.yaml
@@ -175,6 +175,9 @@
                     {
                         "name": "GatewayAPIWithoutOLM"
                     },
+                    {
+                        "name": "HTTPSLogFormat"
+                    },
                     {
                         "name": "ImageModeStatusReporting"
                     },
diff --git a/payload-manifests/featuregates/featureGate-4-10-Hypershift-TechPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-4-10-Hypershift-TechPreviewNoUpgrade.yaml
@@ -243,6 +243,9 @@
                     {
                         "name": "GatewayAPIWithoutOLM"
                     },
+                    {
+                        "name": "HTTPSLogFormat"
+                    },
                     {
                         "name": "HighlyAvailableArbiter"
                     },
diff --git a/payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-Default.yaml b/payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-Default.yaml
@@ -170,6 +170,9 @@
                     {
                         "name": "GatewayAPIWithoutOLM"
                     },
+                    {
+                        "name": "HTTPSLogFormat"
+                    },
                     {
                         "name": "HyperShiftOnlyDynamicResourceAllocation"
                     },
diff --git a/payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-DevPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-DevPreviewNoUpgrade.yaml
@@ -210,6 +210,9 @@
                     {
                         "name": "GatewayAPIWithoutOLM"
                     },
+                    {
+                        "name": "HTTPSLogFormat"
+                    },
                     {
                         "name": "HighlyAvailableArbiter"
                     },
diff --git a/payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-OKD.yaml b/payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-OKD.yaml
@@ -172,6 +172,9 @@
                     {
                         "name": "GatewayAPIWithoutOLM"
                     },
+                    {
+                        "name": "HTTPSLogFormat"
+                    },
                     {
                         "name": "HyperShiftOnlyDynamicResourceAllocation"
                     },
diff --git a/payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-TechPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-TechPreviewNoUpgrade.yaml
@@ -222,6 +222,9 @@
                     {
                         "name": "GatewayAPIWithoutOLM"
                     },
+                    {
+                        "name": "HTTPSLogFormat"
+                    },
                     {
                         "name": "HighlyAvailableArbiter"
                     },

Original file line number	Diff line number	Diff line change
`@@ -173,6 +173,9 @@`
`173`	`173`	`{`
`174`	`174`	`"name": "GatewayAPIWithoutOLM"`
`175`	`175`	`},`
	`176`	`+ {`
	`177`	`+ "name": "HTTPSLogFormat"`
	`178`	`+ },`
`176`	`179`	`{`
`177`	`180`	`"name": "ImageModeStatusReporting"`
`178`	`181`	`},`
Original file line number	Diff line number	Diff line change
`@@ -231,6 +231,9 @@`
`231`	`231`	`{`
`232`	`232`	`"name": "GatewayAPIWithoutOLM"`
`233`	`233`	`},`
	`234`	`+ {`
	`235`	`+ "name": "HTTPSLogFormat"`
	`236`	`+ },`
`234`	`237`	`{`
`235`	`238`	`"name": "HighlyAvailableArbiter"`
`236`	`239`	`},`
Original file line number	Diff line number	Diff line change
`@@ -175,6 +175,9 @@`
`175`	`175`	`{`
`176`	`176`	`"name": "GatewayAPIWithoutOLM"`
`177`	`177`	`},`
	`178`	`+ {`
	`179`	`+ "name": "HTTPSLogFormat"`
	`180`	`+ },`
`178`	`181`	`{`
`179`	`182`	`"name": "ImageModeStatusReporting"`
`180`	`183`	`},`