Skip to content

Commit

Permalink
docs: update azure repos app docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alikhajeh1 committed Oct 24, 2024
1 parent 9068ccd commit b9fd03b
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 20 deletions.
6 changes: 3 additions & 3 deletions docs/features/terraform_modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ See the following two sections for separate instructions on how to setup private

### Source control integrations

If you use the Infracost [GitHub](/docs/integrations/github_app/) or [GitLab App](/docs/integrations/gitlab_app/), go to [Infracost Cloud](https://dashboard.infracost.io/) > Org Settings > Integrations, and click on the GitHub or GitLab App organization that has the repos with private module access errors. Click on Next to go to the Run configurations page.
If you use the Infracost [GitHub](/docs/integrations/github_app/), [GitLab App](/docs/integrations/gitlab_app/) or [Azure Repos App](/docs/integrations/azure_repos_app/), go to [Infracost Cloud](https://dashboard.infracost.io/) > Settings > Org Settings > Integrations, and click on the GitHub, GitLab or Azure Repos App organization that has the repos with private module access errors. Click on Next to go to the Run configurations page then:

For git modules, ensure that the Infracost GitHub App or the GitLab App has access to the module repos, no further action is needed as Infracost will automatically use that access to process the modules.
For **git modules**, ensure that the Infracost App has access to the module repos, no further action is needed as Infracost will automatically use that access to process the modules.

For registry modules, enter the following information:
For **registry modules**, enter the following information:

* **Terraform Cloud:** set the host to `app.terraform.io` and the token to a [Team API Token or User API Token](https://www.terraform.io/docs/cloud/users-teams-organizations/api-tokens.html) (these tokens do not have permission to read variables marked as Sensitive).
* **Terraform Enterprise:** set the host to your Terraform Enterprise hostname and the token to a [Team API Token or User API Token](https://www.terraform.io/docs/cloud/users-teams-organizations/api-tokens.html) (these tokens do not have permission to read variables marked as Sensitive).
Expand Down
3 changes: 2 additions & 1 deletion docs/infracost_cloud/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ Assuming you have already purchased Infracost Cloud, you can setup SSO by follow
Thanks!
</pre>
</li>
<li>In the Okta Admin dashboard assign any users to the Infracost Cloud app. You can also add an <a href="https://avatars.githubusercontent.com/u/68374653?s=200&v=4">Infracost button or icon</a> to your SSO portal as we support IdP-Initiated logins from Okta too.</li>
<li>In the Okta Admin dashboard assign any users to the Infracost Cloud app. You can also add an Infracost button or icon to your SSO portal as we support IdP-Initiated logins from Okta too, save the following image to use for that:</li>
<img src={useBaseUrl("img/small-logo.png")} width="128px" />
</ol>
</details>
<details>
Expand Down
13 changes: 5 additions & 8 deletions docs/integrations/azure_repos_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ The Infracost Azure Repos App is an automated integration meaning that Infracost

| 1. Install the Infracost Azure Repos App | 2. Get pull request comments |
|--------------|-----------|
<img src={useBaseUrl("img/screenshots/azure-app-install.png")} alt="Install the Infracost Azure Repos App into any Azure organization"/> | <img src={useBaseUrl("img/screenshots/azure-app-comment.png")} alt="Infracost automatically leaves a comment on every pull request"/>
<img src={useBaseUrl("img/screenshots/azure-app-install.png")} width="90%" alt="Install the Infracost Azure Repos App into any Azure organization"/> | <img src={useBaseUrl("img/screenshots/azure-app-comment.png")} alt="Infracost automatically leaves a comment on every pull request"/>

## Benefits

There are two key benefits of using the Azure Repos App over manual CI/CD integrations:
1. You can add Infracost to multiple repositories with one click, no need to install or update CLI versions in your CI/CD pipeline.
1. You can add Infracost to multiple repositories with a few clicks, no need to install or update CLI versions in your CI/CD pipeline. The Infracost Azure Repos App uses a service principal and operates independently of Azure users.
2. Infracost runs faster as only changed folders are run based on Azure Repos App events.

## Usage
Expand All @@ -31,7 +31,7 @@ There are two key benefits of using the Azure Repos App over manual CI/CD integr

5. The Infracost Azure Repos App also requires **admin consent** during setup. This step ensures that the app has the necessary permissions to manage service hooks and policies across the selected projects. [Learn more about admin consent](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/user-admin-consent-overview#admin-consent).

6. During setup, Infracost will use a short-lived Personal Access Token (PAT) with additional permissions to:
6. During setup, Infracost will need a temporary 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 selected projects to this group so Infracost can manage webhooks and policies in those projects.
Expand All @@ -42,12 +42,9 @@ There are two key benefits of using the Azure Repos App over manual CI/CD integr
- **Project and Team (Read)** - to list projects.
- **Member Entitlement Management (Read & Write)** - to add projects to the Infracost group.

> **Note**: If you add new projects in the future, you will need to provide the PAT again to temporarily elevate access for setting up that project.
> **Note**: If you add new projects in the future, you will need to provide a PAT again to temporarily elevate access for setting up that project.

7. If you use private modules:
- For private **git modules**, add your private SSH key (RSA format is recommended) and/or Git HTTPS credentials so Infracost can clone the repos in the same way Terraform does.
- For private **registry modules**, see [this page](/docs/features/terraform_modules/#terraform-registry-modules) and set the required Terraform registry token and host in the integration settings page in Infracost Cloud.
7. If you use private modules, see [this docs section](/docs/features/terraform_modules/#source-control-integrations).

8. If you need to customize how Infracost runs, add an `infracost.yml` or `infracost.yml.tmpl` [config file](/docs/features/config_file/) in the **Repo** > **My repo** > **Settings** tab, or to the root of your repo. The Azure Repos App will automatically use that file if it’s present. The app will also apply any usage values defined in the `infracost-usage.yml` [usage file](/docs/features/usage_based_resources/) at the root of the repo.

Expand Down
5 changes: 1 addition & 4 deletions docs/integrations/github_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,7 @@ There are two key benefits of using the GitHub App over manual CI/CD integration

3. Click on Settings > Org Settings > Integrations > GitHub and follow the wizard to select the repos you want to give Infracost access to.

4. If you use private modules:
- For private **git modules**, add your private SSH key (RSA format is recommended) and/or Git HTTPS credentials so Infracost can clone the repos in the same way that Terraform does.

- For private **registry modules**, see [this page](/docs/features/terraform_modules/#terraform-registry-modules) and set the required Terraform registry token and host in the integration settings page in Infracost Cloud.
4. If you use private modules, see [this docs section](/docs/features/terraform_modules/#source-control-integrations).

5. If you need to customize how Infracost runs, add an `infracost.yml` or `infracost.yml.tmpl` [config file](/docs/features/config_file/) in the Repo > my repo > Settings tab, or to the root of your repo. The GitHub App will automatically use that file if it's present. The app will also apply any usage values defined in the `infracost-usage.yml` [usage file](/docs/features/usage_based_resources/) at the root of the repo.

Expand Down
5 changes: 1 addition & 4 deletions docs/integrations/gitlab_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,7 @@ There are two key benefits of using the GitLab App over manual CI/CD integration

3. Click on Settings > Org Settings > Integrations > GitLab and follow the wizard to select the repos you want to give Infracost access to.

4. If you use private modules:
- For private **git modules**, add your private SSH key (RSA format is recommended) and/or Git HTTPS credentials so Infracost can clone the repos in the same way that Terraform does.

- For private **registry modules**, see [this page](/docs/features/terraform_modules/#terraform-registry-modules) and set the required Terraform registry token and host in the integration settings page in Infracost Cloud.
4. If you use private modules, see [this docs section](/docs/features/terraform_modules/#source-control-integrations).

5. If you need to customize how Infracost runs, add an `infracost.yml` or `infracost.yml.tmpl` [config file](/docs/features/config_file/) in the Repo > my repo > Settings tab, or to the root of your repo. The GitLab App will automatically use that file if it's present. The app will also apply any usage values defined in the `infracost-usage.yml` [usage file](/docs/features/usage_based_resources/) at the root of the repo.

Expand Down
Binary file added static/img/screenshots/azure-app-comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/screenshots/azure-app-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/small-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b9fd03b

Please sign in to comment.