[fix] Add min function to the dc name substring functionparameters to avoid template deployment failure for shorter names (#951)

This pr adds min function to the dc name substrings so that the template
deployment does not fail for shorter(than 44/64) string lengths.

I was testing onboarding a cluster with a short name testsohambicep and
caught this bug.

This fixes current failure for shorter strings:

Getting this error from selected code : {"code": "InvalidTemplate",
"message": "Deployment template validation failed: 'The template
variable 'dceName' is not valid: Unable to evaluate the template
language function 'substring'. The index and length parameters must
refer to a location within the string. The index parameter: '0', the
length parameter: '44', the length of the string parameter: '28'. Please
see https://aka.ms/arm-function-substring for usage details.. Please see
https://aka.ms/arm-functions for usage details.'.", "additionalInfo":
[{"type": "TemplateViolation", "info": {"lineNumber": 55,
"linePosition": 132, "path": "properties.template.variables.dceName"}}]}

[comment]: # (Note that your PR title should follow the conventional
commit format: https://conventionalcommits.org/en/v1.0.0/#summary)
# PR Description

[comment]: # (The below checklist is for PRs adding new features. If a
box is not checked, add a reason why it's not needed.)
# New Feature Checklist

- [ ] List telemetry added about the feature.
- [ ] Link to the one-pager about the feature.
- [ ] List any tasks necessary for release (3P docs, AKS RP chart
changes, etc.) after merging the PR.
- [ ] Attach results of scale and perf testing.

[comment]: # (The below checklist is for code changes. Not all boxes
necessarily need to be checked. Build, doc, and template changes do not
need to fill out the checklist.)
# Tests Checklist

