Skip to content

Commit

Permalink
docs: add notes (#682)
Browse files Browse the repository at this point in the history
  • Loading branch information
alikhajeh1 authored Dec 9, 2024
1 parent f4722f2 commit 923caf8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/integrations/azure_repos_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ There are two key benefits of using the Azure Repos App over manual CI/CD integr

6. During setup, Infracost will need a short-lived Personal Access Token (PAT) with additional permissions to do the following. The PAT can be deleted in Azure Repos after the setup is done.
- Create an Azure Active Directory (AAD) group that can manage service hooks and branch policies.
- Add the Infracost service principal to this group.
- Add the Infracost service principal to this group. The Azure DevOps Access Level for the Infracost service principal needs to be "Basic" (not the free Stakeholder one) so it has permission to list repos.
- Add selected projects to this group so Infracost can manage webhooks and policies in those projects.
Ensure that the short-lived PAT belongs to an Owner or Project Collection Administrator and has the following scopes:
- **Graph (Read & Manage)** - to create the Infracost group.
Expand Down
14 changes: 7 additions & 7 deletions docs/integrations/github_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,17 +99,11 @@ The GitHub App automatically reflects the following changes in Infracost:

From the Org Settings > Integrations > GitHub App page, you can disable pull request comments so cost estimates, guardrails and tagging policies are only shown in Infracost Cloud. This enables you to test these features without impacting engineering workflows.

### GitHub Actions to App migration

1. Follow the [usage](#usage) docs to install the app. You can do this from the same Infracost organization you use already, and going into the Org Settings > Integrations page.
2. Test it by [sending a pull request](/docs/infracost_cloud/get_started/#4-send-a-pull-request).
3. Remove all Infracost steps from your GitHub Actions.

### Dismissing policy issues

Infracost FinOps and Tagging issues can be dismissed directly from the GitHub pull request UI, even if the policy is set to block pull requests. This allows engineers to ship critical changes without having to fix all issues. During non-emergency circumstances, we recommend engineers fix the issues they can, and dismiss any that they cannot fix.

Any GitHub pull request comment will contain information on how to dismiss the issues.
GitHub pull request comments contain information on how to dismiss issues.

<img src={useBaseUrl("img/github/desc.png")} alt="pr comment" />

Expand All @@ -127,3 +121,9 @@ Dismissing a policy issue works as follows:
<img src={useBaseUrl("img/github/checks.png")} alt="checks" />
- Dismissed issues are shown in Infracost Cloud in the policies pages. You can filter by dismissed issues to see all the issues your engineers have dismissed and their reasons.
<img src={useBaseUrl("img/github/dismissed-table.png")} alt="dismissed table" />

### GitHub Actions to App migration

1. Follow the [usage](#usage) docs to install the app. You can do this from the same Infracost organization you use already, and going into the Org Settings > Integrations page.
2. Test it by [sending a pull request](/docs/infracost_cloud/get_started/#4-send-a-pull-request).
3. Remove all Infracost steps from your GitHub Actions.
4 changes: 4 additions & 0 deletions src/components/Navbar.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@ function Navbar({ isDocs }) {
label: 'FinOps Glossary',
href: '/glossary/',
},
{
label: 'FinOps Policies',
href: '/finops-policies/',
},
{
label: 'Blog',
href: '/blog/',
Expand Down

0 comments on commit 923caf8

Please sign in to comment.