Skip to content

Commit

Permalink
Fix links in hubs docs
Browse files Browse the repository at this point in the history
  • Loading branch information
flanakin committed Feb 19, 2024
1 parent a6b328e commit 7f26715
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 16 deletions.
12 changes: 12 additions & 0 deletions docs/_docs/focus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Learn about the new billing data specification that will make it easier to under
- [▶️ Getting started](#️-getting-started)
- [🔀 Mapping to FOCUS](#-mapping-to-focus)
- [⚠️ Important notes about FOCUS support](#️-important-notes-about-focus-support)
- [🍎 Learn more at the FinOps Foundation](#-learn-more-at-the-finops-foundation)
- [🧰 Related tools](#-related-tools)

</details>
Expand Down Expand Up @@ -347,6 +348,17 @@ If you have feedback about our mappings or about our full FOCUS support plans, p

If you have feedback about FOCUS, please [create an issue in the FOCUS repository](https://github.com/FinOps-Open-Cost-and-Usage-Spec/FOCUS_Spec/issues/new/choose). We also encourage you to consider contributing to the FOCUS project. The project is looking for more practitioners to help bring their experience to help guide efforts and make this the most useful spec it can be. To learn more about FOCUS or to contribute to the project, visit [focus.finops.org](https://focus.finops.org).

<br>

## 🍎 Learn more at the FinOps Foundation

The FinOps Open Cost and Usage Specification (FOCUS) was built in collaboration with the FinOps Foundation, a non-profit organization dedicated to advancing cloud cost management and optimization. For more information about FOCUS, see the [FOCUS project site](https://focus.finops.org) article in the FinOps Framework documentation.

You can also find related videos on the FinOps Foundation YouTube channel:

<!--[!VIDEO https://www.youtube.com/embed/{id}?list={list}]-->
{% include video.md title="FinOps Open Cost and Usage Specification videos" id="w-RiyFpUhTSXtixI" list="PLUSCToibAswmzF4s0HHYlyoN9J9wi4Aur" %}

---

## 🧰 Related tools
Expand Down
5 changes: 5 additions & 0 deletions docs/_docs/framework/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ FinOps requires a holistic and cross-functional approach that involves various s
- **Engineering teams** – Deliver high quality, cost-effective services.
- **FinOps practitioners** – Educate, standardize, and promote FinOps best practices.

<!--
You can also find related videos on the FinOps Foundation YouTube channel:
{% include video.md title="FinOps personas" id="gXzGwWDQmI0CFrHM" list="PLUSCToibAswkRhkO_PfxqD8et5j0F6VcC" %}
-->

<br>

## Lifecycle
Expand Down
5 changes: 5 additions & 0 deletions docs/_docs/framework/capabilities/quantify/budgeting.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ So far, you've defined granular and targeted cost alerts for each scope and appl

This capability is a part of the FinOps Framework by the FinOps Foundation, a non-profit organization dedicated to advancing cloud cost management and optimization. For more information about FinOps, including useful playbooks, training and certification programs, and more, see to the [Budget management](https://www.finops.org/framework/capabilities/budget-management) article in the FinOps Framework documentation.

You can also find related videos on the FinOps Foundation YouTube channel:

<!--[!VIDEO https://www.youtube.com/embed/{id}?list={list}]-->
{% include video.md title="Budgeting videos" id="5Qe7eRXKMRzRrwBI" list="PLUSCToibAswnjB7fYRA02ePxySkpDex6q" %}

<br>

## Next steps
Expand Down
11 changes: 6 additions & 5 deletions docs/_reporting/hubs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ FinOps hubs will streamline implementing the FinOps Framework, are being designe
- Connect Power BI to Microsoft Online Services Agreement (MOSA) subscriptions<sup>1</sup>.
- Report on multiple subscriptions, resource groups, or billing accounts.
- Streamlined deployment and management with PowerShell.
- Full alignment with the [FinOps Open Cost and Usage Specification (FOCUS)](../_docs/focus/README.md).
- Full alignment with the [FinOps Open Cost and Usage Specification (FOCUS)](../../_docs/focus/README.md).
- _Coming soon: Ingest data from subscriptions in multiple tenants into a single storage account._
- _Coming soon: Ingest data into Azure Data Explorer._

Expand Down Expand Up @@ -135,9 +135,10 @@ Once deployed, you can report on the data in Power BI or by connecting to the st
- Exports can take up to a day to show up after first created.
- Use the **Run now** command at the top of the Cost Management Exports page.
- Your data should be available within 15 minutes or so, depending on how big your account is.
5. Download one or more of the available Power BI starter templates from the [latest release](https://github.com/microsoft/finops-toolkit/releases):
5. Download one or more of the available Power BI starter templates from the [latest release](https://aka.ms/ftk/latest):
- [Cost summary](../power-bi/cost-summary.md) for standard cost roll-ups.
- [Commitment discounts](../power-bi/commitment-discounts.md) for commitment-based savings utilization and coverage.
- [Data ingestion](../power-bi/data-ingestion.md) for insight into your hub storage.
6. [Connect Power BI to your hub](../power-bi/README.md#-connect-to-your-data)

If you run into any issues, refer to the [Troubleshooting guide](../../_resources/troubleshooting.md).
Expand All @@ -156,15 +157,15 @@ After deploying a hub instance, there are several ways for you to get started:

2. Create your own Power BI reports.

If you'd like to create your own reports or add cost data to an existing report, you can either [copy queries from a pre-built report](../power-bi/README.md#setup-a-finops-hub-report) or [connect manually](../power-bi/README.md#connect-manually) using the Azure Data Lake Storage Gen2 connector.
If you'd like to create your own reports or add cost data to an existing report, you can either [copy queries from a pre-built report](../power-bi/README.md#setup-a-finops-hub-report) or connect manually using the Azure Data Lake Storage Gen2 connector.

3. Connect to Microsoft Fabric for advanced queries.

If you use OneLake in Microsoft Fabric, you can create a shortcut to the `ingestion` container in your hubs storage account to run SQL or KQL queries directly against the data in hubs. [Learn more](https://learn.microsoft.com/fabric/real-time-analytics/onelake-shortcuts?tabs=adlsgen2).

4. Access the cost data from custom tools.

Cost data is stored in an [Azure Data Lake Storage Gen2](https://learn.microsoft.com/azure/storage/blobs/data-lake-storage-introduction) account. You can use any tool that supports Azure Data Lake Storage Gen2 to access the data. Refer to the [data dictionary](./data-dictionary.md) for details about available columns.
Cost data is stored in an [Azure Data Lake Storage Gen2](https://learn.microsoft.com/azure/storage/blobs/data-lake-storage-introduction) account. You can use any tool that supports Azure Data Lake Storage Gen2 to access the data. Refer to the [data dictionary](../../_resources/data-dictionary.md) for details about available columns.

5. Apply cost allocation logic, augment, or manipulate your cost data using Data Factory.

Expand Down Expand Up @@ -206,6 +207,6 @@ For additional details, refer to [Cost Management documentation](https://learn.m

## 🧰 Related tools

{% include tools.md pbi="1" ps="1" opt="1" %}
{% include tools.md bicep="0" data="1" gov="0" pbi="1" ps="1" opt="1" %}

<br>
8 changes: 3 additions & 5 deletions docs/_reporting/hubs/data-processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ sequenceDiagram

<br>

1. Cost Management exports raw cost details to the **msexports** container. [Learn more](#about-exports).
1. Cost Management exports raw cost details to the **msexports** container. [Learn more](#ℹ️-about-exports).
2. The **msexports_ExecuteETL** pipeline kicks off the extract-transform-load (ETL) process when files are added to storage.
3. The **msexports_ETL_ingestion** pipeline saves exported data in parquet format in the **ingestion** container. [Learn more](#about-ingestion).
3. The **msexports_ETL_ingestion** pipeline saves exported data in parquet format in the **ingestion** container. [Learn more](#ℹ️-about-ingestion).
4. Power BI reads cost data from the **ingestion** container.

<br>
Expand All @@ -55,9 +55,7 @@ ingestion/{scope-id}/{month}/focuscost
- `focuscost` is the exported dataset.
> Hubs 0.2 only supports FOCUS cost exports. Other export types will be added in a future release.
If you need to

If you need to use hubs to monitor non-Azure data, convert the data to [FOCUS](../focus/README.md) and drop it into the **ingestion** container. Please note this has not been explicitly tested in the latest release. If you experience any issues, please [create an issue](https://aka.ms/finops/toolkit/ideas).
If you need to use hubs to monitor non-Azure data, convert the data to [FOCUS](../../_docs/focus/README.md) and drop it into the **ingestion** container. Please note this has not been explicitly tested in the latest release. If you experience any issues, please [create an issue](https://aka.ms/finops/toolkit/ideas).

<br>

Expand Down
4 changes: 2 additions & 2 deletions docs/_reporting/hubs/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Behind the scenes peek at what makes up the FinOps hub template, including input
{: .fs-6 .fw-300 }

[Deploy](./README.md#-create-a-new-hub){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-4 }
[Learn more](️#-why-finops-hubs){: .btn .fs-5 .mb-4 .mb-md-0 .mr-4 }
[Prerequisites](️#-prerequisites){: .btn .fs-5 .mb-4 .mb-md-0 .mr-4 }

<details open markdown="1">
<summary class="fs-2 text-uppercase">On this page</summary>
Expand Down Expand Up @@ -65,7 +65,7 @@ Please ensure the following prerequisites are met before deploying this template
2. The Microsoft.EventGrid resource provider must be registered in your subscription. See [Register a resource provider](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-providers-and-types#register-resource-provider) for details.

<blockquote class="important" markdown="1">
_If you forget this step, the deployment will succeed, but the pipeline trigger will not be started and data will not be ready. See [Troubleshooting Power BI reports](../resources/troubleshooting.md) for details._
_If you forget this step, the deployment will succeed, but the pipeline trigger will not be started and data will not be ready. See [Troubleshooting Power BI reports](../../_resources/troubleshooting.md) for details._
</blockquote>

<br>
Expand Down
6 changes: 3 additions & 3 deletions docs/_reporting/hubs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,17 +98,17 @@ Before you upgrade, consider the following:
- If you modified the reports, you will need to re-apply your changes to the new reports. Refer to [How to update existing reports to FOCUS](../../_docs/focus/README.md#how-to-update-existing-reports-to-focus) for details.
- If you need your customized reports to continue to run while you upgrade, deploy a second instance of FinOps hubs using a different storage account to avoid data processing errors.

Based on the above, use the following steps to upgrade your hub instance from `0.1.x` to `0.2`:
Based on the above, use the following steps to upgrade your hub instance from `0.1.x` to `0.2.x`:

1. Delete any amortized cost exports pointing to your hub instance.
2. If desired, delete the historical amortized cost data to keep storage costs down.
3. Deploy FinOps hubs `0.2` and create new FOCUS exports using the [Create a new hub](./README.md#-create-a-new-hub) instructions.
3. Deploy FinOps hubs `0.2.1` and create new FOCUS exports using the [Create a new hub](./README.md#-create-a-new-hub) instructions.
<blockquote class="note" markdown="1">
_You can skip step 1 since resource providers have already been registered._
</blockquote>
4. Backfill historical data using the FOCUS export.

[Download](https://github.com/microsoft/finops-toolkit/releases/tag/v0.2){: .btn .mb-4 .mb-md-0 .mr-4 }
[Download](https://github.com/microsoft/finops-toolkit/releases/tag/v0.2.1){: .btn .mb-4 .mb-md-0 .mr-4 }

<br>

Expand Down
6 changes: 5 additions & 1 deletion docs/_reporting/power-bi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,14 @@ Accelerate your analytics efforts with simple, targeted reports. Summarize and b

## 📈 Available reports

The FinOps toolkit includes the following reports:
The FinOps toolkit includes two sets of reports that connect to different data sources. We recommend using the following reports which connect to [FinOps hubs](../hubs/README.md):

- [Cost summary](./cost-summary.md) – Overview of amortized costs with common breakdowns.
- [Commitment discounts](./commitment-discounts.md) – Summarizes existing and potential savings from commitment-based discounts.
- [Data ingestion](./data-ingestion.md) – Provides insights into your data ingestion layer.

The following reports use the Cost Managemnt connector for Power BI to connect to your data. While the connector is not recommended due to the reasons below, these reports will be available as long as the connector is supported by the Cost Management team.

- [Cost Management connector](./connector.md) – Summarizes costs, savings, and commitment discounts using the Cost Management connector.
- [Cost Management template app](./template-app.md) (EA only) – The original Cost Management template app as a customizable PBIX file.

Expand Down

0 comments on commit 7f26715

Please sign in to comment.