Skip to content

Commit

Permalink
Docs: Getting started policy guide (#42577)
Browse files Browse the repository at this point in the history
* getting started policy guide - draft

* getting started policy guide - draft

* getting started policy guide - draft

* getting started policy guide - draft

* restoring cspell - deleted by mistake

* getting started policy guide - fixing link

* getting started policy guide - fixing link

* getting started policy guide - prose edit

* Update docs/pages/access-controls/access-graph.mdx

Co-authored-by: Paul Gottschling <[email protected]>

* getting started policy guide - license  edit

* getting started policy guide - draft

* getting started policy guide - draft

* policy guide - draft (restoring deleted lock file)

* getting started policy guide draft - page rename

* getting started policy guide draft - page rename

* getting started policy guide draft - page rename

* getting started policy guide draft - new pages

* getting started policy guide draft - new pages

* getting started policy guide draft

* getting started policy - config

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy

* getting started policy - post-feedback

* getting started policy - post-feedback

* getting started policy - post-feedback

---------

Co-authored-by: Paul Gottschling <[email protected]>
  • Loading branch information
mmcallister and ptgott authored Jun 22, 2024
1 parent 50cacff commit 5e25f01
Show file tree
Hide file tree
Showing 15 changed files with 339 additions and 242 deletions.
31 changes: 22 additions & 9 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -493,11 +493,24 @@
},
{
"title": "Teleport Policy",
"slug": "/access-controls/access-graph/",
"forScopes": [
"enterprise"
],
"slug": "/access-controls/teleport-policy/getting-started-policy/",
"forScopes": ["enterprise", "cloud"],
"entries": [
{
"title": "Teleport Policy Integrations",
"slug": "/access-controls/teleport-policy/policy-integrations/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Teleport Policy Connections",
"slug": "/access-controls/teleport-policy/policy-connections/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Teleport Policy Usage",
"slug" : "/access-controls/teleport-policy/policy-how-to-use/",
"forScopes":["enterprise","cloud"]
},
{
"title": "Teleport Policy for Self-Hosted Clusters",
"slug": "/access-controls/access-graph/self-hosted/",
Expand Down Expand Up @@ -2420,6 +2433,11 @@
"destination": "/access-controls/introduction/",
"permanent": true
},
{
"source": "/access-controls/teleport-policy/",
"destination": "/access-controls/teleport-policy/getting-started-policy/",
"permanent": true
},
{
"source": "/try-out-teleport/",
"destination": "/",
Expand Down Expand Up @@ -2715,11 +2733,6 @@
"destination": "/server-access/guides/",
"permanent": true
},
{
"source": "/access-graph/",
"destination": "/access-controls/access-graph/",
"permanent": true
},
{
"source": "/database-access/guides/aws-discovery/",
"destination": "/auto-discovery/databases/",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 docs/img/access-graph/connection_view.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 docs/img/access-graph/graph_view.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 docs/img/access-graph/query_view.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 docs/img/access-graph/search_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
230 changes: 0 additions & 230 deletions docs/pages/access-controls/access-graph.mdx

This file was deleted.

4 changes: 2 additions & 2 deletions docs/pages/access-controls/access-graph/aws-sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Access Graph options can be found under the Permission Management section.
Teleport Access Graph discovers AWS access patterns, synchronizes various AWS resources,
including IAM Policies, Groups, Users, User Groups, EC2 instances, EKS clusters, and RDS databases.
These resources are then visualized using the graph representation detailed in the
[Access Graph page](../access-graph.mdx).
[Access Graph page](../teleport-policy/getting-started-policy.mdx).

The importing process involves two primary steps:

Expand Down Expand Up @@ -66,7 +66,7 @@ graphical representation thereof.
- A running Teleport Enterprise cluster v14.3.9/v15.2.0 or later.
- For self-hosted clusters, an updated `license.pem` with Teleport Policy enabled.
- For self-hosted clusters, a running Teleport Access Graph node v1.17.0 or later.
Check [Access Graph page](../access-graph.mdx) for details on
Check [Access Graph page](../teleport-policy/getting-started-policy.mdx) for details on
how to setup Teleport Access Graph.
- The node running the Access Graph service must be reachable
from Teleport Auth Service and Discovery Service.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Teleport Policy
description: A reference for Access Graph with Teleport Policy.
---

Teleport Policy streamlines and centralizes access management across your entire infrastructure. Access Graph provides a
visual representation of the relationships between users, roles, and resources in your organization.
It can help you answer questions like:

- What resources can a specific user access?
- 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 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) and ensure you have an updated
`license.pem` with Teleport Policy enabled to use it.
</Admonition>

## Next steps
- Set up [Policy integrations](./policy-integrations.mdx) for use with Access Graph.
Loading

0 comments on commit 5e25f01

Please sign in to comment.