Skip to content

NO-JIRA: fix(api): replace CEL url() validators with regex to fix CRD cost budget #8004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
enxebre merged 1 commit into from
Mar 19, 2026
Merged

NO-JIRA: fix(api): replace CEL url() validators with regex to fix CRD cost budget #8004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 7 additions & 14 deletions api/hypershift/v1beta1/etcdbackup_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,10 +183,8 @@ type HCPEtcdBackupAzureBlob struct {
// This field is immutable once set and cannot be removed.
// +optional
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=512
// +kubebuilder:validation:XValidation:rule="isURL(self) && url(self).getScheme() == 'https'",message="encryptionKeyURL must be a valid HTTPS URL"
// +kubebuilder:validation:XValidation:rule="url(self).getHostname().matches('[a-zA-Z0-9-]+\\\\.vault\\\\.azure\\\\.net$')",message="encryptionKeyURL must point to an Azure Key Vault (*.vault.azure.net)"
// +kubebuilder:validation:XValidation:rule="url(self).getEscapedPath().matches('^/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')",message="encryptionKeyURL path must be /keys/<key-name> or /keys/<key-name>/<key-version>"
// +kubebuilder:validation:MaxLength=210
// +kubebuilder:validation:XValidation:rule="self.matches('^https://[a-zA-Z0-9-]+\\\\.vault\\\\.azure\\\\.net/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')",message="encryptionKeyURL must be a valid Azure Key Vault HTTPS URL (https://<vault>.vault.azure.net/keys/<key-name>[/<key-version>])"
// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="encryptionKeyURL is immutable"
EncryptionKeyURL string `json:"encryptionKeyURL,omitempty"`
Comment on lines +186 to 189

@coderabbitai coderabbitai Bot Mar 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify Azure Key Vault naming constraints

echo "Checking Azure Key Vault documentation references in codebase..."
rg -n "vault.azure.net" --type go -C2

echo ""
echo "Finding any existing MaxLength constraints for Azure URLs..."
rg -n "MaxLength.*[0-9]+" api/ --type go | grep -i azure

Repository: openshift/hypershift

Length of output: 16951

MaxLength=210 is insufficient for maximum-length Azure Key Vault URLs.

The documented format https://<vault-name>.vault.azure.net/keys/<key-name>[/<key-version>] with maximum allowed component lengths requires 213 characters:

  • https:// (8) + vault-name (24 max) + .vault.azure.net/keys/ (21) + key-name (127 max) + / + version (32 max) = 213

