Merge pull request #2159 from chiragkyal/ext-crt

OAPE-94: Update API doc for route externalCertificate
openshift · Jan 29, 2025 · 107848b · 107848b
2 parents 7d3599b + a56eff3
commit 107848b
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 3 deletions.
diff --git a/openapi/generated_openapi/zz_generated.openapi.go b/openapi/generated_openapi/zz_generated.openapi.go
diff --git a/openapi/openapi.json b/openapi/openapi.json
@@ -35687,7 +35687,7 @@
           "type": "string"
         },
         "externalCertificate": {
-          "description": "externalCertificate provides certificate contents as a secret reference. This should be a single serving certificate, not a certificate chain. Do not include a CA certificate. The secret referenced should be present in the same namespace as that of the Route. Forbidden when `certificate` is set.",
+          "description": "externalCertificate provides certificate contents as a secret reference. This should be a single serving certificate, not a certificate chain. Do not include a CA certificate. The secret referenced should be present in the same namespace as that of the Route. Forbidden when `certificate` is set. The router service account needs to be granted with read-only access to this secret, please refer to openshift docs for additional details.",
           "$ref": "#/definitions/com.github.openshift.api.route.v1.LocalObjectReference"
         },
         "insecureEdgeTerminationPolicy": {

diff --git a/route/v1/generated.proto b/route/v1/generated.proto
diff --git a/route/v1/types.go b/route/v1/types.go
@@ -469,6 +469,8 @@ type TLSConfig struct {
 	// chain. Do not include a CA certificate. The secret referenced should
 	// be present in the same namespace as that of the Route.
 	// Forbidden when `certificate` is set.
+	// The router service account needs to be granted with read-only access to this secret,
+	// please refer to openshift docs for additional details.
 	//
 	// +openshift:enable:FeatureGate=RouteExternalCertificate
 	// +optional

diff --git a/route/v1/zz_generated.crd-manifests/routes-CustomNoUpgrade.crd.yaml b/route/v1/zz_generated.crd-manifests/routes-CustomNoUpgrade.crd.yaml
@@ -508,6 +508,8 @@ spec:
                       chain. Do not include a CA certificate. The secret referenced should
                       be present in the same namespace as that of the Route.
                       Forbidden when `certificate` is set.
+                      The router service account needs to be granted with read-only access to this secret,
+                      please refer to openshift docs for additional details.
                     properties:
                       name:
                         description: |-

diff --git a/route/v1/zz_generated.crd-manifests/routes-DevPreviewNoUpgrade.crd.yaml b/route/v1/zz_generated.crd-manifests/routes-DevPreviewNoUpgrade.crd.yaml
@@ -508,6 +508,8 @@ spec:
                       chain. Do not include a CA certificate. The secret referenced should
                       be present in the same namespace as that of the Route.
                       Forbidden when `certificate` is set.
+                      The router service account needs to be granted with read-only access to this secret,
+                      please refer to openshift docs for additional details.
                     properties:
                       name:
                         description: |-

diff --git a/route/v1/zz_generated.crd-manifests/routes-TechPreviewNoUpgrade.crd.yaml b/route/v1/zz_generated.crd-manifests/routes-TechPreviewNoUpgrade.crd.yaml
@@ -508,6 +508,8 @@ spec:
                       chain. Do not include a CA certificate. The secret referenced should
                       be present in the same namespace as that of the Route.
                       Forbidden when `certificate` is set.
+                      The router service account needs to be granted with read-only access to this secret,
+                      please refer to openshift docs for additional details.
                     properties:
                       name:
                         description: |-

diff --git a/...erated.featuregated-crd-manifests/routes.route.openshift.io/RouteExternalCertificate.yaml b/...erated.featuregated-crd-manifests/routes.route.openshift.io/RouteExternalCertificate.yaml
@@ -450,6 +450,8 @@ spec:
                       chain. Do not include a CA certificate. The secret referenced should
                       be present in the same namespace as that of the Route.
                       Forbidden when `certificate` is set.
+                      The router service account needs to be granted with read-only access to this secret,
+                      please refer to openshift docs for additional details.
                     properties:
                       name:
                         description: |-

diff --git a/route/v1/zz_generated.swagger_doc_generated.go b/route/v1/zz_generated.swagger_doc_generated.go