diff --git a/docs/config.json b/docs/config.json index ff2af4f081fe9..6093bb55d4b65 100644 --- a/docs/config.json +++ b/docs/config.json @@ -79,6 +79,16 @@ } ] }, + { + "title": "Admin Guides", + "icon": "wrench", + "entries": [ + { + "title": "All Topics", + "slug": "/admin-guides/" + } + ] + }, { "icon": "success", "title": "Choose an Edition", @@ -1687,37 +1697,6 @@ } ] }, - { - "icon": "list", - "title": "API", - "entries": [ - { - "title": "Introduction", - "slug": "/api/introduction/" - }, - { - "title": "Getting Started", - "slug": "/api/getting-started/" - }, - { - "title": "Architecture", - "slug": "/api/architecture/" - }, - { - "title": "How to Build an Access Request Plugin", - "slug": "/api/access-plugin/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Automatically Register Teleport Agents", - "slug": "/api/automatically-register-agents/" - }, - { - "title": "Automatically Generate Roles", - "slug": "/api/rbac/" - } - ] - }, { "icon": "book", "title": "Reference", @@ -1857,55 +1836,11 @@ "slug": "/reference/helm-reference/teleport-plugin-slack/" } ] - } - ] - }, - { - "icon": "integrations", - "title": "Architecture", - "entries": [ - { - "title": "Introduction", - "slug": "/architecture/introduction/" - }, - { - "title": "Authentication", - "slug": "/architecture/authentication/" - }, - { - "title": "Authorization", - "slug": "/architecture/authorization/" - }, - { - "title": "Teleport Proxy", - "slug": "/architecture/proxy/" - }, - { - "title": "Trusted Clusters", - "slug": "/architecture/trustedclusters/" }, { - "title": "Teleport Agents", - "slug": "/architecture/agents/" - }, - { - "title": "Session Recording", - "slug": "/architecture/session-recording/" - }, - { - "title": "TLS Routing", - "slug": "/architecture/tls-routing/" - }, - { - "title": "Proxy Peering", - "slug": "/architecture/proxy-peering/", - "forScopes": ["enterprise"] - }, - { - "title": "Agent Update Management", - "slug": "/architecture/agent-update-management/", - "forScopes": ["enterprise", "cloud"] - } + "title": "All Topics", + "slug": "/reference/" + } ] } ], @@ -2003,11 +1938,6 @@ } }, "redirects": [ - { - "source": "/architecture/users/", - "destination": "/architecture/authorization/", - "permanent": true - }, { "source": "/enterprise/ssh_sso/", "destination": "/access-controls/sso/", @@ -2038,11 +1968,6 @@ "destination": "/", "permanent": true }, - { - "source": "/api-reference/", - "destination": "/api/getting-started/", - "permanent": true - }, { "source": "/server-access/guides/tsh/", "destination": "/connect-your-client/tsh/", @@ -2708,21 +2633,11 @@ "destination": "/connect-your-client/introduction/", "permanent": true }, - { - "source": "/api/", - "destination": "/api/introduction/", - "permanent": true - }, { "source": "/preview/", "destination": "/upcoming-releases/", "permanent": true }, - { - "source": "/architecture/", - "destination": "/architecture/introduction/", - "permanent": true - }, { "source": "/management/guides/joining-nodes-aws-ec2/", "destination": "/agents/join-services-to-your-cluster/aws-ec2/", diff --git a/docs/pages/admin-guides.mdx b/docs/pages/admin-guides.mdx new file mode 100644 index 0000000000000..7934cd0c45e3b --- /dev/null +++ b/docs/pages/admin-guides.mdx @@ -0,0 +1,15 @@ +--- +title: "Teleport Admin Guides" +description: "Step-by-step guides to performing common Teleport tasks" +--- + +{/*TOPICS*/} + +## Teleport API Introduction + +Introduction to the Teleport gRPC API. ([more info](admin-guides/api.mdx)) + +- [API Getting Started Guide](admin-guides/api/getting-started.mdx): Get started working with the Teleport API programmatically using Go. +- [Automatically Register Resources with Teleport](admin-guides/api/automatically-register-agents.mdx): Learn how to use the Teleport API to start agents automatically when you add resources to your infrastructure. +- [Generate Teleport Roles from an External RBAC System](admin-guides/api/rbac.mdx): Use Teleport's API to automatically generate Teleport roles based on third-party RBAC policies +- [How to Build an Access Request Plugin](admin-guides/api/access-plugin.mdx): Manage Access Requests using custom workflows with the Teleport API diff --git a/docs/pages/api/introduction.mdx b/docs/pages/admin-guides/api.mdx similarity index 59% rename from docs/pages/api/introduction.mdx rename to docs/pages/admin-guides/api.mdx index cd3a3879ea97e..34b6b3b3d7194 100644 --- a/docs/pages/api/introduction.mdx +++ b/docs/pages/admin-guides/api.mdx @@ -7,8 +7,6 @@ layout: tocless-doc The Teleport Auth Service provides a gRPC API for remotely interacting with your cluster. In this section, we will show you how to use Teleport's API. -## Go client - Teleport has a public [Go client](https://pkg.go.dev/github.com/gravitational/teleport/api/client) to programatically interact with the API. [tsh and tctl](../reference/cli.mdx) use @@ -23,24 +21,14 @@ Here is what you can do with the Go Client: and provisioning tokens. - Dynamically configure Teleport. -## Get started - -Create an API client in 3 minutes with the [Getting Started -Guide](./getting-started.mdx). - -## Learn how to use Teleport's API libraries - The following guides provide tours of API libraries that are relevant when setting up an API client to automate some aspect of setting up Teleport. Read these guides to set up a minimal working example and plan your own use of Teleport's API client libraries: -- [Automatically Register Teleport Agents](./automatically-register-agents.mdx): - Write a Teleport API client to reconcile the resources in your Teleport - cluster with an external service discovery API. -- [Automatically generate Teleport roles](./rbac.mdx) from an external RBAC - system, making it easier to get started with Teleport-based RBAC and keep your - Teleport roles up to date. -- [Write an Access Request Plugin](./access-plugin.mdx): Follow this guide for a - minimal working example of a plugin that you can use to manage Access Requests - through your organization's unique communication workflows. +{/*TOPICS*/} + +- [API Getting Started Guide](api/getting-started.mdx): Get started working with the Teleport API programmatically using Go. +- [Automatically Register Resources with Teleport](api/automatically-register-agents.mdx): Learn how to use the Teleport API to start agents automatically when you add resources to your infrastructure. +- [Generate Teleport Roles from an External RBAC System](api/rbac.mdx): Use Teleport's API to automatically generate Teleport roles based on third-party RBAC policies +- [How to Build an Access Request Plugin](api/access-plugin.mdx): Manage Access Requests using custom workflows with the Teleport API diff --git a/docs/pages/api/access-plugin.mdx b/docs/pages/admin-guides/api/access-plugin.mdx similarity index 100% rename from docs/pages/api/access-plugin.mdx rename to docs/pages/admin-guides/api/access-plugin.mdx diff --git a/docs/pages/api/automatically-register-agents.mdx b/docs/pages/admin-guides/api/automatically-register-agents.mdx similarity index 100% rename from docs/pages/api/automatically-register-agents.mdx rename to docs/pages/admin-guides/api/automatically-register-agents.mdx diff --git a/docs/pages/api/getting-started.mdx b/docs/pages/admin-guides/api/getting-started.mdx similarity index 100% rename from docs/pages/api/getting-started.mdx rename to docs/pages/admin-guides/api/getting-started.mdx diff --git a/docs/pages/api/rbac.mdx b/docs/pages/admin-guides/api/rbac.mdx similarity index 100% rename from docs/pages/api/rbac.mdx rename to docs/pages/admin-guides/api/rbac.mdx diff --git a/docs/pages/api.mdx b/docs/pages/api.mdx deleted file mode 100644 index 9c1f58cde3a73..0000000000000 --- a/docs/pages/api.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Teleport API Guides -description: How to use the Teleport gRPC API, which allows custom client tools to manage dynamic Teleport resources. ---- - -{/*TOPICS*/} - -- [API Architecture](api/architecture.mdx): Architectural overview of the Teleport gRPC API. -- [API Getting Started Guide](api/getting-started.mdx): Get started working with the Teleport API programmatically using Go. -- [Automatically Register Resources with Teleport](api/automatically-register-agents.mdx): Learn how to use the Teleport API to start agents automatically when you add resources to your infrastructure. -- [Generate Teleport Roles from an External RBAC System](api/rbac.mdx): Use Teleport's API to automatically generate Teleport roles based on third-party RBAC policies -- [How to Build an Access Request Plugin](api/access-plugin.mdx): Manage Access Requests using custom workflows with the Teleport API -- [Teleport API Introduction](api/introduction.mdx): Introduction to the Teleport gRPC API. diff --git a/docs/pages/reference.mdx b/docs/pages/reference.mdx index e4c05f97632d2..25c0cfe1ba4a4 100644 --- a/docs/pages/reference.mdx +++ b/docs/pages/reference.mdx @@ -36,6 +36,22 @@ Comprehensive lists of configuration values in Teleport's Helm charts ([more inf - [teleport-plugin-pagerduty Chart Reference](reference/helm-reference/teleport-plugin-pagerduty.mdx): Values that can be set using the teleport-plugin-pagerduty Helm chart - [teleport-plugin-slack Chart Reference](reference/helm-reference/teleport-plugin-slack.mdx): Values that can be set using the teleport-plugin-slack Helm chart +## Teleport Architecture Guides + +Guides to the inner workings of components within a Teleport cluster. ([more info](reference/architecture.mdx)) + +- [API Architecture](reference/architecture/architecture.mdx): Architectural overview of the Teleport gRPC API. +- [Agent Update Management](reference/architecture/agent-update-management.mdx): This chapter explains how Teleport agent automatic update is working. +- [Proxy Peering](reference/architecture/proxy-peering.mdx): How Teleport implements more efficient networking with Proxy Peering. +- [TLS Routing](reference/architecture/tls-routing.mdx): How Teleport implements a single-port setup with TLS routing +- [Teleport Architecture Guides](reference/architecture/introduction.mdx): Get detailed information about how Teleport works +- [Teleport Authentication](reference/architecture/authentication.mdx): This chapter explains how Teleport uses certificate authorities to authenticate users and services. +- [Teleport Authorization](reference/architecture/authorization.mdx): This chapter explains how Teleport authorizes users and roles. +- [Teleport Proxy Service](reference/architecture/proxy.mdx): Architecture of Teleport's identity-aware proxy service +- [Teleport SSH Nodes](reference/architecture/nodes.mdx): This chapter explains the concept of a Teleport Node and how Teleport manages SSH. +- [Teleport Session Recording](reference/architecture/session-recording.mdx): An overview of Teleport's session recording and its configuration +- [Trusted Clusters Architecture](reference/architecture/trustedclusters.mdx): Deep dive into design of Teleport Trusted Clusters. + ## Teleport CLI Reference Guides Comprehensive lists of commands, arguments, and flags for Teleport CLI tools. ([more info](reference/cli.mdx)) diff --git a/docs/pages/architecture.mdx b/docs/pages/reference/architecture.mdx similarity index 93% rename from docs/pages/architecture.mdx rename to docs/pages/reference/architecture.mdx index 9709d7b61edea..9d2142388a6e1 100644 --- a/docs/pages/architecture.mdx +++ b/docs/pages/reference/architecture.mdx @@ -5,6 +5,7 @@ description: Guides to the inner workings of components within a Teleport cluste {/*TOPICS*/} +- [API Architecture](architecture/architecture.mdx): Architectural overview of the Teleport gRPC API. - [Agent Update Management](architecture/agent-update-management.mdx): This chapter explains how Teleport agent automatic update is working. - [Proxy Peering](architecture/proxy-peering.mdx): How Teleport implements more efficient networking with Proxy Peering. - [TLS Routing](architecture/tls-routing.mdx): How Teleport implements a single-port setup with TLS routing diff --git a/docs/pages/architecture/agent-update-management.mdx b/docs/pages/reference/architecture/agent-update-management.mdx similarity index 100% rename from docs/pages/architecture/agent-update-management.mdx rename to docs/pages/reference/architecture/agent-update-management.mdx diff --git a/docs/pages/architecture/agents.mdx b/docs/pages/reference/architecture/agents.mdx similarity index 100% rename from docs/pages/architecture/agents.mdx rename to docs/pages/reference/architecture/agents.mdx diff --git a/docs/pages/api/architecture.mdx b/docs/pages/reference/architecture/architecture.mdx similarity index 100% rename from docs/pages/api/architecture.mdx rename to docs/pages/reference/architecture/architecture.mdx diff --git a/docs/pages/architecture/authentication.mdx b/docs/pages/reference/architecture/authentication.mdx similarity index 100% rename from docs/pages/architecture/authentication.mdx rename to docs/pages/reference/architecture/authentication.mdx diff --git a/docs/pages/architecture/authorization.mdx b/docs/pages/reference/architecture/authorization.mdx similarity index 100% rename from docs/pages/architecture/authorization.mdx rename to docs/pages/reference/architecture/authorization.mdx diff --git a/docs/pages/architecture/introduction.mdx b/docs/pages/reference/architecture/introduction.mdx similarity index 100% rename from docs/pages/architecture/introduction.mdx rename to docs/pages/reference/architecture/introduction.mdx diff --git a/docs/pages/architecture/proxy-peering.mdx b/docs/pages/reference/architecture/proxy-peering.mdx similarity index 100% rename from docs/pages/architecture/proxy-peering.mdx rename to docs/pages/reference/architecture/proxy-peering.mdx diff --git a/docs/pages/architecture/proxy.mdx b/docs/pages/reference/architecture/proxy.mdx similarity index 100% rename from docs/pages/architecture/proxy.mdx rename to docs/pages/reference/architecture/proxy.mdx diff --git a/docs/pages/architecture/session-recording.mdx b/docs/pages/reference/architecture/session-recording.mdx similarity index 100% rename from docs/pages/architecture/session-recording.mdx rename to docs/pages/reference/architecture/session-recording.mdx diff --git a/docs/pages/architecture/tls-routing.mdx b/docs/pages/reference/architecture/tls-routing.mdx similarity index 100% rename from docs/pages/architecture/tls-routing.mdx rename to docs/pages/reference/architecture/tls-routing.mdx diff --git a/docs/pages/architecture/trustedclusters.mdx b/docs/pages/reference/architecture/trustedclusters.mdx similarity index 100% rename from docs/pages/architecture/trustedclusters.mdx rename to docs/pages/reference/architecture/trustedclusters.mdx diff --git a/package.json b/package.json index c2a3d2185015c..7bf2b9001b7f7 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "teleport-ui", "version": "1.0.0", "scripts": { - "all-topics": "node docs/gen-topic-pages/index.js --in docs/pages/database-access,docs/pages/access-controls,docs/pages/desktop-access,docs/pages/kubernetes-access,docs/pages/connect-your-client,docs/pages/agents,docs/pages/auto-discovery,docs/pages/architecture,docs/pages/api,docs/pages/choose-an-edition,docs/pages/server-access,docs/pages/deploy-a-cluster,docs/pages/machine-id,docs/pages/reference,docs/pages/application-access", + "all-topics": "node docs/gen-topic-pages/index.js --in docs/pages/admin-guides,docs/pages/database-access,docs/pages/access-controls,docs/pages/desktop-access,docs/pages/kubernetes-access,docs/pages/connect-your-client,docs/pages/agents,docs/pages/auto-discovery,docs/pages/choose-an-edition,docs/pages/server-access,docs/pages/deploy-a-cluster,docs/pages/machine-id,docs/pages/reference,docs/pages/application-access", "build-ui": "yarn build-ui-oss && yarn build-ui-e", "build-ui-oss": "yarn workspace @gravitational/teleport build", "build-ui-e": "yarn workspace @gravitational/teleport.e build",