While practical real-world URLs are significantly shorter, consider increasing to 215–220 to fully accommodate the documented format specification.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@api/hypershift/v1beta1/etcdbackup_types.go` around lines 186 - 189, The
kubebuilder validation for EncryptionKeyURL uses MaxLength=210 which is too
small for worst-case Azure Key Vault URLs; update the kubebuilder tag on the
EncryptionKeyURL field (the struct field EncryptionKeyURL in
etcdbackup_types.go) to a larger value (e.g., 220) to safely accommodate the
documented maximum component lengths, leaving the XValidation regex/immutability
rules unchanged.

}
Expand All @@ -209,8 +207,7 @@ type HCPEtcdBackupStatus struct {
// +optional
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=2048
// +kubebuilder:validation:XValidation:rule="isURL(self)",message="snapshotURL must be a valid URL"
// +kubebuilder:validation:XValidation:rule="url(self).getScheme() == 'https' || url(self).getScheme() == 's3'",message="snapshotURL scheme must be https or s3"
// +kubebuilder:validation:XValidation:rule="self.matches('^(https|s3)://.*')",message="snapshotURL must be a valid URL with scheme https or s3"
SnapshotURL string `json:"snapshotURL,omitempty"`

// encryptionMetadata contains metadata about the encryption of the backup.
Expand Down Expand Up @@ -256,10 +253,8 @@ type HCPEtcdBackupEncryptionMetadataAzure struct {
// "https://<vault-name>.vault.azure.net/keys/<key-name>[/<key-version>]".
// +required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=512
// +kubebuilder:validation:XValidation:rule="isURL(self) && url(self).getScheme() == 'https'",message="encryptionKeyURL must be a valid HTTPS URL"
// +kubebuilder:validation:XValidation:rule="url(self).getHostname().matches('[a-zA-Z0-9-]+\\\\.vault\\\\.azure\\\\.net$')",message="encryptionKeyURL must point to an Azure Key Vault (*.vault.azure.net)"
// +kubebuilder:validation:XValidation:rule="url(self).getEscapedPath().matches('^/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')",message="encryptionKeyURL path must be /keys/<key-name> or /keys/<key-name>/<key-version>"
// +kubebuilder:validation:MaxLength=210
// +kubebuilder:validation:XValidation:rule="self.matches('^https://[a-zA-Z0-9-]+\\\\.vault\\\\.azure\\\\.net/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')",message="encryptionKeyURL must be a valid Azure Key Vault HTTPS URL (https://<vault>.vault.azure.net/keys/<key-name>[/<key-version>])"
EncryptionKeyURL string `json:"encryptionKeyURL,omitempty"`
}

Expand Down Expand Up @@ -358,9 +353,7 @@ type HCPEtcdBackupConfigAzure struct {
// "https://<vault-name>.vault.azure.net/keys/<key-name>[/<key-version>]".
// +required
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=512
// +kubebuilder:validation:XValidation:rule="isURL(self) && url(self).getScheme() == 'https'",message="encryptionKeyURL must be a valid HTTPS URL"
// +kubebuilder:validation:XValidation:rule="url(self).getHostname().matches('[a-zA-Z0-9-]+\\\\.vault\\\\.azure\\\\.net$')",message="encryptionKeyURL must point to an Azure Key Vault (*.vault.azure.net)"
// +kubebuilder:validation:XValidation:rule="url(self).getEscapedPath().matches('^/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')",message="encryptionKeyURL path must be /keys/<key-name> or /keys/<key-name>/<key-version>"
// +kubebuilder:validation:MaxLength=210
// +kubebuilder:validation:XValidation:rule="self.matches('^https://[a-zA-Z0-9-]+\\\\.vault\\\\.azure\\\\.net/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')",message="encryptionKeyURL must be a valid Azure Key Vault HTTPS URL (https://<vault>.vault.azure.net/keys/<key-name>[/<key-version>])"
EncryptionKeyURL string `json:"encryptionKeyURL,omitempty"`
}
33 changes: 10 additions & 23 deletions ...ated.featuregated-crd-manifests/hcpetcdbackups.hypershift.openshift.io/HCPEtcdBackup.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,18 +105,13 @@ spec:
Must be a valid Azure Key Vault key URL in the format
"https://<vault-name>.vault.azure.net/keys/<key-name>[/<key-version>]".
This field is immutable once set and cannot be removed.
maxLength: 512
maxLength: 210
minLength: 1
type: string
x-kubernetes-validations:
- message: encryptionKeyURL must be a valid HTTPS URL
rule: isURL(self) && url(self).getScheme() == 'https'
- message: encryptionKeyURL must point to an Azure Key Vault
(*.vault.azure.net)
rule: url(self).getHostname().matches('[a-zA-Z0-9-]+\\.vault\\.azure\\.net$')
- message: encryptionKeyURL path must be /keys/<key-name>
or /keys/<key-name>/<key-version>
rule: url(self).getEscapedPath().matches('^/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')
- message: encryptionKeyURL must be a valid Azure Key Vault
HTTPS URL (https://<vault>.vault.azure.net/keys/<key-name>[/<key-version>])
rule: self.matches('^https://[a-zA-Z0-9-]+\\.vault\\.azure\\.net/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')
- message: encryptionKeyURL is immutable
rule: self == oldSelf
keyPrefix:
Expand Down Expand Up @@ -380,18 +375,13 @@ spec:
encryptionKeyURL is the URL of the Azure Key Vault key used for encryption of the backup.
Must be a valid Azure Key Vault key URL in the format
"https://<vault-name>.vault.azure.net/keys/<key-name>[/<key-version>]".
maxLength: 512
maxLength: 210
minLength: 1
type: string
x-kubernetes-validations:
- message: encryptionKeyURL must be a valid HTTPS URL
rule: isURL(self) && url(self).getScheme() == 'https'
- message: encryptionKeyURL must point to an Azure Key Vault
(*.vault.azure.net)
rule: url(self).getHostname().matches('[a-zA-Z0-9-]+\\.vault\\.azure\\.net$')
- message: encryptionKeyURL path must be /keys/<key-name>
or /keys/<key-name>/<key-version>
rule: url(self).getEscapedPath().matches('^/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')
- message: encryptionKeyURL must be a valid Azure Key Vault
HTTPS URL (https://<vault>.vault.azure.net/keys/<key-name>[/<key-version>])
rule: self.matches('^https://[a-zA-Z0-9-]+\\.vault\\.azure\\.net/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')
required:
- encryptionKeyURL
type: object
Expand All @@ -404,11 +394,8 @@ spec:
minLength: 1
type: string
x-kubernetes-validations:
- message: snapshotURL must be a valid URL
rule: isURL(self)
- message: snapshotURL scheme must be https or s3
rule: url(self).getScheme() == 'https' || url(self).getScheme()
== 's3'
- message: snapshotURL must be a valid URL with scheme https or s3
rule: self.matches('^(https|s3)://.*')
type: object
required:
- spec
Expand Down
14 changes: 4 additions & 10 deletions ...ated.featuregated-crd-manifests/hostedclusters.hypershift.openshift.io/HCPEtcdBackup.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2338,19 +2338,13 @@ spec:
encryptionKeyURL is the URL of the Azure Key Vault key to use for encrypting etcd backup artifacts.
Must be a valid Azure Key Vault key URL in the format
"https://<vault-name>.vault.azure.net/keys/<key-name>[/<key-version>]".
maxLength: 512
maxLength: 210
minLength: 1
type: string
x-kubernetes-validations:
- message: encryptionKeyURL must be a valid HTTPS
URL
rule: isURL(self) && url(self).getScheme() == 'https'
- message: encryptionKeyURL must point to an Azure
Key Vault (*.vault.azure.net)
rule: url(self).getHostname().matches('[a-zA-Z0-9-]+\\.vault\\.azure\\.net$')
- message: encryptionKeyURL path must be /keys/<key-name>
or /keys/<key-name>/<key-version>
rule: url(self).getEscapedPath().matches('^/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')
- message: encryptionKeyURL must be a valid Azure
Key Vault HTTPS URL (https://<vault>.vault.azure.net/keys/<key-name>[/<key-version>])
rule: self.matches('^https://[a-zA-Z0-9-]+\\.vault\\.azure\\.net/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')
required:
- encryptionKeyURL
type: object
Expand Down
14 changes: 4 additions & 10 deletions ...featuregated-crd-manifests/hostedcontrolplanes.hypershift.openshift.io/HCPEtcdBackup.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2269,19 +2269,13 @@ spec:
encryptionKeyURL is the URL of the Azure Key Vault key to use for encrypting etcd backup artifacts.
Must be a valid Azure Key Vault key URL in the format
"https://<vault-name>.vault.azure.net/keys/<key-name>[/<key-version>]".
maxLength: 512
maxLength: 210
minLength: 1
type: string
x-kubernetes-validations:
- message: encryptionKeyURL must be a valid HTTPS
URL
rule: isURL(self) && url(self).getScheme() == 'https'
- message: encryptionKeyURL must point to an Azure
Key Vault (*.vault.azure.net)
rule: url(self).getHostname().matches('[a-zA-Z0-9-]+\\.vault\\.azure\\.net$')
- message: encryptionKeyURL path must be /keys/<key-name>
or /keys/<key-name>/<key-version>
rule: url(self).getEscapedPath().matches('^/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')
- message: encryptionKeyURL must be a valid Azure
Key Vault HTTPS URL (https://<vault>.vault.azure.net/keys/<key-name>[/<key-version>])
rule: self.matches('^https://[a-zA-Z0-9-]+\\.vault\\.azure\\.net/keys/[a-zA-Z0-9-]+(/[a-zA-Z0-9]+)?$')
required:
- encryptionKeyURL
type: object
Expand Down
33 changes: 10 additions & 23 deletions ...ts/hypershift-operator/zz_generated.crd-manifests/hcpetcdbackups-CustomNoUpgrade.crd.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 10 additions & 23 deletions ...pershift-operator/zz_generated.crd-manifests/hcpetcdbackups-TechPreviewNoUpgrade.crd.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading