This folder contains all the assets needed to deploy and manage the Azure Optimization Engine (AOE). AOE is an extensible solution designed to generate optimization recommendations for your Azure environment. To contribute to AOE, we recommend you to first deploy it in your environment, preferably in an Azure tenant in which you have all the required and optional permissions (see requirements). Reading the AOE documentation is also recommended.
On this page:
AOE runs mostly on top of Azure Automation and Log Analytics. The diagram below depicts the architectural components. For a more detailed description, please read this blog post.
To deploy and test AOE in your development environment, you need to fulfill some tooling and Azure permissions requirements. See more details here.
The simplest, quickest and recommended method for installing AOE is by using the Azure Cloud Shell (PowerShell). Check here the detailed list of deployment instructions. If you are working on a branch other than main and need to test the AOE deployment, use the following PowerShell instruction:
.\Deploy-AzureOptimizationEngine.ps1 -TemplateUri "https://raw.githubusercontent.com/<GitHub user>/<repository>/<branch name>/src/optimization-engine/azuredeploy.bicep"
# Example:
.\Deploy-AzureOptimizationEngine.ps1 -TemplateUri "https://raw.githubusercontent.com/helderpinto/finops-toolkit-hp-fork/features/aoe/src/optimization-engine/azuredeploy.bicep"After deploying AOE, there are several ways for you to get started contributing:
-
Develop new Azure Workbooks or improve existing ones. AOE Workbooks are available from within the Log Analytics workspace chosen during installation (check the
Workbooksblade inside the workspace). Check the Workbooks code and documentation. -
Improve the built-in Power BI report. See documentation for an understanding of all report pages.
-
Contribute with new optimization recommendations or improve existing ones (check the Runbooks folder).