Skip to content

Commit 7a477f1

Browse files
authored
Consolidate Reference docs section contents (#59082)
Backports #58248 * Consolidate Reference docs section contents Closes #56206 Reduce the number of first-level children in the Reference section of the docs from 23 to 9, not counting the index page available at `/docs/reference/`. This makes the Reference section easier to navigate, since a user can more readily form a mental model of the content available in the section with fewer items and a more thematic organization. - Add a section for deployment references, consolidating reference guides for configuring and architecting a Teleport deployment. - Move the Predicate Language and User Types references into the Access Controls section of References. - Add a section for API reference guides, consolidating the Terraform, MWI Terraform, and Operator sections. - Move Cloud FAQ to Quick Links. This places the guide next to the main FAQ in the sidebar to make it more discoverable, since the guide is currently rather hidden. This also helps pave the way to merge the two FAQs in the future. * Add an MWI reference section The MWI Terraform module reference does not belong with reference guides for API clients. Add a section to the reference guide for Machine & Workload Identity. * Rename "API" to "Infrastructure as Code" Teleport users expect tctl, Operator, and Terraform Provider docs to be in an Infrastructure as Code reference section, rather than the more vague "API" section. Responds to **ravicious** feedback.
1 parent 59f5cca commit 7a477f1

File tree

300 files changed

+1130
-453
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

300 files changed

+1130
-453
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -745,3 +745,4 @@ or `alpn-ping` as upgrade types was left as a fallback until v17.
745745

746746
Teleport v18 removes the legacy upgrade mode entirely including the use of the
747747
`TELEPORT_TLS_ROUTING_CONN_UPGRADE_MODE` environment variable.
748+

docs/config.json

Lines changed: 614 additions & 19 deletions
Large diffs are not rendered by default.

docs/cspell.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1118,8 +1118,8 @@
11181118
"hte"
11191119
],
11201120
"ignorePaths": [
1121-
"**/reference/terraform-provider/**",
1122-
"**/reference/operator-resources/**",
1121+
"**/reference/infrastructure-as-code/terraform-provider/**",
1122+
"**/reference/infrastructure-as-code/operator-resources/**",
11231123
"**/includes/reference/code-blocks-no-cspell/**"
11241124
]
11251125
}

docs/pages/reference/cloud-faq.mdx renamed to docs/pages/cloud-faq.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags:
99

1010
This page provides answers to frequently asked questions about Teleport
1111
Enterprise (Cloud). For a list of frequently asked questions about Teleport in
12-
general, see [Frequently Asked Questions](../faq.mdx).
12+
general, see [Frequently Asked Questions](faq.mdx).
1313

1414
## Billing and usage
1515

@@ -29,7 +29,7 @@ If you plan to use S3 and DynamoDB as storage backends, we can provide data for
2929

3030
### How long will Teleport Enterprise Cloud retain my data?
3131

32-
See our documentation on [data retention](architecture/teleport-cloud-architecture.mdx).
32+
See our documentation on [data retention](reference/architecture/teleport-cloud-architecture.mdx).
3333

3434
### Is an independent security audit available?
3535

@@ -51,18 +51,18 @@ for customer data including session recordings and user records.
5151

5252
### Can I get a list of IP addresses that my infrastructure will need to allow connections to?
5353

54-
See the [Public IP Address Allowlist](../ips.mdx) for the list of IP addresses used for inbound connections to Teleport Enterprise Cloud.
54+
See the [Public IP Address Allowlist](ips.mdx) for the list of IP addresses used for inbound connections to Teleport Enterprise Cloud.
5555

5656
### Can I configure a list of IP addresses which are allowed to connect to Teleport Enterprise Cloud?
5757

5858
We do not have plans to offer support for inbound connection IP allowlists.
5959

60-
We believe mTLS with strong user and [device identity](../identity-governance/device-trust/guide.mdx) provides the best available
60+
We believe mTLS with strong user and [device identity](identity-governance/device-trust/guide.mdx) provides the best available
6161
security for client authentication.
6262

6363
For customers that require IP-based control for compliance purposes, we do
6464
support IP Pinning. For more information see `pin_source_ip` in our [Teleport
65-
Access Controls Reference](access-controls/roles.mdx).
65+
Access Controls Reference](reference/access-controls/roles.mdx).
6666

6767
### Are internal connections encrypted / authenticated?
6868

@@ -74,7 +74,7 @@ S3, are established using encryption provided by AWS, both at rest and in transi
7474

7575
You can connect servers, Kubernetes clusters, databases, desktops, and
7676
applications using [reverse
77-
tunnels](../enroll-resources/agents/agents.mdx).
77+
tunnels](enroll-resources/agents/agents.mdx).
7878

