Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial docs for Azure integration #51631

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

mvbrock
Copy link
Contributor

@mvbrock mvbrock commented Jan 30, 2025

Part of https://github.com/gravitational/access-graph/issues/640, this PR provides website documentation on configuring Teleport for fetching Azure resources and importing them into the Access Graph.

Copy link

github-actions bot commented Jan 30, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
mvbrock/azure-integration-docs 8e16214 5 ✅SUCCEED mvbrock-azure-integration-docs 2025-01-31 16:37:22

@mvbrock mvbrock marked this pull request as ready for review January 30, 2025 19:32
@mvbrock mvbrock requested a review from tigrato January 30, 2025 19:32
@mvbrock mvbrock added the no-changelog Indicates that a PR does not require a changelog entry label Jan 30, 2025
- <Var name="teleport-version"/>
- <Var name="azure-subscription-id"/>
- <Var name="azure-principal-id"/>
- <Var name="azure-discovery-role"/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these already set somewhere?

Comment on lines +115 to +125
Once the managed identity is configured with the correct permissions, add the following to the Discovery Service
configuration to enable it for fetching Azure resources:

```yaml
discovery_service:
access_graph:
azure:
- subscription_id: <Var name="azure-subscription-id"/>
```

The Discovery Service will now periodically fetch resources from your Azure subscription.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this required on Teleport Cloud?

Comment on lines +18 to +19
Utilizing the Access Graph to analyze permissions within an Azure subscription necessitates the setup of the Access
Graph (AG) service, a Discovery Service, and integration with your Azure subscription.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Utilizing the Access Graph to analyze permissions within an Azure subscription necessitates the setup of the Access
Graph (AG) service, a Discovery Service, and integration with your Azure subscription.
To use Access Graph to analyze permissions within an Azure subscription, you need to set up the Access
Graph (AG) service, Teleport Discovery Service, and an integration with your Azure subscription.

Style suggestion

Comment on lines +52 to +53
Teleport Policy’s Access Graph feature delves into the resources retrieved from your Azure subscription, crafting a
graphical representation thereof.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Teleport Policy’s Access Graph feature delves into the resources retrieved from your Azure subscription, crafting a
graphical representation thereof.
Teleport Policy’s Access Graph feature visualizes the resources retrieved from your Azure subscription.

Simplifying this sentence. We could think about removing the H3-level headings from "How it works", since this H3-level section is so short.

- Role Assignments
- Virtual Machines

Once all the necessary resources are fetched, the Teleport Discovery Service pushes them to the Access Graph, ensuring
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once all the necessary resources are fetched, the Teleport Discovery Service pushes them to the Access Graph, ensuring
Once all the necessary resources are fetched, the Teleport Discovery Service pushes them to Access Graph, ensuring

how to set up Access Graph.
- The node running the Access Graph service must be reachable from the Teleport Auth Service.

## Step 1/2. Configure Discovery Service (Self-hosted only)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Step 1/2. Configure Discovery Service (Self-hosted only)
## Step 1/2. Configure the Discovery Service (Self-hosted only)

Comment on lines +105 to +108
Download and extract the Teleport binary:
```shell
curl -L https://cdn.teleport.dev/teleport-v<Var name="teleport-version"/>-linux-amd64-bin.tar.gz | tar xz
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to include docs/pages/includes/install-linux.mdx here?

To do so, you'd add:

(!docs/pages/includes/install-linux.mdx!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation no-changelog Indicates that a PR does not require a changelog entry size/md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants