self-hosted/teleport
self-hosted/teleport
1
0
Fork 0
mirror of https://github.com/gravitational/teleport synced 2024-10-19 16:53:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
teleport/docs/config.json

2989 lines
88 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": [
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
{
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"title": "Get Started with Teleport",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"slug": "/"
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
},
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": "Installation",
"slug": "/installation/"
},
{
"title": "FAQ",
"slug": "/faq/"
},
Add a Usage Reporting and Billing page (#34254) * Add a Usage Reporting and Billing page Closes #34220 Add a docs page to the Home section that describes the way we calculate customer usage data and billing for commercial editions of Teleport. * Respond to twakes feedback - Remove specific edition names - Clarify counts * Update docs/pages/usage-billing.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-11-08 20:08:27 +00:00
{
"title": "Usage Reporting and Billing",
"slug": "/usage-billing/",
"forScopes": ["cloud", "team", "enterprise"]
},
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
{
"title": "Upcoming Releases",
"slug": "/upcoming-releases/"
},
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": "Changelog",
"slug": "/changelog/"
Add Assist OSS docs (#26462) * Add assist OSS docs * Add more details * Add per-session MFA note. * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Address review comments * Add assist role * Address review comments * Address review comments * Add OpenAI to the spellcheck. * Add architecture diagram * Update docs/pages/ai-assist.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/ai-assist.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/ai-assist.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/ai-assist.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/ai-assist.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/ai-assist.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/ai-assist.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/ai-assist.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Added the architecture diagram to the docs * Added OSS scope * Correct scope info * Make linter happy * Fix another linter issue --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com> Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2023-05-19 19:55:55 +00:00
},
{
"title": "Teleport Assist",
"slug": "/ai-assist/",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"forScopes": ["oss", "team"]
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
{
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
},
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
{
"title": "Teleport Team",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/choose-an-edition/teleport-team/",
"forScopes": ["team"]
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
{
Improve the Teleport Cloud Getting Started guide (#20837) * Improve the Teleport Cloud Getting Started guide While following the Teleport Enterprise Cloud Getting Started guide to test v12, I made the following changes to the guide: - Change the title of the guide--and language throughout our Cloud docs--to use "Teleport Enterprise Cloud" instead of "Teleport Cloud". This reflects the usage in our Core Concepts page. - Add a brief architectural explanation to the guide in case users arrive here from a search engine. - Restructure the guide to include a step to start a local Docker container. This way, we can (a) ensure that all steps are consistent for all users; and (b) let the user get started quickly without "real" infra. - Include instructions to paste a script generated via Teleport Discover into the container shell. - Update screenshots. * Respond to alexfornuto feedback * Minor wording change Responding to PR feedback
2023-02-03 23:22:29 +00:00
"title": "Teleport Enterprise 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/",
Add Teleport Team docs (#26523) * Add documentation for Teleport Team - Remove the Teleport Enterprise Cloud Getting Started guide, since this assumes that you have signed up for an Enterprise Cloud trial. Instead, users will sign up for a Team trial to add their first resource and follow a new guide to using Teleport Team. - Move references to Teleport Team first in lists of Teleport editions, since this is the intended first step for self-service users. * Update the Teleport Team guide - Update screenshots - Move Docker instructions to a Details box and make Docker optional, with the idea that Linux and macOS users could join their workstations to their Teleport cluster. * Require a Docker container again In this test environment, there was no support for ARM on macOS. Requiring a container ensures consistency between environments. * Add a diagram * Fix links * Linter fixes * Respond to alexfornuto feedback
2023-05-19 20:15:40 +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": "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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["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": "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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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
"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": "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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise"]
Add docs for GCP KMS support (#18465)
2022-11-17 17:17:14 +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": "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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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
}
]
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",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/deploy-a-cluster/introduction/",
"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
},
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["oss", "enterprise"]
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
},
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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
"entries": [
{
"title": "Deploy Teleport on Kubernetes",
"slug": "/deploy-a-cluster/helm-deployments/kubernetes-cluster/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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": "Google Cloud GKE Cluster",
"slug": "/deploy-a-cluster/helm-deployments/gcp/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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
},
Azure HA Teleport deployment guide (#29962) * Link to azure guide * ToC * initial version of the azure helm guide * Use <Var> in section 3 and later Co-authored-by: Gus Luxton <gus@goteleport.com> * Use TabItem, tweak values.yaml and dns * hint for non-Azure DNS users * it's ClusterIssuer, not GlobalIssuer Co-authored-by: Gus Luxton <gus@goteleport.com> * Recommend --version Co-authored-by: Gus Luxton <gus@goteleport.com> * Update docs/pages/deploy-a-cluster/helm-deployments/azure.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * spelling fixes --------- Co-authored-by: Gus Luxton <gus@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-09-06 14:27:34 +00:00
{
"title": "Azure AKS Cluster",
"slug": "/deploy-a-cluster/helm-deployments/azure/",
"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": "DigitalOcean Kubernetes Cluster",
"slug": "/deploy-a-cluster/helm-deployments/digitalocean/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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": "Customize Deployment Config",
"slug": "/deploy-a-cluster/helm-deployments/custom/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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
},
{
helm: disable PSPs on 1.23 and document PSA usage (#21258) * helm: disbale PSPs on 1.23 and document PSA usage In 1.25 Kubernetes removes PSP support, this has 2 consequences: - Helm will break after upgrading if PSPs are deployed - We cannot set security policies anymore This commit documents those two behaviours and makes the chart disable PSPs on 1.23 and higher to ensure a smooth upgrade path. * helm: Remove stale 'migrate from legacy charts' guide
2023-02-06 15:39:01 +00:00
"title": "Migrating from v11 to v12",
"slug": "/deploy-a-cluster/helm-deployments/migration-v12/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["oss", "enterprise"]
docs: Document `teleport-cluster` v12 Helm chart (#19881)
2023-02-02 15:37:08 +00:00
},
{
helm: disable PSPs on 1.23 and document PSA usage (#21258) * helm: disbale PSPs on 1.23 and document PSA usage In 1.25 Kubernetes removes PSP support, this has 2 consequences: - Helm will break after upgrading if PSPs are deployed - We cannot set security policies anymore This commit documents those two behaviours and makes the chart disable PSPs on 1.23 and higher to ensure a smooth upgrade path. * helm: Remove stale 'migrate from legacy charts' guide
2023-02-06 15:39:01 +00:00
"title": "Kubernetes 1.25 and PSP removal",
"slug": "/deploy-a-cluster/helm-deployments/migration-kubernetes-1-25-psp/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
}
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
{
docs: Update HA Terraform reference and add starter cluster reference (#32354) * docs: Update Terraform reference documentation * Fixes to shell script
2023-10-05 16:14:44 +00:00
"title": "AWS HA Terraform",
"slug": "/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform/",
"forScopes": ["oss", "enterprise"]
},
{
"title": "AWS Single-Instance Terraform",
"slug": "/deploy-a-cluster/deployments/aws-starter-cluster-terraform/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
},
AWS Route 53 GSLB Multi-Region Proxy Peering High Availability Deployment Guide (#24164) * Create aws-gslb-proxy-peering-ha-deployment.mdx migrating to branch off main repo * adding chart for new guide * adding image for new guide * Delete aws-gslb-proxy-peering-ha-deployment.png * Addressing reviewer comments I applied changes based on @zmb3's feedback. I also made changes to sections that were borrowed from other guides that conflict with this guide. * Update aws-gslb-proxy-peering-ha-deployment.mdx Changes based on @rosstimothy's recommendations. * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: David Boslee <david@goteleport.com> * updated architecture diagram * Update aws-gslb-proxy-peering-ha-deployment.mdx - corrected agent_connection_count guidance - clarified cross-zone LB guidance - added S3 and Dynamo guidance links - Updated title * addressing review comments * Update aws-gslb-proxy-peering-ha-deployment.mdx * Delete aws-gslb-proxy-peering-ha-deployment.png * Add files via upload * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Gus Luxton <gus@goteleport.com> * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Gus Luxton <gus@goteleport.com> * Apply suggestions from code review Co-authored-by: Gus Luxton <gus@goteleport.com> * Update aws-gslb-proxy-peering-ha-deployment.mdx * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.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 aws-gslb-proxy-peering-ha-deployment.mdx adding clarity to technical complex disadvantage * Update aws-gslb-proxy-peering-ha-deployment.mdx * Update aws-gslb-proxy-peering-ha-deployment.mdx * Update aws-gslb-proxy-peering-ha-deployment.mdx * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update aws-gslb-proxy-peering-ha-deployment.mdx * Update config.json * Update deployments.mdx * Update introduction.mdx * Rename docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx to docs/pages/deploy-a-cluster/deployments/aws-gslb-proxy-peering-ha-deployment.mdx * Minor copy edits and linter fixes --------- Co-authored-by: David Boslee <david@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Gus Luxton <gus@goteleport.com> Co-authored-by: Paul Schisa <75806143+pschisa@users.noreply.github.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-05-22 22:04:52 +00:00
{
"title": "AWS Multi-Region Proxy Deployment",
"slug": "/deploy-a-cluster/deployments/aws-gslb-proxy-peering-ha-deployment/",
docs: Mark AWS GSLB deployment as Enterprise only (#34621) It requires/references proxy peering, so shouldn't be offered to OSS users.
2023-11-15 16:16:57 +00:00
"forScopes": ["enterprise"]
AWS Route 53 GSLB Multi-Region Proxy Peering High Availability Deployment Guide (#24164) * Create aws-gslb-proxy-peering-ha-deployment.mdx migrating to branch off main repo * adding chart for new guide * adding image for new guide * Delete aws-gslb-proxy-peering-ha-deployment.png * Addressing reviewer comments I applied changes based on @zmb3's feedback. I also made changes to sections that were borrowed from other guides that conflict with this guide. * Update aws-gslb-proxy-peering-ha-deployment.mdx Changes based on @rosstimothy's recommendations. * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: David Boslee <david@goteleport.com> * updated architecture diagram * Update aws-gslb-proxy-peering-ha-deployment.mdx - corrected agent_connection_count guidance - clarified cross-zone LB guidance - added S3 and Dynamo guidance links - Updated title * addressing review comments * Update aws-gslb-proxy-peering-ha-deployment.mdx * Delete aws-gslb-proxy-peering-ha-deployment.png * Add files via upload * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Gus Luxton <gus@goteleport.com> * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx Co-authored-by: Gus Luxton <gus@goteleport.com> * Apply suggestions from code review Co-authored-by: Gus Luxton <gus@goteleport.com> * Update aws-gslb-proxy-peering-ha-deployment.mdx * Update docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.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 aws-gslb-proxy-peering-ha-deployment.mdx adding clarity to technical complex disadvantage * Update aws-gslb-proxy-peering-ha-deployment.mdx * Update aws-gslb-proxy-peering-ha-deployment.mdx * Update aws-gslb-proxy-peering-ha-deployment.mdx * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update aws-gslb-proxy-peering-ha-deployment.mdx * Update config.json * Update deployments.mdx * Update introduction.mdx * Rename docs/pages/deploy-a-cluster/aws-gslb-proxy-peering-ha-deployment.mdx to docs/pages/deploy-a-cluster/deployments/aws-gslb-proxy-peering-ha-deployment.mdx * Minor copy edits and linter fixes --------- Co-authored-by: David Boslee <david@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Gus Luxton <gus@goteleport.com> Co-authored-by: Paul Schisa <75806143+pschisa@users.noreply.github.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-05-22 22:04:52 +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": "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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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",
Refresh the Access Controls menu (#21649) * Refresh the Access Controls menu Closes #19933 - Changes the "Configure Access" menu item to "Manage Access" - The Access Controls menu page was out of date, so I changed it to reflect the current sequence of subsections. This more narrative approach also puts each subsection in the context of a user's overall Teleport setup. * Respond to PR feedback
2023-03-01 21:56:15 +00:00
"title": "Manage Access",
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": [
{
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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": "Impersonation",
"slug": "/access-controls/guides/impersonation/"
},
{
"title": "Moderated Sessions",
"slug": "/access-controls/guides/moderated-sessions/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
Hardware Key docs (#17258)
2022-10-20 20:01:06 +00:00
},
{
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "Hardware Key Support",
Hardware Key docs (#17258)
2022-10-20 20:01:06 +00:00
"slug": "/access-controls/guides/hardware-key-support/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
Add public docs for device trust (#20954) * Add device trust documentation * Link to Device Trust from Access Control pages * Document `device_trust` authentication section * Document the `tsh device enroll` command * Document `tctl devices` commands * Review: Explain macOS restriction in text * Review: Address Alex's comments Indents, markdown style, code block style, punctuation and missing words. * Review: Use diff blocks on `tctl edit` example * Review: Use diff blocks in other examples * Review: Use standard example names * Review: Address Alex's comments (2) Uppercase SERIAL, macOS enroll notice, config example tabs. * Review: Sort `tctl devices` commands alphabetically * Review: Use config variables for asset_tag and enroll_token * Review: Remove '#' from code blocks in cli.mdx * combine warning and ScopedBlock A ScopedBlock for OSS will never render on a page not scoped for OSS. This way, it's always visible. Once the feature is out of preview, we can just remove the first line. * clarify device trust between trusted clusters This addition dispells any assumptions made by the reader that applying device trust to root clusters would enforece the setting on leaf clusters. * update enterprise tctl version output --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-02 20:43:51 +00:00
},
Headless Authn: documentation (#23272) * Add docs. * Update docs/pages/access-controls/guides/headless-login.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Fix lint error. * Ellaborate on how headless login differs from standard login. * Resolve comments; Fix capitalization. * Resolves comments. * Add cli reference docs. * Restructure guide; Remove scoped blocks; Update descriptions; resolve other comments. * Make configuration options/alternatives collapsible; Fix typos. * Fix file names, titles, and make new config details begin as closed. * Fix hidden merge conflict. * Add line breaks. * Fix dead link. --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-04-03 16:34:38 +00:00
{
docs: Scan topics for (Preview) and remove the label (#31897) * Remove (Preview) from documentation nav and pages * Clean up after removing preview * fix link to heading title * Fix UI reference
2023-09-18 15:42:19 +00:00
"title": "Headless WebAuthn",
Headless Authn: documentation (#23272) * Add docs. * Update docs/pages/access-controls/guides/headless-login.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Fix lint error. * Ellaborate on how headless login differs from standard login. * Resolve comments; Fix capitalization. * Resolves comments. * Add cli reference docs. * Restructure guide; Remove scoped blocks; Update descriptions; resolve other comments. * Make configuration options/alternatives collapsible; Fix typos. * Fix file names, titles, and make new config details begin as closed. * Fix hidden merge conflict. * Add line breaks. * Fix dead link. --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-04-03 16:34:38 +00:00
"slug": "/access-controls/guides/headless/"
},
Add documentation page for IP pinning (#23190)
2023-03-29 20:54:00 +00:00
{
docs: Scan topics for (Preview) and remove the label (#31897) * Remove (Preview) from documentation nav and pages * Clean up after removing preview * fix link to heading title * Fix UI reference
2023-09-18 15:42:19 +00:00
"title": "IP Pinning ",
Add documentation page for IP pinning (#23190)
2023-03-29 20:54:00 +00:00
"slug": "/access-controls/guides/ip-pinning/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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/",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"forScopes": ["oss", "team", "enterprise", "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
{
cleanup SSO sub-tree (#26807)
2023-05-31 21:00:47 +00:00
"title": "Active Directory (ADFS)",
"slug": "/access-controls/sso/adfs/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
},
{
cleanup SSO sub-tree (#26807)
2023-05-31 21:00:47 +00:00
"title": "Azure Active Directory",
"slug": "/access-controls/sso/azuread/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
},
{
cleanup SSO sub-tree (#26807)
2023-05-31 21:00:47 +00:00
"title": "GitHub",
set scopes for GitHub SSO (#32904)
2023-10-03 16:27:52 +00:00
"slug": "/access-controls/sso/github-sso/",
"forScopes": ["oss", "team", "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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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
},
{
cleanup SSO sub-tree (#26807)
2023-05-31 21:00:47 +00:00
"title": "Google Workspace",
"slug": "/access-controls/sso/google-workspace/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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": "OIDC",
"slug": "/access-controls/sso/oidc/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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": "Okta",
"slug": "/access-controls/sso/okta/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
cleanup SSO sub-tree (#26807)
2023-05-31 21:00:47 +00:00
},
{
"title": "OneLogin",
"slug": "/access-controls/sso/one-login/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
}
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
]
},
SAML identity provider docs. (#22414) * SAML identity provider docs. SAML IdP documentation has been added. * formatting * spelling * Zac's and Roman's feedback. * Valid config.json. * Linting updates. * usr Var component Adding as a unique commit in case it's not desired * align output with object name * Roman's feedback, add in a section for disabling the IdP. * copy edits * SAML Grafana guide (#22545) * init Grafana SAML guide * respond to review feedback * Correct entity provider to identity provider. * Note that HSM is not currently supported. * Fix link. --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-03-04 00:29:52 +00:00
{
"title": "Teleport as an IdP",
"slug": "/access-controls/idps/",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"forScopes": ["enterprise", "cloud", "team"],
SAML identity provider docs. (#22414) * SAML identity provider docs. SAML IdP documentation has been added. * formatting * spelling * Zac's and Roman's feedback. * Valid config.json. * Linting updates. * usr Var component Adding as a unique commit in case it's not desired * align output with object name * Roman's feedback, add in a section for disabling the IdP. * copy edits * SAML Grafana guide (#22545) * init Grafana SAML guide * respond to review feedback * Correct entity provider to identity provider. * Note that HSM is not currently supported. * Fix link. --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-03-04 00:29:52 +00:00
"entries": [
{
"title": "SAML Identity Provider Guide",
"slug": "/access-controls/idps/saml-guide/",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"forScopes": ["enterprise", "cloud", "team"]
SAML identity provider docs. (#22414) * SAML identity provider docs. SAML IdP documentation has been added. * formatting * spelling * Zac's and Roman's feedback. * Valid config.json. * Linting updates. * usr Var component Adding as a unique commit in case it's not desired * align output with object name * Roman's feedback, add in a section for disabling the IdP. * copy edits * SAML Grafana guide (#22545) * init Grafana SAML guide * respond to review feedback * Correct entity provider to identity provider. * Note that HSM is not currently supported. * Fix link. --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-03-04 00:29:52 +00:00
},
{
"title": "Authenticate to Grafana with Teleport SAML",
"slug": "/access-controls/idps/saml-grafana/",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"forScopes": ["enterprise", "cloud", "team"]
SAML identity provider docs. (#22414) * SAML identity provider docs. SAML IdP documentation has been added. * formatting * spelling * Zac's and Roman's feedback. * Valid config.json. * Linting updates. * usr Var component Adding as a unique commit in case it's not desired * align output with object name * Roman's feedback, add in a section for disabling the IdP. * copy edits * SAML Grafana guide (#22545) * init Grafana SAML guide * respond to review feedback * Correct entity provider to identity provider. * Note that HSM is not currently supported. * Fix link. --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-03-04 00:29:52 +00:00
},
{
"title": "SAML Identity Provider Reference",
"slug": "/access-controls/idps/saml-reference/",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"forScopes": ["enterprise", "cloud", "team"]
SAML identity provider docs. (#22414) * SAML identity provider docs. SAML IdP documentation has been added. * formatting * spelling * Zac's and Roman's feedback. * Valid config.json. * Linting updates. * usr Var component Adding as a unique commit in case it's not desired * align output with object name * Roman's feedback, add in a section for disabling the IdP. * copy edits * SAML Grafana guide (#22545) * init Grafana SAML guide * respond to review feedback * Correct entity provider to identity provider. * Note that HSM is not currently supported. * Fix link. --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-03-04 00:29:52 +00:00
}
]
},
{
docs: login rule docs (#21195)
2023-02-14 18:26:32 +00:00
"title": "Login Rules",
"slug": "/access-controls/login-rules/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"],
docs: login rule docs (#21195)
2023-02-14 18:26:32 +00:00
"entries": [
{
"title": "Set Up Login Rules",
"slug": "/access-controls/login-rules/guide/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
docs: login rule docs (#21195)
2023-02-14 18:26:32 +00:00
},
{
"title": "Login Rules Reference",
"slug": "/access-controls/login-rules/reference/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
docs: Login Rules Terraform docs (#23855)
2023-04-17 16:20:35 +00:00
},
{
"title": "Terraform",
"slug": "/access-controls/login-rules/terraform/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
docs: Login Rule k8s operator docs (#23888) * docs: Login Rule k8s operator docs * apply Tiago's suggestions * minor edits * add loginrules to cspell.json * address code review comments * explicitly mention enterprise instructions * fix lint * consolidate CRD check into prereq bullet --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-04-25 16:55:29 +00:00
},
{
"title": "Kubernetes Operator",
"slug": "/access-controls/login-rules/kubernetes/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise"]
docs: login rule docs (#21195)
2023-02-14 18:26:32 +00:00
}
SAML identity provider docs. (#22414) * SAML identity provider docs. SAML IdP documentation has been added. * formatting * spelling * Zac's and Roman's feedback. * Valid config.json. * Linting updates. * usr Var component Adding as a unique commit in case it's not desired * align output with object name * Roman's feedback, add in a section for disabling the IdP. * copy edits * SAML Grafana guide (#22545) * init Grafana SAML guide * respond to review feedback * Correct entity provider to identity provider. * Note that HSM is not currently supported. * Fix link. --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-03-04 00:29:52 +00:00
]
},
Move "Device Trust" to a top-level docs item (#28108) * Move "Device Trust" to a top-level item * Split device trust page as intro and guide * Fix links and appease linter
2023-06-22 22:27:31 +00:00
{
"title": "Device Trust",
"slug": "/access-controls/device-trust/",
"forScopes": [
"enterprise",
Update device trust docs (#30821) * add dedicated page for device management and enforcement - remove auto enrollment page - update config.json * update guide page to getting started, update copy to focus on day 1 usage * update base device-trust doc with concepts. - content is borrowed and expanded from existing doc * update copy and links * fix links, run linter write * add reference to hosted Jamf plugin * resolve review comments: - multiple grammar update - auto enrollment -> auto-enrollment - add signed prereqs in enforcing ddevice trust page * accomodate new preset roles and default auto-enrollment: - udpated getting started guide to use preset require-trusted-device role - minor grammar and code formating * fix typo udpate -> update * remove auto-enrollment default enabled admonition * address review suggestions: - adds resolved comments * add clusterDefaults variable for generic code reference * add troubleshooting to guide and enforcment page * reference tctl edit role/access and add tsh relogin * fix typo * mention required role for auto-enrollment and minimum requirements * add in command * fix typo
2023-08-31 20:09:21 +00:00
"cloud",
"team"
Move "Device Trust" to a top-level docs item (#28108) * Move "Device Trust" to a top-level item * Split device trust page as intro and guide * Fix links and appease linter
2023-06-22 22:27:31 +00:00
],
"entries": [
{
Update device trust docs (#30821) * add dedicated page for device management and enforcement - remove auto enrollment page - update config.json * update guide page to getting started, update copy to focus on day 1 usage * update base device-trust doc with concepts. - content is borrowed and expanded from existing doc * update copy and links * fix links, run linter write * add reference to hosted Jamf plugin * resolve review comments: - multiple grammar update - auto enrollment -> auto-enrollment - add signed prereqs in enforcing ddevice trust page * accomodate new preset roles and default auto-enrollment: - udpated getting started guide to use preset require-trusted-device role - minor grammar and code formating * fix typo udpate -> update * remove auto-enrollment default enabled admonition * address review suggestions: - adds resolved comments * add clusterDefaults variable for generic code reference * add troubleshooting to guide and enforcment page * reference tctl edit role/access and add tsh relogin * fix typo * mention required role for auto-enrollment and minimum requirements * add in command * fix typo
2023-08-31 20:09:21 +00:00
"title": "Getting Started",
update device trust guide (#28365) This update adds scope to the page, uses the standard partial to add a new group to a user, and uses the Var component to describe registering a device.
2023-06-28 15:45:22 +00:00
"slug": "/access-controls/device-trust/guide/",
"forScopes": [
"enterprise",
Update device trust docs (#30821) * add dedicated page for device management and enforcement - remove auto enrollment page - update config.json * update guide page to getting started, update copy to focus on day 1 usage * update base device-trust doc with concepts. - content is borrowed and expanded from existing doc * update copy and links * fix links, run linter write * add reference to hosted Jamf plugin * resolve review comments: - multiple grammar update - auto enrollment -> auto-enrollment - add signed prereqs in enforcing ddevice trust page * accomodate new preset roles and default auto-enrollment: - udpated getting started guide to use preset require-trusted-device role - minor grammar and code formating * fix typo udpate -> update * remove auto-enrollment default enabled admonition * address review suggestions: - adds resolved comments * add clusterDefaults variable for generic code reference * add troubleshooting to guide and enforcment page * reference tctl edit role/access and add tsh relogin * fix typo * mention required role for auto-enrollment and minimum requirements * add in command * fix typo
2023-08-31 20:09:21 +00:00
"cloud",
"team"
update device trust guide (#28365) This update adds scope to the page, uses the standard partial to add a new group to a user, and uses the Var component to describe registering a device.
2023-06-28 15:45:22 +00:00
]
Document Jamf service and auto-enroll (#28167) * Use teleport.example.com as the example proxy * Add the core Jamf guide steps * Add sync schedule optional section * Add the multiple sources optional section * Add the auto-enrollment guide * Add the Jamf service reference config * Add words to cspell.json and sort it * Use `--config` instead of `-c` * Apply Alex's suggestions * Add preview admonition to auto-enrollment.mdx * Add scopes for auto-enrollment guide * Add scopes for jamf-integration guide * Remove "and restart" from Auth update instructions * Auth restart instructions * s/Jamf service/The Teleport Jamf service/ * Use an inline code block for external links * s/the following/the following keys/ * Use inline code block for key names * Use inline code block for key names * Use inline code block for key names * Use inline code block for key names * Mention "local workstation" after we transition from Jamf to Teleport * Mention Jamf service host when switching context * Use `(=presets.tokens.second=)` * Use `(=presets.ca_pin=)` * Mention logs example explicitly * Add a missing comma Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Address Alex's comments * Reflow text * Remove redudant tsh prereqs sentence * Add a registered device to auto-enrollment prereqs * Use headers instead of bold * Use a narrower image for jamf-setup-2.png --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-06-27 19:54:19 +00:00
},
{
Update device trust docs (#30821) * add dedicated page for device management and enforcement - remove auto enrollment page - update config.json * update guide page to getting started, update copy to focus on day 1 usage * update base device-trust doc with concepts. - content is borrowed and expanded from existing doc * update copy and links * fix links, run linter write * add reference to hosted Jamf plugin * resolve review comments: - multiple grammar update - auto enrollment -> auto-enrollment - add signed prereqs in enforcing ddevice trust page * accomodate new preset roles and default auto-enrollment: - udpated getting started guide to use preset require-trusted-device role - minor grammar and code formating * fix typo udpate -> update * remove auto-enrollment default enabled admonition * address review suggestions: - adds resolved comments * add clusterDefaults variable for generic code reference * add troubleshooting to guide and enforcment page * reference tctl edit role/access and add tsh relogin * fix typo * mention required role for auto-enrollment and minimum requirements * add in command * fix typo
2023-08-31 20:09:21 +00:00
"title": "Manage Trusted Devices",
"slug": "/access-controls/device-trust/device-management/",
Document Jamf service and auto-enroll (#28167) * Use teleport.example.com as the example proxy * Add the core Jamf guide steps * Add sync schedule optional section * Add the multiple sources optional section * Add the auto-enrollment guide * Add the Jamf service reference config * Add words to cspell.json and sort it * Use `--config` instead of `-c` * Apply Alex's suggestions * Add preview admonition to auto-enrollment.mdx * Add scopes for auto-enrollment guide * Add scopes for jamf-integration guide * Remove "and restart" from Auth update instructions * Auth restart instructions * s/Jamf service/The Teleport Jamf service/ * Use an inline code block for external links * s/the following/the following keys/ * Use inline code block for key names * Use inline code block for key names * Use inline code block for key names * Use inline code block for key names * Mention "local workstation" after we transition from Jamf to Teleport * Mention Jamf service host when switching context * Use `(=presets.tokens.second=)` * Use `(=presets.ca_pin=)` * Mention logs example explicitly * Add a missing comma Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Address Alex's comments * Reflow text * Remove redudant tsh prereqs sentence * Add a registered device to auto-enrollment prereqs * Use headers instead of bold * Use a narrower image for jamf-setup-2.png --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-06-27 19:54:19 +00:00
"forScopes": [
"enterprise",
Update device trust docs (#30821) * add dedicated page for device management and enforcement - remove auto enrollment page - update config.json * update guide page to getting started, update copy to focus on day 1 usage * update base device-trust doc with concepts. - content is borrowed and expanded from existing doc * update copy and links * fix links, run linter write * add reference to hosted Jamf plugin * resolve review comments: - multiple grammar update - auto enrollment -> auto-enrollment - add signed prereqs in enforcing ddevice trust page * accomodate new preset roles and default auto-enrollment: - udpated getting started guide to use preset require-trusted-device role - minor grammar and code formating * fix typo udpate -> update * remove auto-enrollment default enabled admonition * address review suggestions: - adds resolved comments * add clusterDefaults variable for generic code reference * add troubleshooting to guide and enforcment page * reference tctl edit role/access and add tsh relogin * fix typo * mention required role for auto-enrollment and minimum requirements * add in command * fix typo
2023-08-31 20:09:21 +00:00
"cloud",
"team"
]
},
{
"title": "Enforce Device Trust",
"slug": "/access-controls/device-trust/enforcing-device-trust/",
"forScopes": [
"enterprise",
"cloud",
"team"
Document Jamf service and auto-enroll (#28167) * Use teleport.example.com as the example proxy * Add the core Jamf guide steps * Add sync schedule optional section * Add the multiple sources optional section * Add the auto-enrollment guide * Add the Jamf service reference config * Add words to cspell.json and sort it * Use `--config` instead of `-c` * Apply Alex's suggestions * Add preview admonition to auto-enrollment.mdx * Add scopes for auto-enrollment guide * Add scopes for jamf-integration guide * Remove "and restart" from Auth update instructions * Auth restart instructions * s/Jamf service/The Teleport Jamf service/ * Use an inline code block for external links * s/the following/the following keys/ * Use inline code block for key names * Use inline code block for key names * Use inline code block for key names * Use inline code block for key names * Mention "local workstation" after we transition from Jamf to Teleport * Mention Jamf service host when switching context * Use `(=presets.tokens.second=)` * Use `(=presets.ca_pin=)` * Mention logs example explicitly * Add a missing comma Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Address Alex's comments * Reflow text * Remove redudant tsh prereqs sentence * Add a registered device to auto-enrollment prereqs * Use headers instead of bold * Use a narrower image for jamf-setup-2.png --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-06-27 19:54:19 +00:00
]
},
{
Docs: Jamf Pro (#29482) * s/Jamf/Jamf Pro * full sync recommendation
2023-07-24 18:14:36 +00:00
"title": "Jamf Pro Integration",
Document Jamf service and auto-enroll (#28167) * Use teleport.example.com as the example proxy * Add the core Jamf guide steps * Add sync schedule optional section * Add the multiple sources optional section * Add the auto-enrollment guide * Add the Jamf service reference config * Add words to cspell.json and sort it * Use `--config` instead of `-c` * Apply Alex's suggestions * Add preview admonition to auto-enrollment.mdx * Add scopes for auto-enrollment guide * Add scopes for jamf-integration guide * Remove "and restart" from Auth update instructions * Auth restart instructions * s/Jamf service/The Teleport Jamf service/ * Use an inline code block for external links * s/the following/the following keys/ * Use inline code block for key names * Use inline code block for key names * Use inline code block for key names * Use inline code block for key names * Mention "local workstation" after we transition from Jamf to Teleport * Mention Jamf service host when switching context * Use `(=presets.tokens.second=)` * Use `(=presets.ca_pin=)` * Mention logs example explicitly * Add a missing comma Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Address Alex's comments * Reflow text * Remove redudant tsh prereqs sentence * Add a registered device to auto-enrollment prereqs * Use headers instead of bold * Use a narrower image for jamf-setup-2.png --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-06-27 19:54:19 +00:00
"slug": "/access-controls/device-trust/jamf-integration/",
"forScopes": [
"enterprise",
"cloud"
]
Move "Device Trust" to a top-level docs item (#28108) * Move "Device Trust" to a top-level item * Split device trust page as intro and guide * Fix links and appease linter
2023-06-22 22:27:31 +00:00
}
]
},
Add Access List documentation. (#31781) * Add Access List documentation. Access List documentation has been added, providing a reference for Access Lists for Teleport v14. * Reword things, clarify unclear things, remove copy paste error. * Migrate CLI docs. * Show user creation via the GUI. * Make the dumper app the concrete example in the access list guide. * Remove references to running resources in prerequisites. * Update docs/pages/access-controls/access-lists/reference.mdx Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Add in admonition about audit reviews not being in Teleport yet. * Remove language surrounding missed audit reviews leading to expired access. * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Make the requirements fields more clear. * Correct typo. --------- Co-authored-by: Roman Tkachenko <roman@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-09-15 16:53:57 +00:00
{
"title": "Access Lists",
"slug": "/access-controls/access-lists/",
"forScopes": ["enterprise", "cloud"],
"entries": [
{
"title": "Getting Started with Access Lists",
"slug": "/access-controls/access-lists/guide/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Reference",
"slug": "/access-controls/access-lists/reference/",
"forScopes": ["enterprise", "cloud"]
}
]
},
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
"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",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/access-controls/access-requests/role-requests/",
"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": "Resource Requests",
"slug": "/access-controls/access-requests/resource-requests/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
docs: include a separate page for OSS access requests (#22613) OSS Teleport supports access requests in a very limited fashion. Make this clear by adding a separate page that covers the supported OSS features. Closes #4818 Closes #13175 Closes #14889 Closes #15979 Closes #22587
2023-03-11 00:05:29 +00:00
},
Add an Access Request configuration guide (#33414) * Add an Access Request configuration guide Fixes #22496 Fixes #13927 Fixes #6557 Fixes #31095 Fixes #29980 Fixes #17630 The current approach to documenting Access Requests is to include how-to guides for various scenarios. The downside of this approach is that we don't have a great place to put general conceptual discussions of Access Request configuration fields. This leads to confusion among users regarding the way Teleport handles certain Access Request configuration options. This change adds a conceptual guide that explains all of the fields in a Teleport role that are relevant to configuring Access Requests. This change also moves conceptual discussions from other guides into the new guide. To limit the scope of this change, it is not intended to overhaul the existing guides. If a discussion of a particular configuration field was buried in another guide, this change moves it into the new guide: - `preview_as_roles` discussion in the Role Requests guide - TTL information in the Role Requests guide - The reference role in the Role Requests page * Respond to zmb3 feedback - Use clearer wording when describing key concepts. - Include more detail about the `max_duration` field. - Use consistent version numbers in example roles. * Fix linter issues
2023-10-20 15:20:00 +00:00
{
"title": "Configure Access Requests",
"slug": "/access-controls/access-requests/access-request-configuration/",
"forScopes": ["enterprise", "cloud"]
},
docs: include a separate page for OSS access requests (#22613) OSS Teleport supports access requests in a very limited fashion. Make this clear by adding a separate page that covers the supported OSS features. Closes #4818 Closes #13175 Closes #14889 Closes #15979 Closes #22587
2023-03-11 00:05:29 +00:00
{
Add an Access Request configuration guide (#33414) * Add an Access Request configuration guide Fixes #22496 Fixes #13927 Fixes #6557 Fixes #31095 Fixes #29980 Fixes #17630 The current approach to documenting Access Requests is to include how-to guides for various scenarios. The downside of this approach is that we don't have a great place to put general conceptual discussions of Access Request configuration fields. This leads to confusion among users regarding the way Teleport handles certain Access Request configuration options. This change adds a conceptual guide that explains all of the fields in a Teleport role that are relevant to configuring Access Requests. This change also moves conceptual discussions from other guides into the new guide. To limit the scope of this change, it is not intended to overhaul the existing guides. If a discussion of a particular configuration field was buried in another guide, this change moves it into the new guide: - `preview_as_roles` discussion in the Role Requests guide - TTL information in the Role Requests guide - The reference role in the Role Requests page * Respond to zmb3 feedback - Use clearer wording when describing key concepts. - Include more detail about the `max_duration` field. - Use consistent version numbers in example roles. * Fix linter issues
2023-10-20 15:20:00 +00:00
"title": "Access Requests in Teleport Community Edition",
docs: include a separate page for OSS access requests (#22613) OSS Teleport supports access requests in a very limited fashion. Make this clear by adding a separate page that covers the supported OSS features. Closes #4818 Closes #13175 Closes #14889 Closes #15979 Closes #22587
2023-03-11 00:05:29 +00:00
"slug": "/access-controls/access-requests/oss-role-requests/",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"forScopes": ["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
}
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
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
},
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
Add initial rough opsgenie docs (#29309) * Add initial rough opsgenie docs * Add image for api key creation to opsgenie docs * Add remaining images * Add missing image to opsgenie docs * Fix minor erros and remove unnecessary sections from opsgenie docs * Add opsgenie docs to doc side menu * Add more images and clarity to opsgenie docs * Clarify alert behaviour in opsgenie docs * Add example role to opsgenie docs * Fix minor grammer and formatting mistakes * Rename opsgenie docs page * Add instructions to docs for creating a user via the ui * Add explanation of annotation * Remove unnecessary image form opsgneie docs and fix formating * Add image for creating role in opsgenie docs * Add back example role yaml and remove unused image * Remove extra newline to fix linting
2023-08-16 15:22:44 +00:00
},
{
"title": "Opsgenie",
"slug": "/access-controls/access-request-plugins/opsgenie/",
Update opsgenie docs (#32730) * Update opsgenie docs * Update config forScope for opsgenie plugin docs
2023-10-10 12:08:19 +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
},
Add initial ServiceNow plugin docs (#31890) * Add initial servicenow docs * Add servicenow to config.json * Clarify servicenow docs permissions * Resize screenshot of integration page * Remove ending admonition * Change requester role to demo-requester * Remove request role screenshot * Crop add user screenshot * Update docs/pages/access-controls/access-request-plugins/servicenow.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/access-controls/access-request-plugins/servicenow.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Remove instucitons for adding users --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-09-20 20:04:53 +00:00
{
"title": "ServiceNow",
"slug": "/access-controls/access-request-plugins/servicenow/",
Remove cloud only warning in servicenow docs (#32844) * Remove cloud only warning in servicenow docs * Update forScopes for servicenow plugin doc
2023-10-13 08:57:03 +00:00
"forScopes": ["enterprise", "cloud"]
Add initial ServiceNow plugin docs (#31890) * Add initial servicenow docs * Add servicenow to config.json * Clarify servicenow docs permissions * Resize screenshot of integration page * Remove ending admonition * Change requester role to demo-requester * Remove request role screenshot * Crop add user screenshot * Update docs/pages/access-controls/access-request-plugins/servicenow.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/access-controls/access-request-plugins/servicenow.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Remove instucitons for adding users --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-09-20 20:04:53 +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
{
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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": "Email",
"slug": "/access-controls/access-request-plugins/ssh-approval-email/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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
}
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/"
}
]
},
{
"icon": "wrench",
"title": "Manage your Cluster",
"entries": [
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
{
"title": "Introduction",
"slug": "/management/introduction/"
},
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
{
"title": "Using Dynamic Resources",
"slug": "/management/dynamic-resources/",
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"entries": [
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
{
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "Kubernetes Operator",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/management/dynamic-resources/teleport-operator/",
"forScopes": ["oss","enterprise"]
Docs: GCP join method (#27054) * Add GCP join method docs * Update prerequisites * Fix linting * Fix linting * Address comments * Fix Kube join link * Fix punctuation
2023-06-06 17:47:38 +00:00
},
Add docs subsection about joining services (#23869) * Add docs subsection about joining services Closes #21851 Also see #21305 Restructure the "Adding Nodes" guide to make joining Teleport processes via the Proxy Service the default approach. Make it easier for users to put these instructions in the context of our other joining methods by creating a separate docs subsection for our joining guides. This change also updates the previous "Adding Nodes" guide based on testing. This also renames "Node" to "Teleport process" and clarifies the distinction between running a Teleport process and running services on the process. * Respond to zmb3 feedback * Respond to alexfornuto feedback * Improve the "Join Token" guide descriptionA Makes this guide consistent with df3e36e49e19acb5ab1f301d0d3b83f8b5d524d5 * Move the Kubernetes guide * Fix spelling * Linter fixes
2023-04-18 16:42:50 +00:00
{
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"title": "Terraform Provider",
"slug": "/management/dynamic-resources/terraform-provider/"
Create a guide to using Teleport with Spacelift (#28690) * Add a guide to Teleport+Spacelift Closes #25421 * Respond to alexfornuto feedback * Spell fix * Fix linter errors
2023-11-02 15:49:38 +00:00
},
{
"title": "Spacelift",
"slug": "/management/dynamic-resources/spacelift/"
}
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
]
},
Add docs subsection about joining services (#23869) * Add docs subsection about joining services Closes #21851 Also see #21305 Restructure the "Adding Nodes" guide to make joining Teleport processes via the Proxy Service the default approach. Make it easier for users to put these instructions in the context of our other joining methods by creating a separate docs subsection for our joining guides. This change also updates the previous "Adding Nodes" guide based on testing. This also renames "Node" to "Teleport process" and clarifies the distinction between running a Teleport process and running services on the process. * Respond to zmb3 feedback * Respond to alexfornuto feedback * Improve the "Join Token" guide descriptionA Makes this guide consistent with df3e36e49e19acb5ab1f301d0d3b83f8b5d524d5 * Move the Kubernetes guide * Fix spelling * Linter fixes
2023-04-18 16:42:50 +00:00
{
"title": "Admin Guides",
"slug": "/management/admin/",
"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": "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",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/management/admin/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
},
{
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",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/management/admin/self-signed-certs/",
"forScopes": ["oss", "enterprise"]
docs: Add instructions on uninstalling Teleport (#22989) * docs: Add instructions on uninstalling Teleport * Add standalone RPM/DEB instructions and clarification for different OSes * Language * Suggestions from code review * Add more specifics for Teleport Connect * Address PR feedback
2023-03-15 16:51:22 +00:00
},
{
"title": "Uninstall Teleport",
"slug": "/management/admin/uninstall-teleport/"
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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": "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",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/management/operations/backup-restore/"
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["oss", "enterprise"]
Add documentation for proxy peering (#15790)
2022-10-04 16:00:37 +00:00
},
{
docs: proxy peering out of preview (#29027)
2023-07-12 19:48:42 +00:00
"title": "Proxy Peering Migration",
Add documentation for proxy peering (#15790)
2022-10-04 16:00:37 +00:00
"slug": "/management/operations/proxy-peering/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise"]
docs: document the updater (#24628) * docs: document the updater This commit adds the updater documentation covering: - its architecture - how to setup a self-hosted version server for on-prem users - how to enroll an agent into automatic updates - the `cluster_maintenance_config` resource reference The PR currently restricts the automatic update scope to enterprise and cloud. Technically oss users could benefit from it but we don't have an oss package yet. Hopefully this should happen post 13.0 release. * add new page to section index and sort * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.1 * docs feedback pt.2 * fix tabs and edit innards * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.3 * docs feedback pt.4 * Apply suggestions from code review Co-authored-by: Roman Tkachenko <roman@goteleport.com> * docs feedback pt.5 * mark as preview --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 14:18:02 +00:00
},
{
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"title": "Self-Hosted Automatic Updates",
docs: document the updater (#24628) * docs: document the updater This commit adds the updater documentation covering: - its architecture - how to setup a self-hosted version server for on-prem users - how to enroll an agent into automatic updates - the `cluster_maintenance_config` resource reference The PR currently restricts the automatic update scope to enterprise and cloud. Technically oss users could benefit from it but we don't have an oss package yet. Hopefully this should happen post 13.0 release. * add new page to section index and sort * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.1 * docs feedback pt.2 * fix tabs and edit innards * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.3 * docs feedback pt.4 * Apply suggestions from code review Co-authored-by: Roman Tkachenko <roman@goteleport.com> * docs feedback pt.5 * mark as preview --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 14:18:02 +00:00
"slug": "/management/operations/self-hosted-automatic-agent-updates/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise"]
docs: document the updater (#24628) * docs: document the updater This commit adds the updater documentation covering: - its architecture - how to setup a self-hosted version server for on-prem users - how to enroll an agent into automatic updates - the `cluster_maintenance_config` resource reference The PR currently restricts the automatic update scope to enterprise and cloud. Technically oss users could benefit from it but we don't have an oss package yet. Hopefully this should happen post 13.0 release. * add new page to section index and sort * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.1 * docs feedback pt.2 * fix tabs and edit innards * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.3 * docs feedback pt.4 * Apply suggestions from code review Co-authored-by: Roman Tkachenko <roman@goteleport.com> * docs feedback pt.5 * mark as preview --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 14:18:02 +00:00
},
{
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"title": "Enroll Agents in Automatic Updates",
docs: document the updater (#24628) * docs: document the updater This commit adds the updater documentation covering: - its architecture - how to setup a self-hosted version server for on-prem users - how to enroll an agent into automatic updates - the `cluster_maintenance_config` resource reference The PR currently restricts the automatic update scope to enterprise and cloud. Technically oss users could benefit from it but we don't have an oss package yet. Hopefully this should happen post 13.0 release. * add new page to section index and sort * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.1 * docs feedback pt.2 * fix tabs and edit innards * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.3 * docs feedback pt.4 * Apply suggestions from code review Co-authored-by: Roman Tkachenko <roman@goteleport.com> * docs feedback pt.5 * mark as preview --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 14:18:02 +00:00
"slug": "/management/operations/enroll-agent-into-automatic-updates/",
docs: include teams in automatic updates and spell fix (#34331)
2023-11-08 15:30:30 +00:00
"forScopes": ["enterprise", "cloud", "team"]
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 new topic to the left nav (#32431)
2023-09-25 18:07:56 +00:00
"title": "Secure Practices",
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": "/management/security/",
"entries": [
Add new topic to the left nav (#32431)
2023-09-25 18:07:56 +00:00
{
Update based on Mike's comments (#32988)
2023-10-04 19:54:42 +00:00
"title": "Restrict Access for Privileged Accounts",
"slug": "/management/security/restrict-privileges/"
Add new topic to the left nav (#32431)
2023-09-25 18:07:56 +00:00
},
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/"
Add documentation for `proxy_protocol` setting. (#32134) * Add documentation for `proxy_protocol` setting. * Improve wording. Co-authored-by: Tiago Silva <tiago.silva@goteleport.com> * Improve wording. Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Improve wording. Co-authored-by: Tiago Silva <tiago.silva@goteleport.com> * Improve wording. Co-authored-by: Tiago Silva <tiago.silva@goteleport.com> * Imrove wording. * Improve wording. * Add example of a PROXY protocol header. * Don't mention 'unspecified` mode as a possible value for `proxy_protocol` setting * Add security section --------- Co-authored-by: Tiago Silva <tiago.silva@goteleport.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-09-19 23:09:16 +00:00
},
{
"title": "PROXY Protocol",
"slug": "/management/security/proxy-protocol/",
"forScopes": [
"enterprise",
"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
}
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": "EC2 Tags",
"slug": "/management/guides/ec2-tags/"
},
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["oss", "enterprise", "cloud"]
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": "Metrics",
"slug": "/management/diagnostics/metrics/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["oss", "enterprise", "cloud"]
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": "Collecting Profiles",
"slug": "/management/diagnostics/profiles/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["oss", "enterprise", "cloud"]
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": "Distributed Tracing",
"slug": "/management/diagnostics/tracing/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["oss", "enterprise", "cloud"]
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
}
]
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": [
{
Docs: Add Datadog guide. (#21950) * tighten existing audit title in nav * Move plugin install and config to partials This move not only consolidates these instructions to a single source of truth, but also takes the divergent updates from these instructions across multiple docs. * init datadog guide * Update docs/pages/includes/configure-event-handler.mdx Co-authored-by: Michael Wilson <mike@mdwn.dev> * respond to review feedback * add context for Logstash * add context for Splunk * update page titles See https://github.com/gravitational/teleport/pull/21950/files\#r1110311232 for details * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * move link to next steps * Apply suggestions from code review * adjust prereqs * Apply suggestions from code review * Update docs/pages/management/export-audit-events/datadog.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * appease pointless linter rule --------- Co-authored-by: Michael Wilson <mike@mdwn.dev> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-06 18:24:46 +00:00
"title": "Export Audit Events to Fluentd",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/management/export-audit-events/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
},
{
Docs: Add Datadog guide. (#21950) * tighten existing audit title in nav * Move plugin install and config to partials This move not only consolidates these instructions to a single source of truth, but also takes the divergent updates from these instructions across multiple docs. * init datadog guide * Update docs/pages/includes/configure-event-handler.mdx Co-authored-by: Michael Wilson <mike@mdwn.dev> * respond to review feedback * add context for Logstash * add context for Splunk * update page titles See https://github.com/gravitational/teleport/pull/21950/files\#r1110311232 for details * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * move link to next steps * Apply suggestions from code review * adjust prereqs * Apply suggestions from code review * Update docs/pages/management/export-audit-events/datadog.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * appease pointless linter rule --------- Co-authored-by: Michael Wilson <mike@mdwn.dev> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-06 18:24:46 +00:00
"title": "Export Audit Events to Datadog",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/management/export-audit-events/datadog/"
Docs: Add Datadog guide. (#21950) * tighten existing audit title in nav * Move plugin install and config to partials This move not only consolidates these instructions to a single source of truth, but also takes the divergent updates from these instructions across multiple docs. * init datadog guide * Update docs/pages/includes/configure-event-handler.mdx Co-authored-by: Michael Wilson <mike@mdwn.dev> * respond to review feedback * add context for Logstash * add context for Splunk * update page titles See https://github.com/gravitational/teleport/pull/21950/files\#r1110311232 for details * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * move link to next steps * Apply suggestions from code review * adjust prereqs * Apply suggestions from code review * Update docs/pages/management/export-audit-events/datadog.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * appease pointless linter rule --------- Co-authored-by: Michael Wilson <mike@mdwn.dev> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-06 18:24:46 +00:00
},
{
"title": "Export Audit Events to the Elastic Stack",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/management/export-audit-events/elastic-stack/"
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
},
{
Docs: Add Datadog guide. (#21950) * tighten existing audit title in nav * Move plugin install and config to partials This move not only consolidates these instructions to a single source of truth, but also takes the divergent updates from these instructions across multiple docs. * init datadog guide * Update docs/pages/includes/configure-event-handler.mdx Co-authored-by: Michael Wilson <mike@mdwn.dev> * respond to review feedback * add context for Logstash * add context for Splunk * update page titles See https://github.com/gravitational/teleport/pull/21950/files\#r1110311232 for details * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * move link to next steps * Apply suggestions from code review * adjust prereqs * Apply suggestions from code review * Update docs/pages/management/export-audit-events/datadog.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * appease pointless linter rule --------- Co-authored-by: Michael Wilson <mike@mdwn.dev> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-06 18:24:46 +00:00
"title": "Export Audit Events to Splunk",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/management/export-audit-events/splunk/"
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
}
]
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
},
add webui page with active session section (#22428)
2023-03-21 17:40:09 +00:00
{
"title": "Using the Web UI",
"slug": "/connect-your-client/web-ui/"
},
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/"
},
docs: `tsh puttyconfig` (#29458) * docs: Add info on tsh puttyconfig * docs: Add info on tsh puttyconfig * docs: tsh puttyconfig * Updates * Fix lint * Further lint fixes * Apply code review comments
2023-07-31 19:30:05 +00:00
{
docs: Add WinSCP to PuTTY client instructions (#32868) * docs: Add WinSCP to PuTTY client instructions * Restore validity section * Restore validity section * Formatting tweaks * Merge lists * Change title * Fix docs link title to match page * Bump tsh version for WinSCP support * Whitelist WinSCP in spellcheck * putty.mdx -> putty-winscp.mdx
2023-10-06 18:55:58 +00:00
"title": "Using PuTTY and WinSCP",
"slug": "/connect-your-client/putty-winscp/"
docs: `tsh puttyconfig` (#29458) * docs: Add info on tsh puttyconfig * docs: Add info on tsh puttyconfig * docs: tsh puttyconfig * Updates * Fix lint * Further lint fixes * Apply code review comments
2023-07-31 19:30:05 +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": "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
}
]
},
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
{
"title": "Run Teleport Agents",
"icon": "layers",
"entries": [
{
"title": "Introduction",
"slug": "/agents/introduction/"
},
{
"title": "Deploy via Terraform",
"slug": "/agents/deploy-agents-terraform/"
},
{
"title": "Join Services to Your Cluster",
"slug": "/agents/join-services-to-your-cluster/",
"entries": [
{
"title": "Via AWS EC2",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/agents/join-services-to-your-cluster/aws-ec2/",
"forScopes": ["oss", "enterprise"]
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
},
{
"title": "Via AWS IAM",
"slug": "/agents/join-services-to-your-cluster/aws-iam/"
},
{
"title": "Via Azure",
"slug": "/agents/join-services-to-your-cluster/azure/"
},
{
"title": "Joining Services via Kubernetes ServiceAccount",
"slug": "/agents/join-services-to-your-cluster/kubernetes/"
},
{
"title": "Via GCP",
"slug": "/agents/join-services-to-your-cluster/gcp/"
},
{
"title": "Via a Join Token",
"slug": "/agents/join-services-to-your-cluster/join-token/"
}
]
}
]
},
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/"
},
[docs] Add main documentation for Kubernetes Apps Discovery (#31038) * Add main documentation for Kubernetes Apps Discovery * Improve wording. * Add internal link for annotation * Improve wording. Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Remove unneeded symbol Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Improve wording. Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Make example cluster names consistent * Restructure the Kubernetes app discovery guide (#31606) - Move the docs to the Application Access section, since this material has to do with proxying applications via the Application Service. - Split up the guide into separate guides for different documentation purposes: a how-to guide, configuration reference, and architecture guide. - Fix linter/spelling issues * Add not about running agent inside the Kuberentes cluster * Add instruction how to enabled kube app discovery on existing installation * Add example of configuration of teleport-kube-agent Helm chart * convert tip to tabs * fix wrong ref --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Tiago Silva <tiago.silva@goteleport.com>
2023-09-18 18:38:57 +00:00
{
"title": "Enroll Kubernetes Applications",
"slug": "/application-access/enroll-kubernetes-applications/",
"entries":[
{
"title": "Get Started",
"slug": "/application-access/enroll-kubernetes-applications/get-started/"
},
{
"title": "Architecture",
"slug": "/application-access/enroll-kubernetes-applications/architecture/"
},
{
"title": "Reference",
"slug": "/application-access/enroll-kubernetes-applications/reference/"
}
]
},
Update application access docs (#6055) (#6137)
2021-03-28 17:09:58 +00:00
{
Document Google Cloud CLI access (#19905) * Document Google Cloud CLI access Closes #17584 - Add a guide to configuring and using Google Cloud CLI access via the Teleport Application Service. - Since we now have three guides to setting up secure access to cloud APIs, create a new subsection of the "Application Access" docs section related to cloud provider APIs. * Respond to PR feedback - Capitalize "JSON Web Tokens" - Edit the AWS guide's nav bar entry - Fix garbled section in the App Access intro page - Improve the service account name we use in the how-to guide - Clarify the way the App Service uses a service account - Add new env vars to the `tsh proxy` command output - Other small changes in response to suggestions/comments * Edit instructions for starting the VM Add instructions to launch a new VM with a service account attached. This addresses feedback on the PR. * Use more precise terminology for service accounts This addresses feedback on the PR * Add information about `tsh gsutil` This adds to both the Google Cloud API access how-to guide and the CLI reference. * Respond to PR feedback * use nobr tags * fix multiline command --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-03 16:45:53 +00:00
"title": "Securing Cloud Provider APIs",
"slug": "/application-access/cloud-apis/",
"entries": [
{
"title": "Google Cloud CLI Access",
"slug": "/application-access/cloud-apis/google-cloud/"
},
{
"title": "AWS CLI and Console Access",
"slug": "/application-access/cloud-apis/aws-console/"
},
{
"title": "Azure CLI Access",
"slug": "/application-access/cloud-apis/azure/"
}
]
},
{
"title": "Securing Internal Applications",
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
{
Remove 'preview' from tcp app access guides (#26811)
2023-05-23 21:47:43 +00:00
"title": "TCP App Access",
Add docs for TCP apps access (#14978)
2022-08-02 17:26:27 +00:00
"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/"
},
{
"title": "Dynamic Registration",
"slug": "/application-access/guides/dynamic-registration/"
New guide: AWS DynamoDB with Database Access (#19956) * move application-based dynamodb guide * update and move images * init new dynamo guide * Apply suggestions from code review Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * updates based on review * Add NoSQL workbench to gui clients doc * cluster > plane * add redirect for dynamo through app access * gui-client cleanup * Update docs/pages/database-access/guides/aws-dynamodb.mdx Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * Apply suggestions from code review Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * update labs link * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * updates based on review * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * move service nodes into AWS cloud * edits based on review feedback * clarify AWS IAM roles * Adjust explanation of user role * reference generated token * Move dynamic registration to next steps * explain advantage to DynamoDB through App service * merge conflict resolution * clarify database region restrictions --------- Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 18:42:18 +00:00
},
{
[docs] Amazon Athena guide for Application Access (#25329) * [docs] Amazon Athena guide for Application Access * review comments * update cspell.json * Alex's comment and fix lint
2023-05-18 13:02:25 +00:00
"title": "Amazon Athena",
"slug": "/application-access/guides/amazon-athena/"
},
{
"title": "Amazon DynamoDB",
New guide: AWS DynamoDB with Database Access (#19956) * move application-based dynamodb guide * update and move images * init new dynamo guide * Apply suggestions from code review Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * updates based on review * Add NoSQL workbench to gui clients doc * cluster > plane * add redirect for dynamo through app access * gui-client cleanup * Update docs/pages/database-access/guides/aws-dynamodb.mdx Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * Apply suggestions from code review Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * update labs link * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * updates based on review * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * move service nodes into AWS cloud * edits based on review feedback * clarify AWS IAM roles * Adjust explanation of user role * reference generated token * Move dynamic registration to next steps * explain advantage to DynamoDB through App service * merge conflict resolution * clarify database region restrictions --------- Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 18:42:18 +00:00
"slug": "/application-access/guides/dynamodb/"
Updated config to include HA guide (#23139)
2023-03-15 20:41:19 +00:00
},
{
"title": "High Availability",
"slug": "/application-access/guides/ha/"
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 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
{
Document Google Cloud CLI access (#19905) * Document Google Cloud CLI access Closes #17584 - Add a guide to configuring and using Google Cloud CLI access via the Teleport Application Service. - Since we now have three guides to setting up secure access to cloud APIs, create a new subsection of the "Application Access" docs section related to cloud provider APIs. * Respond to PR feedback - Capitalize "JSON Web Tokens" - Edit the AWS guide's nav bar entry - Fix garbled section in the App Access intro page - Improve the service account name we use in the how-to guide - Clarify the way the App Service uses a service account - Add new env vars to the `tsh proxy` command output - Other small changes in response to suggestions/comments * Edit instructions for starting the VM Add instructions to launch a new VM with a service account attached. This addresses feedback on the PR. * Use more precise terminology for service accounts This addresses feedback on the PR * Add information about `tsh gsutil` This adds to both the Google Cloud API access how-to guide and the CLI reference. * Respond to PR feedback * use nobr tags * fix multiline command --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-03 16:45:53 +00:00
"title": "Using Teleport-Signed JWTs",
Add JWT auth guide for ElasticSearch (#12612) (#13137)
2022-06-03 15:25:20 +00:00
"slug": "/application-access/jwt/",
"entries": [
{
"title": "Introduction",
"slug": "/application-access/jwt/introduction/"
},
{
"title": "ElasticSearch",
"slug": "/application-access/jwt/elasticsearch/"
}
]
},
Okta documentation. (#25580) * Okta documentation. Okta documentation has been added for the Okta service. This aims to explain the Okta service and give simple examples. * Typo fixes, comment fixes, naming fixes. * Reorganization of Okta docs, fixing typos, adding in images and tuning wording. * Use an architecture image for now until mermaid support can be reenabled. * Correct spellings. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Correct architecture diagram. * Linting fixes. --------- Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 17:58:02 +00:00
{
docs: Scan topics for (Preview) and remove the label (#31897) * Remove (Preview) from documentation nav and pages * Clean up after removing preview * fix link to heading title * Fix UI reference
2023-09-18 15:42:19 +00:00
"title": "Protect Okta Applications and Groups ",
Okta documentation. (#25580) * Okta documentation. Okta documentation has been added for the Okta service. This aims to explain the Okta service and give simple examples. * Typo fixes, comment fixes, naming fixes. * Reorganization of Okta docs, fixing typos, adding in images and tuning wording. * Use an architecture image for now until mermaid support can be reenabled. * Correct spellings. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Correct architecture diagram. * Linting fixes. --------- Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 17:58:02 +00:00
"slug": "/application-access/okta/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"],
Okta documentation. (#25580) * Okta documentation. Okta documentation has been added for the Okta service. This aims to explain the Okta service and give simple examples. * Typo fixes, comment fixes, naming fixes. * Reorganization of Okta docs, fixing typos, adding in images and tuning wording. * Use an architecture image for now until mermaid support can be reenabled. * Correct spellings. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Correct architecture diagram. * Linting fixes. --------- Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 17:58:02 +00:00
"entries": [
{
Docs: mark Okta application access as preview (#26515) * mark Okta application access as preview * expand warnings, update titles * rm errant newline * assign code syntax to blocks... without wich the Var components will not render
2023-05-18 18:32:06 +00:00
"title": "Okta Service",
Okta service docs only show in enterprise and cloud. (#28061) * Okta service docs only show in enterprise and cloud. The docs describing the Okta service now only display in the enterprise and cloud scopes. Additionally, some of the wording and variable usage was corrected in the Okta guide. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Steven Martin <steven@goteleport.com> --------- Co-authored-by: Steven Martin <steven@goteleport.com>
2023-06-20 15:41:24 +00:00
"slug": "/application-access/okta/guide/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
Okta documentation. (#25580) * Okta documentation. Okta documentation has been added for the Okta service. This aims to explain the Okta service and give simple examples. * Typo fixes, comment fixes, naming fixes. * Reorganization of Okta docs, fixing typos, adding in images and tuning wording. * Use an architecture image for now until mermaid support can be reenabled. * Correct spellings. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Correct architecture diagram. * Linting fixes. --------- Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 17:58:02 +00:00
},
{
"title": "Architecture",
Okta service docs only show in enterprise and cloud. (#28061) * Okta service docs only show in enterprise and cloud. The docs describing the Okta service now only display in the enterprise and cloud scopes. Additionally, some of the wording and variable usage was corrected in the Okta guide. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Steven Martin <steven@goteleport.com> --------- Co-authored-by: Steven Martin <steven@goteleport.com>
2023-06-20 15:41:24 +00:00
"slug": "/application-access/okta/architecture/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
Okta documentation. (#25580) * Okta documentation. Okta documentation has been added for the Okta service. This aims to explain the Okta service and give simple examples. * Typo fixes, comment fixes, naming fixes. * Reorganization of Okta docs, fixing typos, adding in images and tuning wording. * Use an architecture image for now until mermaid support can be reenabled. * Correct spellings. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Correct architecture diagram. * Linting fixes. --------- Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 17:58:02 +00:00
},
{
"title": "Reference",
Okta service docs only show in enterprise and cloud. (#28061) * Okta service docs only show in enterprise and cloud. The docs describing the Okta service now only display in the enterprise and cloud scopes. Additionally, some of the wording and variable usage was corrected in the Okta guide. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Steven Martin <steven@goteleport.com> --------- Co-authored-by: Steven Martin <steven@goteleport.com>
2023-06-20 15:41:24 +00:00
"slug": "/application-access/okta/reference/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"]
Okta documentation. (#25580) * Okta documentation. Okta documentation has been added for the Okta service. This aims to explain the Okta service and give simple examples. * Typo fixes, comment fixes, naming fixes. * Reorganization of Okta docs, fixing typos, adding in images and tuning wording. * Use an architecture image for now until mermaid support can be reenabled. * Correct spellings. * Update docs/pages/application-access/okta/guide.mdx Co-authored-by: Roman Tkachenko <roman@goteleport.com> * Correct architecture diagram. * Linting fixes. --------- Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 17:58:02 +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": "/application-access/controls/"
},
docs: Rough draft of troubleshooting for apps (#31738) * Rough draft of troubleshooting for apps * Add Kubernetes fix and untrusted certificate * Fix typo in untrusted certs topic * Change app service to application configuration to make the linter happy * Add troubleshooting to nav * Add troubleshooting to nav
2023-09-13 17:19:36 +00:00
{
"title": "Troubleshooting Application Access",
"slug": "/application-access/troubleshooting-apps/"
update cloud docs to 13.4.0 (#32486) Signed-off-by: Evan Freed <evan.freed@goteleport.com>
2023-10-03 17:06: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
{
"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/"
},
{
Mention agentless in the OpenSSH guide for better SEO (#28749) * Mention agentless in the OpenSSH guide for better SEO * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-07-10 20:31:36 +00:00
"title": "Agentless OpenSSH Integration",
re-add agentless node manual installation docs (#31647) * re-add agentless node manual installation docs * fix linter issues * Add missing closing paren Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * use tabs in manual install guide * removed more ScopedBlocks I missed * add note about upgrading to v14 * add redirect and notes linking the two guides to one another * addressed feedback * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * fix links --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-09-28 23:00:29 +00:00
"slug": "/server-access/guides/openssh/openssh/"
},
{
"title": "Agentless OpenSSH Integration (Manual Install)",
"slug": "/server-access/guides/openssh/openssh-manual-install/"
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
},
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"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
{
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "EC2 Instance Discovery",
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
},
Add Azure auto-join docs (#22752) This change adds documentation for Azure VM auto-joining.
2023-03-31 22:38:44 +00:00
{
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "Azure Instance Discovery",
Add Azure auto-join docs (#22752) This change adds documentation for Azure VM auto-joining.
2023-03-31 22:38:44 +00:00
"slug": "/server-access/guides/azure-discovery/"
},
Add GCP auto-discovery docs (#29840) * Draft * Add guide for creating service account * Editing * Elaborate in discovery config * Address comments
2023-08-04 16:00:47 +00:00
{
"title": "GCP Instance Discovery",
"slug": "/server-access/guides/gcp-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
]
Server Access RBAC Docs page (#20246) * Server Access RBAC Docs page * verbiage change Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * verbiage change Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * verbiage change Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Addressed comments * Verbiage update Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage update Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage update Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage update Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * wording update Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage update Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * change Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage change Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage change Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage change Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage change Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage change Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage change Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * verbiage change Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Add trusted cluster def * Update docs/pages/server-access/rbac.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/server-access/rbac.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-01 18:58:43 +00:00
},
{
"title": "Access Controls",
"slug": "/server-access/rbac/"
Add server troubleshooting to left nav (#32989)
2023-10-09 22:24:15 +00:00
},
{
"title": "Troubleshooting Server Access",
"slug": "/server-access/troubleshooting-server/"
[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
{
Replace mermaid diagram, add guided instructions, remove includes wit… (#33554) * Replace mermaid diagram, add guided instructions, remove includes with the get context command * Change strings to pass linter * Update diagram text, collapse sign in steps, add Kubernetes where missing. * Remove manual enrollment, add new next steps, modify wording around running commands * Rename Getting Started to Enroll s Kubernetes Cluster * Change link to registering clusters toppic
2023-10-26 18:11:50 +00:00
"title": "Enroll a Kubernetes Cluster",
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
{
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "Kubernetes Discovery",
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
"slug": "/kubernetes-access/discovery/",
Update Kubernetes Access docs (#5865) (#5933)
2021-03-10 19:48:37 +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
{
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
"title": "AWS",
"slug": "/kubernetes-access/discovery/aws/"
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
},
{
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
"title": "Azure",
"slug": "/kubernetes-access/discovery/azure/"
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
},
{
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
"title": "Google Cloud",
"slug": "/kubernetes-access/discovery/google-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
}
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
{
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
"title": "Manual Cluster Registration",
"slug": "/kubernetes-access/register-clusters/",
[docs] EKS & AKS auto-discovery docs (#17628) Closes #17427
2022-11-07 22:48:01 +00:00
"entries": [
{
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
"title": "Register a Cluster with Static kubeconfigs",
"slug": "/kubernetes-access/register-clusters/static-kubeconfig/"
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
},
Add EKS guide to install agents using IAM joining (#22978) * Add EKS guide to install agents using IAM token This PR adds a guide to help users deploy Teleport Kubernetes agents without sharing secrets or rotating them. This step-by-step guide helps users configure IAM roles and force Kubernetes Service Accounts to use them. The kube-agent will present its identity to the auth server and be allowed to join the Teleport cluster. Fixes #22849 * remove long lived tokens references * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * add paul feedback * add paul feedback * Update docs/pages/kubernetes-access/register-clusters/iam-joining.mdx Co-authored-by: Edoardo Spadolini <edoardo.spadolini@goteleport.com> * fix expires * add requirement of multiplexing * Update docs/pages/kubernetes-access/register-clusters/iam-joining.mdx Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com> --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Edoardo Spadolini <edoardo.spadolini@goteleport.com> Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
2023-03-22 16:24:38 +00:00
{
"title": "Register a Cluster with IAM Joining",
"slug": "/kubernetes-access/register-clusters/iam-joining/"
},
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
{
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
"title": "Register Clusters Dynamically",
"slug": "/kubernetes-access/register-clusters/dynamic-registration/"
[docs] EKS & AKS auto-discovery docs (#17628) Closes #17427
2022-11-07 22:48:01 +00:00
}
]
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
},
{
"title": "Configuring Access",
"slug": "/kubernetes-access/manage-access/",
"entries": [
{
"title": "Setting up Role-Based Access Controls",
"slug": "/kubernetes-access/manage-access/rbac/"
},
{
"title": "Federation",
"slug": "/kubernetes-access/manage-access/federation/"
}
]
},
{
"title": "Access Controls Reference",
"slug": "/kubernetes-access/controls/"
Add Kubernetes Access FAQ and Troubleshooting docs (#29632) * Add Kubernetes Access FAQ and Troubleshooting docs This PR adds two new major sections for Kubernetes Access docs: - FAQ - Troubleshooting Signed-off-by: Tiago Silva <tiago.silva@goteleport.com> * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * update version to be v7 * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * add intros * Update docs/pages/kubernetes-access/troubleshooting.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> --------- Signed-off-by: Tiago Silva <tiago.silva@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-08-01 11:22:17 +00:00
},
{
"title": "FAQ",
"slug": "/kubernetes-access/faq/"
},
{
"title": "Troubleshooting",
"slug": "/kubernetes-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
}
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
{
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"title": "AWS Cross-Account",
"slug": "/database-access/guides/aws-cross-account/"
add AWS cross-account db access guide (#25687)
2023-05-17 17:36:31 +00:00
},
[docs] AWS database discovery (#30913) * [docs] AWS database discovery * try to fix spell * remove tctl/terraform from guides * update next steps * fix link * fix discovery token * remove register step * try to fix lint * another review comments round * merge create db configuration tabs * use simple sudo teleport db configure create * fix opensearch next steps * review comments from Isgunn
2023-09-15 18:36:48 +00:00
{
"title": "AWS Discovery",
"slug": "/database-access/guides/aws-discovery/"
},
add AWS cross-account db access guide (#25687)
2023-05-17 17:36:31 +00:00
{
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"title": "AWS DynamoDB",
"slug": "/database-access/guides/aws-dynamodb/"
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
},
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "AWS ElastiCache & MemoryDB",
"slug": "/database-access/guides/redis-aws/"
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
},
Documentation for ElastiCache (#13133)
2022-06-30 16:10:57 +00:00
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "AWS Keyspaces (Apache Cassandra)",
"slug": "/database-access/guides/aws-cassandra-keyspaces/"
Documentation for ElastiCache (#13133)
2022-06-30 16:10:57 +00:00
},
Documentation for AWS DynamoDB guide (#14319)
2022-08-10 16:34:01 +00:00
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "AWS RDS & Aurora",
"slug": "/database-access/guides/rds/"
Documentation for AWS DynamoDB guide (#14319)
2022-08-10 16:34:01 +00:00
},
Docs: AWS RDS Proxy Guide (#21322) * init RDS proxy guide * update diagram * update doc * add missing png * copy edits... Minor phrasing adjustment, replaced scoped blocks for cloud with Vars, fixed code fencing for commands and json * RDS Proxies -> RDS Proxy instances * database agent -> Database Service instance --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-07 14:32:26 +00:00
{
Split RDS Proxy guides per protocol (#32903) * docs(database-access): split rds proxy page per protocol * docs(database-access): fix lint
2023-10-09 12:33:35 +00:00
"title": "AWS RDS Proxy for MariaDB/MySQL",
"slug": "/database-access/guides/rds-proxy-mysql/"
},
{
"title": "AWS RDS Proxy for PostgreSQL",
"slug": "/database-access/guides/rds-proxy-postgres/"
},
{
"title": "AWS RDS Proxy for SQL Server",
"slug": "/database-access/guides/rds-proxy-sqlserver/"
Docs: AWS RDS Proxy Guide (#21322) * init RDS proxy guide * update diagram * update doc * add missing png * copy edits... Minor phrasing adjustment, replaced scoped blocks for cloud with Vars, fixed code fencing for commands and json * RDS Proxies -> RDS Proxy instances * database agent -> Database Service instance --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-07 14:32:26 +00:00
},
Add Cassandra and ScyllaDB docs (#17833)
2022-11-08 09:43:02 +00:00
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "AWS Redshift",
"slug": "/database-access/guides/postgres-redshift/"
Add Cassandra and ScyllaDB docs (#17833)
2022-11-08 09:43:02 +00:00
},
[Docs] Redshift Serverless Guide (#20168) * init Redshift Serverless guide * Apply suggestions from code review Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com> * Update docs/pages/database-access/guides/redshift-serverless.mdx * update for review feedback * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * update based on review feedback * clarify ambiguous pronoun * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 16:43:56 +00:00
{
"title": "AWS Redshift Serverless",
"slug": "/database-access/guides/redshift-serverless/"
},
docs: AWS OpenSearch (#26008)
2023-05-11 08:03:44 +00:00
{
"title": "AWS OpenSearch",
"slug": "/database-access/guides/aws-opensearch/"
},
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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Azure Cache for Redis",
"slug": "/database-access/guides/azure-redis/"
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
},
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Azure PostgreSQL & MySQL",
"slug": "/database-access/guides/azure-postgres-mysql/"
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 preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "Azure SQL Server",
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"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
},
Documentation for Azure Cache for Redis (Database Access) (#17387)
2022-10-27 20:32:25 +00:00
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Dynamic Registration",
"slug": "/database-access/guides/dynamic-registration/"
Documentation for Azure Cache for Redis (Database Access) (#17387)
2022-10-27 20:32:25 +00:00
},
Azure AD user managed identity authentication for SQL server documentation (#17693)
2022-11-01 23:39:43 +00:00
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "GCP Cloud SQL MySQL",
"slug": "/database-access/guides/mysql-cloudsql/"
Azure AD user managed identity authentication for SQL server documentation (#17693)
2022-11-01 23:39:43 +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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "GCP Cloud SQL PostgreSQL",
"slug": "/database-access/guides/postgres-cloudsql/"
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] 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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "High Availability",
"slug": "/database-access/guides/ha/"
[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
},
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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "MongoDB Atlas",
"slug": "/database-access/guides/mongodb-atlas/"
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 preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "SQL Server",
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"slug": "/database-access/guides/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
},
SQL Server access with PKINIT documentation page (#23202) * feat(docs): add sqlserver pkinit guide page * docs(database-access): update with codereview suggestions * docs(database-access): update CRL path * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * refactor(docs): apply code review requested changes * refactor(docs): remove kinit install from admonition * feat(docs): comment mermaid diagrams * docs(database-access): fix lint * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * docs(database-access): move kinit installation instructions * docs(database-access): fix spellchek errors * docs(database-access): change database access usage --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-04-19 19:34:29 +00:00
{
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "SQL Server with PKINIT",
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"slug": "/database-access/guides/sql-server-ad-pkinit/"
SQL Server access with PKINIT documentation page (#23202) * feat(docs): add sqlserver pkinit guide page * docs(database-access): update with codereview suggestions * docs(database-access): update CRL path * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * refactor(docs): apply code review requested changes * refactor(docs): remove kinit install from admonition * feat(docs): comment mermaid diagrams * docs(database-access): fix lint * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * docs(database-access): move kinit installation instructions * docs(database-access): fix spellchek errors * docs(database-access): change database access usage --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-04-19 19:34:29 +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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +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
},
[docs] Self-hosted ClickHouse Database Access (#28460)
2023-09-12 22:32:38 +00:00
{
"title": "Self-Hosted ClickHouse",
"slug": "/database-access/guides/clickhouse-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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Self-Hosted CockroachDB",
"slug": "/database-access/guides/cockroachdb-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
},
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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Self-Hosted Elasticsearch",
"slug": "/database-access/guides/elastic/"
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
},
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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Self-Hosted MongoDB",
"slug": "/database-access/guides/mongodb-self-hosted/"
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
},
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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Self-Hosted MySQL/MariaDB",
"slug": "/database-access/guides/mysql-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
},
Add Snowflake integration docs (#12816) Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-06-30 02:53:19 +00:00
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Self-Hosted PostgreSQL",
"slug": "/database-access/guides/postgres-self-hosted/"
Add Snowflake integration docs (#12816) Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-06-30 02:53:19 +00:00
},
Add Cassandra and ScyllaDB docs (#17833)
2022-11-08 09:43:02 +00:00
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Self-Hosted Redis",
"slug": "/database-access/guides/redis/"
Add Cassandra and ScyllaDB docs (#17833)
2022-11-08 09:43:02 +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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +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
},
docs: Oracle Database Access (#23925)
2023-04-05 14:55:24 +00:00
{
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "Self-Hosted Oracle",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"forScopes": ["enterprise", "cloud"],
docs: Oracle Database Access (#23925)
2023-04-05 14:55:24 +00:00
"slug": "/database-access/guides/oracle-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
{
Remove preview from several features (#28924) * Remove preview from several features * Fix * Update oracle-self-hosted.mdx
2023-07-11 00:32:27 +00:00
"title": "Snowflake",
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"slug": "/database-access/guides/snowflake/"
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
]
},
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",
Add docs for database auto user provisioning (#26987) * Add docs for database auto user provisioning * Address feedback * Fix * More lint fixes * Fix * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-06-02 17:20:25 +00:00
"slug": "/database-access/rbac/",
"entries": [
{
"title": "RBAC",
"slug": "/database-access/rbac/configuring-access/"
[docs] Automatic user provisioning for MySQL (#33084) * [docs] Automatic user provisioning for MySQL/MariaDB * remove mariadb * address comments * add Admonition for database username * fix lint (links)
2023-10-20 13:37:29 +00:00
}
]
},
{
"title": "Automatic User Provisioning",
"slug": "/database-access/auto-user-provisioning/",
"entries": [
[docs] Database Automatic User Provisioning for MariaDB and Redshift (#33888) * [docs] Database Automatic User Provisioning for MariaDB and Redshift * fix spelling
2023-10-25 16:46:58 +00:00
{
"title": "AWS Redshift",
"slug": "/database-access/auto-user-provisioning/aws-redshift/"
},
{
"title": "MariaDB",
"slug": "/database-access/auto-user-provisioning/mariadb/"
},
[docs] Automatic user provisioning for MySQL (#33084) * [docs] Automatic user provisioning for MySQL/MariaDB * remove mariadb * address comments * add Admonition for database username * fix lint (links)
2023-10-20 13:37:29 +00:00
{
"title": "MySQL",
"slug": "/database-access/auto-user-provisioning/mysql/"
Add docs for database auto user provisioning (#26987) * Add docs for database auto user provisioning * Address feedback * Fix * More lint fixes * Fix * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-06-02 17:20:25 +00:00
},
{
[docs] Automatic user provisioning for MySQL (#33084) * [docs] Automatic user provisioning for MySQL/MariaDB * remove mariadb * address comments * add Admonition for database username * fix lint (links)
2023-10-20 13:37:29 +00:00
"title": "PostgreSQL",
"slug": "/database-access/auto-user-provisioning/postgres/"
Add docs for database auto user provisioning (#26987) * Add docs for database auto user provisioning * Address feedback * Fix * More lint fixes * Fix * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-06-02 17:20:25 +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": "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/"
[doc] database labels reference (#28825) * [doc] database labels reference * Alex's comments
2023-07-13 17:06:58 +00:00
},
{
"title": "Database Labels",
"slug": "/database-access/reference/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
}
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/"
},
{
docs: Desktop access: Move local Windows users content changes to a new version of the gett… (#31678) * Move local Windows users content changes to a new version of the getting-started.mdx * Update from review comments, remove diagram * Remove joined to domain from the descriptions and modify next steps * Add suffix to link
2023-09-18 19:15:01 +00:00
"title": "Configure local Windows users",
docs: update local windows getting started to include all scopes (#33789)
2023-10-23 14:41:43 +00:00
"slug": "/desktop-access/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
},
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
{
Desktop Access without Active Directory (#19311) * rename manual to active directory manual * rename getting started to active directory * update titles and descriptions * first draft of non-AD getting started Note: I have images but did not yet include them in the commit history. No need to bloat the repo if those steps will be invalidated by a new installer * update draft * update links for new paths * Update based on review feedback * update config reference * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * post-review edits * note non-AD as enterprise feature * expand manual AD process adminition * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * disable default services for Desktop node * document cli access, clarify non-AD listing of hosts * add join token for new node * update screenshot for new UI * copy edit... Based on https://github.com/gravitational/teleport/pull/19311\#discussion_r1095187559 * name and link for windows exe * Update download link * note zip format --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-02-06 17:22:21 +00:00
"title": "Active Directory",
"slug": "/desktop-access/active-directory/"
},
{
"title": "Active Directory (Manual)",
"slug": "/desktop-access/active-directory-manual/"
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
},
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
},
{
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"title": "Deploying Machine ID",
"slug": "/machine-id/deployment/",
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
"entries": [
{
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"title": "AWS",
"slug": "/machine-id/deployment/aws/"
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
{
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"title": "Google Cloud",
"slug": "/machine-id/deployment/gcp/"
},
{
"title": "Azure",
"slug": "/machine-id/deployment/azure/"
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
},
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",
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"slug": "/machine-id/deployment/circleci/"
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
},
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
{
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"title": "GitHub Actions",
"slug": "/machine-id/deployment/github-actions/"
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
},
GitLab Delegated Joining docs (#23047) * Skeleton out docs for GitLab joining * Adjust description of guide * Add more GitLab docs * Explain the possible constraints * Add final example of GitLab CI * Correct token name * Further clarify a few parts of the documentation * Correct example of project_path constraint * Add more specific link to GitLab docs * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/machine-id/guides/github-actions.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * add new guide to navbar * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/machine-id/guides/github-actions.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * More concise/precise language in bot creation * Add further explanation of fields * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Add reference page for gitlab joining * Fix link * line break adjustments * note bot role is built in * Minor spag correction --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-04-03 11:00:44 +00:00
{
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"title": "GitLab",
"slug": "/machine-id/deployment/gitlab/"
GitLab Delegated Joining docs (#23047) * Skeleton out docs for GitLab joining * Adjust description of guide * Add more GitLab docs * Explain the possible constraints * Add final example of GitLab CI * Correct token name * Further clarify a few parts of the documentation * Correct example of project_path constraint * Add more specific link to GitLab docs * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/machine-id/guides/github-actions.mdx Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * add new guide to navbar * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/machine-id/guides/github-actions.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * More concise/precise language in bot creation * Add further explanation of fields * Update docs/pages/machine-id/guides/gitlab.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Add reference page for gitlab joining * Fix link * line break adjustments * note bot role is built in * Minor spag correction --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-04-03 11:00:44 +00:00
},
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",
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"slug": "/machine-id/deployment/jenkins/"
},
{
"title": "Linux Server",
"slug": "/machine-id/deployment/linux/"
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
},
{
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"title": "Kubernetes",
"slug": "/machine-id/deployment/kubernetes/"
}
]
},
{
"title": "Accessing Infrastructure with Machine ID",
"slug": "/machine-id/access-guides/",
"entries": [
{
"title": "tctl",
"slug": "/machine-id/access-guides/tctl/"
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",
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"slug": "/machine-id/access-guides/kubernetes/"
},
{
"title": "Terraform",
"slug": "/machine-id/access-guides/terraform/"
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": "Applications",
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"slug": "/machine-id/access-guides/applications/"
},
{
"title": "Databases",
"slug": "/machine-id/access-guides/databases/"
},
{
"title": "SSH",
"slug": "/machine-id/access-guides/ssh/"
[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
},
{
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"title": "Ansible",
"slug": "/machine-id/access-guides/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
}
]
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/"
Machine ID telemetry docs (#22541) * Start writing Telemetry docs * Add description of events * Update examples with TELEPORT_ANONYMOUS_TELEMETRY * Add note on Telemetry * Fix SPAG in telemetry docs page * Correct link in guides/ for telemetry page * Fix link on reference index page * Update docs for GH action examples * SPAG Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * kubernetes -> Kubernetes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/reference/telemetry.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Fix list punctuation * Don't break user reading flow in guides --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-06 11:46:30 +00:00
},
Machine ID: More rules to `gitlab` joining and add globby matching to some fields (#34290) * Add fields for to-be-supported token claims * Modify validation to include new field * Add comparisons for new fields to joining logic * Add support for globby matching for sub, ref, namespace_path and project_path * Document which fields support globby matching * Add tests for join rule engine changes * Regenerate operator CRDs * Add docs for new fields * Correct punctuation in error message Co-authored-by: Marco André Dinis <marco.dinis@goteleport.com> * Correctly use GoDoc-esque comments * Address docs comments * Reuse glob matching code * Correct type of RunnerID field --------- Co-authored-by: Marco André Dinis <marco.dinis@goteleport.com>
2023-11-09 16:52:04 +00:00
{
"title": "GitLab",
"slug": "/machine-id/reference/gitlab/"
},
Machine ID telemetry docs (#22541) * Start writing Telemetry docs * Add description of events * Update examples with TELEPORT_ANONYMOUS_TELEMETRY * Add note on Telemetry * Fix SPAG in telemetry docs page * Correct link in guides/ for telemetry page * Fix link on reference index page * Update docs for GH action examples * SPAG Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * kubernetes -> Kubernetes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/reference/telemetry.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Fix list punctuation * Don't break user reading flow in guides --------- Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-06 11:46:30 +00:00
{
"title": "Telemetry",
"slug": "/machine-id/reference/telemetry/"
Add a table of contents entry (#30235) The Machine ID upgrade guide is missing a table of contents entry. Add one for it.
2023-08-10 14:43:07 +00:00
},
{
"title": "Upgrading to v14",
"slug": "/machine-id/reference/v14-upgrade-guide/"
}
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/"
Add a guide to writing an Access Request plugin (#22441) * Add a guide to writing an Access Request plugin Closes #22227 This guide uses a minimal working example of an Access Request plugin to demonstrate some of the key libraries that Teleport makes available to plugin developers. The guide is based on a 270-line plugin that manages Access Requests using Google Sheets. * Respond to hugoShaka feedback * Respond to zmb3 feedback * Add some minor tweaks - Update the line of code count in the demo program - Mention Machine ID * Respond to alexfornuto PR feedback
2023-03-14 17:35:05 +00:00
},
{
"title": "How to Build an Access Request Plugin",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/api/access-plugin/",
"forScopes": ["enterprise", "cloud"]
Add a guide to using the API for auto-discovery (#22817) * Add a guide to using the API for auto-discovery See #19716 Adding resources is a popular use of Teleport's API, so I have added a guide to using the API for syncing resources to a service discovery API using an example of a local Docker setup. * Respond to zmb3 feedback * Use the examples directory for the code This way, users can have a compilable example before they start working through the guide. * Respond to alexfornuto feedback * Respond to PR feedback * Run make fix-license
2023-03-29 21:27:05 +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
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Automatically Register Teleport Agents",
"slug": "/api/automatically-register-agents/"
},
{
"title": "Automatically Generate Roles",
"slug": "/api/rbac/"
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
]
},
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": [
Provide more context in the docs intro page (#22517) * Provide more context in the docs intro page Closes #22469 The current docs landing page does not include enough context for new readers. After the general description of Teleport, the rest of the landing page is series of links, with little guidance for what a new user should do first (or what an intermediate user should do after completing the initial setup steps). This change takes a more narrative approach to the landing page, briefly describing the content of each top-level docs section and putting it in context with the rest of the docs. This also helps users find the right top-level docs section for their needs, since otherwise the only way to do this is to visit each section. This change is also more opinionated about which guide new users should begin with. It recommends the guide to getting started with Teleport Cloud, since this doesn't require setting up a Teleport cluster and helps a user register a resource quickly. The landing page links to the introduction page of each top-level docs section. If a section does not have an introduction page, this change adds one. * Respond to zmb3 feedback Reorder list items * Linter fixes * Respond to alexfornuto PR feedback
2023-03-13 16:16:38 +00:00
{
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"title": "Introduction",
"slug": "/reference/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
{
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",
Split up the CLI reference (#30129) Fixes #29957 Improves the page load performance of our CLI reference documentation by splitting up the long CLI reference page. This also has other benefits, including: - **SEO**: Users don't need to search for the Teleport CLI reference (and don't need to know that this page exists), but can search for a specific tool they want reference docs for. - **In-page search:** Users searching within a specific page will get results for the tool they are researching, not all of Teleport's CLI tools.
2023-08-10 13:56:47 +00:00
"slug": "/reference/cli/",
"entries": [
{
"title": "teleport",
"slug": "/reference/cli/teleport/"
},
{
"title": "tsh",
"slug": "/reference/cli/tsh/"
},
{
"title": "tctl",
"slug": "/reference/cli/tctl/"
},
{
"title": "tbot",
"slug": "/reference/cli/tbot/"
}
]
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +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": "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",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/reference/helm-reference/teleport-cluster/",
"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": "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": [
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
{
"title": "Introduction",
"slug": "/architecture/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
{
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
},
{
docs: proxy peering out of preview (#29027)
2023-07-12 19:48:42 +00:00
"title": "Proxy Peering",
Edit forScopes configurations and edit guides (#28443) * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
2023-07-05 20:58:08 +00:00
"slug": "/architecture/proxy-peering/",
"forScopes": ["enterprise"]
docs: document the updater (#24628) * docs: document the updater This commit adds the updater documentation covering: - its architecture - how to setup a self-hosted version server for on-prem users - how to enroll an agent into automatic updates - the `cluster_maintenance_config` resource reference The PR currently restricts the automatic update scope to enterprise and cloud. Technically oss users could benefit from it but we don't have an oss package yet. Hopefully this should happen post 13.0 release. * add new page to section index and sort * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.1 * docs feedback pt.2 * fix tabs and edit innards * Apply suggestions from code review Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * docs feedback pt.3 * docs feedback pt.4 * Apply suggestions from code review Co-authored-by: Roman Tkachenko <roman@goteleport.com> * docs feedback pt.5 * mark as preview --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 14:18:02 +00:00
},
{
"title": "Agent Update Management",
"slug": "/architecture/agent-update-management/",
"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
}
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/"
},
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
{
"title": "Reviewing Documentation Changes",
"slug": "/contributing/documentation/reviewing-docs/"
},
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": "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 device trust docs (#30821) * add dedicated page for device management and enforcement - remove auto enrollment page - update config.json * update guide page to getting started, update copy to focus on day 1 usage * update base device-trust doc with concepts. - content is borrowed and expanded from existing doc * update copy and links * fix links, run linter write * add reference to hosted Jamf plugin * resolve review comments: - multiple grammar update - auto enrollment -> auto-enrollment - add signed prereqs in enforcing ddevice trust page * accomodate new preset roles and default auto-enrollment: - udpated getting started guide to use preset require-trusted-device role - minor grammar and code formating * fix typo udpate -> update * remove auto-enrollment default enabled admonition * address review suggestions: - adds resolved comments * add clusterDefaults variable for generic code reference * add troubleshooting to guide and enforcment page * reference tctl edit role/access and add tsh relogin * fix typo * mention required role for auto-enrollment and minimum requirements * add in command * fix typo
2023-08-31 20:09:21 +00:00
"clusterDefaults": {
"clusterName": "teleport.example.com",
"username": "myuser",
"nodeIP": "ip-172-31-35-170"
},
[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 14.1.3 (#34604) Signed-off-by: Evan Freed <evan.freed@goteleport.com>
2023-11-16 15:37:34 +00:00
"version": "14.1.3",
"major_version": "14",
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": {
Bump Cloud SLA to 99.9% (#24076)
2023-04-04 20:25:46 +00:00
"monthly_percentage": "99.9%",
"monthly_downtime": "44 minutes"
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
}
},
Add public docs for device trust (#20954) * Add device trust documentation * Link to Device Trust from Access Control pages * Document `device_trust` authentication section * Document the `tsh device enroll` command * Document `tctl devices` commands * Review: Explain macOS restriction in text * Review: Address Alex's comments Indents, markdown style, code block style, punctuation and missing words. * Review: Use diff blocks on `tctl edit` example * Review: Use diff blocks in other examples * Review: Use standard example names * Review: Address Alex's comments (2) Uppercase SERIAL, macOS enroll notice, config example tabs. * Review: Sort `tctl devices` commands alphabetically * Review: Use config variables for asset_tag and enroll_token * Review: Remove '#' from code blocks in cli.mdx * combine warning and ScopedBlock A ScopedBlock for OSS will never render on a page not scoped for OSS. This way, it's always visible. Once the feature is out of preview, we can just remove the first line. * clarify device trust between trusted clusters This addition dispells any assumptions made by the reader that applying device trust to root clusters would enforece the setting on leaf clusters. * update enterprise tctl version output --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-02 20:43:51 +00:00
"devicetrust": {
"asset_tag": "C00AA0AAAA0A",
Docs: Device Trust role and locking support (#21915) * per-role device trust configuration * device locking * resolved review comments related to copy edits. added device trust reference to role-spec, reference and locking * revert mdx formatting * updated reference. * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/locking.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * word added in cluster and role-based device enforcement * Update docs/pages/access-controls/guides/device-trust.mdx Co-authored-by: Alan Parra <alan.parra@goteleport.com> * added variable for device_id. Removed trusted from locking header. Placed 'option' before 'required' in device trust mode * fix build errors --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> Co-authored-by: Alan Parra <alan.parra@goteleport.com>
2023-02-27 17:21:52 +00:00
"enroll_token": "AAAAAAAAAAAAAAAAAAAAAAAA-this-is-an-example",
"device_id": "9cdfc0ad-64b7-4d9c-this-is-an-example"
Add public docs for device trust (#20954) * Add device trust documentation * Link to Device Trust from Access Control pages * Document `device_trust` authentication section * Document the `tsh device enroll` command * Document `tctl devices` commands * Review: Explain macOS restriction in text * Review: Address Alex's comments Indents, markdown style, code block style, punctuation and missing words. * Review: Use diff blocks on `tctl edit` example * Review: Use diff blocks in other examples * Review: Use standard example names * Review: Address Alex's comments (2) Uppercase SERIAL, macOS enroll notice, config example tabs. * Review: Sort `tctl devices` commands alphabetically * Review: Use config variables for asset_tag and enroll_token * Review: Remove '#' from code blocks in cli.mdx * combine warning and ScopedBlock A ScopedBlock for OSS will never render on a page not scoped for OSS. This way, it's always visible. Once the feature is out of preview, we can just remove the first line. * clarify device trust between trusted clusters This addition dispells any assumptions made by the reader that applying device trust to root clusters would enforece the setting on leaf clusters. * update enterprise tctl version output --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-02 20:43:51 +00:00
},
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"
},
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
"teleport": {
Lg/labels page (#30200) * Edit the labels topic * Update labels section and related includes, add a new variable * Add missing word * Fix spelling * Fix spelling * Fix issues, remove off-topic section * Modify the partial a little more * Fix typo * Remove the scopedblock from tctl.mdx, fix some typos and terminology. * Lint typos * fix path to Local users * change description for static labels, add complex string example * Clarify string example * Clarify string example * Change h4 to bold text to appease the linter
2023-08-28 17:05:31 +00:00
"git": "api/14.0.0-gd1e081e",
Updated master branch makefile version to 15.0.0-dev (#31220) * Updated master branch makefile version to 15.0.0-dev * Updated `docs/config.json` * Revert "Updated `docs/config.json`" This reverts commit 4d4c8846b168b7311679d8629081e20e98f604f8. * Updated `docs/config.json` * Revert e ref update * revert docs git property removal * Fixed version check integration test * Re-ordered imports * Reverted accidental format change by IDE
2023-09-11 19:54:40 +00:00
"major_version": "15",
"version": "15.0.0-dev",
Lg/labels page (#30200) * Edit the labels topic * Update labels section and related includes, add a new variable * Add missing word * Fix spelling * Fix spelling * Fix issues, remove off-topic section * Modify the partial a little more * Fix typo * Remove the scopedblock from tctl.mdx, fix some typos and terminology. * Lint typos * fix path to Local users * change description for static labels, add complex string example * Clarify string example * Clarify string example * Change h4 to bold text to appease the linter
2023-08-28 17:05:31 +00:00
"url": "teleport.example.com",
chore: Bump Go to v1.21.0 (#31116) Update Go toolchain to the latest release.
2023-08-28 21:36:54 +00:00
"golang": "1.21",
New docs structure (#5520) * Move docs files to new location
2021-02-10 18:07:30 +00:00
"plugin": {
Updated master branch makefile version to 15.0.0-dev (#31220) * Updated master branch makefile version to 15.0.0-dev * Updated `docs/config.json` * Revert "Updated `docs/config.json`" This reverts commit 4d4c8846b168b7311679d8629081e20e98f604f8. * Updated `docs/config.json` * Revert e ref update * revert docs git property removal * Fixed version check integration test * Re-ordered imports * Reverted accidental format change by IDE
2023-09-11 19:54:40 +00:00
"version": "13.3.7"
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",
Updated master branch makefile version to 15.0.0-dev (#31220) * Updated master branch makefile version to 15.0.0-dev * Updated `docs/config.json` * Revert "Updated `docs/config.json`" This reverts commit 4d4c8846b168b7311679d8629081e20e98f604f8. * Updated `docs/config.json` * Revert e ref update * revert docs git property removal * Fixed version check integration test * Re-ordered imports * Reverted accidental format change by IDE
2023-09-11 19:54:40 +00:00
"latest_oss_docker_image": "public.ecr.aws/gravitational/teleport-distroless:13.3.7",
"latest_oss_debug_docker_image": "public.ecr.aws/gravitational/teleport-distroless-debug:13.3.7",
"latest_ent_docker_image": "public.ecr.aws/gravitational/teleport-ent-distroless:13.3.7",
"latest_ent_debug_docker_image": "public.ecr.aws/gravitational/teleport-ent-distroless-debug:13.3.7"
[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/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"destination": "/choose-an-edition/teleport-enterprise/introduction/",
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/",
docs: Update HA Terraform reference and add starter cluster reference (#32354) * docs: Update Terraform reference documentation * Fixes to shell script
2023-10-05 16:14:44 +00:00
"destination": "/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform/",
"permanent": true
},
{
"source": "/aws-terraform/",
"destination": "/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-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/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"destination": "/installation/",
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/",
Fix redirects (#27488) The `/docs/cloud` redirect was 404ing because `/docs/choose-an-edition/teleport-cloud/` does not correspond to a page within the docs. This updates the redirects for this and similar configurations.
2023-06-07 15:00:07 +00:00
"destination": "/choose-an-edition/teleport-cloud/introduction/",
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
},
Add missing redirect (#33879) Ensure that users visiting `/docs/desktop-access/` are redirected to the introduction page for the Desktop Access docs section.
2023-10-24 18:38:09 +00:00
{
"source": "/desktop-access/",
"destination": "/desktop-access/introduction/",
"permanent": true
},
Move introductions to the appropriate sections (#6456)
2021-04-15 00:06:57 +00:00
{
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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/",
Fix redirects (#27488) The `/docs/cloud` redirect was 404ing because `/docs/choose-an-edition/teleport-cloud/` does not correspond to a page within the docs. This updates the redirects for this and similar configurations.
2023-06-07 15:00:07 +00:00
"destination": "/choose-an-edition/teleport-cloud/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": "/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/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"destination": "/installation/",
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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/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/",
docs: remove duplicative k8s access guide (#27119) * docs: remove duplicative k8s access guide * fix to config json * spacing fix * fix links * Update docs/pages/deploy-a-cluster/helm-deployments/digitalocean.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-05-30 17:11:08 +00:00
"destination": "/kubernetes-access/getting-started/",
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
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"destination": "/kubernetes-access/",
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/",
fix redirects pointing at removed guide (#21310)
2023-02-06 17:51:13 +00:00
"destination": "/deploy-a-cluster/helm-deployments/migration-v12/",
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/",
docs: Update HA Terraform reference and add starter cluster reference (#32354) * docs: Update Terraform reference documentation * Fixes to shell script
2023-10-05 16:14:44 +00:00
"destination": "/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-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
"permanent": true
},
{
"source": "/setup/deployments/digitalocean/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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/",
fix redirects pointing at removed guide (#21310)
2023-02-06 17:51:13 +00:00
"destination": "/deploy-a-cluster/helm-deployments/migration-v12/",
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": "/getting-started/linux-server/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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/",
Add Teleport Team docs (#26523) * Add documentation for Teleport Team - Remove the Teleport Enterprise Cloud Getting Started guide, since this assumes that you have signed up for an Enterprise Cloud trial. Instead, users will sign up for a Team trial to add their first resource and follow a new guide to using Teleport Team. - Move references to Teleport Team first in lists of Teleport editions, since this is the intended first step for self-service users. * Update the Teleport Team guide - Update screenshots - Move Docker instructions to a Details box and make Docker optional, with the idea that Linux and macOS users could join their workstations to their Teleport cluster. * Require a Docker container again In this test environment, there was no support for ARM on macOS. Requiring a container ensures consistency between environments. * Add a diagram * Fix links * Linter fixes * Respond to alexfornuto feedback
2023-05-19 20:15:40 +00:00
"destination": "/choose-an-edition/teleport-team/",
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/",
Fix redirects (#27488) The `/docs/cloud` redirect was 404ing because `/docs/choose-an-edition/teleport-cloud/` does not correspond to a page within the docs. This updates the redirects for this and similar configurations.
2023-06-07 15:00:07 +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/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +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/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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/join-token/",
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/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/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"destination": "/installation/",
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/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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/aws-ec2/",
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-iam/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/aws-iam/",
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/ssh-key-extensions/",
"destination": "/management/guides/ssh-key-extensions/",
"permanent": true
},
{
"source": "/setup/guides/teleport-operator/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/management/dynamic-resources/teleport-operator/",
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/terraform-provider/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/management/dynamic-resources/terraform-provider/",
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/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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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 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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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 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/",
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
"destination": "/machine-id/access-guides/kubernetes/",
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
"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/",
Add Teleport Team docs (#26523) * Add documentation for Teleport Team - Remove the Teleport Enterprise Cloud Getting Started guide, since this assumes that you have signed up for an Enterprise Cloud trial. Instead, users will sign up for a Team trial to add their first resource and follow a new guide to using Teleport Team. - Move references to Teleport Team first in lists of Teleport editions, since this is the intended first step for self-service users. * Update the Teleport Team guide - Update screenshots - Move Docker instructions to a Details box and make Docker optional, with the idea that Linux and macOS users could join their workstations to their Teleport cluster. * Require a Docker container again In this test environment, there was no support for ARM on macOS. Requiring a container ensures consistency between environments. * Add a diagram * Fix links * Linter fixes * Respond to alexfornuto feedback
2023-05-19 20:15:40 +00:00
"destination": "/choose-an-edition/teleport-team/",
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
"permanent": true
},
{
"source": "/deploy-a-cluster/teleport-cloud/introduction/",
Fix redirects (#27488) The `/docs/cloud` redirect was 404ing because `/docs/choose-an-edition/teleport-cloud/` does not correspond to a page within the docs. This updates the redirects for this and similar configurations.
2023-06-07 15:00:07 +00:00
"destination": "/choose-an-edition/teleport-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
"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/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"destination": "/choose-an-edition/teleport-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
"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/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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
"permanent": true
},
{
"source": "/deploy-a-cluster/open-source/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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
"permanent": true
},
{
"source": "/getting-started/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
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
"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
Document Google Cloud CLI access (#19905) * Document Google Cloud CLI access Closes #17584 - Add a guide to configuring and using Google Cloud CLI access via the Teleport Application Service. - Since we now have three guides to setting up secure access to cloud APIs, create a new subsection of the "Application Access" docs section related to cloud provider APIs. * Respond to PR feedback - Capitalize "JSON Web Tokens" - Edit the AWS guide's nav bar entry - Fix garbled section in the App Access intro page - Improve the service account name we use in the how-to guide - Clarify the way the App Service uses a service account - Add new env vars to the `tsh proxy` command output - Other small changes in response to suggestions/comments * Edit instructions for starting the VM Add instructions to launch a new VM with a service account attached. This addresses feedback on the PR. * Use more precise terminology for service accounts This addresses feedback on the PR * Add information about `tsh gsutil` This adds to both the Google Cloud API access how-to guide and the CLI reference. * Respond to PR feedback * use nobr tags * fix multiline command --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-03 16:45:53 +00:00
},
{
"source": "/application-access/guides/aws-console/",
"destination": "/application-access/cloud-apis/aws-console/",
"permanent": true
},
{
"source": "/application-access/guides/azure/",
"destination": "/application-access/cloud-apis/azure/",
"permanent": true
New guide: AWS DynamoDB with Database Access (#19956) * move application-based dynamodb guide * update and move images * init new dynamo guide * Apply suggestions from code review Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * updates based on review * Add NoSQL workbench to gui clients doc * cluster > plane * add redirect for dynamo through app access * gui-client cleanup * Update docs/pages/database-access/guides/aws-dynamodb.mdx Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * Apply suggestions from code review Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * update labs link * Apply suggestions from code review Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * updates based on review * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * move service nodes into AWS cloud * edits based on review feedback * clarify AWS IAM roles * Adjust explanation of user role * reference generated token * Move dynamic registration to next steps * explain advantage to DynamoDB through App service * merge conflict resolution * clarify database region restrictions --------- Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 18:42:18 +00:00
},
{
"source": "/database-access/guides/dynamodb/",
"destination": "/application-access/guides/dynamodb/",
"permanent": true
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
},
{
"source": "/kubernetes-access/guides/federation/",
"destination": "/kubernetes-access/manage-access/federation/",
"permanent": true
},
{
"source": "/kubernetes-access/guides/dynamic-registration/",
"destination": "/kubernetes-access/register-clusters/dynamic-registration/",
"permanent": true
},
{
"source": "/kubernetes-access/guides/multiple-clusters/",
docs: remove duplicative k8s access guide (#27119) * docs: remove duplicative k8s access guide * fix to config json * spacing fix * fix links * Update docs/pages/deploy-a-cluster/helm-deployments/digitalocean.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-05-30 17:11:08 +00:00
"destination": "/kubernetes-access/getting-started/",
Explain Kubernetes RBAC more comprehensively (#20730) * Explain Kubernetes RBAC more comprehensively Closes #18230 This change explains Teleport's RBAC system in relation to the Teleport Kubernetes Service. The docs didn't leave me with a readily available place to put this information, since explanations of Kubernetes-related role fields are scattered in asides throughout various pages. As a result, I have added a more comprehensive, focused explanation of Teleport's Kubernetes RBAC system in two places: - A new how-to guide for setting up Kubernetes RBAC with Teleport using a local `minikube` cluster. - A reference guide that explains the Kubernetes-related fields within a Teleport role as well as the logic that the Kubernetes Service uses to evaluate these fields. This replaces the existing Kubernetes Access Controls guide. To make room for the RBAC how-to guide, I've reorganized the other guides into a logical sequence: enabling auto-discovery, manually registering clusters, and setting up access controls. I've also edited the Resource Access Requests guides to explain role fields for the different resources you can restrict access to via `search_as_roles`, including `pods`. * Partially respond to PR feedback - Add `kubernetes_labels` to example snippets - Rename a misleading H5 in the Resource Requests guide - Make the description of impersonation more accurate in the Access Controls guide - Move a Notice in the Access Controls guide - Add an example role to the warning re: namespace restrictions in the Access Controls guide - Make resource filtering info more accurate in the CLI reference * Change the RBAC how-to guide Use Deployments in the demo cluster instead of Pods, showcasing the use of regular expressions in per-pod RBAC. This responds to PR feedback. * Provide an example of internal traits This responds to PR feedback * Add notes about regex support Responds to PR feedback * Explain multiple values in labels Responds to PR feedback * Document progressively enabling access to pods In response to PR feedback * unbreak redirect * copy edits * more copy edits * Respond to alexfornuto feedback --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
"permanent": true
},
{
"source": "/kubernetes-access/guides/standalone-teleport/",
"destination": "/kubernetes-access/register-clusters/static-kubeconfig/",
"permanent": true
},
{
"source": "/kubernetes-access/guides/",
"destination": "/kubernetes-access/introduction/",
"permanent": true
Remove the Access Controls FAQ (#23997) Fixes #11829 Teleport's Access Controls section is pretty sprawling, with 8 top-level subsections and 46 pages. The Access Controls FAQ, meanwhile, is unusually short, with only three questions. This can become misleading, since there's a good chance that any information someone is looking for in the FAQ will not exist there. This change removes the Access Controls FAQ. If an answer found in the FAQ does not exist explicitly elsewhere in the docs, I have added it.
2023-04-04 20:42:33 +00:00
},
Add Teleport Team docs (#26523) * Add documentation for Teleport Team - Remove the Teleport Enterprise Cloud Getting Started guide, since this assumes that you have signed up for an Enterprise Cloud trial. Instead, users will sign up for a Team trial to add their first resource and follow a new guide to using Teleport Team. - Move references to Teleport Team first in lists of Teleport editions, since this is the intended first step for self-service users. * Update the Teleport Team guide - Update screenshots - Move Docker instructions to a Details box and make Docker optional, with the idea that Linux and macOS users could join their workstations to their Teleport cluster. * Require a Docker container again In this test environment, there was no support for ARM on macOS. Requiring a container ensures consistency between environments. * Add a diagram * Fix links * Linter fixes * Respond to alexfornuto feedback
2023-05-19 20:15:40 +00:00
{
"source": "/choose-an-edition/teleport-cloud/getting-started/",
"destination": "/choose-an-edition/teleport-team/",
"permanent": true
},
Remove the Access Controls FAQ (#23997) Fixes #11829 Teleport's Access Controls section is pretty sprawling, with 8 top-level subsections and 46 pages. The Access Controls FAQ, meanwhile, is unusually short, with only three questions. This can become misleading, since there's a good chance that any information someone is looking for in the FAQ will not exist there. This change removes the Access Controls FAQ. If an answer found in the FAQ does not exist explicitly elsewhere in the docs, I have added it.
2023-04-04 20:42:33 +00:00
{
"source": "/access-controls/faq/",
"destination": "/access-controls/introduction/",
"permanent": true
Add top-level redirects to intro pages (#24338) Fixes #9156 In case someone manually browses to a top-level docs section, ensure that each top-level URL path redirects to the intro page (or only page) for that section.
2023-04-12 14:31:10 +00:00
},
{
"source": "/try-out-teleport/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
Add top-level redirects to intro pages (#24338) Fixes #9156 In case someone manually browses to a top-level docs section, ensure that each top-level URL path redirects to the intro page (or only page) for that section.
2023-04-12 14:31:10 +00:00
"permanent": true
},
{
"source": "/choose-an-edition/",
"destination": "/choose-an-edition/introduction/",
"permanent": true
},
{
"source": "/deploy-a-cluster/",
"destination": "/deploy-a-cluster/introduction/",
"permanent": true
},
{
"source": "/access-controls/",
"destination": "/access-controls/introduction/",
"permanent": true
},
{
"source": "/management/",
"destination": "/management/introduction/",
"permanent": true
},
{
"source": "/connect-your-client/",
"destination": "/connect-your-client/introduction/",
"permanent": true
},
{
"source": "/server-access/",
"destination": "/server-access/introduction/",
"permanent": true
},
{
"source": "/machine-id/",
"destination": "/machine-id/introduction/",
"permanent": true
},
{
"source": "/api/",
"destination": "/api/introduction/",
"permanent": true
},
{
"source": "/preview/",
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
"destination": "/upcoming-releases/",
Add top-level redirects to intro pages (#24338) Fixes #9156 In case someone manually browses to a top-level docs section, ensure that each top-level URL path redirects to the intro page (or only page) for that section.
2023-04-12 14:31:10 +00:00
"permanent": true
},
{
"source": "/reference/",
"destination": "/reference/introduction/",
"permanent": true
},
{
"source": "/architecture/",
"destination": "/architecture/introduction/",
"permanent": true
},
{
"source": "/contributing/",
"destination": "/contributing/documentation/",
"permanent": true
Add docs subsection about joining services (#23869) * Add docs subsection about joining services Closes #21851 Also see #21305 Restructure the "Adding Nodes" guide to make joining Teleport processes via the Proxy Service the default approach. Make it easier for users to put these instructions in the context of our other joining methods by creating a separate docs subsection for our joining guides. This change also updates the previous "Adding Nodes" guide based on testing. This also renames "Node" to "Teleport process" and clarifies the distinction between running a Teleport process and running services on the process. * Respond to zmb3 feedback * Respond to alexfornuto feedback * Improve the "Join Token" guide descriptionA Makes this guide consistent with df3e36e49e19acb5ab1f301d0d3b83f8b5d524d5 * Move the Kubernetes guide * Fix spelling * Linter fixes
2023-04-18 16:42:50 +00:00
},
{
"source": "/management/guides/joining-nodes-aws-ec2/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/aws-ec2/",
Add docs subsection about joining services (#23869) * Add docs subsection about joining services Closes #21851 Also see #21305 Restructure the "Adding Nodes" guide to make joining Teleport processes via the Proxy Service the default approach. Make it easier for users to put these instructions in the context of our other joining methods by creating a separate docs subsection for our joining guides. This change also updates the previous "Adding Nodes" guide based on testing. This also renames "Node" to "Teleport process" and clarifies the distinction between running a Teleport process and running services on the process. * Respond to zmb3 feedback * Respond to alexfornuto feedback * Improve the "Join Token" guide descriptionA Makes this guide consistent with df3e36e49e19acb5ab1f301d0d3b83f8b5d524d5 * Move the Kubernetes guide * Fix spelling * Linter fixes
2023-04-18 16:42:50 +00:00
"permanent": true
},
{
"source": "/management/guides/joining-nodes-aws-iam/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/aws-iam/",
Add docs subsection about joining services (#23869) * Add docs subsection about joining services Closes #21851 Also see #21305 Restructure the "Adding Nodes" guide to make joining Teleport processes via the Proxy Service the default approach. Make it easier for users to put these instructions in the context of our other joining methods by creating a separate docs subsection for our joining guides. This change also updates the previous "Adding Nodes" guide based on testing. This also renames "Node" to "Teleport process" and clarifies the distinction between running a Teleport process and running services on the process. * Respond to zmb3 feedback * Respond to alexfornuto feedback * Improve the "Join Token" guide descriptionA Makes this guide consistent with df3e36e49e19acb5ab1f301d0d3b83f8b5d524d5 * Move the Kubernetes guide * Fix spelling * Linter fixes
2023-04-18 16:42:50 +00:00
"permanent": true
},
{
"source": "/management/admin/adding-nodes/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/join-token/",
Add docs subsection about joining services (#23869) * Add docs subsection about joining services Closes #21851 Also see #21305 Restructure the "Adding Nodes" guide to make joining Teleport processes via the Proxy Service the default approach. Make it easier for users to put these instructions in the context of our other joining methods by creating a separate docs subsection for our joining guides. This change also updates the previous "Adding Nodes" guide based on testing. This also renames "Node" to "Teleport process" and clarifies the distinction between running a Teleport process and running services on the process. * Respond to zmb3 feedback * Respond to alexfornuto feedback * Improve the "Join Token" guide descriptionA Makes this guide consistent with df3e36e49e19acb5ab1f301d0d3b83f8b5d524d5 * Move the Kubernetes guide * Fix spelling * Linter fixes
2023-04-18 16:42:50 +00:00
"permanent": true
},
{
"source": "/management/guides/joining-nodes-azure/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/azure/",
Add docs subsection about joining services (#23869) * Add docs subsection about joining services Closes #21851 Also see #21305 Restructure the "Adding Nodes" guide to make joining Teleport processes via the Proxy Service the default approach. Make it easier for users to put these instructions in the context of our other joining methods by creating a separate docs subsection for our joining guides. This change also updates the previous "Adding Nodes" guide based on testing. This also renames "Node" to "Teleport process" and clarifies the distinction between running a Teleport process and running services on the process. * Respond to zmb3 feedback * Respond to alexfornuto feedback * Improve the "Join Token" guide descriptionA Makes this guide consistent with df3e36e49e19acb5ab1f301d0d3b83f8b5d524d5 * Move the Kubernetes guide * Fix spelling * Linter fixes
2023-04-18 16:42:50 +00:00
"permanent": true
},
{
"source": "/management/guides/joining-services-kubernetes-serviceaccount/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/agents/join-services-to-your-cluster/kubernetes/",
Add docs subsection about joining services (#23869) * Add docs subsection about joining services Closes #21851 Also see #21305 Restructure the "Adding Nodes" guide to make joining Teleport processes via the Proxy Service the default approach. Make it easier for users to put these instructions in the context of our other joining methods by creating a separate docs subsection for our joining guides. This change also updates the previous "Adding Nodes" guide based on testing. This also renames "Node" to "Teleport process" and clarifies the distinction between running a Teleport process and running services on the process. * Respond to zmb3 feedback * Respond to alexfornuto feedback * Improve the "Join Token" guide descriptionA Makes this guide consistent with df3e36e49e19acb5ab1f301d0d3b83f8b5d524d5 * Move the Kubernetes guide * Fix spelling * Linter fixes
2023-04-18 16:42:50 +00:00
"permanent": true
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
},
{
"source": "/try-out-teleport/browser-labs/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"permanent": true
},
{
"source": "/try-out-teleport/digitalocean/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"permanent": true
},
{
"source": "/try-out-teleport/docker-compose/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"permanent": true
},
{
"source": "/try-out-teleport/introduction/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"permanent": true
},
{
"source": "/try-out-teleport/local-kubernetes/",
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
"destination": "/",
Simplify the Getting Started experience (#25415) This change makes the experience of getting started with Teleport more opinionated and more precisely molded around our intended audience. The assumption is that people who want to go through our getting started experience are skilled technologists who: - Are curious about how Teleport works and want to tinker with a toy cluster - Need to set up a production cluster in order to protect their infrastructure, in which case a toy cluster is less important than a way to get started with the real thing Promote the "Linux Server" guide -------------------------------- Make the "Linux Server" guide the definitive introduction to OSS Teleport by removing other "Try out Teleport" guides and moving this one to the "Home" section. We want to remove the need for users to decide which getting started guide to try, and this guide is the only one that lets users spin up a fully fledged demo cluster besides the Digital Ocean guide. To let users know about the DigitalOcean 1-Click droplet, this change links to our DigitalOcean 1-Click app from within the Linux Server guide. It also advises users who don't meet the Linux Server guide prerequisites to sign up for a Teleport Enterprise Cloud free trial. This change also removes the Docker guide and redirects Docker-related traffic to the Installation page, since the Docker guide is more of a Getting Started guide than an integration guide, and our Installation page already includes Docker setup information. Edit the Linux Server getting started guide ------------------------------------------- - Remove Application Service instructions, since it can turn off users who, for example, don't use Python or don't want to run the Application Service (plus we already mention it at the end of the guide for users who do want to run this service). - Update installation instructions to use our one-liner. - Make this guide more explicitly focused on the Open Source edition, removing Enterprise instructions. Users who want to tinker with Teleport will not be interested in the Enterprise edition. - Add session recording instructions. Most of the content of the Linux Server guide has to do with setting up Teleport, rather than seeing Teleport features, so I wanted to adjust this balance a bit. - Remove the permission warning. It takes up around 1/4 of the screen height when viewing the page, and we expect our intended audience to know this information already. Change the Enterprise information architecture ---------------------------------------------- - Remove the Enterprise "Getting Started" guide: This guide shows you how to deploy a demo Teleport Enterprise cluster, which is sort of a contradiction in terms. Enterprise users expect a production-grade cluster, which is not what you get in this guide. - In the Enterprise Introduction page, include instructions to read the Deployment Guides, which show how to set up a mature HA deployment, plus a recommendation to use Teleport Enterprise Cloud unless you need the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
"permanent": true
},
{
"source": "/management/guides/docker/",
"destination": "/installation/",
"permanent": true
},
{
"source": "/choose-an-edition/teleport-enterprise/getting-started/",
"destination": "/choose-an-edition/teleport-enterprise/introduction/",
"permanent": true
Move upcoming releases to Home section to make it more visible (#25783)
2023-05-08 20:13:50 +00:00
},
{
"source": "/preview/upcoming-releases/",
"destination": "/upcoming-releases/",
"permanent": true
Remove the Adopters page (#26231) We already have a case studies page on the main Teleport site, so the Adopters page adds clutter to the "Home" section of the sidebar. It also tends to fall out of date, and ironically gives the impression that Teleport has fewer adopters than it actually does. Co-authored-by: Steven Martin <steven@goteleport.com>
2023-05-16 15:31:33 +00:00
},
{
"source": "/adopters/",
"destination": "/",
"permanent": true
Fix SEO issues (#26804) - Add a missing redirect from `choose-an-edition/teleport-cloud` to the introduction page of the "Teleport Cloud" docs subsection - Fix broken links
2023-06-01 17:40:48 +00:00
},
{
"source": "/choose-an-edition/teleport-cloud/",
"destination": "/choose-an-edition/teleport-cloud/introduction/",
"permanent": true
Move "Device Trust" to a top-level docs item (#28108) * Move "Device Trust" to a top-level item * Split device trust page as intro and guide * Fix links and appease linter
2023-06-22 22:27:31 +00:00
},
{
"source": "/access-controls/guides/device-trust/",
"destination": "/access-controls/device-trust/guide/",
"permanent": true
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
},
Update device trust docs (#30821) * add dedicated page for device management and enforcement - remove auto enrollment page - update config.json * update guide page to getting started, update copy to focus on day 1 usage * update base device-trust doc with concepts. - content is borrowed and expanded from existing doc * update copy and links * fix links, run linter write * add reference to hosted Jamf plugin * resolve review comments: - multiple grammar update - auto enrollment -> auto-enrollment - add signed prereqs in enforcing ddevice trust page * accomodate new preset roles and default auto-enrollment: - udpated getting started guide to use preset require-trusted-device role - minor grammar and code formating * fix typo udpate -> update * remove auto-enrollment default enabled admonition * address review suggestions: - adds resolved comments * add clusterDefaults variable for generic code reference * add troubleshooting to guide and enforcment page * reference tctl edit role/access and add tsh relogin * fix typo * mention required role for auto-enrollment and minimum requirements * add in command * fix typo
2023-08-31 20:09:21 +00:00
{
"source": "/access-controls/device-trust/auto-enrollment/",
"destination": "/access-controls/device-trust/device-management/",
"permanent": true
},
Promote IAC docs for agents and dynamic resources (#27703) * Promote IAC docs for agents and dynamic resources Closes #27382 Closes #25418 Closes #25442 Two aspects of setting up a Teleport cluster are omnipresent in the docs but never get dedicated treatment: - Running agents - Applying dynamic resources As a result, it is difficult to include discussions about those topics that are separate from a specific workflow or how-to guide. One glaring absence has been prominent guidance on using infrastructure-as-code tools to achieve these tasks. This change improves the visibility of Teleport's support for infrastructure-as-code tools by: - Creating top-level docs sections for running agents and applying dynamic resources - Making IAC instructions prominent within these sections The intention is for readers to become familiar with different methods of applying dynamic resources and running agents, including how to do this with IAC, so they can apply this knowledge when reading other parts of the docs. As a result, in the docs sidebar, the "Dynamic Resources" section comes before the section on RBAC, and the "Teleport Agents" section comes before the sections related to individual Teleport services ("Application Access", "Server Access", etc.). The new section on dynamic resources also gives us a place to put other guides to using the Terraform provider and Kubernetes Operator, e.g., if we add guides to using these tools with popular GitOps platforms. Likewise, the section on agents gives us a place to put other agent-wide information, e.g., how to enable an additional Teleport service on an instance that is already running. To allow for these changes, I have also made the following, more tangentially related sidebar changes: - **Renamed sidebar sections to be noun phrases instead of verb phrases:** Currently, one half of the sidebar is made of imperative phrases like "Manage Access" and "Manage your Cluster". This doesn't really work for the sections on agents and dynamic resources, so I have renamed these sections for consistency. - **Moved the "Manage your Cluster" and "Deploy a Cluster" sections**: I have arranged the sidebar so more basic topics (i.e., those that new users and experienced users alike will need to be familiar with) are on the top and more advanced ones are on the bottom. The other sections that are currently in the first half of the sidebar are topics that all Teleport users will need to get familiar with, while day two operations and self-hosted production deployments are more advanced topics. - **Edited the landing page:** I have edited the landing page of the docs to reflect the new sidebar organization. This also makes the page shorter, simpler, and more opinionated. It spells out a high-level sequence for setting up Teleport, then provides a list of advanced topics for further reading. Links correspond to sidebar sections--as before, I wanted to describe the topic of each sidebar section so users would know this information without having to navigate away from the landing page. * Move the "Dynamic Configuration" section Make this a subsection of "Manage your Cluster" since it's not self-evidently clear as a top-level docs section. Users will probably need an introduction via the "Manage your Cluster" section intro page. This also reverts some of the more drastic sidebar changes introduced by the previous commit. Responds to xinding33 feedback. * Make IAC learning tracks prominent/hard to avoid Closes #27751 Responds to xinding33 feedback The motivation is to be more opinionated about the course that users take through the docs. We currently recommend two tracks for self-service users, i.e., the users expected to make use of the landing page: - Setting up a toy self-hosted Teleport cluster - Setting up a Teleport Team/Enterprise Cloud cluster that can eventually become production ready By moving the "Get Started" guide to the landing page, we direct users immediately on to the first track. This change then gives new users a way to enter the second track from the docs landing page with a prominent link to the Teleport Team docs. This change also edits The landing page to direct users who have completed the getting started experience to instructions for setting up a pool of agents on Terraform, helping to make infrastructure-as-code a first-class citizen of the docs. This change also removes the menu of links that used to confront users on the landing page. Since all sidebar sections include introduction pages, users interested in the content of a sidebar section can visit the section. By removing links, we make it clearer for users how to proceed through the docs. * Fix linter errors * Incorporate Trivy recommendations * Respond to alexfornuto feedback * Restore list of dynamic resources to the reference * Fix linter warnings * Remove the ".sh" extension from userdata script The Terraform module that reads this file does not need the extension, which was causing trouble for our shellcheck linter.
2023-06-30 15:45:37 +00:00
{
"source": "/management/guides/teleport-operator/",
"destination": "/management/dynamic-resources/teleport-operator/",
"permanent": true
},
{
"source": "/management/guides/terraform-provider/",
"destination": "/management/dynamic-resources/terraform-provider/",
"permanent": true
},
{
"source": "/get-started/",
"destination": "/",
"permanent": true
Add redirects introduced by docs reorganization (#28731) PR #27703 rearranged some docs pages without adding redirects. This change corrects the missing redirects.
2023-07-07 14:51:47 +00:00
},
{
"source": "/management/join-services-to-your-cluster/",
"destination": "/agents/join-services-to-your-cluster/",
"permanent": true
},
{
"source": "/management/join-services-to-your-cluster/aws-ec2/",
"destination": "/agents/join-services-to-your-cluster/aws-ec2/",
"permanent": true
},
{
"source": "/management/join-services-to-your-cluster/aws-iam/",
"destination": "/agents/join-services-to-your-cluster/aws-iam/",
"permanent": true
},
{
"source": "/management/join-services-to-your-cluster/azure/",
"destination": "/agents/join-services-to-your-cluster/azure/",
"permanent": true
},
{
"source": "/management/join-services-to-your-cluster/gcp/",
"destination": "/agents/join-services-to-your-cluster/gcp/",
"permanent": true
},
{
"source": "/management/join-services-to-your-cluster/join-token/",
"destination": "/agents/join-services-to-your-cluster/join-token/",
"permanent": true
},
{
"source": "/management/join-services-to-your-cluster/kubernetes/",
"destination": "/agents/join-services-to-your-cluster/kubernetes/",
"permanent": true
},
{
"source": "/management/guides/teleport-operator/",
"destination": "/management/dynamic-resources/teleport-operator/",
"permanent": true
},
{
"source": "/management/guides/terraform-provider/",
"destination": "/management/dynamic-resources/terraform-provider/",
"permanent": true
re-add agentless node manual installation docs (#31647) * re-add agentless node manual installation docs * fix linter issues * Add missing closing paren Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * use tabs in manual install guide * removed more ScopedBlocks I missed * add note about upgrading to v14 * add redirect and notes linking the two guides to one another * addressed feedback * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * fix links --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-09-28 23:00:29 +00:00
},
Machine ID Docs Refactor (#31259) * Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-10-19 17:19:29 +00:00
{
"source": "/machine-id/guides/",
"destination": "/machine-id/",
"permanent": true
},
{
"source": "/machine-id/guides/applications/",
"destination": "/machine-id/access-guides/applications/",
"permanent": true
},
{
"source": "/machine-id/guides/ansible/",
"destination": "/machine-id/access-guides/ansible/",
"permanent": true
},
{
"source": "/machine-id/guides/databases/",
"destination": "/machine-id/access-guides/databases/",
"permanent": true
},
{
"source": "/machine-id/guides/kubernetes/",
"destination": "/machine-id/access-guides/kubernetes/",
"permanent": true
},
{
"source": "/machine-id/guides/circleci/",
"destination": "/machine-id/deployment/circleci/",
"permanent": true
},
{
"source": "/machine-id/guides/jenkins/",
"destination": "/machine-id/deployment/jenkins/",
"permanent": true
},
{
"source": "/machine-id/guides/gitlab/",
"destination": "/machine-id/deployment/gitlab/",
"permanent": true
},
{
"source": "/machine-id/guides/gitlab/",
"destination": "/machine-id/deployment/github-actions/",
"permanent": true
},
re-add agentless node manual installation docs (#31647) * re-add agentless node manual installation docs * fix linter issues * Add missing closing paren Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * use tabs in manual install guide * removed more ScopedBlocks I missed * add note about upgrading to v14 * add redirect and notes linking the two guides to one another * addressed feedback * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * fix links --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-09-28 23:00:29 +00:00
{
"source": "/server-access/guides/openssh/",
"destination": "/server-access/guides/openssh/openssh/",
"permanent": true
docs: Add WinSCP to PuTTY client instructions (#32868) * docs: Add WinSCP to PuTTY client instructions * Restore validity section * Restore validity section * Formatting tweaks * Merge lists * Change title * Fix docs link title to match page * Bump tsh version for WinSCP support * Whitelist WinSCP in spellcheck * putty.mdx -> putty-winscp.mdx
2023-10-06 18:55:58 +00:00
},
{
"source": "/connect-your-client/putty/",
"destination": "/connect-your-client/putty-winscp/",
"permanent": true
[docs] Automatic user provisioning for MySQL (#33084) * [docs] Automatic user provisioning for MySQL/MariaDB * remove mariadb * address comments * add Admonition for database username * fix lint (links)
2023-10-20 13:37:29 +00:00
},
{
"source": "/database-access/rbac/configuring-auto-user-provisioning/",
"destination": "/database-access/auto-user-provisioning/",
"permanent": true
Fix potential SEO issues (#33903) - Fix clashing reference page titles ("Teleport CLI Reference" and "teleport CLI reference"). - Add missing redirects: The Teleport blog encountered 404s navigating to three pages. This change adds redirects for these pages in case other sites link to them as well.
2023-10-26 18:08:09 +00:00
},
docs: Mark AWS GSLB deployment as Enterprise only (#34621) It requires/references proxy peering, so shouldn't be offered to OSS users.
2023-11-15 16:16:57 +00:00
{
Fix potential SEO issues (#33903) - Fix clashing reference page titles ("Teleport CLI Reference" and "teleport CLI reference"). - Add missing redirects: The Teleport blog encountered 404s navigating to three pages. This change adds redirects for these pages in case other sites link to them as well.
2023-10-26 18:08:09 +00:00
"source": "/database-access/guides/rds-proxy/",
"destination": "/database-access/guides/",
"permanent": true
},
{
"source": "/deploy-a-cluster/deployments/aws-terraform/",
"destination": "/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform/",
"permanent": true
},
{
"source": "/machine-id/guides/github-actions/",
"destination": "/machine-id/deployment/github-actions/",
"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
]
Set Cloud version to 12.3.3 (#25957)
2023-05-10 21:36:53 +00:00
}
Reference in a new issue Copy permalink