Skip to content

Commit

Permalink
AOE FAQ and setup docs improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Helder Pinto committed Aug 2, 2024
1 parent f87bc73 commit ab2c7d7
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ There are many ways to participate. From reporting bugs and requesting features
<tr>
<td align="center" valign="top" width="16.66%"><a href="https://github.com/arjenhuitema"><img src="https://avatars.githubusercontent.com/u/15944031?v=4?s=100" width="100px;" alt="Arjen Huitema"/><br /><sub><b>Arjen Huitema</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=arjenhuitema" title="Code">💻</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://github.com/bandersmsft"><img src="https://avatars.githubusercontent.com/u/9596428?v=4?s=100" width="100px;" alt="Bill Anderson"/><br /><sub><b>Bill Anderson</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=bandersmsft" title="Documentation">📖</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://aka.ms/helderpinto"><img src="https://avatars.githubusercontent.com/u/10661605?v=4?s=100" width="100px;" alt="Hélder Pinto"/><br /><sub><b>Hélder Pinto</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=helderpinto" title="Documentation">📖</a> <a href="https://github.com/microsoft/finops-toolkit/issues?q=author%3Ahelderpinto" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://aka.ms/helderpinto"><img src="https://avatars.githubusercontent.com/u/10661605?v=4?s=100" width="100px;" alt="Hélder Pinto"/><br /><sub><b>Hélder Pinto</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=helderpinto" title="Code">💻</a> <a href="https://github.com/microsoft/finops-toolkit/pulls?q=is%3Apr+reviewed-by%3Ahelderpinto" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/microsoft/finops-toolkit/commits?author=helderpinto" title="Documentation">📖</a> <a href="https://github.com/microsoft/finops-toolkit/issues?q=author%3Ahelderpinto" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://aka.ms/yuanzhang9"><img src="https://avatars.githubusercontent.com/u/114724932?v=4?s=100" width="100px;" alt="Yuan Zhang"/><br /><sub><b>Yuan Zhang</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=yuanzhang9" title="Code">💻</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://github.com/ymehdimsft"><img src="https://avatars.githubusercontent.com/u/134303029?v=4?s=100" width="100px;" alt="ymehdimsft"/><br /><sub><b>ymehdimsft</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=ymehdimsft" title="Code">💻</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://github.com/sri-"><img src="https://avatars.githubusercontent.com/u/4493254?v=4?s=100" width="100px;" alt="srilatha inavolu"/><br /><sub><b>srilatha inavolu</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=sri-" title="Code">💻</a> <a href="https://github.com/microsoft/finops-toolkit/pulls?q=is%3Apr+reviewed-by%3Asri-" title="Reviewed Pull Requests">👀</a></td>
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ All the main changes are tracked in the changelog. For additional details, refer
<tr>
<td align="center" valign="top" width="16.66%"><a href="https://github.com/arjenhuitema"><img src="https://avatars.githubusercontent.com/u/15944031?v=4?s=100" width="100px;" alt="Arjen Huitema"/><br /><sub><b>Arjen Huitema</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=arjenhuitema" title="Code">💻</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://github.com/bandersmsft"><img src="https://avatars.githubusercontent.com/u/9596428?v=4?s=100" width="100px;" alt="Bill Anderson"/><br /><sub><b>Bill Anderson</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=bandersmsft" title="Documentation">📖</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://aka.ms/helderpinto"><img src="https://avatars.githubusercontent.com/u/10661605?v=4?s=100" width="100px;" alt="Hélder Pinto"/><br /><sub><b>Hélder Pinto</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=helderpinto" title="Documentation">📖</a> <a href="https://github.com/microsoft/finops-toolkit/issues?q=author%3Ahelderpinto" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://aka.ms/helderpinto"><img src="https://avatars.githubusercontent.com/u/10661605?v=4?s=100" width="100px;" alt="Hélder Pinto"/><br /><sub><b>Hélder Pinto</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=helderpinto" title="Code">💻</a> <a href="https://github.com/microsoft/finops-toolkit/pulls?q=is%3Apr+reviewed-by%3Ahelderpinto" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/microsoft/finops-toolkit/commits?author=helderpinto" title="Documentation">📖</a> <a href="https://github.com/microsoft/finops-toolkit/issues?q=author%3Ahelderpinto" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://aka.ms/yuanzhang9"><img src="https://avatars.githubusercontent.com/u/114724932?v=4?s=100" width="100px;" alt="Yuan Zhang"/><br /><sub><b>Yuan Zhang</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=yuanzhang9" title="Code">💻</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://github.com/ymehdimsft"><img src="https://avatars.githubusercontent.com/u/134303029?v=4?s=100" width="100px;" alt="ymehdimsft"/><br /><sub><b>ymehdimsft</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=ymehdimsft" title="Code">💻</a></td>
<td align="center" valign="top" width="16.66%"><a href="https://github.com/sri-"><img src="https://avatars.githubusercontent.com/u/4493254?v=4?s=100" width="100px;" alt="srilatha inavolu"/><br /><sub><b>srilatha inavolu</b></sub></a><br /><a href="https://github.com/microsoft/finops-toolkit/commits?author=sri-" title="Code">💻</a> <a href="https://github.com/microsoft/finops-toolkit/pulls?q=is%3Apr+reviewed-by%3Asri-" title="Reviewed Pull Requests">👀</a></td>
Expand Down
11 changes: 10 additions & 1 deletion docs/_optimize/optimization-engine/faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ All the frequently asked questions about AOE in one place.

