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

Docs: Getting started policy guide #42577

Merged
merged 40 commits into from
Jun 22, 2024
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
65c309b
getting started policy guide - draft
mmcallister Jun 6, 2024
9e3f8b9
getting started policy guide - draft
mmcallister Jun 7, 2024
5093d76
getting started policy guide - draft
mmcallister Jun 7, 2024
f8eb0df
getting started policy guide - draft
mmcallister Jun 10, 2024
12ea503
restoring cspell - deleted by mistake
mmcallister Jun 10, 2024
43b3895
getting started policy guide - fixing link
mmcallister Jun 10, 2024
64df9f4
getting started policy guide - fixing link
mmcallister Jun 10, 2024
9685318
getting started policy guide - prose edit
mmcallister Jun 10, 2024
bc194ef
Update docs/pages/access-controls/access-graph.mdx
mmcallister Jun 11, 2024
7e64fdb
getting started policy guide - license edit
mmcallister Jun 11, 2024
9271b16
getting started policy guide - draft
mmcallister Jun 12, 2024
a2b5689
getting started policy guide - draft
mmcallister Jun 12, 2024
a57c40a
policy guide - draft (restoring deleted lock file)
mmcallister Jun 12, 2024
8a2eb95
getting started policy guide draft - page rename
mmcallister Jun 13, 2024
c9e76f4
getting started policy guide draft - page rename
mmcallister Jun 13, 2024
7aa21b9
getting started policy guide draft - page rename
mmcallister Jun 13, 2024
522ebd2
getting started policy guide draft - new pages
mmcallister Jun 14, 2024
5b45027
getting started policy guide draft - new pages
mmcallister Jun 14, 2024
a2a78d0
getting started policy guide draft
mmcallister Jun 14, 2024
1853c30
getting started policy - config
mmcallister Jun 14, 2024
f47354c
getting started policy
mmcallister Jun 14, 2024
c719a0e
getting started policy
mmcallister Jun 14, 2024
1533c2a
getting started policy
mmcallister Jun 14, 2024
de81a04
getting started policy
mmcallister Jun 15, 2024
7f847bc
getting started policy
mmcallister Jun 15, 2024
ae43f36
getting started policy
mmcallister Jun 15, 2024
a68e31c
getting started policy
mmcallister Jun 16, 2024
8943eb3
getting started policy
mmcallister Jun 17, 2024
871eb4a
getting started policy
mmcallister Jun 17, 2024
a020804
getting started policy
mmcallister Jun 17, 2024
0c06da1
getting started policy
mmcallister Jun 17, 2024
ef49a7e
Merge branch 'master' into 2024_policy_getting_started
mmcallister Jun 17, 2024
6829854
getting started policy
mmcallister Jun 17, 2024
4b3800e
getting started policy
mmcallister Jun 17, 2024
ba03c73
getting started policy
mmcallister Jun 17, 2024
5c3a489
getting started policy
mmcallister Jun 17, 2024
d63d848
getting started policy - post-feedback
mmcallister Jun 22, 2024
a7de4ca
Merge branch 'master' into 2024_policy_getting_started
mmcallister Jun 22, 2024
a7f16b3
getting started policy - post-feedback
mmcallister Jun 22, 2024
5625c55
getting started policy - post-feedback
mmcallister Jun 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,8 @@
"ioreg",
"isnt",
"isrgrootx",
"jamfapiendpoint",
"jamfclientid",
"javapipeline",
"jetbrains",
"jiraapitoken",
Expand Down
90 changes: 52 additions & 38 deletions docs/pages/access-controls/access-graph.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,61 @@ users, roles, and resources in your organization. It can help you answer questio
- What users can access a specific resource?
- What are the relationships between users, roles, and resources?

## Getting started with Teleport Policy

Access Graph is a feature of the [Teleport Policy](https://goteleport.com/platform/policy/) product that is only
available to Teleport Enterprise customers.

After logging into the Teleport UI, go to the Management tab. If enabled, Access Graph options can be found
under the Permission Management section.

<Admonition type="note">
Note: For managed Teleport Enterprise customers, Access Graph is enabled by default.
If you are a self-hosted Teleport customer, you will need to set up [Access Graph](./access-graph/self-hosted.mdx).
</Admonition>

![Teleport Access Graph](../../img/access-graph/main-view.png)

## How to use it

Teleport Access Graph can help you to answer questions like:

- Who can access a specific resource?

Determine who has access to resources and understand the pathways that grant access:

![Show Access Path Resource](../../img/access-graph/show-access-path-resource.gif)

- What resources can a specific user access?

At a glance, you can view all the resources a user can access:

![Show Access Path](../../img/access-graph/show-access-path.gif)

## Navigation

![Navigation](../../img/access-graph/sidebar.png)

The left hand side menu contains the main navigation options:

- Graph view
- Search
- SQL editor
- Integrations

## Graph View

Graph view is the main view that shows the connections between identities and resources.
By default, an aggregated view of access paths grouped by identity is showed.

## Search

To search for a graph node, use the search bar at the top of the page or the search icon on the right hand side:

![Search](../../img/access-graph/search.png)

You can then search through all node types and all imported entities.

## Graph nodes

Teleport Access Graph divides your infrastructure into six main components:
Expand Down Expand Up @@ -72,6 +119,8 @@ The number on the right hand side shows the number of resources that a resource
Resources are the things that users can or cannot access. They can be
servers, databases, or Kubernetes clusters.

## Connecting to resources

## Graph paths

Teleport Access Graph shows the relationships between users, roles, and
Expand Down Expand Up @@ -101,42 +150,6 @@ Deny paths connect identities to resources. They show what an identity cannot ac
and what actions they cannot perform. Deny paths take precedence over allow
paths.

## How to use it

Teleport Access Graph can help you to answer questions like:

- Who can access a specific resource?

![Show Access Path Resource](../../img/access-graph/show-access-path-resource.gif)

- What resources can a specific user access?

![Show Access Path](../../img/access-graph/show-access-path.gif)

## Navigation

![Navigation](../../img/access-graph/sidebar.png)

The left hand side menu contains the main navigation options:

- Graph view
- Search
- SQL editor
- Integrations

## Graph View

Graph view is the main view that shows the connections between identities and resources.
By default, an aggregated view of access paths grouped by identity is showed.

## Search

To search for a graph node use the search bar at the top of the page or the search icon on the right hand side.

![Search](../../img/access-graph/search.png)

You can then search through all node types and all imported entities.

## SQL Editor

Access Graph allows creating SQL like queries to explore the graph.
Expand Down Expand Up @@ -177,8 +190,8 @@ More actionable examples is available under ? icon.
Integrations page shows integrations that can be enabled or are already enabled in Access Graph.

<Admonition title="Note" type="tip">
Resources imported into Teleport through Teleport enabled integrations are automatically imported into
Access graph without any additional configuration.
Resources imported into Teleport through Teleport enabled integrations are automatically imported into
Access graph without any additional configuration.
</Admonition>

## How resources and identities are represented
Expand Down Expand Up @@ -228,3 +241,4 @@ Resource Groups are created from Teleport roles.

Resources are created from Teleport resources like nodes, databases, and
Kubernetes clusters.

Loading