Skip to content

Commit

Permalink
wiki updates (#298)
Browse files Browse the repository at this point in the history
* wiki updates

* wiki updates
  • Loading branch information
matebarabas authored Dec 13, 2022
1 parent 9f88020 commit 86ddeee
Show file tree
Hide file tree
Showing 17 changed files with 105 additions and 1,012 deletions.
5 changes: 3 additions & 2 deletions docs/wiki/ADO Dashboard - Deployment Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The CCO Insights Azure DevOps Contributions dashboard requires infrastructure be

# Deployment

Here is the link to the required [bicep][BicepOverview] template that will deploy and connect the architecture presented previously.
[Here][ADODashboardBicepTemplate] is the link to the required [bicep][BicepOverview] template that will deploy and connect the architecture presented previously.

## Pre-requisites

Expand Down Expand Up @@ -87,4 +87,5 @@ After successfully deploying the back-end go to the Azure portal and manually ru
[infrastructure]: <https://github.com/Azure/CCOInsights/blob/main/dashboards/ADODashboard-Contributors/infrastructure>
[src]: <https://github.com/Azure/CCOInsights/blob/main/dashboards/ADODashboard-Contributors/src>
[ADODailySyncFolder]: <https://github.com/Azure/CCOInsights/blob/main/dashboards/ADODashboard-Contributors/src/ADOContributions/ADODailySync>
[WorkflowsFolder]: <https://github.com/Azure/CCOInsights/tree/main/.github/workflows>
[WorkflowsFolder]: <https://github.com/Azure/CCOInsights/tree/main/.github/workflows>
[ADODashboardBicepTemplate]: <https://github.com/Azure/CCOInsights/blob/main/dashboards/ADODashboard-Contributors/infrastructure/deploy.bicep>
6 changes: 4 additions & 2 deletions docs/wiki/ADO Dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ As part of the Continuous Cloud Optimization Insights solution, a dashboard is i
- Number of Projects and branches
- Pull requests
- Average pull requests per day
- Comparison between number of open vs closed pull requests over the last months
- Comparison between number of open vs closed pull requests over the last months*
- Comparison between number of lines added vs deleted per month
- Top contributors measured by changes in their pull requests
- Branches created over the last months
- Branches created over the last months*

> ***NOTE**: time span depends on when the active branches in scope were created.
An important note is that the **the ADO Dashboard can be published in the PowerBI online service with auto refresh enabled**. This differs from other dashboards of CCO Insights because for the ADO Dashboard, dynamic queries are not being done directly from the PowerBI file, meaning that it can be published and consumed from the [PowerBI online][PublishPowerBI] service.

Expand Down
19 changes: 15 additions & 4 deletions docs/wiki/GitHub Dashboard - Deployment Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This dashboard requires infrastructure being deployed in Azure. The infrastructu

# Setup

Here is the link to the required [bicep][BicepOverview] template that will deploy and connect the architecture presented previously.
[Here][GitHubDashboardBicepTemplate] is the link to the required [bicep][BicepOverview] template that will deploy and connect the architecture presented previously.

## Prerequisites

Expand Down Expand Up @@ -64,9 +64,19 @@ Finally, navigate to the root folder of the repository where you will find the [
Now you are ready to deploy your backend in your environment:
![deploy-backend][DeployBackend]
After successfully deploying the backend go to the Azure portal and manually run the `InitializeTables` endpoint. Make sure you see the tables in your Storage Account before moving forward.
After successfully deploying the backend go to the Azure portal and manually run the `InitializeTables` endpoint.
![storage-tables][StorageTables]
On the Azure portal, go to the Storage account and under the Tables section in the Storage browser, verify that the following tables are present:
- Repository
- Forks
- Clones
- OpenPullRequests
- ClosedPullRequests
- Stargazers
- Contributors
- Traffic
- Issues
- Releases
<br>
Expand All @@ -88,4 +98,5 @@ After successfully deploying the backend go to the Azure portal and manually run
[infrastructure]: <https://github.com/Azure/CCOInsights/blob/main/dashboards/GitHubDashboard-Contributors/infrastructure>
[src]: <https://github.com/Azure/CCOInsights/blob/main/dashboards/GitHubDashboard-Contributors/src>
[GitHubDailySyncfolder]: <https://github.com/Azure/CCOInsights/blob/main/dashboards/GitHubDashboard-Contributors/src/GitHubContributions/GitHubDailySync>
[WorkflowsFolder]: <https://github.com/Azure/CCOInsights/tree/main/.github/workflows>
[WorkflowsFolder]: <https://github.com/Azure/CCOInsights/tree/main/.github/workflows>
[GitHubDashboardBicepTemplate]: <https://github.com/Azure/CCOInsights/blob/main/dashboards/GitHubDashboard-Contributors/infrastructure/deploy.bicep>
4 changes: 3 additions & 1 deletion docs/wiki/GitHub Dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ As part of the Continuous Cloud Optimization Insights solution, a dashboard is i
- Number of open pull requests
- Average pull requests per day
- Pull requests' lifecycle (in days)
- Comparison between number of open vs closed pull requests over the last months
- Comparison between number of open vs closed pull requests over the last months*
- Comparison between number of lines added vs deleted per month
- Top contributors measured by changes in their pull requests

> ***NOTE**: time span depends on when the active branches in scope were created.
An important note is that the **the Github Dashboard can be published in the PowerBI online service with auto refresh enabled**. This differs from other dashboards of CCO Insights because for the Github Dashboard, dynamic queries are not being done directly from the PowerBI file, meaning that it can be published and consumed from the [PowerBI online][PublishPowerBI] service.

<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/Governance Dashboard - Deployment Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Registering this Resource Provider has no cost or performance penalty on the sub

# Installing the custom connector

The CCO Azure Governance Dashboard requires to install the Power BI Custom Connector located in the same folder as the CCO Governance Dashboard: ([CCoDashboardAzureConnector.mez][CCoDashboardAzureConnector]). This Custom Connector allows us to leverage information from Azure Management REST APIs that requires POST methods and errors control
The CCO Azure Governance Dashboard requires to install the Power BI Custom Connector located in the same folder as the CCO Governance Dashboard: ([CCoDashboardAzureConnector.mez][CCoDashboardAzureConnector]). This Custom Connector allows us to leverage information from Azure Management REST APIs that require POST methods and error handling.

To install the custom connector you must copy the file [CCoDashboardAzureConnector.mez][CCoDashboardAzureConnector] from the **ccodashboard/dashboards/CCODashboard-Governance/** folder to the folder that Power BI creates by default in the Documents folder in your PC. If this folder doesn't exist, you can create a new one with this name.

Expand Down
4 changes: 2 additions & 2 deletions docs/wiki/Governance Dashboard - Reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [Management Groups and Subscriptions Hierarchy Overview page](#management-groups-and-subscriptions-hierarchy-overview-page)
- [Tags and naming standards page](#tags-and-naming-standards-page)
- [Azure Regulatory Standards Forecast](#azure-regulatory-standards-forecast)
- [Azure Resources Security & Compliance page](#azure-resources-security--compliance-page)
- [Azure Resources Security \& Compliance page](#azure-resources-security--compliance-page)
- [Azure Policies page](#azure-policies-page)
- [Azure Blueprints page](#azure-blueprints-page)

Expand Down Expand Up @@ -80,7 +80,7 @@ You can filter the information by:
- Subscription with assigned blueprints
- Blueprint Definition


![GovernanceSubsBlueprints][GovernanceSubsBlueprints]


<!-- Docs -->
Expand Down
11 changes: 10 additions & 1 deletion docs/wiki/Governance Dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,16 @@

# Overview

The CCO Azure Governance Dashboard is aligned with the Microsoft Cloud Adoption Framework governance principles and will allow you to get quick insights around Management Groups, Subscriptions, Blueprints, Polices, Naming Standards, Tagging and Regulatory Standards compliance. The information captured on this Power BI Dashboard can help Cloud Teams, Operations Teams or business decision makers to have a snapshot of the current Azure configuration in just few minutes.
The CCO Azure Governance Dashboard is aligned with the Microsoft Cloud Adoption Framework governance principles and will allow you to get quick insights around important cloud assets and configuration, such as:
- Management Groups,
- Subscriptions,
- Blueprints,
- Polices,
- Naming Standards,
- Tagging
- and Regulatory Standards compliance.

The information captured on this Power BI Dashboard can help Cloud Teams, Operations Teams or business decision makers to have a snapshot of the current Azure configuration in just few minutes.

<br>

Expand Down
27 changes: 17 additions & 10 deletions docs/wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

The Continuous Cloud Optimization Insights (CCO Insights) project is a set of Power BI Desktop Reports that enables monitoring, operation and infrastructure teams to quickly gain insights about their existing Azure Platform footprint, resources and code contribution characteristics on Azure DevOps and GitHub. CCO Insights is developed using Power Query M language and DAX that pulls information directly from different Azure REST API.

![OverviewImage](./media/OverviewImage.png)
![OverviewImage][OverviewImage]

CCO Insights currently includes 4 different dashboards to discover information about your Azure, Azure DevOps and GitHub cloud platforms:

Expand All @@ -38,13 +38,13 @@ The [**Troubleshooting Guide**][TroubleshootingGuide] chapter contains guidance

# List of assets

1. **queries folder**: Includes the M queries used in the Dashboard to pull data from Azure and Graph REST APIs. This content is for reference purposes to facilitate the Data Model comprehension and to enable contributors to expand the Dashboard capabilities.
2. **docs/assets/pictures folder**: Contains all the images that the Dashboard will use when loading data from Azure. The content of this folder is dynamic and updated regularly. Make sure the computer running the Dashboard also has access to [this URL][GraphicalElements] via the internet.
3. **dashboards folder**: This folder contains sub folders with different versions of the CCO Insights dashboards.
- ***CCODashboard-Infra folder*** has a more generic version of the Dashboard that includes information from Azure Advisor, Azure Defender , Azure Networking REST APIs, Azure Compute and more REST and Graph APIs. This dashboard requires the installation of a [custom connector][CustomConnector].
- ***CCODashboard-Governance folder*** has a dashboard aligned with the Microsoft Cloud Adoption Framework governance principles and will allow to get quick insights around Management Groups, Subscriptions, Blueprints, Polices, Naming Standards, Tagging and Regulatory Standards compliance. This dashboard requires the installation of a [custom connector][CustomConnector].
- [***GitHub Contributions Dashboard folder***][GitHubContributionsDashboard]: has a dashboard to get insights about the contributions to your GitHub project.
- [***Azure DevOps Contributions Dashboard folder***][AdoContributionsDashboard]: has a dashboard to get insights about the contributions to your Azure DevOps (ADO) project.
1. **[queries folder][QueriesFolder]**: Includes the M queries used in the Dashboard to pull data from Azure and Graph REST APIs. This content is for reference purposes to facilitate the Data Model comprehension and to enable contributors to expand the Dashboard capabilities.
2. **[docs/assets/pictures folder][GraphicalElementsFolder]**: Contains all the images that the Dashboard will use when loading data from Azure. The content of this folder is dynamic and updated regularly. Make sure the computer running the Dashboard also has access to [this URL][GraphicalElementsFolder] via the internet.
3. **[dashboards folder][DashboardsFolder]**: This folder contains sub folders with different versions of the CCO Insights dashboards.
- ***[CCODashboard-Infra folder][InfraDashboardFolder]*** has a more generic version of the Dashboard that includes information from Azure Advisor, Azure Defender , Azure Networking REST APIs, Azure Compute and more REST and Graph APIs. This dashboard requires the installation of a [custom connector][CustomConnector].
- ***[CCODashboard-Governance folder][GovDashboardFolder]*** has a dashboard aligned with the Microsoft Cloud Adoption Framework governance principles and will allow to get quick insights around Management Groups, Subscriptions, Blueprints, Polices, Naming Standards, Tagging and Regulatory Standards compliance. This dashboard requires the installation of a [custom connector][CustomConnector].
- [***GitHub Contributions Dashboard folder***][GitHubDashboardFolder]: has a dashboard to get insights about the contributions to your GitHub project.
- [***Azure DevOps Contributions Dashboard folder***][ADODashboardFolder]: has a dashboard to get insights about the contributions to your Azure DevOps (ADO) project.

<br>

Expand Down Expand Up @@ -115,6 +115,7 @@ Any use of third-party trademarks or logos are subject to those third-party's po
[MicrosoftsTrademarkAndBrandGuidelines]: <https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general>

<!-- Images -->
[OverviewImage]: <./media/OverviewImage.png>
[YouTubeVideos]: <https://aka.ms/ccoinsights/videos>
[Video0]: <https://www.youtube.com/watch?v=9l9ME_WXxJk>
[Video1]: <https://www.youtube.com/watch?v=z5pez0kl8_s>
Expand All @@ -130,8 +131,14 @@ Any use of third-party trademarks or logos are subject to those third-party's po
<!-- References -->
[AzureInfrastructureDashboard]: <./Infrastructure-Dashboard>
[AzureGovernanceDashboard]: <./Governance Dashboard>
[GitHubContributionsDashboard]: <./GitHub Dashboard>
[GitHubContributionsDashboard]: </GitHub Dashboard>
[AdoContributionsDashboard]: <./ADO Dashboard>
[TroubleshootingGuide]: <./Troubleshooting%20Guide>
[CustomConnector]: <./Governance Dashboard%20-%20Deployment Guide#installing-the-custom-connector>
[GraphicalElements]: <https://github.com/Azure/CCOInsights/tree/main/docs/assets/pictures>
[GraphicalElementsFolder]: <https://github.com/Azure/CCOInsights/tree/main/docs/assets/pictures>
[QueriesFolder]: <https://github.com/Azure/CCOInsights/tree/main/queries>
[DashboardsFolder]: <https://github.com/Azure/CCOInsights/tree/main/dashboards>
[InfraDashboardFolder]: <https://github.com/Azure/CCOInsights/tree/main/dashboards/CCODashboard-Infra>
[GovDashboardFolder]: <https://github.com/Azure/CCOInsights/tree/main/dashboards/>
[GitHubDashboardFolder]: <https://github.com/Azure/CCOInsights/tree/main/dashboards/GitHub%20Dashboard>
[ADODashboardFolder]: <https://github.com/Azure/CCOInsights/tree/main/dashboards/ADO%20Dashboard>
21 changes: 12 additions & 9 deletions docs/wiki/Infrastructure-Dashboard-Deployment Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [Installing the custom connector](#installing-the-custom-connector)
- [Azure Advisor Recommendations](#azure-advisor-recommendations)
- [Generating Azure Advisor recommendations manually](#generating-azure-advisor-recommendations-manually)
- [Azure Defender Recommendations](#azure-defender-recommendations)
- [Recommendations from Microsoft Defender for Azure](#recommendations-from-microsoft-defender-for-azure)
- [Setting up the Azure Infrastructure Dashboard](#setting-up-the-azure-infrastructure-dashboard)
- [Template download](#template-download)
- [Environment selection](#environment-selection)
Expand All @@ -15,7 +15,7 @@
- [Refresh the dashboard](#refresh-the-dashboard)
- [Credentials for management.azure.com REST API request:](#credentials-for-managementazurecom-rest-api-request)
- [Credentials for graph.windows.net API](#credentials-for-graphwindowsnet-api)
- [Enter Access Web content credentials](#enter-access-web-content-credentials)
- [Enter Organizational credentials](#enter-organizational-credentials)

---

Expand Down Expand Up @@ -58,7 +58,7 @@ Registering these 2 Resource Providers has no cost or performance penalty on the

# Installing the custom connector

The CCO Azure Infrastructure Dashboard requires you to install the Power BI Custom Connector located in the same folder as the CCO Infrastructure Dashboard: ([CCoDashboardAzureConnector.mez][CCoDashboardAzureConnector]). This Custom Connector allows us to leverage information from Azure Management REST APIs that requires POST methods and errors control.
The CCO Azure Infrastructure Dashboard requires you to install the Power BI Custom Connector located in the same folder as the CCO Infrastructure Dashboard: ([CCoDashboardAzureConnector.mez][CCoDashboardAzureConnector]). This Custom Connector allows us to leverage information from Azure Management REST APIs that require POST methods and error handling.

To install the custom connector you must copy the file [CCoDashboardAzureConnector.mez][CCoDashboardAzureConnector] from the **ccodashboard/dashboards/CCODashboard-Infrastructure/** folder to the folder that Power BI creates by default in the Documents folder in your PC. If this folder doesn't exist, you can create a new one with this name.

Expand Down Expand Up @@ -92,13 +92,13 @@ Open the Azure Portal with your Azure Account https://portal.azure.com

<br>

# Azure Defender Recommendations
# Recommendations from Microsoft Defender for Azure

Microsoft Defender for Cloud is a Cloud Security Posture Management (CSPM) and Cloud Workload Protection Platform (CWPP) for all of your Azure, on-premises, and multicloud (Amazon AWS and Google GCP) resources. Defender for Cloud fills three vital needs as you manage the security of your resources and workloads in the cloud and on-premises.
Microsoft Defender for Cloud is a Cloud Security Posture Management (CSPM) and Cloud Workload Protection Platform (CWPP) for all of your Azure, on-premises, and multi-cloud (Amazon AWS and Google GCP) resources. Defender for Cloud fills the vital needs as you manage the security of your resources and workloads in the cloud and on-premises.

You can find more information at the official Azure Defender site [here][SecurityCenterIntro].
You can find more information at the official Microsoft Defender for Azure [site][SecurityCenterIntro].

The subscriptions will need to use the **paid** tier if you want to detect and see the alerts in the Azure Defender Alerts page of the dashboard.
The subscriptions will need to use the **paid** tier if you want to detect and see the alerts in the Microsoft Defender for Azure Alerts page of the dashboard.

<br>

Expand Down Expand Up @@ -166,7 +166,7 @@ If the permissions and credentials are properly flushed it should ask you for cr
![credentials5][Credentials5]


### Enter Access Web content credentials
### Enter Organizational credentials

- Make sure that you select **Organization account** type.
- Click on **Sign in**.
Expand Down Expand Up @@ -196,8 +196,11 @@ If the permissions and credentials are properly flushed it should ask you for cr
[Credentials5]: <./media/Credentials5.png>
[LogAnalytics]: <./media/loganalyticsAPI.PNG>
[Credentials7]: <./media/Credentials7.png>
[CustomConnectorFolder]: <./media/customconnectorfolder.PNG>
[CustomConnectorSecurity]: <./media/customconnectorsecurity.PNG>

<!-- References -->
[GenerateAllSubscriptionsAdvisorRecommendations.ps1]: <https://github.com/Azure/CCOInsights/blob/main/install/scripts/GenerateAllSubsAdvisorRecommendations.ps1>
[CCODashboardInfra]: <https://github.com/Azure/CCOInsights/tree/master/dashboards/CCODashboard-Infra>
[PowerBIDownload]: <https://aka.ms/pbidesktopstore>
[PowerBIDownload]: <https://aka.ms/pbidesktopstore>
[CCoDashboardAzureConnector]: <https://github.com/Azure/CCOInsights/tree/master/dashboards/CCODashboard-Governance/CcoDashboardAzureConnector.mez>
Loading

0 comments on commit 86ddeee

Please sign in to comment.