* **What type of Azure subscriptions/clouds are supported?** AOE has been deployed and tested against EA, MCA and MSDN subscriptions in the Azure commercial cloud (AzureCloud). Although not tested yet, it should also work in MOSA subscriptions. It was designed to also operate in the US Government cloud, though it was never tested there. Sponsorship (MS-AZR-0036P and MS-AZR-0143P), CSP (MS-AZR-0145P, MS-AZR-0146P, and MS-AZR-159P) DreamSpark (MS-AZR-0144P) and Internal subscriptions should also work, but due to lack of availability or disparities in their consumption (billing) exports models, some of the Workbooks may not fully work.

* **Why are my Recommendations workbook and Power BI report still empty after deploying AOE?** AOE takes up to 3 hours after deployment to export and ingest the data required to generate recommendations into Log Analytics / SQL Database. If after this time you aren't still seeing any recommendations, check whether:
* Azure Advisor has been reporting recommendations for the subscriptions in the AOE scope;
* Azure Automation runbooks have been failing, especially critical ones such as `Ingest-` and `Recommend-`, and verify the Exception message that is logged, which will normally give you a hint for the failure cause;
* a daily cap has been set in the AOE Log Analytics Workspace that might be dropping the ingestion of AOE logs after the cap was reached.

* **Why some workbooks present this message: `Failed to resolve table or column expression named 'AzureOptimizationPricesheetV1_CL'`?** This is typically a symptom of not having granted the required permissions to the AOE Automation Account managed identity. See instructions [here](https://aka.ms/AzureOptimizationEngine/commitmentssetup).

* **Why is the Identity and Roles workbook empty and presenting error messages?** This is typically a symptom of not having granted the required permissions, at the Entra ID tenant level, to the AOE Automation Account managed identity. After having granted the `Global Reader` role to the AOE managed identity, the workbook should populate on the next day.

* **Why is my Power BI report empty?** Most of the Power BI report pages are configured to filter out recommendations older than 7 days. If it shows empty, just try to refresh the report data.

* **Why is my VM right-size recommendations overview page empty?** The AOE depends on Azure Advisor Cost recommendations for VM right-sizing. If no VMs are showing up, try increasing the CPU threshold in the Azure Advisor configuration... or maybe your infrastructure is not oversized after all!
Expand All @@ -27,7 +36,7 @@ All the frequently asked questions about AOE in one place.

* **What is the currency used for costs and savings?** The currency used is the one that is reported by default by the Azure Consumption APIs. It should match the one you usually see in Azure Cost Management.

* **What is the default time span for collecting Azure consumption data?** By default, the Azure consumption exports daily runbook collects 1-day data from 7 days ago. This offset works well for many types of subscriptions. If you're running AOE in PAYG or EA subscriptions, you can decrease the offset by adjusting the `AzureOptimization_ConsumptionOffsetDays` variable. However, using a value less than 2 days is not recommended.
* **What is the default time span for collecting Azure consumption data?** By default, the Azure consumption exports daily runbook collects 1-day data from 3 days ago. This offset works well for many types of subscriptions. If you're running AOE in PAYG or EA subscriptions, you can decrease the offset by adjusting the `AzureOptimization_ConsumptionOffsetDays` variable. However, using a value less than 2 days is not recommended.

* **Why is AOE recommending to delete a long-deallocated VM that was deallocated just a few days before?** The _LongDeallocatedVms_ recommendation depends on accurate Azure consumption exports. If you just deployed AOE, it hasn't collected consumption long enough to provide accurate recommendations. Let AOE run at least for 30 days to get accurate recommendations.

Expand Down
4 changes: 4 additions & 0 deletions docs/_optimize/optimization-engine/setup-options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ parameters, for example to grant the SQL administrator role to an Entra ID group
.\Deploy-AzureOptimizationEngine.ps1 -SilentDeploymentSettingsPath "<path to deployment settings file>" -SqlAdminPrincipalType Group -SqlAdminPrincipalName "<Group Name>" -SqlAdminPrincipalObjectId "<Group Object GUID>"
```

<blockquote class="note" markdown="1">
When deploying AOE with non-user identities (service principals), you must ensure you assign a system identity to the AOE SQL Server and grant it the `Directory Readers` role in Entra ID. Please follow the steps described [here](https://aka.ms/sqlaadsetup).
</blockquote>

## 🤝 Enabling Azure commitments workbooks

In order to leverage the Workbooks that allow you to analyze your Azure commitments usage (`Benefits Usage`, `Reservations Usage` and `Savings Plans Usage`) or estimate the impact of doing additional consumption commitments (`Benefits Simulation` and `Reservations Potential`), you need to configure AOE and grant privileges to its Managed Identity at your consumption agreement level (EA or MCA). If you could not do it during setup/upgrade, you can still execute those extra configuration steps, provided you do it with a user that is **both Contributor in the AOE resource group and have administrative privileges over the consumption agreement** (Enterprise Enrollment Administrator for EA or Billing Profile Owner for MCA). You just have to use the `Setup-BenefitsUsageDependencies.ps1` script following the syntax below and answer the input requests:
Expand Down
18 changes: 18 additions & 0 deletions docs/_resources/changelog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,24 @@ Legend:
> 1. Added support for FOCUS, pricesheet, and reservation dataset filters in [Get-FinOpsCostExport](../_automation/powershell/cost/Get-FinOpsCostExport.md).
> 2. Added a `-DatasetVersion` filter in [Get-FinOpsCostExport](../_automation/powershell/cost/Get-FinOpsCostExport.md).
🔍 Optimization engine
{: .fs-5 .fw-500 .mt-4 mb-0 }

> ➕ Added:
>
> 1. `Register-MultitenantAutomationSchedules` PowerShell script helper to [add a different Azure tenant to the scope of AOE](../_optimize/optimization-engine/customize.md).
> 2. ZRS disks included in the scope of the `Premium SSD disk has been underutilized` recommendation (besides LRS).
> 3. Option to scope consumption exports to MCA Billing Profile.
>
> ✏️ Changed:
>
> 1. Improved SQL Database security, replacing SQL authentication by Entra ID authentication-only.
>
> 🛠️ Fixed:
>
> 1. `Premium SSD disk has been underutilized` recommendation was not showing results due to a meter name change in Cost Management ([#831](https://github.com/microsoft/finops-toolkit/issues/831)).
> 2. Consumption exports for Pay-As-You-Go MCA subscriptions were missing cost data ([#828](https://github.com/microsoft/finops-toolkit/issues/828))
## 🚚 v0.4

<sup>Released July 12, 2024</sup>
Expand Down

0 comments on commit ab2c7d7

Please sign in to comment.