- [ ] Have end-to-end Ginkgo tests been run on your cluster and passed?
To bootstrap your cluster to run the tests, follow [these
instructions](/otelcollector/test/README.md#bootstrap-a-dev-cluster-to-run-ginkgo-tests).
  - Labels used when running the tests on your cluster:
    - [ ] `operator`
    - [ ] `windows`
    - [ ] `arm64`
    - [ ] `arc-extension`
    - [ ] `fips`
- [ ] Have new tests been added? For features, have tests been added for
this feature? For fixes, is there a test that could have caught this
issue and could validate that the fix works?
  - [ ] Is a new scrape job needed?
- [ ] The scrape job was added to the folder
[test-cluster-yamls](/otelcollector/test/test-cluster-yamls/) in the
correct configmap or as a CR.
  - [ ] Was a new test label added?
- [ ] A string constant for the label was added to
[constants.go](/otelcollector/test/utils/constants.go).
- [ ] The label and description was added to the [test
README](/otelcollector/test/README.md).
- [ ] The label was added to this [PR
checklist](/.github/pull_request_template).
- [ ] The label was added as needed to
[testkube-test-crs.yaml](/otelcollector/test/testkube/testkube-test-crs.yaml).
  - [ ] Are additional API server permissions needed for the new tests?
- [ ] These permissions have been added to
[api-server-permissions.yaml](/otelcollector/test/testkube/api-server-permissions.yaml).
  - [ ] Was a new test suite (a new folder under `/tests`) added?
- [ ] The new test suite is included in
[testkube-test-crs.yaml](/otelcollector/test/testkube/testkube-test-crs.yaml).

Author: Sohamdg081992

.trivyignore

@@ -3,6 +3,8 @@
 
 # =========== CRITICAL ================
 CVE-2024-24790
+CVE-2024-5535
+CVE-2024-41110
 
 # =========== HIGH ================
 # HIGH - otelcollector

AddonArmTemplate/FullAzureMonitorMetricsProfile.json

@@ -52,8 +52,8 @@
     "clusterSubscriptionId": "[split(parameters('clusterResourceId'),'/')[2]]",
     "clusterResourceGroup": "[split(parameters('clusterResourceId'),'/')[4]]",
     "clusterName": "[split(parameters('clusterResourceId'),'/')[8]]",
-    "dceName": "[substring(Concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')), 0, 44)]",
-    "dcrName": "[substring(Concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')), 0, 64)]",
+    "dceName": "[substring(concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')), 0, min(44, length(concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')))))]",
+    "dcrName": "[substring(concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')), 0, min(64, length(concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')))))]",
     "dcraName": "[Concat('MSProm', '-', parameters('clusterLocation'), '-', variables('clusterName'))]",
     "nodeRecordingRuleGroup": "NodeRecordingRulesRuleGroup-",
     "nodeRecordingRuleGroupName": "[concat(variables('nodeRecordingRuleGroup'), variables('clusterName'))]",

AddonBicepTemplate/FullAzureMonitorMetricsProfile.bicep

@@ -17,8 +17,8 @@ var azureMonitorWorkspaceSubscriptionId = split(azureMonitorWorkspaceResourceId,
 var clusterSubscriptionId = split(clusterResourceId, '/')[2]
 var clusterResourceGroup = split(clusterResourceId, '/')[4]
 var clusterName = split(clusterResourceId, '/')[8]
-var dceName = substring('MSProm-${azureMonitorWorkspaceLocation}-${clusterName}', 0, 44)
-var dcrName = substring('MSProm-${azureMonitorWorkspaceLocation}-${clusterName}', 0, 64)
+var dceName = substring('MSProm-${azureMonitorWorkspaceLocation}-${clusterName}', 0, min(44, length('MSProm-${azureMonitorWorkspaceLocation}-${clusterName}')))
+var dcrName = substring('MSProm-${azureMonitorWorkspaceLocation}-${clusterName}', 0, min(64, length('MSProm-${azureMonitorWorkspaceLocation}-${clusterName}')))
 var dcraName = 'MSProm-${clusterLocation}-${clusterName}'
 var nodeRecordingRuleGroupPrefix = 'NodeRecordingRulesRuleGroup-'
 var nodeRecordingRuleGroupName = '${nodeRecordingRuleGroupPrefix}${clusterName}'

AddonPolicyTemplate/AddonPolicyMetricsProfile.rules.json

@@ -51,8 +51,8 @@
 							"clusterSubscriptionId": "[split(parameters('clusterResourceId'),'/')[2]]",
 							"clusterResourceGroup": "[split(parameters('clusterResourceId'),'/')[4]]",
 							"clusterName": "[split(parameters('clusterResourceId'),'/')[8]]",
-							"dceName": "[substring(Concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')), 0, 44)]",
-							"dcrName": "[substring(Concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')), 0, 64)]",
+							"dceName": "[substring(concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')), 0, min(44, length(concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')))))]",
+							"dcrName": "[substring(concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')), 0, min(64, length(concat('MSProm', '-', parameters('azureMonitorWorkspaceLocation'), '-', variables('clusterName')))))]",
 							"dcraName": "[Concat('MSProm', '-', parameters('clusterLocation'), '-', variables('clusterName'))]",
 							"nodeRecordingRuleGroup": "NodeRecordingRulesRuleGroup-",
 							"nodeRecordingRuleGroupName": "[concat(variables('nodeRecordingRuleGroup'), variables('clusterName'))]",
@@ -548,4 +548,4 @@
 			}
 		}
 	}
-}
+}

AddonTerraformTemplate/main.tf

@@ -42,14 +42,14 @@ resource "azurerm_monitor_workspace" "amw" {
 }
 
 resource "azurerm_monitor_data_collection_endpoint" "dce" {
-  name                = substr("MSProm-${azurerm_resource_group.rg.location}-${var.cluster_name}", 0, 44)
+  name                = substr("MSProm-${azurerm_resource_group.rg.location}-${var.cluster_name}", 0, min(44, length("MSProm-${azurerm_resource_group.rg.location}-${var.cluster_name}")))
   resource_group_name = azurerm_resource_group.rg.name
   location            = azurerm_resource_group.rg.location
   kind                = "Linux"
 }
 
 resource "azurerm_monitor_data_collection_rule" "dcr" {
-  name                        = substr("MSProm-${azurerm_resource_group.rg.location}-${var.cluster_name}", 0, 64)
+  name                        = substr("MSProm-${azurerm_resource_group.rg.location}-${var.cluster_name}", 0, min(64, length("MSProm-${azurerm_resource_group.rg.location}-${var.cluster_name}")))
   resource_group_name         = azurerm_resource_group.rg.name
   location                    = azurerm_resource_group.rg.location
   data_collection_endpoint_id = azurerm_monitor_data_collection_endpoint.dce.id