7979
There is no need to open any ports on your infrastructure for inbound traffic.
8080

@@ -88,7 +88,7 @@ If you plan on connecting more than 10,000 nodes or agents, please contact your
8888
### Are dynamic node tokens available?
8989

9090
After [connecting](#how-can-i-access-the-tctl-admin-tool) `tctl` to Teleport Enterprise Cloud, users can generate
91-
[dynamic tokens](../enroll-resources/agents/join-token.mdx):
91+
[dynamic tokens](enroll-resources/agents/join-token.mdx):
9292

9393
```code
9494
$ tctl nodes add --ttl=5m --roles=node,proxy --token=$(uuid)
@@ -98,7 +98,7 @@ $ tctl nodes add --ttl=5m --roles=node,proxy --token=$(uuid)
9898

9999
### How can I access the `tctl` admin tool?
100100

101-
Find the appropriate download at [Installation](../installation/installation.mdx).
101+
Find the appropriate download at [Installation](installation/installation.mdx).
102102

103103
After downloading the tools, first log in to your cluster using `tsh`, then use `tctl` remotely:
104104

@@ -120,11 +120,11 @@ $ tctl tokens add --type=node
120120

121121
### Is there a way to forward Teleport Enterprise Cloud audit events to my company's internal Security Information and Event Management (SIEM)?
122122

123-
Yes. We recommend Teleport's [event handler plugin](../zero-trust-access/export-audit-events/fluentd.mdx) to export Teleport Enterprise Cloud audit events.
123+
Yes. We recommend Teleport's [event handler plugin](zero-trust-access/export-audit-events/fluentd.mdx) to export Teleport Enterprise Cloud audit events.
124124

125125
### Is it possible to store audit logs and session recordings in my own S3 bucket?
126126

127-
Yes, you can configure [External Audit Storage](../zero-trust-access/management/external-audit-storage.mdx).
127+
Yes, you can configure [External Audit Storage](zero-trust-access/management/external-audit-storage.mdx).
128128

129129
### Is it possible to enable proxy recording mode?
130130

@@ -141,12 +141,12 @@ The ability to download recordings for offline viewing will be available in a fu
141141
If you have Teleport Agents connected to a Teleport Enterprise Cloud cluster
142142
that are more than one major version behind, you might experience compatibility
143143
issues unless your Teleport Agents are enrolled in automatic updates. See the [Upgrading
144-
Overview](../upgrading/overview.mdx) for more information.
144+
Overview](upgrading/overview.mdx) for more information.
145145

146146
To get version information for your Teleport Agents, see [How can I find version information on
147147
connected agents?](#how-can-i-find-version-information-on-connected-agents).
148148

149-
If you want more details about cluster updates, see [Cloud Cluster Updates](../upgrading/cloud-cluster-updates.mdx).
149+
If you want more details about cluster updates, see [Cloud Cluster Updates](upgrading/cloud-cluster-updates.mdx).
150150

151151
For more information about automatic updates and compatibility issues, contact
152152
[Teleport support](https://goteleport.com/support/).
@@ -165,7 +165,7 @@ connected agents?](#how-can-i-find-version-information-on-connected-agents) for
165165

166166
### Are updates times configurable for Teleport Enterprise Cloud?
167167

168-
Yes, see [Cloud Cluster Updates](../upgrading/cloud-cluster-updates.mdx#maintenance-windows) for further instruction.
168+
Yes, see [Cloud Cluster Updates](upgrading/cloud-cluster-updates.mdx#maintenance-windows) for further instruction.
169169

170170
### When are agents automatically updated?
171171

@@ -177,7 +177,7 @@ update the software when new versions are found.
177177
If you enroll in automatic agent updates, Teleport Agents are automatically
178178
updated after your Teleport cluster is updated during your scheduled maintenance
179179
period. For more information, read the [Automatic Agent
180-
Updates](../upgrading/agent-managed-updates.mdx) guide.
180+
Updates](upgrading/agent-managed-updates.mdx) guide.
181181

182182
### How can I find version information on connected agents?
183183

@@ -239,7 +239,7 @@ than through a port allocated to that service.
239239
In this case, you can see that TLS routing is enabled, and that the Proxy
240240
Service's public web address (`ssh.public_addr`) is `example.teleport.sh:443`.
241241

242-
Read more in our [TLS Routing](architecture/tls-routing.mdx) guide.
242+
Read more in our [TLS Routing](reference/architecture/tls-routing.mdx) guide.
243243

244244
### How does Teleport manage web certificates? Can I upload my own?
245245

@@ -250,7 +250,7 @@ certificate or use a custom domain name.
250250
### Where does Teleport Enterprise Cloud run?
251251

252252
Teleport Cloud runs on Amazon Web Services (AWS). We run proxies in a variety
253-
of regions all over the world, and allow customers to [select the region](architecture/teleport-cloud-architecture.mdx) where the data is stored.
253+
of regions all over the world, and allow customers to [select the region](reference/architecture/teleport-cloud-architecture.mdx) where the data is stored.
254254

255255
### Are you using AWS-managed encryption keys, or CMKs via KMS?
256256

@@ -260,7 +260,7 @@ We use AWS-managed keys. Currently there is no option to provide your own key.
260260

261261
It's a Teleport-managed S3 bucket with AWS-managed keys by default.
262262

263-
Configuring [External Audit Storage](../zero-trust-access/management/external-audit-storage.mdx) will allow
263+
Configuring [External Audit Storage](zero-trust-access/management/external-audit-storage.mdx) will allow
264264
you to use your own S3 bucket.
265265

266266
### Is IPv6 Supported for connections to Teleport Enterprise Cloud?
@@ -315,7 +315,7 @@ When you sign up for a Teleport Enterprise (Cloud) account and set up your first
315315
user within the account, the Teleport Web UI displays a set of recovery codes:
316316

317317
![Web UI view showing Teleport recovery
318-
codes](../../img/cloud/recovery-codes.png)
318+
codes](../img/cloud/recovery-codes.png)
319319

320320
Save the recovery codes into a safe location, such as your organization's
321321
password manager. You can use these codes to reset your account if you lose

docs/pages/connect-your-client/tsh.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1136,7 +1136,7 @@ proxy_templates:
11361136
In the configuration above, `query` accepts an predicate expression. This has
11371137
priority over search but will be ignored if a host is provided. See the
11381138
[predicate language
1139-
documentation](../reference/predicate-language.mdx#resource-filtering) for
1139+
documentation](../reference/access-controls/predicate-language.mdx#resource-filtering) for
11401140
predicate expression examples.
11411141

11421142
`tsh -J {{proxy}} ssh` and `tsh -J {{proxy}} proxy ssh` will attempt to match the

docs/pages/core-concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ A **configuration resource** is a document stored on the **Teleport Auth
194194
Service** backend that specifies settings for your **Teleport cluster**.
195195
Examples include **roles**, **local users**, and **authentication connectors**
196196

197-
Read more in our [resource reference](./reference/resources.mdx).
197+
Read more in our [resource reference](reference/infrastructure-as-code/resources.mdx).
198198

199199
### Role
200200

docs/pages/enroll-resources/agents/add-service-to-agent.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,9 +253,9 @@ While this guide shows you how to create a token using `tctl`, you can also
253253
manage tokens using the Teleport Terraform provider or Kubernetes operator. See
254254
the following documentation for information on the token resource:
255255
- [Terraform
256-
provider](../../reference/terraform-provider/resources/provision_token.mdx)
256+
provider](../../reference/infrastructure-as-code/terraform-provider/resources/provision_token.mdx)
257257
- [Kubernetes
258-
operator](../../reference/operator-resources/resources-teleport-dev-provisiontokens.mdx)
258+
operator](../../reference/infrastructure-as-code/operator-resources/resources-teleport-dev-provisiontokens.mdx)
259259

260260
You can set up a system to automate the process of assigning join tokens to
261261
agents, ensuring that all Teleport services you run have the correct join

docs/pages/enroll-resources/auto-discovery/databases/databases.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Here's how it works in detail:
151151

152152
For more information about Discovery Service configuration, refer to
153153
[one of the guides above](#supported-clouds) or the
154-
[Discovery Service Config File Reference](../../../reference/config.mdx).
154+
[Discovery Service Config File Reference](../../../reference/deployment/config.mdx).
155155

156156
## How the Database Service works
157157

docs/pages/enroll-resources/auto-discovery/servers/azure-discovery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,4 +314,4 @@ logs can be found on the targeted VM at
314314
- Read [Joining Nodes via Azure Managed Identity](../../agents/azure.mdx)
315315
for more information on Azure tokens.
316316
- Full documentation on Azure discovery configuration can be found through the [
317-
config file reference documentation](../../../reference/config.mdx).
317+
config file reference documentation](../../../reference/deployment/config.mdx).

docs/pages/enroll-resources/auto-discovery/servers/gcp-discovery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,4 +304,4 @@ for details on alternate methods.
304304
- Read [Joining Services via GCP](../../agents/gcp.mdx)
305305
for more information on GCP tokens.
306306
- Full documentation on GCP discovery configuration can be found through the [
307-
config file reference documentation](../../../reference/config.mdx).
307+
config file reference documentation](../../../reference/deployment/config.mdx).

0 commit comments

Comments
 (0)