self-hosted/teleport
self-hosted/teleport
1
0
Fork 0
mirror of https://github.com/gravitational/teleport synced 2024-10-20 01:03:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
teleport/docs/config.json

2155 lines
62 KiB
JSON
Raw Normal View History

New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
{
"navigation": [
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"icon": "home",
Move introductions to the appropriate sections (#6456)
2021-04-15 00:06:57 +00:00
"title": "Home",
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Introduction",
"slug": "/"
},
Add a glossary of Teleport terms (#16762) * Add a glossary of Teleport terms Closes #16121 Closes #13363 - Create a Core Concepts page based on the Architecture Overview page. The Overview page is an outline of core concepts, so I thought it would make a good starting point for the glossary. - Add the Core Concepts page to the Home section to make it more prominent for users who are visiting the docs homepage. This should give it more traffic than leaving it in the Architecture section. - Move definitions out of the "Definitions" table. Since this table repeats content from the body sections and comes after them, it makes sense to condense all content into brief body sections. - Alphabetize sections - Bold the first instance of each keyword within a given section. Not adding links since these are all to the same page. It might get a bit confusing to click a link and not see a change in view, since the target section would already be on the page. - Remove the intro paragraph of the old Overview page, since it's not strictly related to core concepts. * Respond to PR feedback and add further edits - Group definitions into H3-level sections organized into H2s, improving readability by presenting the more central components first. - Group "Machine ID" with "Teleport Services" to simplify the glossary. - Call instances of a Teleport Service an "agent". This is consistent with our source and informal language about Teleport. This also removes the "Node" terminology, which is prone to misuse (does it mean "a Service instance"? An "SSH Service instance"? Both are present in the docs) and easily confused with the lowercase "node" (i.e., a host). - For simplicity, remove the term "Teleport Process" and simply explain that multiple Teleport Services can run via the same binary. - Add a section on Teleport's editions, including the terms "Community Edition", "Enterprise", and "Enterprise Cloud". - Remove the mention of Teleport Discover, which isn't documented yet. - Minor wording/readability changes. * Respond to PR feedback * Respond to zmb3 feedback
2022-12-08 17:32:50 +00:00
{
"title": "Core Concepts",
"slug": "/core-concepts/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Adopters",
"slug": "/adopters/"
},
{
"title": "Installation",
"slug": "/installation/"
},
{
"title": "FAQ",
"slug": "/faq/"
},
{
"title": "Changelog",
"slug": "/changelog/"
}
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
]
},
Initial terraform guide (#7136) (#7149)
2021-06-02 22:46:59 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"icon": "play",
"title": "Try out Teleport",
Initial terraform guide (#7136) (#7149)
2021-06-02 22:46:59 +00:00
"entries": [
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
{
"title": "Introduction",
"slug": "/try-out-teleport/introduction/"
},
{
"title": "Linux Server",
"slug": "/try-out-teleport/linux-server/"
},
{
"title": "Digital Ocean",
"slug": "/try-out-teleport/digitalocean/"
},
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Browser Labs",
"slug": "/try-out-teleport/browser-labs/"
},
{
"title": "Docker Compose",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/try-out-teleport/docker-compose/"
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
},
{
"title": "Local Kubernetes Lab",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/try-out-teleport/local-kubernetes/"
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
}
]
},
{
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"icon": "success",
"title": "Choose an Edition",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"entries": [
Add a guide to deploying an HA cluster (#19217) * Add a guide to deploying an HA cluster Closes #16751 This is a general guide that prefaces our HA deployment guides. Also adds an introduction to the "deploy-a-cluster" section. * Respond to some PR feedback - Add mentions of specific services (Auth and Proxy) where it would help with clarity. - Edit port tables to remove ports that shouldn't be publicly exposed. - Clarify the supported backends. - Clarify that Let's Encrypt is not required for TLS credential management. * Respond to more PR feedback - Add context around DNS records - Use "Layer 4" instead of "Layer Four" - Explain optional ports more explicitly - Fix spacing issues - Indicate that you can use an S3-compatible object store - Clarify cert-fetching behavior for applications - Describe separate port configs depending on whether TLS Routing is enabled, and add a brief section re: whether to enable TLS Routing - Expand the Teleport configuration section to accommodate TLS Routing and separate listeners * Add more context to the "Deploy a Cluster" intro * Small language tweaks * Add an image * Respond to zmb3 feedback - Use "cluster state backend" and "session recording backend" - Mention cross-zone load balancing - Link to the Backends Reference instead of including example backend configurations - Use v3 for example configs - Fix example config indentation * Add CTA for Teleport Cloud and forScopes
2022-12-21 13:46:16 +00:00
{
"title": "Introduction",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/introduction/"
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
},
{
"title": "Teleport Cloud",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-cloud/introduction/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["cloud"],
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Getting Started",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-cloud/getting-started/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Architecture",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-cloud/architecture/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Downloads",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-cloud/downloads/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "FAQ",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-cloud/faq/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["cloud"]
}
]
},
{
"title": "Teleport Enterprise",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-enterprise/introduction/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["enterprise"],
"entries": [
{
"title": "Getting Started",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-enterprise/getting-started/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "HSM",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-enterprise/hsm/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
Add docs for GCP KMS support (#18465)
2022-11-17 17:17:14 +00:00
{
"title": "Google Cloud KMS",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-enterprise/gcp-kms/",
Add docs for GCP KMS support (#18465)
2022-11-17 17:17:14 +00:00
"forScopes": ["enterprise"]
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Enterprise License File",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"slug": "/choose-an-edition/teleport-enterprise/license/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["enterprise"]
}
]
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
}
]
},
{
"icon": "quickstart",
"title": "Deploy a Cluster",
"entries": [
{
"title": "Introduction",
"slug": "/deploy-a-cluster/introduction/"
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
},
Add a guide to deploying an HA cluster (#19217) * Add a guide to deploying an HA cluster Closes #16751 This is a general guide that prefaces our HA deployment guides. Also adds an introduction to the "deploy-a-cluster" section. * Respond to some PR feedback - Add mentions of specific services (Auth and Proxy) where it would help with clarity. - Edit port tables to remove ports that shouldn't be publicly exposed. - Clarify the supported backends. - Clarify that Let's Encrypt is not required for TLS credential management. * Respond to more PR feedback - Add context around DNS records - Use "Layer 4" instead of "Layer Four" - Explain optional ports more explicitly - Fix spacing issues - Indicate that you can use an S3-compatible object store - Clarify cert-fetching behavior for applications - Describe separate port configs depending on whether TLS Routing is enabled, and add a brief section re: whether to enable TLS Routing - Expand the Teleport configuration section to accommodate TLS Routing and separate listeners * Add more context to the "Deploy a Cluster" intro * Small language tweaks * Add an image * Respond to zmb3 feedback - Use "cluster state backend" and "session recording backend" - Mention cross-zone load balancing - Link to the Backends Reference instead of including example backend configurations - Use v3 for example configs - Fix example config indentation * Add CTA for Teleport Cloud and forScopes
2022-12-21 13:46:16 +00:00
{
"title": "High Availability Deployments",
"slug": "/deploy-a-cluster/high-availability/",
"forScopes": ["oss", "enterprise"]
},
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
{
"title": "Deploy with Helm",
"slug": "/deploy-a-cluster/helm-deployments/",
"forScopes": ["oss", "enterprise"],
"entries": [
{
"title": "Deploy Teleport on Kubernetes",
"slug": "/deploy-a-cluster/helm-deployments/kubernetes-cluster/",
Apply forScopes feature to articles (#14704)
2022-07-20 19:26:27 +00:00
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "AWS EKS Cluster",
"slug": "/deploy-a-cluster/helm-deployments/aws/",
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Google Cloud GKE Cluster",
"slug": "/deploy-a-cluster/helm-deployments/gcp/",
"forScopes": ["oss", "enterprise"]
},
{
"title": "DigitalOcean Kubernetes Cluster",
"slug": "/deploy-a-cluster/helm-deployments/digitalocean/",
"forScopes": ["oss", "enterprise"]
},
{
"title": "Customize Deployment Config",
"slug": "/deploy-a-cluster/helm-deployments/custom/",
"forScopes": ["oss", "enterprise"]
},
{
"title": "Migrating From Older Charts",
"slug": "/deploy-a-cluster/helm-deployments/migration/",
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
]
},
Initial terraform guide (#7136) (#7149)
2021-06-02 22:46:59 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Deploy to your Cloud",
"slug": "/deploy-a-cluster/deployments/",
Apply forScopes feature to articles (#14704)
2022-07-20 19:26:27 +00:00
"forScopes": ["oss", "enterprise"],
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "AWS Terraform",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/deploy-a-cluster/deployments/aws-terraform/",
Apply forScopes feature to articles (#14704)
2022-07-20 19:26:27 +00:00
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
"title": "GCP",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/deploy-a-cluster/deployments/gcp/",
Apply forScopes feature to articles (#14704)
2022-07-20 19:26:27 +00:00
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
"title": "IBM",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/deploy-a-cluster/deployments/ibm/",
Apply forScopes feature to articles (#14704)
2022-07-20 19:26:27 +00:00
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
]
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
}
]
},
{
"icon": "lock",
"title": "Configure Access",
"entries": [
{
"title": "Introduction",
"slug": "/access-controls/introduction/"
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
},
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Getting Started",
"slug": "/access-controls/getting-started/"
},
{
"title": "Cluster Access and RBAC",
"slug": "/access-controls/guides/",
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
"entries": [
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Role Templates",
"slug": "/access-controls/guides/role-templates/"
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Session Locking",
"slug": "/access-controls/guides/locking/"
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
},
{
Drop "preview" from passwordless docs (#20143) Officially drop "preview" from passwordless.
2023-01-12 19:13:20 +00:00
"title": "Passwordless",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/access-controls/guides/passwordless/"
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Second Factor - WebAuthn",
"slug": "/access-controls/guides/webauthn/"
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Per-session MFA",
"slug": "/access-controls/guides/per-session-mfa/"
},
{
"title": "Dual Authorization",
"slug": "/access-controls/guides/dual-authz/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Impersonation",
"slug": "/access-controls/guides/impersonation/"
},
{
"title": "Moderated Sessions",
"slug": "/access-controls/guides/moderated-sessions/",
"forScopes": ["enterprise", "cloud"]
Hardware Key docs (#17258)
2022-10-20 20:01:06 +00:00
},
{
"title": "Hardware Key Support (Preview)",
"slug": "/access-controls/guides/hardware-key-support/",
"forScopes": ["enterprise", "cloud"]
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
}
]
},
Splits admin guide into setup sections (#8324) * Updates scaling guide. * Rewrites CA rotation guide. * Small tweaks and fixes to other parts.
2021-09-20 17:22:12 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Single Sign-On (SSO)",
"slug": "/access-controls/sso/",
[Docs] SSO Page fixes. (#17447) * Add scopes to the SSO page This page contains ScopedBlocks for all three current scopes * remove ScopedBlock from workarounns section I understand why the block was added, but if users forget to check Enterprise or Cloud they will miss valuable information, and it does no harm showing it for OSS users * Markdown cleanup Newlines around codeblocks make my local linter happy. the <br/> tags in the table prevent the rendered table from breaking up .
2022-10-17 15:12:59 +00:00
"forScopes": ["enterprise", "oss", "cloud"],
Splits admin guide into setup sections (#8324) * Updates scaling guide. * Rewrites CA rotation guide. * Small tweaks and fixes to other parts.
2021-09-20 17:22:12 +00:00
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "GitHub SSO",
Add info to docs about working with github enterprise server (#18712) * add info to docs about working with github enterprise server * Update docs/pages/access-controls/sso/github-sso.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Review Edits for #18712 (#18755) * add scopes for edited file to config.json * replace ScopedBlock with Tabs for config example * Update docs/pages/access-controls/sso/github-sso.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2022-11-28 16:25:37 +00:00
"slug": "/access-controls/sso/github-sso/",
"forScopes": ["enterprise", "cloud", "oss"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Azure Active Directory (AD)",
"slug": "/access-controls/sso/azuread/",
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Active Directory (ADFS)",
"slug": "/access-controls/sso/adfs/",
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Google Workspace",
"slug": "/access-controls/sso/google-workspace/",
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "GitLab",
"slug": "/access-controls/sso/gitlab/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "OneLogin",
"slug": "/access-controls/sso/one-login/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "OIDC",
"slug": "/access-controls/sso/oidc/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Okta",
"slug": "/access-controls/sso/okta/",
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Splits admin guide into setup sections (#8324) * Updates scaling guide. * Rewrites CA rotation guide. * Small tweaks and fixes to other parts.
2021-09-20 17:22:12 +00:00
]
},
Create a blast radius reduction guide (#9189) * Create a blast radius reduction guide This is the first guide within the "Security" subsection within the "Setup" section of the docs site. Closes #9055 * Respond to PR feedback
2021-12-15 15:58:16 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Access Requests",
"slug": "/access-controls/access-requests/",
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
"entries": [
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Role Requests",
"slug": "/access-controls/access-requests/role-requests/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Resource Requests",
"slug": "/access-controls/access-requests/resource-requests/",
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Create a blast radius reduction guide (#9189) * Create a blast radius reduction guide This is the first guide within the "Security" subsection within the "Setup" section of the docs site. Closes #9055 * Respond to PR feedback
2021-12-15 15:58:16 +00:00
]
},
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Access Request Plugins",
"slug": "/access-controls/access-request-plugins/",
"forScopes": ["enterprise", "cloud"],
Initial terraform guide (#7136) (#7149)
2021-06-02 22:46:59 +00:00
"entries": [
Document teleport-operator (#14965) * Document teleport-operator
2022-08-08 20:33:07 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Mattermost",
"slug": "/access-controls/access-request-plugins/ssh-approval-mattermost/",
"forScopes": ["enterprise", "cloud"]
Document teleport-operator (#14965) * Document teleport-operator
2022-08-08 20:33:07 +00:00
},
Document MsTeams access plugin (#15941) Co-authored-by: alexfornuto <alex@fornuto.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-09-22 18:35:06 +00:00
{
"title": "Microsoft Teams",
"slug": "/access-controls/access-request-plugins/ssh-approval-msteams/",
"forScopes": ["enterprise", "cloud"]
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "PagerDuty",
"slug": "/access-controls/access-request-plugins/ssh-approval-pagerduty/",
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Remove the Jira Server Access Plugin guide (#17546) Closes #14578 The Jira Cloud guide applies to all Jira deployments already, so we don't need to maintain separate guides. This change renames the Jira Cloud guide so it's about Jira in general.
2022-11-04 20:28:58 +00:00
"title": "Jira",
"slug": "/access-controls/access-request-plugins/ssh-approval-jira/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Slack",
"slug": "/access-controls/access-request-plugins/ssh-approval-slack/",
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Email",
"slug": "/access-controls/access-request-plugins/ssh-approval-email/",
"forScopes": ["enterprise", "cloud"]
Document Discord access plugin (#17593) * Document Discord access plugin * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * fixup! Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-11-25 21:43:58 +00:00
},
{
"title": "Discord",
"slug": "/access-controls/access-request-plugins/ssh-approval-discord/",
"forScopes": ["enterprise", "cloud"]
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
}
]
},
{
"title": "Compliance Frameworks",
"slug": "/access-controls/compliance-frameworks/",
"forScopes": ["enterprise", "cloud"],
"entries": [
Split the AWS Node Joining guide (#11081) * Split the AWS Node Joining guide This is to better address users with different scopes (see #10633). Since the EC2 method is irrelevant for Cloud users, this approach makes it straightforward to add an edition warning to the top of the EC2 join method guide and scoped Tabs components to the IAM join method guide. The alternative was to add nested Tabs components, with the top level including Cloud vs. Self-Hosted TabItems and the inner level including TabItems for the IAM and EC2 join methods. This looked pretty unattractive and couldn't accommodate the final section on using the EC2 method with multiple AWS accounts. * Respond to PR feedback Co-authored-by: Nic Klaassen <nic@goteleport.com> * Respond to PR feedback Co-authored-by: Nic Klaassen <nic@goteleport.com>
2022-03-23 21:09:26 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "FedRAMP",
"slug": "/access-controls/compliance-frameworks/fedramp/",
"forScopes": ["enterprise"]
Add documentation for ssh key extensions with github (#10386)
2022-03-30 08:45:32 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "SOC 2",
"slug": "/access-controls/compliance-frameworks/soc2/",
"forScopes": ["enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Terraform reference (#7291) Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com> Co-authored-by: Victor Sokolov <gzigzigzeo@gmail.com>
2021-06-13 02:10:19 +00:00
]
},
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
Terraform reference (#7291) Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com> Co-authored-by: Victor Sokolov <gzigzigzeo@gmail.com>
2021-06-13 02:10:19 +00:00
{
"title": "Reference",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/access-controls/reference/"
},
{
"title": "FAQ",
"slug": "/access-controls/faq/"
}
]
},
{
"icon": "wrench",
"title": "Manage your Cluster",
"entries": [
{
"title": "Admin Guides",
"slug": "/management/admin/",
Terraform reference (#7291) Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com> Co-authored-by: Victor Sokolov <gzigzigzeo@gmail.com>
2021-06-13 02:10:19 +00:00
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Adding Nodes",
"slug": "/management/admin/adding-nodes/"
},
{
"title": "Trusted Clusters",
"slug": "/management/admin/trustedclusters/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Labels",
"slug": "/management/admin/labels/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Local Users",
"slug": "/management/admin/users/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Troubleshooting",
"slug": "/management/admin/troubleshooting/",
[Docs] Adjust scoped blocks. (#17221) * Remove spaces between scoped blocks This enables faster regex searching for single scoped blocks, without alternate content for other scopes * replace single scoped block with details component By doing this, something remains visible even when the user hasn't selected the Enterprise scope. That way if they forgot to, they still have something visible to expand and get the information they need. * make single scoped Details blocks scopeOnly=false That way readers will still know there is content that doesn't apply to the current scope, in case they forgot to select the correct one
2022-10-15 01:01:19 +00:00
"forScopes": ["oss", "enterprise", "cloud"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Upgrading the Teleport Binary",
"slug": "/management/admin/upgrading-the-teleport-binary/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Run Teleport as a Daemon",
"slug": "/management/admin/daemon/"
docs: add self signed certs guide (#16182) * Add slug for self signed certs * Add self-signed certs guide * Move tls cert setup into an include snippet * Update tsh section on self signed certs * Fix indentation * Remove extra slash before heading * Update docs/config.json Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/includes/tls-certificate-setup.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Fix formatting of github suggestion commit * Change link title to avoid abbreviation * Update intro to explain the purpose of the guide and why anyone would want it * Make 'proxy' and 'certs' consistent throughout the guide: certs -> certificates proxy -> Proxy Service * Move motivation for guide out of warning and into intro * Simplify the warning notice * Change headings * Capitalize helm and simplify label * Update Helm info to include inline instructions * Simplify systemd label * Update systemd tab * Update slug certs -> certificates * Fix include snippet yaml example * Change prereqs to omit cloud tab and instruct user to check for self-signed certs config * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Get specific about problem caused by insecure TLS * Remove 'how to setup tls certs' section in favor of a link at the bottom * Add examples for tsh and tctl, and clean up tctl wording * Remove link to systemd guide * Add more detail to systemd instructions * Change wording around instructions for teleport * Rearrange links * Remove reference to deleted acme.mdx * Remove v2 config reference to auth_servers * Remove list syntax for proxy_server Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-10-11 18:02:42 +00:00
},
{
"title": "Run Teleport with Self-Signed Certificates",
"slug": "/management/admin/self-signed-certs/"
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
}
]
},
{
"title": "Operations",
"slug": "/management/operations/",
"entries": [
{
"title": "Scaling",
"slug": "/management/operations/scaling/",
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Upgrading a Cluster",
"slug": "/management/operations/upgrading/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Backup and Restore",
"slug": "/management/operations/backup-restore/",
Apply forScopes feature to articles (#14704)
2022-07-20 19:26:27 +00:00
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Cert Authority Rotation",
"slug": "/management/operations/ca-rotation/"
Update predicate doc example to use bracket notation (#12237) To train users to use the bracket notation as the dot notation has limitations e.g `labels.type` is an error because `type` is a reserved keyword in the parser we use in vulcand library.
2022-04-26 23:57:19 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "TLS Routing Migration",
"slug": "/management/operations/tls-routing/",
"forScopes": ["oss", "enterprise"]
Add documentation for proxy peering (#15790)
2022-10-04 16:00:37 +00:00
},
{
"title": "Proxy Peering Migration",
"slug": "/management/operations/proxy-peering/",
"forScopes": ["enterprise"]
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
}
]
},
{
"title": "Security",
"slug": "/management/security/",
"entries": [
Make the Graceful Restarts guide more usable (#12119) * Make the Graceful Restarts guide more usable See #11841 - Split the Graceful Restarts guide. Move the Signals section into its own reference so users looking for all signals (and not necessarily the ones to use for restarts) can find them more easily. - Rename the guide to "Upgrading the Teleport Binary", since the bulk of the guide is about upgrading, not just restarts. - Used the "Step n/d" format in headings since the guide is a step-by-step tutorial. - Distinguish the cluster and binary upgrade guides by renaming the cluster upgrade guide and adding links between the guides. - Tweak/fill in example commands/steps based on manual testing. * Respond to PR feedback
2022-05-12 21:17:34 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Reducing the Blast Radius of Attacks",
"slug": "/management/security/reduce-blast-radius/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Initial terraform guide (#7136) (#7149)
2021-06-02 22:46:59 +00:00
]
Move Helm references (#13102) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm chart references. These are not exclusive to the Teleport Kubernetes Service, so I am suggesting moving these guides to the /docs/setup section to make them more discoverable.
2022-06-24 21:38:59 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Integrations",
"slug": "/management/guides/",
Move Helm references (#13102) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm chart references. These are not exclusive to the Teleport Kubernetes Service, so I am suggesting moving these guides to the /docs/setup section to make them more discoverable.
2022-06-24 21:38:59 +00:00
"entries": [
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Kubernetes Operator (Preview)",
"slug": "/management/guides/teleport-operator/"
Move Helm references (#13102) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm chart references. These are not exclusive to the Teleport Kubernetes Service, so I am suggesting moving these guides to the /docs/setup section to make them more discoverable.
2022-06-24 21:38:59 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Terraform Provider",
"slug": "/management/guides/terraform-provider/"
},
{
"title": "Docker",
"slug": "/management/guides/docker/"
},
{
"title": "EC2 Tags",
"slug": "/management/guides/ec2-tags/"
},
{
"title": "Joining Nodes via AWS IAM",
"slug": "/management/guides/joining-nodes-aws-iam/"
},
{
"title": "Joining Nodes via AWS EC2",
"slug": "/management/guides/joining-nodes-aws-ec2/",
"forScopes": ["oss", "enterprise"]
Add documentation for Event Handler chart (#13732)
2022-08-18 10:22:23 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Using Teleport's CA with GitHub",
"slug": "/management/guides/ssh-key-extensions/"
Move Helm references (#13102) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm chart references. These are not exclusive to the Teleport Kubernetes Service, so I am suggesting moving these guides to the /docs/setup section to make them more discoverable.
2022-06-24 21:38:59 +00:00
}
]
Enhance diagnostics docs (#15648) * Enhance diagnostics docs The diagnostics docs were all in one page(`setup/reference/metrics.mdx`) which made things a bit hard to find, and wasn't conducive to adding new content. Diagnostics information is now located at `setup/diagnostics` with each section from the original `metrics.mdx` doc now having its own dedicated page. The section will now show up in the navbar at "Setup" > "Monitoring Your Cluster". The content of the profiling page is expanded to include information from https://github.com/gravitational/teleport/blob/740d184d1cfc69ae2e96c50ee738b13884fb232b/assets/monitoring/README.md#low-level-monitoring to illustrate what the different profile types are, the information that they capture, and how to retrieve them. A new Distributed Tracing page is also added to instruct users on how to setup the `tracing_service` to collect and export spans (the last open item for #12241).
2022-10-14 20:05:07 +00:00
},
{
"title": "Diagnostics",
"slug": "/management/diagnostics/",
"entries": [
{
"title": "Health Monitoring",
"slug": "/management/diagnostics/monitoring/",
"forScopes": ["oss", "enterprise", "cloud"]
},
{
"title": "Metrics",
"slug": "/management/diagnostics/metrics/",
"forScopes": ["oss", "enterprise", "cloud"]
},
{
"title": "Collecting Profiles",
"slug": "/management/diagnostics/profiles/",
"forScopes": ["oss", "enterprise", "cloud"]
},
{
"title": "Distributed Tracing",
"slug": "/management/diagnostics/tracing/",
"forScopes": ["oss", "enterprise", "cloud"]
}
]
Add a guide to exporting events to Splunk (#17405) * Add a guide to exporting events to Splunk Closes #13158 Since there are multiple guides to exporting audit events now, this also adds a new section of the docs for these guides. Also fixes a tiny error in the Elastic Stack guide. * Respond to PR feedback * Fix linter issues * Respond to PR feedback - Use consistent naming - Mention the `--ttl` flag for `tctl auth sign` - Mention Machine ID - Add a quick Troubleshooting section - Fix `chmod` command - Add systemd configs (also added this to the Elastic Stack Event Handler guide. I didn't do this to the Fluentd guide because the structure of the guide is different from the Splunk guide's).
2022-12-19 22:09:58 +00:00
},
{
"title": "Exporting Audit Events",
"slug": "/management/export-audit-events/",
"entries": [
{
"title": "Exporting Audit Events to Fluentd",
"slug": "/management/export-audit-events/fluentd/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Monitoring Audit Events with the Elastic Stack",
"slug": "/management/export-audit-events/elastic-stack/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Monitoring Audit Events with Splunk",
"slug": "/management/export-audit-events/splunk/",
"forScopes": ["enterprise", "cloud"]
}
]
Initial terraform guide (#7136) (#7149)
2021-06-02 22:46:59 +00:00
}
]
},
Move the tsh guide to the new "Use Teleport" section (#14636) * Move the tsh guide to the new "Use Teleport" section This new section will be a good place to add Connect docs to in the near future.
2022-07-20 08:32:53 +00:00
{
"icon": "connect",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Connect your Client",
Move the tsh guide to the new "Use Teleport" section (#14636) * Move the tsh guide to the new "Use Teleport" section This new section will be a good place to add Connect docs to in the near future.
2022-07-20 08:32:53 +00:00
"entries": [
[Docs] End User Doc Page (#18055) * init end user doc * lint fix * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * simplify inline icon * incorporate feedback * Add Kubernetes instructions to the end-user guide (#18234) * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * move to 'connect your client' * Updates based on review. * adjust next steps para * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * consolidate tsh examples with Var component * linting * Add Kubernetes instructions for the Web UI/Connect (#18611) * Add Kubernetes instructions for the Web UI/Connect * optimize images * add SAML connector to Vars Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-11-18 21:25:59 +00:00
{
"title": "Introduction",
"slug": "/connect-your-client/introduction/"
},
Move the tsh guide to the new "Use Teleport" section (#14636) * Move the tsh guide to the new "Use Teleport" section This new section will be a good place to add Connect docs to in the near future.
2022-07-20 08:32:53 +00:00
{
"title": "Using tsh",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/connect-your-client/tsh/"
Add docs for Teleport Connect (#14458) Co-authored-by: Michael <michaelzmyers@gmail.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-07-27 16:02:52 +00:00
},
{
"title": "Using Teleport Connect",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/connect-your-client/teleport-connect/"
},
{
"title": "Database GUI Clients",
"slug": "/connect-your-client/gui-clients/"
Move the tsh guide to the new "Use Teleport" section (#14636) * Move the tsh guide to the new "Use Teleport" section This new section will be a good place to add Connect docs to in the near future.
2022-07-20 08:32:53 +00:00
}
]
},
Update application access docs (#6055) (#6137)
2021-03-28 17:09:58 +00:00
{
"icon": "window",
"title": "Application Access",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Introduction",
"slug": "/application-access/introduction/"
},
{
"title": "Getting Started",
"slug": "/application-access/getting-started/"
},
Update application access docs (#6055) (#6137)
2021-03-28 17:09:58 +00:00
{
Add JWT auth guide for ElasticSearch (#12612) (#13137)
2022-06-03 15:25:20 +00:00
"title": "Access Guides",
Update application access docs (#6055) (#6137)
2021-03-28 17:09:58 +00:00
"slug": "/application-access/guides/",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Add docs for TCP apps access (#14978)
2022-08-02 17:26:27 +00:00
"title": "Web App Access",
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
"slug": "/application-access/guides/connecting-apps/"
},
Add docs for TCP apps access (#14978)
2022-08-02 17:26:27 +00:00
{
"title": "TCP App Access (Preview)",
"slug": "/application-access/guides/tcp/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "API Access",
"slug": "/application-access/guides/api-access/"
},
{
Documentation for AWS API access (#14429)
2022-08-24 15:17:38 +00:00
"title": "AWS Access",
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
"slug": "/application-access/guides/aws-console/"
},
Document Azure CLI access (#18979) * Document Azure CLI access Closes #17583 - Create a guide to Azure CLI access - Update references to reflect changes to roles, commands, and the file config * Respond to alexfornuto feedback * Add a section to the guide on `tsh proxy azure` * Respond to smaller feedback items from Tener * Switch the order of role approaches Responds to one item of feedback from Tener. * Respond to zmb3 feedback * Document new behavior - Wildcards in `deny` rules - The `tsh proxy az` alias * Add SSO instructions for defining a role * Update env var values * optimize images Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2022-12-13 21:06:52 +00:00
{
"title": "Azure CLI Access",
"slug": "/application-access/guides/azure/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Dynamic Registration",
"slug": "/application-access/guides/dynamic-registration/"
}
Update application access docs (#6055) (#6137)
2021-03-28 17:09:58 +00:00
]
},
Add JWT auth guide for ElasticSearch (#12612) (#13137)
2022-06-03 15:25:20 +00:00
{
"title": "JWT Guides",
"slug": "/application-access/jwt/",
"entries": [
{
"title": "Introduction",
"slug": "/application-access/jwt/introduction/"
},
{
"title": "ElasticSearch",
"slug": "/application-access/jwt/elasticsearch/"
}
]
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Access Controls",
"slug": "/application-access/controls/"
},
{
"title": "Reference",
"slug": "/application-access/reference/"
}
Update application access docs (#6055) (#6137)
2021-03-28 17:09:58 +00:00
]
},
[v7.0] Port of 6.2 Server Access Section (#6936) * docs: port of server access section * docs: correct query * docs: remove teleconsole
2021-05-27 02:36:48 +00:00
{
"icon": "server",
"title": "Server Access",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Introduction",
"slug": "/server-access/introduction/"
},
{
"title": "Getting Started",
"slug": "/server-access/getting-started/"
},
[v7.0] Port of 6.2 Server Access Section (#6936) * docs: port of server access section * docs: correct query * docs: remove teleconsole
2021-05-27 02:36:48 +00:00
{
"title": "Guides",
"slug": "/server-access/guides/",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Using Teleport with PAM",
"slug": "/server-access/guides/ssh-pam/"
},
{
"title": "OpenSSH Guide",
"slug": "/server-access/guides/openssh/"
},
Edit two guides for Cloud users (#11470) * Edit two guides for Cloud users (1) Server Access Getting Started While this guide mentions Teleport Cloud throughout, I wanted to make sure that users of one edition wouldn't see scope-irrelevant details. - Add scoped Tabs to the Prerequisites section - Add the scoped "tctl.mdx" Details box - Add ScopedBlocks for minor scope-relevant details like the address of the Proxy Service - Edit the tctl.mdx partial to mention when you would use sudo to run tctl on a local machine, a detail that was added to this guide but could be included in any guide that uses the tctl.mdx partial. Also makes misc. style, grammar, and clarity edits. (2) Edit the OpenSSH guide and spin off a PRM guide - The Recording Proxy Mode instructions don't apply to Cloud users. I didn't want to use a ScopedBlock to hide the relevant H2s, since these still appear within a page's table of contents. Instead, I separated the Recording Proxy Mode instructions into their own guide, and added an edition warning for Cloud users at the top of the guide. I also did some restructuring of the OpenSSH guide to clean it up after separating the Recording Proxy Mode instructions. - Used ScopedBlocks to ensure that only scope-relevant information is shown in the OpenSSH guide. - Misc grammar/style/clarity tweaks * Respond to PR feedback
2022-03-31 21:35:48 +00:00
{
"title": "Recording Proxy Mode",
Apply forScopes feature to articles (#14704)
2022-07-20 19:26:27 +00:00
"slug": "/server-access/guides/recording-proxy-mode/",
"forScopes": ["oss", "enterprise"]
Edit two guides for Cloud users (#11470) * Edit two guides for Cloud users (1) Server Access Getting Started While this guide mentions Teleport Cloud throughout, I wanted to make sure that users of one edition wouldn't see scope-irrelevant details. - Add scoped Tabs to the Prerequisites section - Add the scoped "tctl.mdx" Details box - Add ScopedBlocks for minor scope-relevant details like the address of the Proxy Service - Edit the tctl.mdx partial to mention when you would use sudo to run tctl on a local machine, a detail that was added to this guide but could be included in any guide that uses the tctl.mdx partial. Also makes misc. style, grammar, and clarity edits. (2) Edit the OpenSSH guide and spin off a PRM guide - The Recording Proxy Mode instructions don't apply to Cloud users. I didn't want to use a ScopedBlock to hide the relevant H2s, since these still appear within a page's table of contents. Instead, I separated the Recording Proxy Mode instructions into their own guide, and added an edition warning for Cloud users at the top of the guide. I also did some restructuring of the OpenSSH guide to clean it up after separating the Recording Proxy Mode instructions. - Used ScopedBlocks to ensure that only scope-relevant information is shown in the OpenSSH guide. - Misc grammar/style/clarity tweaks * Respond to PR feedback
2022-03-31 21:35:48 +00:00
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "BPF Session Recording",
"slug": "/server-access/guides/bpf-session-recording/"
},
{
"title": "Restricted Session",
"slug": "/server-access/guides/restricted-session/"
},
{
"title": "Visual Studio Code",
"slug": "/server-access/guides/vscode/"
Fixes and clarification of host user creation docs (#14133) Clarify host user creation docs
2022-07-06 15:03:56 +00:00
},
Add SFTP guide for JetBrains IDEs (#15588) Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-10-17 19:11:58 +00:00
{
"title": "JetBrains SFTP",
"slug": "/server-access/guides/jetbrains-sftp/"
},
Fixes and clarification of host user creation docs (#14133) Clarify host user creation docs
2022-07-06 15:03:56 +00:00
{
"title": "Host User Creation",
"slug": "/server-access/guides/host-user-creation/"
Add docs for EC2 instance discovery (#16279) * initial doc for ec2 instance discovery * Resolve review comments * Resolve review comments * Resolve review comments * resolve some review comments * introduce discovery node in the initial paragraph * Resolve comments
2022-10-05 14:53:39 +00:00
},
Add Auditd docs (#15530) Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-11-08 18:31:06 +00:00
{
"title": "Linux Auditing System",
"slug": "/server-access/guides/auditd/"
},
Add docs for EC2 instance discovery (#16279) * initial doc for ec2 instance discovery * Resolve review comments * Resolve review comments * Resolve review comments * resolve some review comments * introduce discovery node in the initial paragraph * Resolve comments
2022-10-05 14:53:39 +00:00
{
mention preview (#17331)
2022-10-13 09:37:06 +00:00
"title": "EC2 Instance Discovery (Preview)",
Add docs for EC2 instance discovery (#16279) * initial doc for ec2 instance discovery * Resolve review comments * Resolve review comments * Resolve review comments * resolve some review comments * introduce discovery node in the initial paragraph * Resolve comments
2022-10-05 14:53:39 +00:00
"slug": "/server-access/guides/ec2-discovery/"
Restore the Ansible Server Access guide (#18134) Closes #14692 PR #10987 repurposed the Ansible Server Access guide to be a Machine ID guide. Since users still found use in the original Server Access guide, this change restores that guide. Note that this change does not attempt to edit the Ansible Server Access guide, and simply restores it to the state it was in before #10987. The Machine ID Ansible guide is left untouched.
2022-11-07 21:40:25 +00:00
},
{
"title": "Using Teleport with Ansible",
"slug": "/server-access/guides/ansible/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
[v7.0] Port of 6.2 Server Access Section (#6936) * docs: port of server access section * docs: correct query * docs: remove teleconsole
2021-05-27 02:36:48 +00:00
]
}
]
},
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
{
Update Kubernetes Access docs (#5865) (#5933)
2021-03-10 19:48:37 +00:00
"icon": "kubernetes",
"title": "Kubernetes Access",
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Introduction",
"slug": "/kubernetes-access/introduction/"
},
Tweaks, update and k8s agent getting started (#7656)
2021-07-23 01:37:42 +00:00
{
"title": "Getting Started",
Fix Kubernetes Access nav sidebar section (#14264) The changes in #13068 moved pages in the Kubernetes Access section that did not relate to Kubernetes Access into more appropriate sections of the docs. This meant converting `/docs/kubernetes-access/getting-started` into a guide, rather than a section, since only one page within the previous `getting-started` section had to do with Kubernetes Access. However, this change left the nav sidebar for the Getting Started section unchanged. The current change deletes the sidebar entries to prevent confusion.
2022-07-12 15:18:37 +00:00
"slug": "/kubernetes-access/getting-started/"
Tweaks, update and k8s agent getting started (#7656)
2021-07-23 01:37:42 +00:00
},
Update Kubernetes Access docs (#5865) (#5933)
2021-03-10 19:48:37 +00:00
{
"title": "Guides",
"slug": "/kubernetes-access/guides/",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Multiple Clusters",
"slug": "/kubernetes-access/guides/multiple-clusters/"
},
{
"title": "Federation",
"slug": "/kubernetes-access/guides/federation/"
},
{
"title": "Standalone",
"slug": "/kubernetes-access/guides/standalone-teleport/"
Add a guide to dynamic Kubernetes registration (#18065) * Add a guide to dynamic Kubernetes registration Closes #17629 * Address PR feedback - Add to and edit the list of dynamic resources Closes #16247 - Describe static and dynamic labels in the `kube_cluster` resource
2022-11-16 20:57:15 +00:00
},
{
"title": "Dynamic Registration",
"slug": "/kubernetes-access/guides/dynamic-registration/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Update Kubernetes Access docs (#5865) (#5933)
2021-03-10 19:48:37 +00:00
]
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Access Controls",
"slug": "/kubernetes-access/controls/"
[docs] EKS & AKS auto-discovery docs (#17628) Closes #17427
2022-11-07 22:48:01 +00:00
},
{
"title": "Kubernetes Discovery (Preview)",
"slug": "/kubernetes-access/discovery/",
"entries": [
{
"title": "AWS",
"slug": "/kubernetes-access/discovery/aws/"
},
{
"title": "Azure",
"slug": "/kubernetes-access/discovery/azure/"
Add a guide to GKE Auto-Discovery (#18582) * Add a guide to GKE Auto-Discovery Closes #18011 * Respond to PR feedback * Update the guide while testing it - Add the `scopes` flag to the `gclodu compute instances set-service-account command` - Replace `auth_servers` with `proxy_server` in the config * Respond to PR feedback
2022-12-01 20:24:08 +00:00
},
{
"title": "Google Cloud",
"slug": "/kubernetes-access/discovery/google-cloud/"
[docs] EKS & AKS auto-discovery docs (#17628) Closes #17427
2022-11-07 22:48:01 +00:00
}
]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
]
},
Update docs structure (#5849)
2021-03-04 18:07:48 +00:00
{
"icon": "database",
"title": "Database Access",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Introduction",
"slug": "/database-access/introduction/"
},
{
"title": "Getting Started",
"slug": "/database-access/getting-started/"
},
Update docs structure (#5849)
2021-03-04 18:07:48 +00:00
{
"title": "Guides",
"slug": "/database-access/guides/",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "AWS RDS & Aurora",
"slug": "/database-access/guides/rds/"
},
{
"title": "AWS Redshift",
"slug": "/database-access/guides/postgres-redshift/"
},
Documentation for ElastiCache (#13133)
2022-06-30 16:10:57 +00:00
{
Add documentation for AWS MemoryDB support (#14088)
2022-07-07 03:29:45 +00:00
"title": "AWS ElastiCache & MemoryDB",
Documentation for ElastiCache (#13133)
2022-06-30 16:10:57 +00:00
"slug": "/database-access/guides/redis-aws/"
},
Documentation for AWS DynamoDB guide (#14319)
2022-08-10 16:34:01 +00:00
{
"title": "AWS DynamoDB",
"slug": "/database-access/guides/dynamodb/"
},
Add Cassandra and ScyllaDB docs (#17833)
2022-11-08 09:43:02 +00:00
{
"title": "AWS Keyspaces (Apache Cassandra)",
"slug": "/database-access/guides/aws-cassandra-keyspaces/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "GCP Cloud SQL PostgreSQL",
"slug": "/database-access/guides/postgres-cloudsql/"
},
{
"title": "GCP Cloud SQL MySQL",
"slug": "/database-access/guides/mysql-cloudsql/"
},
{
"title": "Azure PostgreSQL & MySQL",
"slug": "/database-access/guides/azure-postgres-mysql/"
},
Documentation for Azure Cache for Redis (Database Access) (#17387)
2022-10-27 20:32:25 +00:00
{
"title": "Azure Cache for Redis",
"slug": "/database-access/guides/azure-redis/"
},
Azure AD user managed identity authentication for SQL server documentation (#17693)
2022-11-01 23:39:43 +00:00
{
"title": "Azure SQL Server (Preview)",
"slug": "/database-access/guides/azure-sql-server-ad/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "MongoDB Atlas",
"slug": "/database-access/guides/mongodb-atlas/"
},
[Docs] Database Access for Elastic Guide (#17393) * sort list of db guides alphabetically * add Elastic guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * additional edits from review * add spaces to next steps include This is so that additional ul items added to a guide using this partial will have consistent spacing * remove instructions and add tip Resolves #r995144908 and #r995566035 * fix Database Access config and add scopes * Move note into relevant tab * adjust example user mapping * incorporate more feedback * incorporate feedback from @tener * Update docs/pages/database-access/guides/elastic.mdx Co-authored-by: Krzysztof Skrzętnicki <krzysztof.skrzetnicki@goteleport.com> * bypass linter rule Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Krzysztof Skrzętnicki <krzysztof.skrzetnicki@goteleport.com>
2022-10-25 15:05:14 +00:00
{
"title": "Self-Hosted Elasticsearch",
"slug": "/database-access/guides/elastic/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Self-Hosted PostgreSQL",
"slug": "/database-access/guides/postgres-self-hosted/"
},
{
"title": "Self-Hosted MySQL/MariaDB",
"slug": "/database-access/guides/mysql-self-hosted/"
},
{
"title": "Self-Hosted MongoDB",
"slug": "/database-access/guides/mongodb-self-hosted/"
},
{
"title": "Self-Hosted CockroachDB",
"slug": "/database-access/guides/cockroachdb-self-hosted/"
},
Add Redis docs (#10693) Add Redis documentation on how to setup Redis. Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Marek Smoliński <marek@goteleport.com>
2022-03-11 18:05:13 +00:00
{
"title": "Self-Hosted Redis",
"slug": "/database-access/guides/redis/"
},
Split Redis docs (#11246) * Split Redis docs to Redis Standalone and Cluster for better readability. Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-04-04 15:53:54 +00:00
{
"title": "Self-Hosted Redis Cluster",
"slug": "/database-access/guides/redis-cluster/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "SQL Server (Preview)",
"slug": "/database-access/guides/sql-server-ad/"
},
Add Snowflake integration docs (#12816) Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-06-30 02:53:19 +00:00
{
"title": "Snowflake (Preview)",
"slug": "/database-access/guides/snowflake/"
},
Add Cassandra and ScyllaDB docs (#17833)
2022-11-08 09:43:02 +00:00
{
"title": "Self-Hosted Cassandra & ScyllaDB",
"slug": "/database-access/guides/cassandra-self-hosted/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Dynamic Registration",
"slug": "/database-access/guides/dynamic-registration/"
},
{
"title": "High Availability",
"slug": "/database-access/guides/ha/"
}
Update docs structure (#5849)
2021-03-04 18:07:48 +00:00
]
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Access Controls",
"slug": "/database-access/rbac/"
},
{
"title": "Architecture",
"slug": "/database-access/architecture/"
},
Application and database access documentation updates (#6932)
2021-05-19 00:03:49 +00:00
{
"title": "Reference",
"slug": "/database-access/reference/",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Configuration",
"slug": "/database-access/reference/configuration/"
},
{
"title": "CLI",
"slug": "/database-access/reference/cli/"
},
{
"title": "Audit Events",
"slug": "/database-access/reference/audit/"
},
{
"title": "AWS IAM",
"slug": "/database-access/reference/aws/"
}
Application and database access documentation updates (#6932)
2021-05-19 00:03:49 +00:00
]
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "FAQ",
"slug": "/database-access/faq/"
Add message for "certificate has expired" error on database connect (#14794)
2022-10-04 12:02:34 +00:00
},
{
"title": "Troubleshooting",
"slug": "/database-access/troubleshooting/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Update docs structure (#5849)
2021-03-04 18:07:48 +00:00
]
},
Desktop Access Beta documentation (#8504) * Desktop Access documentation First draft of the Desktop Access docs. This is for Beta and has the warnings on every page to make that clear. * Apply suggestions from code review Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com> Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>
2021-10-11 22:42:00 +00:00
{
"icon": "desktop",
"title": "Desktop Access",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Introduction",
"slug": "/desktop-access/introduction/"
},
{
"title": "Getting Started",
"slug": "/desktop-access/getting-started/"
},
Desktop Discovery guide (#17602) * init Desktop Discovery guide * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * edit for feedback * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * adjust from feedback * edit for #16956 (merge conflict) * use auth_server for cloud * fix links * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * break up long lines * linting ul spacing * Update docs/pages/desktop-access/getting-started.mdx * import upstream changes to old getting started * lint Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-11-17 18:43:35 +00:00
{
"title": "Manual Setup",
"slug": "/desktop-access/manual-setup/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
docs: add desktop session recording and clipboard sharing (#11005)
2022-03-16 22:35:11 +00:00
"title": "Access Controls",
"slug": "/desktop-access/rbac/"
},
docs: add self signed certs guide (#16182) * Add slug for self signed certs * Add self-signed certs guide * Move tls cert setup into an include snippet * Update tsh section on self signed certs * Fix indentation * Remove extra slash before heading * Update docs/config.json Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/includes/tls-certificate-setup.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Fix formatting of github suggestion commit * Change link title to avoid abbreviation * Update intro to explain the purpose of the guide and why anyone would want it * Make 'proxy' and 'certs' consistent throughout the guide: certs -> certificates proxy -> Proxy Service * Move motivation for guide out of warning and into intro * Simplify the warning notice * Change headings * Capitalize helm and simplify label * Update Helm info to include inline instructions * Simplify systemd label * Update systemd tab * Update slug certs -> certificates * Fix include snippet yaml example * Change prereqs to omit cloud tab and instruct user to check for self-signed certs config * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/management/admin/self-signed-certs.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Get specific about problem caused by insecure TLS * Remove 'how to setup tls certs' section in favor of a link at the bottom * Add examples for tsh and tctl, and clean up tctl wording * Remove link to systemd guide * Add more detail to systemd instructions * Change wording around instructions for teleport * Rearrange links * Remove reference to deleted acme.mdx * Remove v2 config reference to auth_servers * Remove list syntax for proxy_server Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-10-11 18:02:42 +00:00
{
"title": "Directory Sharing",
"slug": "/desktop-access/directory-sharing/"
},
docs: add desktop session recording and clipboard sharing (#11005)
2022-03-16 22:35:11 +00:00
{
"title": "Reference",
"slug": "/desktop-access/reference/",
"entries": [
{
"title": "Configuration",
"slug": "/desktop-access/reference/configuration/"
},
{
"title": "Audit Events",
"slug": "/desktop-access/reference/audit/"
},
{
"title": "Clipboard Sharing",
"slug": "/desktop-access/reference/clipboard/"
},
{
"title": "Session Recording",
"slug": "/desktop-access/reference/sessions/"
},
{
"title": "CLI",
"slug": "/desktop-access/reference/cli/"
}
]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
"title": "Troubleshooting",
"slug": "/desktop-access/troubleshooting/"
}
Desktop Access Beta documentation (#8504) * Desktop Access documentation First draft of the Desktop Access docs. This is for Beta and has the warnings on every page to make that clear. * Apply suggestions from code review Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com> Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>
2021-10-11 22:42:00 +00:00
]
},
Added Machine ID docs. Added Machine ID docs. Co-authored-by: Zac Bergquist <zmb3@users.noreply.github.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com> Co-authored-by: Xin Ding <xinding33@gmail.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-03 01:40:51 +00:00
{
Update Machine ID icon to chip icon.
2022-03-25 00:30:42 +00:00
"icon": "chip",
Added Machine ID docs. Added Machine ID docs. Co-authored-by: Zac Bergquist <zmb3@users.noreply.github.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com> Co-authored-by: Xin Ding <xinding33@gmail.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-03 01:40:51 +00:00
"title": "Machine ID",
"entries": [
{
"title": "Introduction",
"slug": "/machine-id/introduction/"
},
{
"title": "Getting Started",
"slug": "/machine-id/getting-started/"
Refactored Ansible guide to work with Machine ID. Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-09 02:42:42 +00:00
},
{
"title": "Guides",
"slug": "/machine-id/guides/",
"entries": [
{
Add Machine ID Kubernetes and Apps guides (#14976) * Add Machine ID Kubernetes guide and partial Apps guide * Small wording tweaks to the k8s guide * Rename menu titles to match convention * Fix inaccurate CA cert recommendation on the API access guide * Tidy up the Kubernetes guide * Finish up first pass on Apps guide * Remove empty admonition * Address review feedback * Fix doctest lints * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address a batch of review comments * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address further review comments * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-12 19:50:09 +00:00
"title": "Ansible",
Refactored Ansible guide to work with Machine ID. Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-09 02:42:42 +00:00
"slug": "/machine-id/guides/ansible/"
Added Machine ID Jenkins Guide. Co-authored-by: Zac Bergquist <zmb3@users.noreply.github.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-10 02:35:27 +00:00
},
Machine ID GitHub Actions guide (#17798) * [Docs] Using Machine ID with Github Actions * remove skip-version-check * strideynet recs * fix spacing * example fixes, spacing * optimize image * adjust capitalization for GitHub and GitHub Actions * alphabetize machine ID guides partial * add new page to sidebar and guides index partial * tech/copy fixes * separate tokens from bot * allow block improvements * spec.bot_name tense fix, clarifications * Privelege -> privilege * tense fixes for allow block Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Noah Stride <noah.stride@goteleport.com>
2022-11-04 00:08:41 +00:00
{
"title": "GitHub Actions",
"slug": "/machine-id/guides/github-actions/"
},
Document Machine ID and CircleCI joining (#20009) * Add CircleCI doucmentation page * Add configuration for CircleCI * Add headings * Start filling out instructions for configuring CircleCI joining * Start fleshing out CircleCI config explanation * Add CircleCI guide to indexes * Add more explanation * Updated workflow that fetches the teleport binaries * Move initial notes on context: * Change directory for datadir * reference clopud tenant * tiodying * Explain CircleCI contexts * Add intro * fix sentence casing in title * We -> You * Fix config key * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/guides/circleci.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reflow markdown PR comment changes * Move replacement guidance to after config block Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-01-18 23:20:20 +00:00
{
"title": "CircleCI",
"slug": "/machine-id/guides/circleci/"
},
Document GitHub Actions and Kubernetes (#19911) * GHA Kubernetes and docs tidying * spag adjustments * "GitHub Action" -> "GitHub Actions" * Update docs/pages/includes/machine-id/github-actions-create-token.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/includes/machine-id/github-actions-create-token.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * More explicitly explain what the token input should be * Correct "KUBE_CONFIG" -> "KUBECONFIG" Co-authored-by: Tim Buckley <tim@goteleport.com> * Add application access link Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Tim Buckley <tim@goteleport.com>
2023-01-13 08:53:57 +00:00
{
"title": "GitHub Actions & Kubernetes",
"slug": "/machine-id/guides/github-actions-kubernetes/"
},
Added Machine ID Jenkins Guide. Co-authored-by: Zac Bergquist <zmb3@users.noreply.github.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-10 02:35:27 +00:00
{
Add Machine ID Kubernetes and Apps guides (#14976) * Add Machine ID Kubernetes guide and partial Apps guide * Small wording tweaks to the k8s guide * Rename menu titles to match convention * Fix inaccurate CA cert recommendation on the API access guide * Tidy up the Kubernetes guide * Finish up first pass on Apps guide * Remove empty admonition * Address review feedback * Fix doctest lints * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address a batch of review comments * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address further review comments * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-12 19:50:09 +00:00
"title": "Jenkins",
Added Machine ID Jenkins Guide. Co-authored-by: Zac Bergquist <zmb3@users.noreply.github.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-10 02:35:27 +00:00
"slug": "/machine-id/guides/jenkins/"
Added Machine ID guide for database access from custom apps (#13226) * Added Machine ID and Web Apps Guide. Co-authored-by: Tim Buckley <tim@goteleport.com> * Update reference pages with latest v9.3 content Also, update the mongodb example * Address review feedback * Remove unfinished though and fix a few typos * Tweak wording for the webapps guide Also, fix broken lints in the go examples. * Fix Postgres example * Rename "webapps" guide to "database" guide (with custom app) * Apply suggestions from code review Co-authored-by: Noah Stride <noah.stride@goteleport.com> * Address review feedback * Fix go.mod issue breaking linter, remove duped postgres library * Fix broken links * Rephrase the final sentence a bit. * Update docs/pages/machine-id/guides.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * First batch of review feedback * Apply more suggestions from review * Restore original go.sum / go.mod * Show different version requirement text for cloud vs OSS/enterprise * Add small note about `tbot db` limitations * Add new Machine ID / Database Access diagram * Fix lint errors * Fix broken link * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address review feedback * Fix whitespace * Address review feedback * Update docs/pages/machine-id/guides/databases.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Russell Jones <rjones@gravitational.com> Co-authored-by: Noah Stride <noah.stride@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-07-07 23:50:31 +00:00
},
{
Add Machine ID Kubernetes and Apps guides (#14976) * Add Machine ID Kubernetes guide and partial Apps guide * Small wording tweaks to the k8s guide * Rename menu titles to match convention * Fix inaccurate CA cert recommendation on the API access guide * Tidy up the Kubernetes guide * Finish up first pass on Apps guide * Remove empty admonition * Address review feedback * Fix doctest lints * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address a batch of review comments * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address further review comments * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-12 19:50:09 +00:00
"title": "Databases",
Added Machine ID guide for database access from custom apps (#13226) * Added Machine ID and Web Apps Guide. Co-authored-by: Tim Buckley <tim@goteleport.com> * Update reference pages with latest v9.3 content Also, update the mongodb example * Address review feedback * Remove unfinished though and fix a few typos * Tweak wording for the webapps guide Also, fix broken lints in the go examples. * Fix Postgres example * Rename "webapps" guide to "database" guide (with custom app) * Apply suggestions from code review Co-authored-by: Noah Stride <noah.stride@goteleport.com> * Address review feedback * Fix go.mod issue breaking linter, remove duped postgres library * Fix broken links * Rephrase the final sentence a bit. * Update docs/pages/machine-id/guides.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * First batch of review feedback * Apply more suggestions from review * Restore original go.sum / go.mod * Show different version requirement text for cloud vs OSS/enterprise * Add small note about `tbot db` limitations * Add new Machine ID / Database Access diagram * Fix lint errors * Fix broken link * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address review feedback * Fix whitespace * Address review feedback * Update docs/pages/machine-id/guides/databases.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Russell Jones <rjones@gravitational.com> Co-authored-by: Noah Stride <noah.stride@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-07-07 23:50:31 +00:00
"slug": "/machine-id/guides/databases/"
Add Machine ID Kubernetes and Apps guides (#14976) * Add Machine ID Kubernetes guide and partial Apps guide * Small wording tweaks to the k8s guide * Rename menu titles to match convention * Fix inaccurate CA cert recommendation on the API access guide * Tidy up the Kubernetes guide * Finish up first pass on Apps guide * Remove empty admonition * Address review feedback * Fix doctest lints * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address a batch of review comments * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address further review comments * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-12 19:50:09 +00:00
},
{
"title": "Kubernetes",
"slug": "/machine-id/guides/kubernetes/"
},
{
"title": "Applications",
"slug": "/machine-id/guides/applications/"
[Docs] Machine ID Host Certificate Support (#16989) * [Docs] Machine ID Host Certificate Support * general tech edits * broken link fix * typos/principal clarifications * typo/spacing fix * strideynet improvement * ptgott fixes * closing tab fix * some additional copy fixes * role fix * heading fix * clarify hosts involved * scope fixes/spelling * final-steps * afornuto copy edits * tech fixes, principal/openssh
2022-10-31 18:38:51 +00:00
},
{
"title": "Host Certificates",
"slug": "/machine-id/guides/host-certificate/"
Refactored Ansible guide to work with Machine ID. Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-09 02:42:42 +00:00
}
]
Organized machine-id docs menu to match other protocols (#19187)
2022-12-08 14:10:12 +00:00
},
{
"title": "Architecture",
"slug": "/machine-id/architecture/"
},
{
"title": "Reference",
"slug": "/machine-id/reference/",
"entries": [
{
"title": "Configuration",
"slug": "/machine-id/reference/configuration/"
Document GitHub Actions and Kubernetes (#19911) * GHA Kubernetes and docs tidying * spag adjustments * "GitHub Action" -> "GitHub Actions" * Update docs/pages/includes/machine-id/github-actions-create-token.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/includes/machine-id/github-actions-create-token.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * More explicitly explain what the token input should be * Correct "KUBE_CONFIG" -> "KUBECONFIG" Co-authored-by: Tim Buckley <tim@goteleport.com> * Add application access link Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Tim Buckley <tim@goteleport.com>
2023-01-13 08:53:57 +00:00
},
{
"title": "GitHub Actions",
"slug": "/machine-id/reference/github-actions/"
Organized machine-id docs menu to match other protocols (#19187)
2022-12-08 14:10:12 +00:00
}
]
},
{
"title": "FAQ",
"slug": "/machine-id/faq/"
},
{
"title": "Troubleshooting",
"slug": "/machine-id/troubleshooting/"
Added Machine ID docs. Added Machine ID docs. Co-authored-by: Zac Bergquist <zmb3@users.noreply.github.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com> Co-authored-by: Xin Ding <xinding33@gmail.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-03 01:40:51 +00:00
}
]
},
Open Sources Access Controls Docs (#6188) (#6217) * Open Sources Access Controls Docs (#6188) Moves RBAC to a separate access controls section, adds a couple of guides and prepares the structure for more content. * Fix href links
2021-03-30 17:04:23 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"icon": "list",
"title": "API",
Open Sources Access Controls Docs (#6188) (#6217) * Open Sources Access Controls Docs (#6188) Moves RBAC to a separate access controls section, adds a couple of guides and prepares the structure for more content. * Fix href links
2021-03-30 17:04:23 +00:00
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Introduction",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/api/introduction/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
"title": "Getting Started",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"slug": "/api/getting-started/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
"title": "Architecture",
"slug": "/api/architecture/"
}
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
]
Desktop Access Beta documentation (#8504) * Desktop Access documentation First draft of the Desktop Access docs. This is for Beta and has the warnings on every page to make that clear. * Apply suggestions from code review Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com> Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>
2021-10-11 22:42:00 +00:00
},
Update Kubernetes Access docs (#5865) (#5933)
2021-03-10 19:48:37 +00:00
{
"icon": "wand",
"title": "Preview",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "Upcoming Releases",
"slug": "/preview/upcoming-releases/"
}
Update Kubernetes Access docs (#5865) (#5933)
2021-03-10 19:48:37 +00:00
]
},
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"icon": "book",
"title": "Reference",
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Config File",
"slug": "/reference/config/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Config Resources",
"slug": "/reference/resources/"
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Command Line",
"slug": "/reference/cli/"
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
},
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Metrics",
"slug": "/reference/metrics/"
Adds SOC2 guide from Travis and ports EC2 tags guide (#7788) Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-09-12 23:21:54 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Terraform Resources",
"slug": "/reference/terraform-provider/"
HSM Docs (#8000)
2021-09-24 19:35:39 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Audit Events and Records",
"slug": "/reference/audit/"
Edit three Setup guides for Cloud users (#10759) * Edit three Setup guides for Cloud users Teleport Daemon - Use a Notice for a warning re: the Auth Service scoped to self-hosted users - Misc grammar/style/clarity tweaks Move the Enterprise License File page The page does not belong in the Setup section, since it does not apply to Cloud and OSS users. I have moved the page into the Enterprise section. Networking guide - Add tabbed instructions so users who have selected a given scope don't see content for other scopes. - Mention auth_service.proxy_listener_mode instead of tls_routing_enabled for self-hosted readers - Misc grammar, style, and clarity edits Scaling We already added an edition warning in a Details box, but I thought a Notice would be more prominent. I've also added some minor grammar, style, and clarity tweaks. * Address PR feedback - Imply that there are non-Auth/Proxy services beside Nodes - Remove "shell" where it is unnecessary - Revert the "HTTP CONNECT" section to where it was before this change. The copy-edits were inaccurate, but I don't have time to perform the edits agin more carefully. * Address PR feedback Simplify the HTTP CONNECT section by bringing the example closer to the explanation of this functionality and removing some ambiguity over whether one or both of HTTPS_PROXY and HTTP_PROXY are required. The original text suggested that either is required, then that both are required. The new text says to assign both, then explains why.
2022-04-13 16:47:12 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Authentication",
"slug": "/reference/authentication/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Storage Backends",
"slug": "/reference/backends/",
"forScopes": ["oss", "enterprise"]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Networking",
"slug": "/reference/networking/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Predicate Language",
"slug": "/reference/predicate-language/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
Add Teleport Cloud downloads page. Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-24 23:47:38 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Signals",
"slug": "/reference/signals/"
Add Teleport Cloud downloads page. Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-03-24 23:47:38 +00:00
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"title": "Helm Charts",
"slug": "/reference/helm-reference/",
"entries": [
{
"title": "teleport-cluster",
"slug": "/reference/helm-reference/teleport-cluster/"
},
{
"title": "teleport-kube-agent",
"slug": "/reference/helm-reference/teleport-kube-agent/"
},
Add documentation for Jira Helm chart (#13730) * Add documentation for Jira Helm chart It includes an updated guide and the reference of the new Helm chart. * Fixed some minor mistakes in the guides * Reorganized Helm related examples * Fixed a few minor mistakes * Alphabetized jira.* settings * Renamed Cloud to Executable in Testing * Extended YAML config example with explanation * Edit Jira Access Request plugin Helm chart docs - Edit the configuration instructions so we don't instruct Helm users to use the `configure` subcommand. Also use the `Tabs` component's dropdown functionality so we can include both self-hosted and Teleport Cloud instructions for Helm and VM users. - Minor style tweaks. * Add Helm Chart example to Installation section * Removed confusing (and broken) link git push * Fixed wrong default value Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-26 12:23:07 +00:00
{
"title": "teleport-plugin-event-handler",
"slug": "/reference/helm-reference/teleport-plugin-event-handler/"
},
{
"title": "teleport-plugin-jira",
"slug": "/reference/helm-reference/teleport-plugin-jira/"
Add documentation for PagerDuty Helm chart (#13729)
2022-08-31 15:57:20 +00:00
},
{
"title": "teleport-plugin-pagerduty",
"slug": "/reference/helm-reference/teleport-plugin-pagerduty/"
Add documentation for MatterMost Helm chart (#13728) Includes an updated guide and the reference of the new Helm chart.
2022-09-08 11:49:30 +00:00
},
Add documentation for Slack Helm chart (#13726) It includes an updated guide and the reference of the new Helm chart.
2022-09-26 10:11:17 +00:00
{
Add documentation for MatterMost Helm chart (#13728) Includes an updated guide and the reference of the new Helm chart.
2022-09-08 11:49:30 +00:00
"title": "teleport-plugin-mattermost",
"slug": "/reference/helm-reference/teleport-plugin-mattermost/"
Add documentation for Slack Helm chart (#13726) It includes an updated guide and the reference of the new Helm chart.
2022-09-26 10:11:17 +00:00
},
{
"title": "teleport-plugin-slack",
"slug": "/reference/helm-reference/teleport-plugin-slack/"
Add documentation for Jira Helm chart (#13730) * Add documentation for Jira Helm chart It includes an updated guide and the reference of the new Helm chart. * Fixed some minor mistakes in the guides * Reorganized Helm related examples * Fixed a few minor mistakes * Alphabetized jira.* settings * Renamed Cloud to Executable in Testing * Extended YAML config example with explanation * Edit Jira Access Request plugin Helm chart docs - Edit the configuration instructions so we don't instruct Helm users to use the `configure` subcommand. Also use the `Tabs` component's dropdown functionality so we can include both self-hosted and Teleport Cloud instructions for Helm and VM users. - Minor style tweaks. * Add Helm Chart example to Installation section * Removed confusing (and broken) link git push * Fixed wrong default value Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-26 12:23:07 +00:00
}
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
]
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
Update docs structure (#5849)
2021-03-04 18:07:48 +00:00
]
},
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
{
"icon": "integrations",
"title": "Architecture",
"entries": [
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
Refactoring of architecture section. (#13651) Our architecture section was written almost 5 years ago and was completely obsolete. I refactored all of it to be up to date, added Kuberentes and other resource type references, replaced and created new diagrams.
2022-06-23 18:39:49 +00:00
"title": "Authentication",
"slug": "/architecture/authentication/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
Refactoring of architecture section. (#13651) Our architecture section was written almost 5 years ago and was completely obsolete. I refactored all of it to be up to date, added Kuberentes and other resource type references, replaced and created new diagrams.
2022-06-23 18:39:49 +00:00
"title": "Authorization",
"slug": "/architecture/authorization/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
{
"title": "Teleport Proxy",
"slug": "/architecture/proxy/"
},
{
"title": "Trusted Clusters",
Refactoring of architecture section. (#13651) Our architecture section was written almost 5 years ago and was completely obsolete. I refactored all of it to be up to date, added Kuberentes and other resource type references, replaced and created new diagrams.
2022-06-23 18:39:49 +00:00
"slug": "/architecture/trustedclusters/"
},
{
"title": "Teleport Nodes",
"slug": "/architecture/nodes/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
},
docs: add overview of session recording (#18717) Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-01-05 23:20:26 +00:00
{
"title": "Session Recording",
"slug": "/architecture/session-recording/"
},
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
{
"title": "TLS Routing",
"slug": "/architecture/tls-routing/"
Add documentation for proxy peering (#15790)
2022-10-04 16:00:37 +00:00
},
{
"title": "Proxy Peering",
"slug": "/architecture/proxy-peering/"
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
}
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
]
Make our docs guidance discoverable (#10155) Make our docs guidance discoverable Currently, our guidance for making docs changes is organized into a /docs/docs page that is only accessible if you know the URL. This change ensures that people who have not received an informal training on docs contributions can contribute in a way that abides by our expectations for consistency and effectiveness. - Splits the docs/docs and docs/docs/best-practices pages into a UI reference, getting started guide, and style guide. This ensures that each kind of content we have in our contributing guide (i.e., tutorial or reference) is accessible from the main nav menu. - Adds a "Contributing" tab to the navigation menu. There is one subsection here related to documenation, and we can add another subsection later with developer guides for editing Teleport's code. - Moves the "philosophy" section into the intro page of the documentation contribution section menu. - Makes various edits to the original docs guidance for clarity. - Document our docs labels in a dedicated "creating an issue" page Fixes #9538
2022-02-09 21:15:49 +00:00
},
{
"icon": "wrench",
"title": "Contribute",
"entries": [
{
"title": "Documentation",
"slug": "/contributing/documentation/",
Update desktop access docs for 9.0 (#10406) * Update desktop access docs for 9.0 - Remove admonition about being in preview - Add audit events listing - Break reference.mdx up into separate pages * Update tile icons * Address review suggestions * Another review pass
2022-02-22 23:21:46 +00:00
"entries": [
{
"title": "How to Contribute",
"slug": "/contributing/documentation/how-to-contribute/"
},
{
"title": "Creating Documentation Issues",
"slug": "/contributing/documentation/issues/"
},
{
"title": "Style Guide",
"slug": "/contributing/documentation/style-guide/"
},
{
"title": "UI Reference",
"slug": "/contributing/documentation/reference/"
}
Make our docs guidance discoverable (#10155) Make our docs guidance discoverable Currently, our guidance for making docs changes is organized into a /docs/docs page that is only accessible if you know the URL. This change ensures that people who have not received an informal training on docs contributions can contribute in a way that abides by our expectations for consistency and effectiveness. - Splits the docs/docs and docs/docs/best-practices pages into a UI reference, getting started guide, and style guide. This ensures that each kind of content we have in our contributing guide (i.e., tutorial or reference) is accessible from the main nav menu. - Adds a "Contributing" tab to the navigation menu. There is one subsection here related to documenation, and we can add another subsection later with developer guides for editing Teleport's code. - Moves the "philosophy" section into the intro page of the documentation contribution section menu. - Makes various edits to the original docs guidance for clarity. - Document our docs labels in a dedicated "creating an issue" page Fixes #9538
2022-02-09 21:15:49 +00:00
]
}
]
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
}
],
"variables": {
Update some variables and links (#6367)
2021-04-08 22:56:53 +00:00
"version": "7.0",
[Docs] Add AWS credentials to variables block (#17916) * alphabetize variables * implement aws access key vars
2022-11-21 15:01:50 +00:00
"ansible": {
"min_version": "2.9.6"
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
},
[Docs] Add AWS credentials to variables block (#17916) * alphabetize variables * implement aws access key vars
2022-11-21 15:01:50 +00:00
"aws": {
"aws_access_key": "abcd1234-this-is-an-example",
"aws_secret_access_key": "zyxw9876-this-is-an-example"
Try mini-diagrams and update launchpad titles (#7684) * Try mini-diagrams and update launchpad titles * fix some reports and links
2021-07-26 16:14:26 +00:00
},
"cloud": {
Bump cloud version to 11.2.1 (#20108) Teleport Cloud tenants will be upgraded to Teleport v11.2.1 on Thursday 1/12
2023-01-12 18:16:46 +00:00
"version": "11.2.1",
Bump cloud version to 11.1.2 (#19175) Teleport Cloud tenants will be upgraded to 11.1.2 on 12/8/22.
2022-12-08 15:04:06 +00:00
"major_version": "11",
Try mini-diagrams and update launchpad titles (#7684) * Try mini-diagrams and update launchpad titles * fix some reports and links
2021-07-26 16:14:26 +00:00
"sla": {
"monthly_percentage": "99.5%",
"monthly_downtime": "3 hours 40 minutes"
}
},
Add event handler (#7470) (#7485)
2021-07-08 20:36:30 +00:00
"docker": {
Adds Teleport lab. (#7480) Teleport lab is a demo environment in docker-compose. All components are setup, so users can jump straight into exploration of Teleport's features.
2021-07-15 18:56:23 +00:00
"version": "20.10.7",
"compose": {
"version": "1.25.0"
}
Add event handler (#7470) (#7485)
2021-07-08 20:36:30 +00:00
},
[Docs] Add AWS credentials to variables block (#17916) * alphabetize variables * implement aws access key vars
2022-11-21 15:01:50 +00:00
"fedramp": {
"control_url": "https://csrc.nist.gov/Projects/risk-management/sp800-53-controls/release-search#!/control?version=5.1&number="
},
"fluentd": {
"version": "1.12.4"
},
Switch bash to code component (#8019) (#8029)
2021-08-23 18:30:02 +00:00
"helm": {
"version": "3.4.2"
},
docs: Add Helm guides (#6390)
2021-05-17 13:38:13 +00:00
"kubernetes": {
"major_version": "1",
"minor_version": "17"
},
Add MongoDB guide, MySQL Cloud SQL guide and other 7.0 docs updates (#7350)
2021-07-12 06:12:21 +00:00
"mongodb": {
"min_version": "3.6"
},
[Docs] Add AWS credentials to variables block (#17916) * alphabetize variables * implement aws access key vars
2022-11-21 15:01:50 +00:00
"presets": {
"tokens": {
"first": "abcd123-insecure-do-not-use-this",
"second": "efgh456-insecure-do-not-use-this",
"third": "ijkl789-insecure-do-not-use-this"
},
"ca_pin": "sha256:abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678"
},
"soc2": {
"last_report": "August 9th, 2022"
},
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
"teleport": {
Update docs for new APT repos (#12959) * Updated docs for new APT repos * Added upgrade notes * Reworded upgrade details * Update docs/pages/includes/install-linux.mdx Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Added APT "legacy" docs * Bumped major version Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2022-07-13 18:28:31 +00:00
"major_version": "11",
update docs vars for master (#18643)
2022-11-21 19:57:38 +00:00
"version": "11.0.3",
"golang": "1.19",
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
"plugin": {
update docs vars for master (#18643)
2022-11-21 19:57:38 +00:00
"version": "11.0.3"
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
},
docs: Add Helm guides (#6390)
2021-05-17 13:38:13 +00:00
"helm_repo_url": "https://charts.releases.teleport.dev",
update docs vars for master (#18643)
2022-11-21 19:57:38 +00:00
"latest_oss_docker_image": "public.ecr.aws/gravitational/teleport:11.0.3",
"latest_ent_docker_image": "public.ecr.aws/gravitational/teleport-ent:11.0.3"
[Docs] Add AWS credentials to variables block (#17916) * alphabetize variables * implement aws access key vars
2022-11-21 15:01:50 +00:00
},
"terraform": {
"version": "1.0.0"
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
}
Move redirects to docs config (#5950) Co-authored-by: Alexey Ivanov <mail@alexeyivanov.info>
2021-03-11 17:02:14 +00:00
},
"redirects": [
Refactoring of architecture section. (#13651) Our architecture section was written almost 5 years ago and was completely obsolete. I refactored all of it to be up to date, added Kuberentes and other resource type references, replaced and created new diagrams.
2022-06-23 18:39:49 +00:00
{
"source": "/architecture/users/",
"destination": "/architecture/authorization/",
"permanent": true
},
move production and user manuals (#8341)
2021-09-22 03:22:21 +00:00
{
"source": "/production/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/deployments/",
move production and user manuals (#8341)
2021-09-22 03:22:21 +00:00
"permanent": true
},
Splits admin guide into setup sections (#8324) * Updates scaling guide. * Rewrites CA rotation guide. * Small tweaks and fixes to other parts.
2021-09-20 17:22:12 +00:00
{
"source": "/admin-guide/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/management/admin/",
Splits admin guide into setup sections (#8324) * Updates scaling guide. * Rewrites CA rotation guide. * Small tweaks and fixes to other parts.
2021-09-20 17:22:12 +00:00
"permanent": true
},
moves sso, labels and nodes to setup (#8216)
2021-09-13 18:49:17 +00:00
{
"source": "/trustedclusters/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/management/admin/trustedclusters/",
moves sso, labels and nodes to setup (#8216)
2021-09-13 18:49:17 +00:00
"permanent": true
},
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
{
"source": "/reference/api/architecture/",
"destination": "/api/architecture/",
"permanent": true
},
{
"source": "/reference/api/getting-started/",
"destination": "/api/getting-started/",
"permanent": true
},
{
"source": "/reference/api/introduction/",
"destination": "/api/introduction/",
"permanent": true
Desktop Access Beta documentation (#8504) * Desktop Access documentation First draft of the Desktop Access docs. This is for Beta and has the warnings on every page to make that clear. * Apply suggestions from code review Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com> Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>
2021-10-11 22:42:00 +00:00
},
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
{
"source": "/metrics-logs-reference/",
Enhance diagnostics docs (#15648) * Enhance diagnostics docs The diagnostics docs were all in one page(`setup/reference/metrics.mdx`) which made things a bit hard to find, and wasn't conducive to adding new content. Diagnostics information is now located at `setup/diagnostics` with each section from the original `metrics.mdx` doc now having its own dedicated page. The section will now show up in the navbar at "Setup" > "Monitoring Your Cluster". The content of the profiling page is expanded to include information from https://github.com/gravitational/teleport/blob/740d184d1cfc69ae2e96c50ee738b13884fb232b/assets/monitoring/README.md#low-level-monitoring to illustrate what the different profile types are, the information that they capture, and how to retrieve them. A new Distributed Tracing page is also added to instruct users on how to setup the `tracing_service` to collect and export spans (the last open item for #12241).
2022-10-14 20:05:07 +00:00
"destination": "/management/diagnostics/metrics/",
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
"permanent": true
},
{
"source": "/config-reference/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/reference/config/",
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
"permanent": true
Desktop Access Beta documentation (#8504) * Desktop Access documentation First draft of the Desktop Access docs. This is for Beta and has the warnings on every page to make that clear. * Apply suggestions from code review Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com> Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>
2021-10-11 22:42:00 +00:00
},
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
{
"source": "/cli-docs/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/reference/cli/",
Sasha/fwd user (#7996) * Video Banner (#7914) * Drain off admin guide into setup sections. (#7960) * Expand daemon section and graceful restarts guide * Move API section to top * Move references to setup Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 22:00:26 +00:00
"permanent": true
},
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
{
"source": "/enterprise/ssh-kubernetes-fedramp/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/compliance-frameworks/fedramp/",
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
"permanent": true
},
{
"source": "/enterprise/sso/ssh-one-login/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/sso/one-login/",
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
"permanent": true
},
{
"source": "/enterprise/sso/ssh-okta/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/sso/okta/",
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
"permanent": true
},
{
"source": "/enterprise/sso/ssh-google-workspace/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/sso/google-workspace/",
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
"permanent": true
},
{
"source": "/enterprise/sso/ssh-azuread/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/sso/azuread/",
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
"permanent": true
},
{
"source": "/enterprise/sso/ssh-adfs/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/sso/adfs/",
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
"permanent": true
},
{
"source": "/enterprise/sso/ssh-sso/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/sso/",
adds enterprise/sso redirect from teleport app (#12656)
2022-05-17 20:26:34 +00:00
"permanent": true
},
{
"source": "/enterprise/ssh_sso/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/sso/",
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
"permanent": true
},
{
"source": "/enterprise/quickstart-enterprise/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-enterprise/getting-started/",
Update SSO guides (#7671) * Cleaning Okta copy. * Update other connectors. * Cleanup and URL tweaks. Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 20:28:53 +00:00
"permanent": true
},
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
{
"source": "/gcp-guide/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/deployments/gcp/",
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
"permanent": true
Desktop Access Beta documentation (#8504) * Desktop Access documentation First draft of the Desktop Access docs. This is for Beta and has the warnings on every page to make that clear. * Apply suggestions from code review Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com> Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>
2021-10-11 22:42:00 +00:00
},
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
{
"source": "/ibm-cloud-guide/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/deployments/ibm/",
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
"permanent": true
},
{
"source": "/aws-terraform-guide/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/deployments/aws-terraform/",
Make reference deployments more visible (#7583)
2021-07-16 20:46:55 +00:00
"permanent": true
},
Adds Teleport lab. (#7480) Teleport lab is a demo environment in docker-compose. All components are setup, so users can jump straight into exploration of Teleport's features.
2021-07-15 18:56:23 +00:00
{
"source": "/setup/guides/docker-compose/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/management/guides/docker/",
Adds Teleport lab. (#7480) Teleport lab is a demo environment in docker-compose. All components are setup, so users can jump straight into exploration of Teleport's features.
2021-07-15 18:56:23 +00:00
"permanent": true
},
Move introductions to the appropriate sections (#6456)
2021-04-15 00:06:57 +00:00
{
"source": "/cloud/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-cloud/",
Move introductions to the appropriate sections (#6456)
2021-04-15 00:06:57 +00:00
"permanent": true
},
{
"source": "/application-access/",
"destination": "/application-access/introduction/",
"permanent": true
},
{
"source": "/database-access/",
"destination": "/database-access/introduction/",
"permanent": true
},
{
"source": "/kubernetes-access/",
"destination": "/kubernetes-access/introduction/",
"permanent": true
},
Open Sources Access Controls Docs (#6188) (#6217) * Open Sources Access Controls Docs (#6188) Moves RBAC to a separate access controls section, adds a couple of guides and prepares the structure for more content. * Fix href links
2021-03-30 17:04:23 +00:00
{
"source": "/enterprise/ssh-rbac/",
"destination": "/access-controls/introduction/",
"permanent": true
},
Move redirects to docs config (#5950) Co-authored-by: Alexey Ivanov <mail@alexeyivanov.info>
2021-03-11 17:02:14 +00:00
{
"source": "/quickstart/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/try-out-teleport/introduction/",
Move redirects to docs config (#5950) Co-authored-by: Alexey Ivanov <mail@alexeyivanov.info>
2021-03-11 17:02:14 +00:00
"permanent": true
},
{
"source": "/preview/database-access/",
"destination": "/database-access/",
"permanent": true
},
{
"source": "/preview/cloud/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-cloud/",
Move redirects to docs config (#5950) Co-authored-by: Alexey Ivanov <mail@alexeyivanov.info>
2021-03-11 17:02:14 +00:00
"permanent": true
},
{
"source": "/kubernetes-ssh/",
"destination": "/kubernetes-access/",
"permanent": true
[v7.0] Port of 6.2 Server Access Section (#6936) * docs: port of server access section * docs: correct query * docs: remove teleconsole
2021-05-27 02:36:48 +00:00
},
{
"source": "/features/ssh-pam/",
"destination": "/server-access/guides/ssh-pam/",
"permanent": true
},
{
"source": "/openssh-teleport/",
"destination": "/server-access/guides/openssh/",
"permanent": true
docs: links for gsuite (#7070)
2021-06-02 19:21:54 +00:00
},
Cleans up and moves session recording section (#7341)
2021-06-18 04:00:34 +00:00
{
"source": "/features/enhanced-session-recording/",
"destination": "/server-access/guides/bpf-session-recording/",
"permanent": true
docs: port to 7 (#7361) Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-06-20 03:20:46 +00:00
},
{
"source": "/quickstart-docker/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/management/guides/docker/",
docs: port to 7 (#7361) Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-06-20 03:20:46 +00:00
"permanent": true
Add dynamic registration and discovery guides (#8694)
2021-11-04 22:52:35 +00:00
},
{
"source": "/database-access/guides/postgres-aws/",
"destination": "/database-access/guides/rds/",
"permanent": true
},
{
"source": "/database-access/guides/mysql-aws/",
"destination": "/database-access/guides/rds/",
"permanent": true
Make our docs guidance discoverable (#10155) Make our docs guidance discoverable Currently, our guidance for making docs changes is organized into a /docs/docs page that is only accessible if you know the URL. This change ensures that people who have not received an informal training on docs contributions can contribute in a way that abides by our expectations for consistency and effectiveness. - Splits the docs/docs and docs/docs/best-practices pages into a UI reference, getting started guide, and style guide. This ensures that each kind of content we have in our contributing guide (i.e., tutorial or reference) is accessible from the main nav menu. - Adds a "Contributing" tab to the navigation menu. There is one subsection here related to documenation, and we can add another subsection later with developer guides for editing Teleport's code. - Moves the "philosophy" section into the intro page of the documentation contribution section menu. - Makes various edits to the original docs guidance for clarity. - Document our docs labels in a dedicated "creating an issue" page Fixes #9538
2022-02-09 21:15:49 +00:00
},
{
"source": "/docs/",
"destination": "/contributing/documentation/",
"permanent": true
},
{
"source": "/docs/best-practices/",
"destination": "/contributing/documentation/",
"permanent": true
Remove the v5 Kubernetes migration guide (#11180) Since we no longer support version 5, including this guide only risks misleading current/prospective users. This change removes the v5 migration guide and redirects the path to the Kubernetes Access Introduction page.
2022-03-18 15:22:08 +00:00
},
{
"source": "/kubernetes-access/guides/migration/",
"destination": "/kubernetes-access/introduction/",
"permanent": true
Split the AWS Node Joining guide (#11081) * Split the AWS Node Joining guide This is to better address users with different scopes (see #10633). Since the EC2 method is irrelevant for Cloud users, this approach makes it straightforward to add an edition warning to the top of the EC2 join method guide and scoped Tabs components to the IAM join method guide. The alternative was to add nested Tabs components, with the top level including Cloud vs. Self-Hosted TabItems and the inner level including TabItems for the IAM and EC2 join methods. This looked pretty unattractive and couldn't accommodate the final section on using the EC2 method with multiple AWS accounts. * Respond to PR feedback Co-authored-by: Nic Klaassen <nic@goteleport.com> * Respond to PR feedback Co-authored-by: Nic Klaassen <nic@goteleport.com>
2022-03-23 21:09:26 +00:00
},
{
"source": "/setup/guides/joining-nodes-aws/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/management/guides/joining-nodes-aws-iam/",
Split the AWS Node Joining guide (#11081) * Split the AWS Node Joining guide This is to better address users with different scopes (see #10633). Since the EC2 method is irrelevant for Cloud users, this approach makes it straightforward to add an edition warning to the top of the EC2 join method guide and scoped Tabs components to the IAM join method guide. The alternative was to add nested Tabs components, with the top level including Cloud vs. Self-Hosted TabItems and the inner level including TabItems for the IAM and EC2 join methods. This looked pretty unattractive and couldn't accommodate the final section on using the EC2 method with multiple AWS accounts. * Respond to PR feedback Co-authored-by: Nic Klaassen <nic@goteleport.com> * Respond to PR feedback Co-authored-by: Nic Klaassen <nic@goteleport.com>
2022-03-23 21:09:26 +00:00
"permanent": true
Edit three Setup guides for Cloud users (#10759) * Edit three Setup guides for Cloud users Teleport Daemon - Use a Notice for a warning re: the Auth Service scoped to self-hosted users - Misc grammar/style/clarity tweaks Move the Enterprise License File page The page does not belong in the Setup section, since it does not apply to Cloud and OSS users. I have moved the page into the Enterprise section. Networking guide - Add tabbed instructions so users who have selected a given scope don't see content for other scopes. - Mention auth_service.proxy_listener_mode instead of tls_routing_enabled for self-hosted readers - Misc grammar, style, and clarity edits Scaling We already added an edition warning in a Details box, but I thought a Notice would be more prominent. I've also added some minor grammar, style, and clarity tweaks. * Address PR feedback - Imply that there are non-Auth/Proxy services beside Nodes - Remove "shell" where it is unnecessary - Revert the "HTTP CONNECT" section to where it was before this change. The copy-edits were inaccurate, but I don't have time to perform the edits agin more carefully. * Address PR feedback Simplify the HTTP CONNECT section by bringing the example closer to the explanation of this functionality and removing some ambiguity over whether one or both of HTTPS_PROXY and HTTP_PROXY are required. The original text suggested that either is required, then that both are required. The new text says to assign both, then explains why.
2022-04-13 16:47:12 +00:00
},
{
Fix docs redirects (#14546) Some docs redirects erroneously include the "/docs/" path segment, which our docs engine ignores while parsing the redirect config. This change fixes these redirects.
2022-07-18 16:43:52 +00:00
"source": "/setup/reference/license/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-enterprise/license/",
Edit three Setup guides for Cloud users (#10759) * Edit three Setup guides for Cloud users Teleport Daemon - Use a Notice for a warning re: the Auth Service scoped to self-hosted users - Misc grammar/style/clarity tweaks Move the Enterprise License File page The page does not belong in the Setup section, since it does not apply to Cloud and OSS users. I have moved the page into the Enterprise section. Networking guide - Add tabbed instructions so users who have selected a given scope don't see content for other scopes. - Mention auth_service.proxy_listener_mode instead of tls_routing_enabled for self-hosted readers - Misc grammar, style, and clarity edits Scaling We already added an edition warning in a Details box, but I thought a Notice would be more prominent. I've also added some minor grammar, style, and clarity tweaks. * Address PR feedback - Imply that there are non-Auth/Proxy services beside Nodes - Remove "shell" where it is unnecessary - Revert the "HTTP CONNECT" section to where it was before this change. The copy-edits were inaccurate, but I don't have time to perform the edits agin more carefully. * Address PR feedback Simplify the HTTP CONNECT section by bringing the example closer to the explanation of this functionality and removing some ambiguity over whether one or both of HTTPS_PROXY and HTTP_PROXY are required. The original text suggested that either is required, then that both are required. The new text says to assign both, then explains why.
2022-04-13 16:47:12 +00:00
"permanent": true
Ports `docs` redirects from nginx-redirects.conf (#12528) * ported docs redirects from nginx-redirects.conf * added additional redirect
2022-05-11 23:24:17 +00:00
},
{
"source": "/intro/",
"destination": "/",
"permanent": true
},
{
"source": "/api-reference/",
"destination": "/api/getting-started/",
"permanent": true
},
Move the tsh guide to the new "Use Teleport" section (#14636) * Move the tsh guide to the new "Use Teleport" section This new section will be a good place to add Connect docs to in the near future.
2022-07-20 08:32:53 +00:00
{
"source": "/server-access/guides/tsh/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/connect-your-client/tsh/",
Move the tsh guide to the new "Use Teleport" section (#14636) * Move the tsh guide to the new "Use Teleport" section This new section will be a good place to add Connect docs to in the near future.
2022-07-20 08:32:53 +00:00
"permanent": true
},
Ports `docs` redirects from nginx-redirects.conf (#12528) * ported docs redirects from nginx-redirects.conf * added additional redirect
2022-05-11 23:24:17 +00:00
{
"source": "/cluster/",
"destination": "/kubernetes-access/guides/multiple-clusters/",
"permanent": true
Add JWT auth guide for ElasticSearch (#12612) (#13137)
2022-06-03 15:25:20 +00:00
},
{
"source": "/application-access/guides/jwt/",
"destination": "/application-access/jwt/",
"permanent": true
Refine the organization of /docs/getting-started (#12923) Fixes #12921 This removes the DigitalOcean link on the /docs/getting-started page and moves the DigitalOcean guide into /docs/setup/deployments, which is a more appropriate home. Now, the "Deploy to production" section of /docs/getting-started only includes links to the Getting Started guide for the Open Source, Cloud, and Enterprise editions, making it clearer to users that there are three editions and that we have separate content for each one. This also changes the href of the Teleport Cloud link on the Getting Started page to /cloud/getting-started/?scope=cloud to be consistent with the other links, which direct users to guides.
2022-06-21 15:32:16 +00:00
},
{
"source": "/getting-started/digitalocean/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/try-out-teleport/digitalocean/",
Refine the organization of /docs/getting-started (#12923) Fixes #12921 This removes the DigitalOcean link on the /docs/getting-started page and moves the DigitalOcean guide into /docs/setup/deployments, which is a more appropriate home. Now, the "Deploy to production" section of /docs/getting-started only includes links to the Getting Started guide for the Open Source, Cloud, and Enterprise editions, making it clearer to users that there are three editions and that we have separate content for each one. This also changes the href of the Teleport Cloud link on the Getting Started page to /cloud/getting-started/?scope=cloud to be consistent with the other links, which direct users to guides.
2022-06-21 15:32:16 +00:00
"permanent": true
Move Auth/Proxy-only Kubernetes guides (#13068) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on the pages in: /docs/pages/kubernetes-access/getting-started/ - Move docs/pages/kubernetes-access/getting-started guides that don't relate to Kubernetes Access out of this section, and change the docs/pages/kubernetes-access/getting-started.mdx page to point to the current "Agent" guide. - Edit the "docs/pages/getting-started.mdx" menu page to accommodate the Kubernetes guides. Previously, this page included separate links for each edition's getting started guide. To add the Kubernetes Cluster guide, I organized the links in the "Deploy to production" section into a TabItem for each Teleport edition. There are separate links to the Kubernetes Cluster guide, one for OSS users and one for Enterprise users. These links also take users to the appropriate scope.
2022-06-22 19:29:32 +00:00
},
{
Fix docs redirects (#14546) Some docs redirects erroneously include the "/docs/" path segment, which our docs engine ignores while parsing the redirect config. This change fixes these redirects.
2022-07-18 16:43:52 +00:00
"source": "/kubernetes-access/getting-started/agent/",
"destination": "/kubernetes-access/getting-started/",
Move Auth/Proxy-only Kubernetes guides (#13068) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on the pages in: /docs/pages/kubernetes-access/getting-started/ - Move docs/pages/kubernetes-access/getting-started guides that don't relate to Kubernetes Access out of this section, and change the docs/pages/kubernetes-access/getting-started.mdx page to point to the current "Agent" guide. - Edit the "docs/pages/getting-started.mdx" menu page to accommodate the Kubernetes guides. Previously, this page included separate links for each edition's getting started guide. To add the Kubernetes Cluster guide, I organized the links in the "Deploy to production" section into a TabItem for each Teleport edition. There are separate links to the Kubernetes Cluster guide, one for OSS users and one for Enterprise users. These links also take users to the appropriate scope.
2022-06-22 19:29:32 +00:00
"permanent": true
},
{
Fix docs redirects (#14546) Some docs redirects erroneously include the "/docs/" path segment, which our docs engine ignores while parsing the redirect config. This change fixes these redirects.
2022-07-18 16:43:52 +00:00
"source": "/kubernetes-access/getting-started/cluster/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/helm-deployments/kubernetes-cluster/",
Move Auth/Proxy-only Kubernetes guides (#13068) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on the pages in: /docs/pages/kubernetes-access/getting-started/ - Move docs/pages/kubernetes-access/getting-started guides that don't relate to Kubernetes Access out of this section, and change the docs/pages/kubernetes-access/getting-started.mdx page to point to the current "Agent" guide. - Edit the "docs/pages/getting-started.mdx" menu page to accommodate the Kubernetes guides. Previously, this page included separate links for each edition's getting started guide. To add the Kubernetes Cluster guide, I organized the links in the "Deploy to production" section into a TabItem for each Teleport edition. There are separate links to the Kubernetes Cluster guide, one for OSS users and one for Enterprise users. These links also take users to the appropriate scope.
2022-06-22 19:29:32 +00:00
"permanent": true
},
{
Fix docs redirects (#14546) Some docs redirects erroneously include the "/docs/" path segment, which our docs engine ignores while parsing the redirect config. This change fixes these redirects.
2022-07-18 16:43:52 +00:00
"source": "/kubernetes-access/getting-started/local/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/try-out-teleport/local-kubernetes/",
Move Auth/Proxy-only Kubernetes guides (#13068) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on the pages in: /docs/pages/kubernetes-access/getting-started/ - Move docs/pages/kubernetes-access/getting-started guides that don't relate to Kubernetes Access out of this section, and change the docs/pages/kubernetes-access/getting-started.mdx page to point to the current "Agent" guide. - Edit the "docs/pages/getting-started.mdx" menu page to accommodate the Kubernetes guides. Previously, this page included separate links for each edition's getting started guide. To add the Kubernetes Cluster guide, I organized the links in the "Deploy to production" section into a TabItem for each Teleport edition. There are separate links to the Kubernetes Cluster guide, one for OSS users and one for Enterprise users. These links also take users to the appropriate scope.
2022-06-22 19:29:32 +00:00
"permanent": true
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
},
{
"source": "/kubernetes-access/helm/guides/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/helm-deployments/",
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/aws/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/helm-deployments/aws/",
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/custom/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/helm-deployments/custom/",
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/digitalocean/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/helm-deployments/digitalocean/",
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/gcp/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/helm-deployments/gcp/",
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
"permanent": true
},
{
"source": "/kubernetes-access/helm/guides/migration/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/deploy-a-cluster/helm-deployments/migration/",
Move Helm deployment guides (#13105) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm deployment guides. These guides are not related to the Kubernetes Service, but rather to deploying the Auth Service and Proxy Service on Kubernetes. I've suggested moving these guides to a /setup/helm-deployments section for visibility.
2022-06-23 15:25:27 +00:00
"permanent": true
Move Helm references (#13102) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm chart references. These are not exclusive to the Teleport Kubernetes Service, so I am suggesting moving these guides to the /docs/setup section to make them more discoverable.
2022-06-24 21:38:59 +00:00
},
{
"source": "/kubernetes-access/helm/reference/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/reference/helm-reference/",
Move Helm references (#13102) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm chart references. These are not exclusive to the Teleport Kubernetes Service, so I am suggesting moving these guides to the /docs/setup section to make them more discoverable.
2022-06-24 21:38:59 +00:00
"permanent": true
},
{
"source": "/kubernetes-access/helm/reference/teleport-cluster/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/reference/helm-reference/teleport-cluster/",
Move Helm references (#13102) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm chart references. These are not exclusive to the Teleport Kubernetes Service, so I am suggesting moving these guides to the /docs/setup section to make them more discoverable.
2022-06-24 21:38:59 +00:00
"permanent": true
},
{
"source": "/kubernetes-access/helm/reference/teleport-kube-agent/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/reference/helm-reference/teleport-kube-agent/",
Move Helm references (#13102) See #12654 The Kubernetes Access section includes guides for using the Kubernetes Service as well as guides for running the Auth and Proxy Service on Kubernetes. This is misleading, since (a) you can run the Auth/Proxy on Kubernetes without using Kubernetes Access and (b) you can use Kubernetes Access without running the Auth/Proxy on Kubernetes. This change focuses on our Helm chart references. These are not exclusive to the Teleport Kubernetes Service, so I am suggesting moving these guides to the /docs/setup section to make them more discoverable.
2022-06-24 21:38:59 +00:00
"permanent": true
Add/update docs for passwordless, WebAuthn and U2F (#13314) Add a batch of public documentation changes that cover: * Passwordless (new guide and various links) * WebAuthn updates in regards to U2F * U2F documentation removal (superseded by WebAuthn) * Updated config reference (`teleport.yaml` and equivalents) * Updated `tsh` reference This should cover the bulk of the work under Passwordless (#9160) and U2F sunset (#10375). #9160 Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-07-06 20:30:51 +00:00
},
{
"source": "/access-controls/guides/u2f/",
"destination": "/access-controls/guides/webauthn/",
"permanent": true
Complete renaming of the Graceful Restarts guide (#14545) Earlier, we had renamed this guide since we had split the signals information into its own reference. This change removes some remaining traces of the old name, including in the guide's URL.
2022-07-18 19:46:35 +00:00
},
{
Move the tsh guide to the new "Use Teleport" section (#14636) * Move the tsh guide to the new "Use Teleport" section This new section will be a good place to add Connect docs to in the near future.
2022-07-20 08:32:53 +00:00
"source": "/setup/admin/graceful-restarts/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/management/admin/upgrading-the-teleport-binary/",
"permanent": true
},
{
"source": "/enterprise/workflow/",
"destination": "/access-controls/access-requests/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-mattermost/",
"destination": "/access-controls/access-request-plugins/ssh-approval-mattermost/",
"permanent": true
},
{
Fix incorrect PagerDuty guide redirect (#15538)
2022-08-26 21:50:06 +00:00
"source": "/enterprise/workflow/ssh-approval-pagerduty/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"destination": "/access-controls/access-request-plugins/ssh-approval-pagerduty/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-jira-server/",
Remove the Jira Server Access Plugin guide (#17546) Closes #14578 The Jira Cloud guide applies to all Jira deployments already, so we don't need to maintain separate guides. This change renames the Jira Cloud guide so it's about Jira in general.
2022-11-04 20:28:58 +00:00
"destination": "/access-controls/access-request-plugins/ssh-approval-jira/",
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-jira-cloud/",
"destination": "/access-controls/access-request-plugins/ssh-approval-jira/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-jira-cloud/",
Remove the Jira Server Access Plugin guide (#17546) Closes #14578 The Jira Cloud guide applies to all Jira deployments already, so we don't need to maintain separate guides. This change renames the Jira Cloud guide so it's about Jira in general.
2022-11-04 20:28:58 +00:00
"destination": "/access-controls/access-request-plugins/ssh-approval-jira/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/enterprise/workflow/ssh-approval-slack/",
"destination": "/access-controls/access-request-plugins/ssh-approval-slack/",
"permanent": true
},
{
"source": "/enterprise/workflow/resource-requests/",
"destination": "/access-controls/access-requests/resource-requests/",
"permanent": true
},
{
"source": "/enterprise/workflow/role-requests/",
"destination": "/access-controls/access-requests/role-requests/",
"permanent": true
},
{
"source": "/user-manual/",
"destination": "/",
"permanent": true
},
{
"source": "/enterprise/fedramp/",
"destination": "/access-controls/compliance-frameworks/fedramp/",
"permanent": true
},
{
"source": "/enterprise/soc2/",
"destination": "/access-controls/compliance-frameworks/soc2/",
"permanent": true
},
{
"source": "/enterprise/sso/",
"destination": "/access-controls/sso/",
"permanent": true
},
{
"source": "/enterprise/sso/adfs/",
"destination": "/access-controls/sso/adfs/",
"permanent": true
},
{
"source": "/enterprise/sso/azuread/",
"destination": "/access-controls/sso/azuread/",
"permanent": true
},
{
"source": "/setup/admin/github-sso/",
"destination": "/access-controls/sso/github-sso/",
"permanent": true
},
{
"source": "/enterprise/sso/gitlab/",
"destination": "/access-controls/sso/gitlab/",
"permanent": true
},
{
"source": "/enterprise/sso/google-workspace/",
"destination": "/access-controls/sso/google-workspace/",
"permanent": true
},
{
"source": "/enterprise/sso/oidc/",
"destination": "/access-controls/sso/oidc/",
"permanent": true
},
{
"source": "/enterprise/sso/okta/",
"destination": "/access-controls/sso/okta/",
"permanent": true
},
{
"source": "/enterprise/sso/one-login/",
"destination": "/access-controls/sso/one-login/",
"permanent": true
},
{
"source": "/database-access/guides/gui-clients/",
"destination": "/connect-your-client/gui-clients/",
"permanent": true
},
{
"source": "/use-teleport/teleport-connect/",
"destination": "/connect-your-client/teleport-connect/",
"permanent": true
},
{
"source": "/use-teleport/tsh/",
"destination": "/connect-your-client/tsh/",
"permanent": true
},
{
"source": "/setup/deployments/",
"destination": "/deploy-a-cluster/deployments/",
"permanent": true
},
{
"source": "/setup/deployments/aws-terraform/",
"destination": "/deploy-a-cluster/deployments/aws-terraform/",
"permanent": true
},
{
"source": "/setup/deployments/digitalocean/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/try-out-teleport/digitalocean/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/setup/deployments/gcp/",
"destination": "/deploy-a-cluster/deployments/gcp/",
"permanent": true
},
{
"source": "/setup/deployments/ibm/",
"destination": "/deploy-a-cluster/deployments/ibm/",
"permanent": true
},
{
"source": "/setup/helm-deployments/",
"destination": "/deploy-a-cluster/helm-deployments/",
"permanent": true
},
{
"source": "/setup/helm-deployments/aws/",
"destination": "/deploy-a-cluster/helm-deployments/aws/",
"permanent": true
},
{
"source": "/setup/helm-deployments/custom/",
"destination": "/deploy-a-cluster/helm-deployments/custom/",
"permanent": true
},
{
"source": "/setup/helm-deployments/digitalocean/",
"destination": "/deploy-a-cluster/helm-deployments/digitalocean/",
"permanent": true
},
{
"source": "/setup/helm-deployments/gcp/",
"destination": "/deploy-a-cluster/helm-deployments/gcp/",
"permanent": true
},
{
"source": "/getting-started/kubernetes-cluster/",
"destination": "/deploy-a-cluster/helm-deployments/kubernetes-cluster/",
"permanent": true
},
{
"source": "/setup/helm-deployments/migration/",
"destination": "/deploy-a-cluster/helm-deployments/migration/",
"permanent": true
},
{
"source": "/getting-started/linux-server/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/try-out-teleport/linux-server/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/cloud/architecture/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-cloud/architecture/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/cloud/downloads/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-cloud/downloads/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/cloud/faq/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-cloud/faq/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/cloud/getting-started/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-cloud/getting-started/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/cloud/introduction/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-cloud/introduction/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/enterprise/getting-started/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-enterprise/getting-started/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/enterprise/hsm/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-enterprise/hsm/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/enterprise/introduction/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-enterprise/introduction/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/enterprise/license/",
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
"destination": "/choose-an-edition/teleport-enterprise/license/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
Add redirect for outdated Machine ID CLI Ref (#18381)
2022-12-10 18:26:41 +00:00
{
"source": "/machine-id/reference/cli/",
"destination": "/reference/cli/",
"permanent": true
},
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
{
"source": "/setup/admin/",
"destination": "/management/admin/",
"permanent": true
},
{
"source": "/setup/admin/adding-nodes/",
"destination": "/management/admin/adding-nodes/",
"permanent": true
},
{
"source": "/setup/admin/daemon/",
"destination": "/management/admin/daemon/",
"permanent": true
},
{
"source": "/setup/admin/labels/",
"destination": "/management/admin/labels/",
"permanent": true
},
{
"source": "/setup/admin/troubleshooting/",
"destination": "/management/admin/troubleshooting/",
"permanent": true
},
{
"source": "/setup/admin/trustedclusters/",
"destination": "/management/admin/trustedclusters/",
"permanent": true
},
{
"source": "/setup/admin/upgrading-the-teleport-binary/",
"destination": "/management/admin/upgrading-the-teleport-binary/",
"permanent": true
},
{
"source": "/setup/admin/users/",
"destination": "/management/admin/users/",
"permanent": true
},
{
"source": "/setup/guides/",
"destination": "/management/guides/",
"permanent": true
},
{
"source": "/setup/guides/docker/",
"destination": "/management/guides/docker/",
"permanent": true
},
{
"source": "/setup/guides/ec2-tags/",
"destination": "/management/guides/ec2-tags/",
"permanent": true
},
{
"source": "/setup/guides/fluentd/",
Add a guide to exporting events to Splunk (#17405) * Add a guide to exporting events to Splunk Closes #13158 Since there are multiple guides to exporting audit events now, this also adds a new section of the docs for these guides. Also fixes a tiny error in the Elastic Stack guide. * Respond to PR feedback * Fix linter issues * Respond to PR feedback - Use consistent naming - Mention the `--ttl` flag for `tctl auth sign` - Mention Machine ID - Add a quick Troubleshooting section - Fix `chmod` command - Add systemd configs (also added this to the Elastic Stack Event Handler guide. I didn't do this to the Fluentd guide because the structure of the guide is different from the Splunk guide's).
2022-12-19 22:09:58 +00:00
"destination": "/management/export-audit-events/fluentd/",
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"permanent": true
},
{
"source": "/setup/guides/joining-nodes-aws-ec2/",
"destination": "/management/guides/joining-nodes-aws-ec2/",
"permanent": true
},
{
"source": "/setup/guides/joining-nodes-aws-iam/",
"destination": "/management/guides/joining-nodes-aws-iam/",
"permanent": true
},
{
"source": "/setup/guides/ssh-key-extensions/",
"destination": "/management/guides/ssh-key-extensions/",
"permanent": true
},
{
"source": "/setup/guides/teleport-operator/",
"destination": "/management/guides/teleport-operator/",
"permanent": true
},
{
"source": "/setup/guides/terraform-provider/",
"destination": "/management/guides/terraform-provider/",
"permanent": true
},
{
"source": "/setup/operations/",
"destination": "/management/operations/",
"permanent": true
},
{
"source": "/setup/operations/backup-restore/",
"destination": "/management/operations/backup-restore/",
"permanent": true
},
{
"source": "/setup/operations/ca-rotation/",
"destination": "/management/operations/ca-rotation/",
"permanent": true
},
Add documentation for proxy peering (#15790)
2022-10-04 16:00:37 +00:00
{
"source": "/setup/operations/proxy-peering/",
"destination": "/management/operations/proxy-peering/",
"permanent": true
},
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
{
"source": "/setup/operations/scaling/",
"destination": "/management/operations/scaling/",
"permanent": true
},
{
"source": "/setup/operations/tls-routing/",
"destination": "/management/operations/tls-routing/",
"permanent": true
},
{
"source": "/setup/operations/upgrading/",
"destination": "/management/operations/upgrading/",
"permanent": true
},
{
"source": "/setup/security/",
"destination": "/management/security/",
"permanent": true
},
{
"source": "/setup/security/reduce-blast-radius/",
"destination": "/management/security/reduce-blast-radius/",
"permanent": true
},
{
"source": "/setup/reference/audit/",
"destination": "/reference/audit/",
"permanent": true
},
{
"source": "/setup/reference/authentication/",
"destination": "/reference/authentication/",
"permanent": true
},
{
"source": "/setup/reference/backends/",
"destination": "/reference/backends/",
"permanent": true
},
{
"source": "/setup/reference/cli/",
"destination": "/reference/cli/",
"permanent": true
},
{
"source": "/setup/reference/config/",
"destination": "/reference/config/",
"permanent": true
},
{
"source": "/setup/helm-reference/",
"destination": "/reference/helm-reference/",
"permanent": true
},
{
"source": "/setup/helm-reference/teleport-cluster/",
"destination": "/reference/helm-reference/teleport-cluster/",
Move the tsh guide to the new "Use Teleport" section (#14636) * Move the tsh guide to the new "Use Teleport" section This new section will be a good place to add Connect docs to in the near future.
2022-07-20 08:32:53 +00:00
"permanent": true
Move Access Requests guides to Access Controls (#14598) Reorganize our Access Request guides Fixes #13696 Most guides to Access Requests are currently not listed on the sidebar, and the guides that are listed are available for Cloud as well as Enterprise. This change makes it easier to find our Access Requests guides by moving them to the Access Controls section and listing all guides on the sidebar. It adds the "Access Requests" and "Access Request Plugins" subsections to "Access Controls". Since the Access Controls section includes one subsection, called "Guides", this change also renames that subsection--and adds a descriptive intro paragraph to the section's menu page--in order to accommodate the Access Requests and Access Request Plugins subsections. Move some guides into "Access Requests"
2022-08-01 17:44:36 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/setup/helm-reference/teleport-kube-agent/",
"destination": "/reference/helm-reference/teleport-kube-agent/",
"permanent": true
Move Access Requests guides to Access Controls (#14598) Reorganize our Access Request guides Fixes #13696 Most guides to Access Requests are currently not listed on the sidebar, and the guides that are listed are available for Cloud as well as Enterprise. This change makes it easier to find our Access Requests guides by moving them to the Access Controls section and listing all guides on the sidebar. It adds the "Access Requests" and "Access Request Plugins" subsections to "Access Controls". Since the Access Controls section includes one subsection, called "Guides", this change also renames that subsection--and adds a descriptive intro paragraph to the section's menu page--in order to accommodate the Access Requests and Access Request Plugins subsections. Move some guides into "Access Requests"
2022-08-01 17:44:36 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/setup/reference/metrics/",
"destination": "/reference/metrics/",
"permanent": true
Move Access Requests guides to Access Controls (#14598) Reorganize our Access Request guides Fixes #13696 Most guides to Access Requests are currently not listed on the sidebar, and the guides that are listed are available for Cloud as well as Enterprise. This change makes it easier to find our Access Requests guides by moving them to the Access Controls section and listing all guides on the sidebar. It adds the "Access Requests" and "Access Request Plugins" subsections to "Access Controls". Since the Access Controls section includes one subsection, called "Guides", this change also renames that subsection--and adds a descriptive intro paragraph to the section's menu page--in order to accommodate the Access Requests and Access Request Plugins subsections. Move some guides into "Access Requests"
2022-08-01 17:44:36 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/setup/reference/networking/",
"destination": "/reference/networking/",
"permanent": true
Move Access Requests guides to Access Controls (#14598) Reorganize our Access Request guides Fixes #13696 Most guides to Access Requests are currently not listed on the sidebar, and the guides that are listed are available for Cloud as well as Enterprise. This change makes it easier to find our Access Requests guides by moving them to the Access Controls section and listing all guides on the sidebar. It adds the "Access Requests" and "Access Request Plugins" subsections to "Access Controls". Since the Access Controls section includes one subsection, called "Guides", this change also renames that subsection--and adds a descriptive intro paragraph to the section's menu page--in order to accommodate the Access Requests and Access Request Plugins subsections. Move some guides into "Access Requests"
2022-08-01 17:44:36 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/setup/reference/predicate-language/",
"destination": "/reference/predicate-language/",
"permanent": true
Move Access Requests guides to Access Controls (#14598) Reorganize our Access Request guides Fixes #13696 Most guides to Access Requests are currently not listed on the sidebar, and the guides that are listed are available for Cloud as well as Enterprise. This change makes it easier to find our Access Requests guides by moving them to the Access Controls section and listing all guides on the sidebar. It adds the "Access Requests" and "Access Request Plugins" subsections to "Access Controls". Since the Access Controls section includes one subsection, called "Guides", this change also renames that subsection--and adds a descriptive intro paragraph to the section's menu page--in order to accommodate the Access Requests and Access Request Plugins subsections. Move some guides into "Access Requests"
2022-08-01 17:44:36 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/setup/reference/resources/",
"destination": "/reference/resources/",
"permanent": true
Move Access Requests guides to Access Controls (#14598) Reorganize our Access Request guides Fixes #13696 Most guides to Access Requests are currently not listed on the sidebar, and the guides that are listed are available for Cloud as well as Enterprise. This change makes it easier to find our Access Requests guides by moving them to the Access Controls section and listing all guides on the sidebar. It adds the "Access Requests" and "Access Request Plugins" subsections to "Access Controls". Since the Access Controls section includes one subsection, called "Guides", this change also renames that subsection--and adds a descriptive intro paragraph to the section's menu page--in order to accommodate the Access Requests and Access Request Plugins subsections. Move some guides into "Access Requests"
2022-08-01 17:44:36 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/setup/reference/signals/",
"destination": "/reference/signals/",
"permanent": true
Move Access Requests guides to Access Controls (#14598) Reorganize our Access Request guides Fixes #13696 Most guides to Access Requests are currently not listed on the sidebar, and the guides that are listed are available for Cloud as well as Enterprise. This change makes it easier to find our Access Requests guides by moving them to the Access Controls section and listing all guides on the sidebar. It adds the "Access Requests" and "Access Request Plugins" subsections to "Access Controls". Since the Access Controls section includes one subsection, called "Guides", this change also renames that subsection--and adds a descriptive intro paragraph to the section's menu page--in order to accommodate the Access Requests and Access Request Plugins subsections. Move some guides into "Access Requests"
2022-08-01 17:44:36 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/setup/reference/terraform-provider/",
"destination": "/reference/terraform-provider/",
"permanent": true
Move Access Requests guides to Access Controls (#14598) Reorganize our Access Request guides Fixes #13696 Most guides to Access Requests are currently not listed on the sidebar, and the guides that are listed are available for Cloud as well as Enterprise. This change makes it easier to find our Access Requests guides by moving them to the Access Controls section and listing all guides on the sidebar. It adds the "Access Requests" and "Access Request Plugins" subsections to "Access Controls". Since the Access Controls section includes one subsection, called "Guides", this change also renames that subsection--and adds a descriptive intro paragraph to the section's menu page--in order to accommodate the Access Requests and Access Request Plugins subsections. Move some guides into "Access Requests"
2022-08-01 17:44:36 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/getting-started/docker-compose/",
"destination": "/try-out-teleport/docker-compose/",
"permanent": true
Add redirect from /user-manual (#15419) An earlier commit erroneously removed the /user-manual redirect, causing 404s for several pages on the goteleport site that still point to this outdated URL. This change reinstates the redirect.
2022-08-12 20:55:13 +00:00
},
{
Organize docs guide sections chronologically (#15357) * Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
2022-08-22 19:45:32 +00:00
"source": "/getting-started/local-kubernetes/",
"destination": "/try-out-teleport/local-kubernetes/",
"permanent": true
Add a glossary of Teleport terms (#16762) * Add a glossary of Teleport terms Closes #16121 Closes #13363 - Create a Core Concepts page based on the Architecture Overview page. The Overview page is an outline of core concepts, so I thought it would make a good starting point for the glossary. - Add the Core Concepts page to the Home section to make it more prominent for users who are visiting the docs homepage. This should give it more traffic than leaving it in the Architecture section. - Move definitions out of the "Definitions" table. Since this table repeats content from the body sections and comes after them, it makes sense to condense all content into brief body sections. - Alphabetize sections - Bold the first instance of each keyword within a given section. Not adding links since these are all to the same page. It might get a bit confusing to click a link and not see a change in view, since the target section would already be on the page. - Remove the intro paragraph of the old Overview page, since it's not strictly related to core concepts. * Respond to PR feedback and add further edits - Group definitions into H3-level sections organized into H2s, improving readability by presenting the more central components first. - Group "Machine ID" with "Teleport Services" to simplify the glossary. - Call instances of a Teleport Service an "agent". This is consistent with our source and informal language about Teleport. This also removes the "Node" terminology, which is prone to misuse (does it mean "a Service instance"? An "SSH Service instance"? Both are present in the docs) and easily confused with the lowercase "node" (i.e., a host). - For simplicity, remove the term "Teleport Process" and simply explain that multiple Teleport Services can run via the same binary. - Add a section on Teleport's editions, including the terms "Community Edition", "Enterprise", and "Enterprise Cloud". - Remove the mention of Teleport Discover, which isn't documented yet. - Minor wording/readability changes. * Respond to PR feedback * Respond to zmb3 feedback
2022-12-08 17:32:50 +00:00
},
{
"source": "/architecture/overview/",
"destination": "/core-concepts/",
"permanent": true
Remove the Kubernetes CI/CD guide (#19529) Closes #19198 The recommended approach is to use Machine ID for impersonated kubeconfigs, and we already have a Machine ID guide for Kubernetes.
2022-12-21 13:58:02 +00:00
},
{
"source": "/kubernetes-access/guides/cicd/",
"destination": "/machine-id/guides/kubernetes/",
"permanent": true
Reorganize early-stage docs sections (#19205) * Reorganize early-stage docs sections Closes #18127 Currently, there are two sections of the docs related to the earliest stages of setting up Teleport, "Try out Teleport" and "Deploy a Cluster". While the organization of our top-level docs sections attempts to correspond to the stages a user goes through when setting up Teleport, these combine some tasks that should probably be separated: - **Choosing an edition and deploying a production cluster**: While the "Deploy a Cluster" section includes our deployment guides as well as our edition guides, user will likely commit to setting up Teleport Cloud, Open Source, or Enterprise before they plan a full HA production deployment. - **Deploying a production cluster and deploying a small-scale Teleport cluster:** While the "Deploy a Cluster" section includes the Linux Server and Digital Ocean 1-Click guides, these two guides are more for small-scale deployments than full production clusters. This change improves the early-stage docs experience for new Teleport users by: Splitting the "Deploy a Cluster" section ---------------------------------------- The "Deploy a Cluster" section includes subsections related to choosing a Teleport edition as well as subsections related to deploying a production cluster. The problem with this approach is that it leaves no room for adding introductory guides to help users with these two purposes. By splitting the "Deploy a Cluster" section into two top-level sections, one related to choosing an edition and the other to dpeloying to production, we can add introductory pages that put the subsections of these sections in context. _This change accompanies the work on #16751 to write a general guide to HA Teleport deployments, since the new guide will have a prominent place in the reorganized "Deploy a Cluster" section._ Adding introductory pages ------------------------- Sections related to getting started with Teleport, "Try out Teleport" and "Deploy a Cluster", were missing introductory pages. This change adds them, and also adds one to the new "Choose an Edition" section. Moving the Linux Server and Digital Ocean guides ------------------------------------------------ Move these to "Try out Teleport". The Digital Ocean guide didn't fit with the rest of the deployment guides, since it's not about architecting an HA deployment. This is also a better home for the "Linux Server" guide, so this change moves that as well. Removing the "getting-started.mdx" page --------------------------------------- This page is not reachable via the navigation menu. * Respond to PR feedback * Respond to PR feedback Also minor text tweaks
2022-12-22 13:34:06 +00:00
},
{
"source": "/deploy-a-cluster/teleport-cloud/architecture/",
"destination": "/choose-an-edition/teleport-cloud/architecture/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-cloud/downloads/",
"destination": "/choose-an-edition/teleport-cloud/downloads/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-cloud/faq/",
"destination": "/choose-an-edition/teleport-cloud/faq/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-cloud/getting-started/",
"destination": "/choose-an-edition/teleport-cloud/getting-started/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-cloud/introduction/",
"destination": "/choose-an-edition/teleport-cloud/introduction/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-enterprise/gcp-kms/",
"destination": "/choose-an-edition/teleport-enterprise/gcp-kms/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-enterprise/getting-started/",
"destination": "/choose-an-edition/teleport-enterprise/getting-started/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-enterprise/hsm/",
"destination": "/choose-an-edition/teleport-enterprise/hsm/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-enterprise/introduction/",
"destination": "/choose-an-edition/teleport-enterprise/introduction/",
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-enterprise/license/",
"destination": "/choose-an-edition/teleport-enterprise/license/",
"permanent": true
},
{
"source": "/deploy-a-cluster/deployments/digitalocean/",
"destination": "/try-out-teleport/digitalocean/",
"permanent": true
},
{
"source": "/deploy-a-cluster/open-source/",
"destination": "/try-out-teleport/linux-server/",
"permanent": true
},
{
"source": "/getting-started/",
"destination": "/try-out-teleport/introduction/",
"permanent": true
Add redirects to the new Audit Events section (#19553) The changes in #17405 added a section to the docs for guides to exporting audit events, and moved guides from `docs/pages/management/guides`, but failed to add redirects. This change adds the missing redirects.
2023-01-05 22:45:04 +00:00
},
{
"source": "/management/guides/fluentd/",
"destination": "/management/export-audit-events/fluentd/",
"permanent": true
},
{
"source": "/management/guides/elastic-stack/",
"destination": "/management/export-audit-events/elastic-stack/",
"permanent": true
docs: port to 7 (#7361) Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-06-20 03:20:46 +00:00
}
Move redirects to docs config (#5950) Co-authored-by: Alexey Ivanov <mail@alexeyivanov.info>
2021-03-11 17:02:14 +00:00
]
Refactoring of architecture section. (#13651) Our architecture section was written almost 5 years ago and was completely obsolete. I refactored all of it to be up to date, added Kuberentes and other resource type references, replaced and created new diagrams.
2022-06-23 18:39:49 +00:00
}
Reference in a new issue Copy permalink