Skip to content

Commit 75ad587

Browse files
authored
doc: readme update for backdoor deployment (#1006)
[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).
1 parent bcd2d5c commit 75ad587

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

otelcollector/deploy/addon-chart/Readme.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
Use cli to enable the addon and then disable the addon.
33
**Enable addon** -
44
```
5-
az aks update --enable-azuremonitormetrics -n <cluster-name> -g <cluster-resource-group>
5+
az aks update --enable-azure-monitor-metrics -n <cluster-name> -g <cluster-resource-group>
66
```
77

88
**Disable addon** -
99
```
10-
az aks update --disable-azuremonitormetrics -n <cluster-name> -g <cluster-resource-group>
10+
az aks update --disable-azure-monitor-metrics -n <cluster-name> -g <cluster-resource-group>
1111
```
1212
We need this step because we need to get the secret created for the addon-token-adapter to serve, which is only created when the addon is enabled.
1313

@@ -16,15 +16,17 @@ We need this step because we need to get the secret created for the addon-token-
1616
Instructions on how to deploy ARM template -
1717
https://learn.microsoft.com/en-us/azure/azure-monitor/containers/container-insights-prometheus-metrics-addon?tabs=resource-manager#download-and-edit-template-and-parameter-file
1818

19-
In the ARM template, comment out the section that enables the addon (with name - **"azuremonitormetrics-profile-"**(Lines 147 to 187), please comment the section acccordingly if template is updated)
19+
In the ARM template, comment out the section that enables the addon (with name - **"azureMonitorProfile"**(Lines 156 to 196), please comment the section acccordingly if template is updated)
2020

2121
### **Step 3: Go to addon-chart directory**
2222
```
2323
cd prometheus-collector\otelcollector\deploy\addon-chart
2424
```
2525
### **Step 4: Update the chart/values file accordingly based on what needs to be tested with your backdoor deployment**
2626

27-
Charts and Values for the addon are in the folder azure-monitor-metrics-addon/
27+
Update, local_testing_aks.ps1 within the azure-monitor-metrics-addon/ folder with the apporpritate ImageTag, Cluster Region and Cluster Resource ID (lines 9 to 11). Run the powershell file to generate the Chart and Values from the template files.
28+
29+
If you do not run the script and manually generate the Chart, Values yaml files then please do the following :
2830

2931
Values.yaml has some settings that need to be replaced, that are specific to your cluster. Please replace them before installing the helm chart.
3032
- global.commonGlobals.Region
@@ -36,18 +38,12 @@ Values.yaml has some settings that need to be replaced, that are specific to you
3638
Repository: https://msazure.visualstudio.com/CloudNativeCompute/_git/aks-rp?path=/ccp/charts/addon-charts/azure-monitor-metrics-addon/templates/ama-metrics-daemonset.yaml&version=GBrashmi/prom-addon-arm64&line=136&lineEnd=136&lineStartColumn=56&lineEndColumn=85&lineStyle=plain&_a=contents
3739
ImageTag: https://msazure.visualstudio.com/CloudNativeCompute/_git/aks-rp?path=/ccp/charts/kube-control-plane/templates/_images.tpl&version=GBrashmi/prom-addon-arm64&line=530&lineEnd=530&lineStartColumn=28&lineEndColumn=53&lineStyle=plain&_a=contents
3840

39-
40-
### **Step 5: Test out with Operator mode turned on**
41-
42-
This is an interim step needed until the operator changes roll out globally to make sure the changes work well with the new mode.
43-
The value TargetAllocatorEnabled is set to false by default, this needs to be set to true to test out with the operator mode turned on.
44-
45-
### **Step 6: Install Helm chart**
41+
### **Step 5: Install Helm chart**
4642
```
4743
helm install ama-metrics azure-monitor-metrics-addon/ --values azure-monitor-metrics-addon/values.yaml
4844
```
4945

50-
### **Step 7: Uninstall helm chart**
46+
### **Step 6: Uninstall helm chart**
5147
```
5248
helm uninstall ama-metrics
5349
```

otelcollector/deploy/addon-chart/azure-monitor-metrics-addon/local_testing_aks.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ $valuesTemplateContent | Out-File -FilePath $valuesOutputPath
2727
$chartTemplateContent = $chartTemplateContent -replace '\$\{HELM_CHART_NAME\}', 'ama-metrics'
2828
$chartTemplateContent = $chartTemplateContent -replace '\$\{IMAGE_TAG\}', $ImageTag
2929
# Remove the dependencies section
30-
$chartTemplateContent = $chartTemplateContent -replace '(?s)dependencies:\s*-\s*name:\s*prometheus-node-exporter\s*version:\s*"4\.26\.0"\s*repository:\s*oci://\$\{MCR_REGISTRY\}\$\{MCR_REPOSITORY_HELM_DEPENDENCIES\}\s*condition:\s*AzureMonitorMetrics\.ArcExtension\s*', ''
30+
$chartTemplateContent = $chartTemplateContent -replace '(?s)dependencies:\s*-\s*name:\s*prometheus-node-exporter\s*version:\s*"4\.39\.0"\s*repository:\s*oci://\$\{MCR_REGISTRY\}\$\{MCR_REPOSITORY_HELM_DEPENDENCIES\}\s*condition:\s*AzureMonitorMetrics\.ArcExtension\s*', ''
3131

3232

3333
# Replace placeholders in values-template.yaml

0 commit comments

Comments
 (0)