update name validation patterns to match Kubernetes as close as possible

Signed-off-by: everettraven <[email protected]>

Author: everettraven

api/v1alpha1/clusterextension_types.go

@@ -67,7 +67,7 @@ type ClusterExtensionSpec struct {
 	// applied to other Namespaces. This Namespace is expected to exist.
 	//
 	// installNamespace is required, immutable, and follows the DNS label standard
-	// as defined in RFC 1123. This means that valid values:
+	// as defined in [RFC 1123]. This means that valid values:
 	//   - Contain no more than 63 characters
 	//   - Contain only lowercase alphanumeric characters or '-'
 	//   - Start with an alphanumeric character
@@ -85,6 +85,8 @@ type ClusterExtensionSpec struct {
 	//   - thisisareallylongnamespacenamethatisgreaterthanthemaximumlength
 	//   - some.namespace
 	//
+	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
+	//
 	//+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
 	//+kubebuilder:validation:MaxLength:=63
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="installNamespace is immutable"
@@ -140,10 +142,9 @@ type CatalogSource struct {
 	// packageName is a reference to the name of the package to be installed
 	// and is used to filter the content from catalogs.
 	//
-	// This field is required, immutable and follows the DNS label standard as defined in RFC
-	// 1123, with a deviation in the maximum length being no more than 48
-	// characters. This means that valid values:
-	//   - Contain no more than 48 characters
+	// This field is required, immutable and follows the DNS label standard as
+	// defined in [RFC 1123]. This means that valid values:
+	//   - Contain no more than 63 characters
 	//   - Contain only lowercase alphanumeric characters or '-'
 	//   - Start with an alphanumeric character
 	//   - End with an alphanumeric character
@@ -160,8 +161,10 @@ type CatalogSource struct {
 	//   - thisisareallylongpackagenamethatisgreaterthanthemaximumlength
 	//   - some.package
 	//
-	//+kubebuilder:validation:MaxLength:=48
-	//+kubebuilder:validation:Pattern:=^[a-z0-9]+(-[a-z0-9]+)*$
+	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
+	//
+	//+kubebuilder:validation:MaxLength:=63
+	//+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="packageName is immutable"
 	PackageName string `json:"packageName"`
 
@@ -259,11 +262,11 @@ type CatalogSource struct {
 	//
 	// When unspecified, upgrade edges across all channels will be used to identify valid automatic upgrade paths.
 	//
-	// This field follows the DNS subdomain name standard as defined in RFC
-	// 1123, with a deviation in the maximum length being no more than 48
-	// characters. This means that valid values:
-	//   - Contain no more than 48 characters
-	//   - Contain only lowercase alphanumeric characters, '-', or '.'
+	// This field follows the DNS label name standard as defined in [RFC 1123]
+	// with the addition of '.' and '_' characters being allowed.
+	// This means that valid values:
+	//   - Contain no more than 63 characters
+	//   - Contain only lowercase alphanumeric characters, '-', '.', or '_'
 	//   - Start with an alphanumeric character
 	//   - End with an alphanumeric character
 	//
@@ -276,14 +279,17 @@ type CatalogSource struct {
 	//   - dev-preview
 	//   - preview
 	//   - community
+	//   - original_40
 	//
 	// Some examples of invalid values are:
 	//   - -some-channel
 	//   - some-channel-
 	//   - thisisareallylongchannelnamethatisgreaterthanthemaximumlength
 	//
-	//+kubebuilder:validation:MaxLength:=48
-	//+kubebuilder:validation:Pattern:=^[a-z0-9]+([\.-][a-z0-9]+)*$
+	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
+	//
+	//+kubebuilder:validation:MaxLength:=63
+	//+kubebuilder:validation:Pattern:=^[a-z0-9]([\._\-a-z0-9]*[a-z0-9])?$
 	//+optional
 	Channel string `json:"channel,omitempty"`
 
@@ -348,7 +354,7 @@ type ServiceAccountReference struct {
 	//   - some-serviceaccount-
 	//
 	//+kubebuilder:validation:MaxLength:=253
-	//+kubebuilder:validation:Pattern:=^[a-z0-9]+([.|-][a-z0-9]+)*$
+	//+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="name is immutable"
 	Name string `json:"name"`
 }

config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml

@@ -47,7 +47,7 @@ spec:
                   applied to other Namespaces. This Namespace is expected to exist.
 
                   installNamespace is required, immutable, and follows the DNS label standard
-                  as defined in RFC 1123. This means that valid values:
+                  as defined in [RFC 1123]. This means that valid values:
                     - Contain no more than 63 characters
                     - Contain only lowercase alphanumeric characters or '-'
                     - Start with an alphanumeric character
@@ -64,6 +64,8 @@ spec:
                     - some-namespace-
                     - thisisareallylongnamespacenamethatisgreaterthanthemaximumlength
                     - some.namespace
+
+                  [RFC 1123]: https://tools.ietf.org/html/rfc1123
                 maxLength: 63
                 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
                 type: string
@@ -151,7 +153,7 @@ spec:
                         - -some-serviceaccount
                         - some-serviceaccount-
                     maxLength: 253
-                    pattern: ^[a-z0-9]+([.|-][a-z0-9]+)*$
+                    pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
                     type: string
                     x-kubernetes-validations:
                     - message: name is immutable
@@ -196,11 +198,11 @@ spec:
 
                           When unspecified, upgrade edges across all channels will be used to identify valid automatic upgrade paths.
 
-                          This field follows the DNS subdomain name standard as defined in RFC
-                          1123, with a deviation in the maximum length being no more than 48
-                          characters. This means that valid values:
-                            - Contain no more than 48 characters
-                            - Contain only lowercase alphanumeric characters, '-', or '.'
+                          This field follows the DNS label name standard as defined in [RFC 1123]
+                          with the addition of '.' and '_' characters being allowed.
+                          This means that valid values:
+                            - Contain no more than 63 characters
+                            - Contain only lowercase alphanumeric characters, '-', '.', or '_'
                             - Start with an alphanumeric character
                             - End with an alphanumeric character
 
@@ -213,23 +215,25 @@ spec:
                             - dev-preview
                             - preview
                             - community
+                            - original_40
 
                           Some examples of invalid values are:
                             - -some-channel
                             - some-channel-
                             - thisisareallylongchannelnamethatisgreaterthanthemaximumlength
-                        maxLength: 48
-                        pattern: ^[a-z0-9]+([\.-][a-z0-9]+)*$
+
+                          [RFC 1123]: https://tools.ietf.org/html/rfc1123
+                        maxLength: 63
+                        pattern: ^[a-z0-9]([\._\-a-z0-9]*[a-z0-9])?$
                         type: string
                       packageName:
                         description: |-
                           packageName is a reference to the name of the package to be installed
                           and is used to filter the content from catalogs.
 
-                          This field is required, immutable and follows the DNS label standard as defined in RFC
-                          1123, with a deviation in the maximum length being no more than 48
-                          characters. This means that valid values:
-                            - Contain no more than 48 characters
+                          This field is required, immutable and follows the DNS label standard as
+                          defined in [RFC 1123]. This means that valid values:
+                            - Contain no more than 63 characters
                             - Contain only lowercase alphanumeric characters or '-'
                             - Start with an alphanumeric character
                             - End with an alphanumeric character
@@ -245,8 +249,10 @@ spec:
                             - some-package-
                             - thisisareallylongpackagenamethatisgreaterthanthemaximumlength
                             - some.package
-                        maxLength: 48
-                        pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
+
+                          [RFC 1123]: https://tools.ietf.org/html/rfc1123
+                        maxLength: 63
+                        pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
                         type: string
                         x-kubernetes-validations:
                         - message: packageName is immutable

internal/controllers/clusterextension_admission_test.go

@@ -72,7 +72,7 @@ func TestClusterExtensionSourceConfig(t *testing.T) {
 }
 
 func TestClusterExtensionAdmissionPackageName(t *testing.T) {
-	tooLongError := "spec.source.catalog.packageName: Too long: may not be longer than 48"
+	tooLongError := "spec.source.catalog.packageName: Too long: may not be longer than 63"
 	regexMismatchError := "spec.source.catalog.packageName in body should match"
 
 	testCases := []struct {
@@ -81,7 +81,7 @@ func TestClusterExtensionAdmissionPackageName(t *testing.T) {
 		errMsg  string
 	}{
 		{"no package name", "", regexMismatchError},
-		{"long package name", "this-is-a-really-long-package-name-that-is-greater-than-48-characters", tooLongError},
+		{"long package name", strings.Repeat("x", 64), tooLongError},
 		{"leading digits with hypens", "0my-1package-9name", ""},
 		{"trailing digits with hypens", "my0-package1-name9", ""},
 		{"digits with hypens", "012-345-678-9", ""},
@@ -123,6 +123,7 @@ func TestClusterExtensionAdmissionPackageName(t *testing.T) {
 		})
 	}
 }
+
 func TestClusterExtensionAdmissionVersion(t *testing.T) {
 	tooLongError := "spec.source.catalog.version: Too long: may not be longer than 64"
 	regexMismatchError := "spec.source.catalog.version in body should match"
@@ -222,7 +223,7 @@ func TestClusterExtensionAdmissionVersion(t *testing.T) {
 }
 
 func TestClusterExtensionAdmissionChannel(t *testing.T) {
-	tooLongError := "spec.source.catalog.channel: Too long: may not be longer than 48"
+	tooLongError := "spec.source.catalog.channel: Too long: may not be longer than 63"
 	regexMismatchError := "spec.source.catalog.channel in body should match"
 
 	testCases := []struct {
@@ -234,7 +235,7 @@ func TestClusterExtensionAdmissionChannel(t *testing.T) {
 		{"hypen-separated", "hyphenated-name", ""},
 		{"dot-separated", "dotted.name", ""},
 		{"includes version", "channel-has-version-1.0.1", ""},
-		{"long channel name", "longname01234567890123456789012345678901234567890", tooLongError},
+		{"long channel name", strings.Repeat("x", 64), tooLongError},
 		{"spaces", "spaces spaces", regexMismatchError},
 		{"capitalized", "Capitalized", regexMismatchError},
 		{"camel case", "camelCase", regexMismatchError},