USHIFT-2459: Add docs to namespaceOwnership

openshift · Mar 13, 2024 · 6480b11 · 6480b11
1 parent d0bb154
commit 6480b11
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/cmd/generate-config/config/config-openapi-spec.json b/cmd/generate-config/config/config-openapi-spec.json
@@ -83,6 +83,7 @@
           ],
           "properties": {
             "namespaceOwnership": {
+              "description": "Describes how host name claims across namespaces should be handled. \n Value must be one of: \n - Strict: Do not allow routes in different namespaces to claim the same host. \n - InterNamespaceAllowed: Allow routes to claim different paths of the same host name across namespaces. \n If empty, the default is InterNamespaceAllowed.",
               "type": "string",
               "default": "InterNamespaceAllowed"
             }

diff --git a/packaging/microshift/config.yaml b/packaging/microshift/config.yaml
@@ -19,6 +19,11 @@ etcd:
     memoryLimitMB: 0
 ingress:
     routeAdmissionPolicy:
+        # Describes how host name claims across namespaces should be handled. 
+        #  Value must be one of: 
+        #  - Strict: Do not allow routes in different namespaces to claim the same host. 
+        #  - InterNamespaceAllowed: Allow routes to claim different paths of the same host name across namespaces. 
+        #  If empty, the default is InterNamespaceAllowed.
         namespaceOwnership: InterNamespaceAllowed
 manifests:
     # The locations on the filesystem to scan for kustomization files to use to load manifests. Set to a list of paths to scan only those paths. Set to an empty list to disable loading manifests. The entries in the list can be glob patterns to match multiple subdirectories.

diff --git a/pkg/config/ingress.go b/pkg/config/ingress.go
@@ -14,6 +14,16 @@ type IngressConfig struct {
 }
 
 type RouteAdmissionPolicy struct {
+	// Describes how host name claims across namespaces should be handled.
+	//
+	// Value must be one of:
+	//
+	// - Strict: Do not allow routes in different namespaces to claim the same host.
+	//
+	// - InterNamespaceAllowed: Allow routes to claim different paths of the same
+	//   host name across namespaces.
+	//
+	// If empty, the default is InterNamespaceAllowed.
 	// +kubebuilder:default="InterNamespaceAllowed"
 	NamespaceOwnership NamespaceOwnershipEnum `json:"namespaceOwnership"`
 }