mirror of
https://github.com/gravitational/teleport.git
synced 2026-09-21 14:35:22 +08:00
Paul Gottschling
915c50c29b
* Begin restructuring installation docs See RFD 246 The documentation in the Installation section is currently organized by platform while documentation for deploying Teleport components is organized elsewhere. This creates confusion for users, who visit the Installation docs far more often than any other section, missing critical instructions. This change modifies the Installation section to include four children: - Deploying Teleport Agents - Installing Teleport on a single machine - Uninstalling Teleport - An external link to the Download page, the fastest way to download Teleport client tools. Implementation details: - Remove the `amazon-ec2.mdx` installation guide. This has to do with cluster installation, not single-machine installation. Move AMI information into the EC2 Terraform guides, which a separate change will add to the Installation section. Also remove `helm.mdx` from the single-machine section, where it does not belong. A separate change will add our Helm guides to the Installation section. - Move `amazon-ecs.mdx` to the `agents` directory. It's a guide for deploying Teleport Agents. - Remove `windows.mdx`, which only pertains to clients, in favor of making the Download page more visible in the Installation section. This change also adds some structural improvements to the `linux.mdx` guide: - Organize section introductiosn to create a clearer hierarchy between more general and more specific information. Readers now read more general information first. - Move the item re: recommending Cloud to the top of the page. - Rework the control plane section. Remove the tab for Teleport Cloud, which is unnecessary since the section isn't for cloud customers. Add stepped instructions to consolidate the text a bit. - Include clearer branching in the TAR and package download section between self-hosted and agent use cases. Move the branching between FIPS and standard installations higher in the section for clarity. * Fix links after reorganizing installation docs * Clean up installation instructions Responds to **GavinFrazar** feedback: - Make the Installation section description more precise. - Extract the Teleport AMI list into a partial. * Fix clarity issues in the Installation section - In the landing page, provide a clearer route for users interested in self-hosting Teleport Community Edition. - Restore the Windows guide so we have consistent installation instructions for all supported platforms. Accordingly, update the `docs/pages/installation/single-machine` landing page to indicate that this section also pertains to client tools. - Place the Amazon EC2 guide in the Single Machine subsection and include the partial that lists AMIs. Replace the single H2 with an Admonition for clarity. Fix redirects accordingly. - Move "Downloads" to the end of the Installation sidebar section. Clarify the purpose of the link. - Include `fdpass-teleport` in the table of installed binaries. - Use "control plane" instead of "cluster" to describe the Auth Service and Proxy Service in the single-machine.mdx index page.
251 lines
5.6 KiB
JSON
251 lines
5.6 KiB
JSON
{
|
|
"docs": [
|
|
{
|
|
"type": "category",
|
|
"label": "Introduction",
|
|
"collapsible": true,
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "index"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "category",
|
|
"label": "Get Started",
|
|
"collapsible": true,
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "get-started/get-started"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "category",
|
|
"label": "Step 1: Deploy a Cluster",
|
|
"collapsible": true,
|
|
"items": [
|
|
{
|
|
"type": "doc",
|
|
"id": "get-started/deploy-cloud",
|
|
"label": "Enterprise Cloud"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"id": "get-started/deploy-community",
|
|
"label": "Community Edition (Linux Demo)"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"id": "get-started/connect",
|
|
"label": "Step 2: Connect Infrastructure"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"id": "get-started/access",
|
|
"label": "Step 3: Set Up Access Controls"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"id": "get-started/audit",
|
|
"label": "Step 4: Monitor Audit Logs"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "Core Concepts",
|
|
"id": "core-concepts"
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "Installation",
|
|
"collapsible": true,
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "installation"
|
|
},
|
|
{
|
|
"type": "link",
|
|
"label": "Downloads",
|
|
"href": "https://goteleport.com/download"
|
|
}
|
|
],
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "installation/installation"
|
|
}
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "Upgrading",
|
|
"collapsible": true,
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "upgrading"
|
|
}
|
|
],
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "upgrading/upgrading"
|
|
}
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "Migrate Teleport Plans",
|
|
"id": "migrate-plans"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "Quick Links",
|
|
"collapsible": true,
|
|
"items": [
|
|
{
|
|
"type": "doc",
|
|
"label": "Teleport Feature Matrix",
|
|
"id": "feature-matrix"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "FAQ",
|
|
"id": "faq"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "Teleport Cloud FAQ",
|
|
"id": "cloud-faq"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "Usage Reporting and Billing",
|
|
"id": "usage-billing"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "Upcoming Releases",
|
|
"id": "upcoming-releases"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "Cloud IP Addresses",
|
|
"id": "ips"
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "Changelog",
|
|
"id": "changelog"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "doc",
|
|
"label": "Agentic Identity Framework",
|
|
"id": "agentic-identity-framework",
|
|
"customProps": { "tag": "new" }
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "User Guides",
|
|
"collapsible": true,
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "connect-your-client/connect-your-client"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "connect-your-client"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "Zero Trust Access",
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "zero-trust-access/zero-trust-access"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "zero-trust-access"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "Machine & Workload Identity",
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "machine-workload-identity/machine-workload-identity"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "machine-workload-identity"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "Identity Governance",
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "identity-governance/identity-governance"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "identity-governance"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "Identity Security",
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "identity-security/identity-security"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "identity-security"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "Enroll Resources",
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "enroll-resources/enroll-resources"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "enroll-resources"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"label": "References",
|
|
"link": {
|
|
"type": "doc",
|
|
"id": "reference/reference"
|
|
},
|
|
"items": [
|
|
{
|
|
"type": "autogenerated",
|
|
"dirName": "reference"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|