Skip to content

Commit cdd7bb2

Browse files
ptgottptgott
authored
Fix outdated docs URLs (#51132)
Backports #50923 - Web UI source - README - lib - api Do not touch docs URLs in test case names or test data where we don't expect users to navigate to the URLs.
1 parent c20d654 commit cdd7bb2

File tree

49 files changed

+129
-123
lines changed

Some content is hidden

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

49 files changed

+129
-123
lines changed

‎README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Here is why you might use Teleport:
1212

1313
Teleport works with SSH, Kubernetes, databases, RDP, and web services.
1414

15-
* Architecture: https://goteleport.com/docs/reference/architecture/architecture
16-
* Getting Started: https://goteleport.com/docs/getting-started/
15+
* Architecture: https://goteleport.com/docs/reference/architecture/
16+
* Getting Started: https://goteleport.com/docs/get-started/
1717

1818
<div align="center">
1919
<a href="https://goteleport.com/download">
@@ -62,7 +62,7 @@ We have implemented Teleport as a single Go binary that integrates with multiple
6262
* [Windows Hosts](https://goteleport.com/docs/desktop-access/introduction/).
6363
* [Networked servers](https://goteleport.com/docs/server-access/introduction/).
6464

65-
You can set up Teleport as a [Linux daemon](https://goteleport.com/docs/#set-up-a-demo-cluster) or a [Kubernetes deployment](https://goteleport.com/docs/deploy-a-cluster/helm-deployments/).
65+
You can set up Teleport as a [Linux daemon](https://goteleport.com/docs/admin-guides/deploy-a-cluster/linux-demo) or a [Kubernetes deployment](https://goteleport.com/docs/admin-guides/deploy-a-cluster/helm-deployments/).
6666

6767
Teleport focuses on best practices for infrastructure security:
6868

@@ -98,7 +98,7 @@ deployment that makes it easier to enable secure access to your infrastructure.
9898
Cloud.
9999

100100
Follow our guide to [registering your first
101-
server](https://goteleport.com/docs/choose-an-edition/teleport-cloud/get-started/)
101+
server](https://goteleport.com/docs/get-started/)
102102
with Teleport Enterprise Cloud.
103103

104104
## Docker
@@ -360,9 +360,10 @@ We had a choice, either start a security consulting business or build a solution
360360
361361
## More Information
362362
363-
* [Teleport Getting Started](https://goteleport.com/docs/getting-started/)
364-
* [Teleport Architecture](https://goteleport.com/teleport/docs/architecture)
365-
* [Reference](https://goteleport.com/docs/reference)
363+
* [Teleport Getting Started](https://goteleport.com/docs/get-started/)
364+
* [Teleport
365+
Architecture](https://goteleport.com/teleport/docs/architecture/introduction)
366+
* [Reference](https://goteleport.com/docs/reference/)
366367
* [FAQ](https://goteleport.com/docs/faq)
367368
368369
## Support and Contributing

‎api/client/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ This package is documented using a combination of [pkg.go.dev](https://pkg.go.de
22

33
## Reference
44

5-
- [Introduction](https://goteleport.com/docs/reference/api/introduction/)
6-
- [Getting Started](https://goteleport.com/docs/reference/api/getting-started/)
7-
- [Architecture](https://goteleport.com/docs/reference/api/architecture/)
5+
- [Introduction](https://goteleport.com/docs/admin-guides/api/)
6+
- [Getting Started](https://goteleport.com/docs/admin-guides/api/getting-started/)
7+
- [Architecture](https://goteleport.com/docs/reference/architecture/api-architecture/)
88
- [pkg.go.dev](https://pkg.go.dev/github.com/gravitational/teleport/api/client/)
99
- [Using the client](https://pkg.go.dev/github.com/gravitational/teleport/api/client#Client/)
1010
- [Working with credentials](https://pkg.go.dev/github.com/gravitational/teleport/api/client#Credentials/)

‎api/types/authentication.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ func (c *AuthPreferenceV2) SetConnectorName(cn string) {
370370
// GetU2F gets the U2F configuration settings.
371371
func (c *AuthPreferenceV2) GetU2F() (*U2F, error) {
372372
if c.Spec.U2F == nil {
373-
return nil, trace.NotFound("U2F is not configured in this cluster, please contact your administrator and ask them to follow https://goteleport.com/docs/access-controls/guides/u2f/")
373+
return nil, trace.NotFound("U2F is not configured in this cluster")
374374
}
375375
return c.Spec.U2F, nil
376376
}
@@ -382,7 +382,7 @@ func (c *AuthPreferenceV2) SetU2F(u2f *U2F) {
382382

383383
func (c *AuthPreferenceV2) GetWebauthn() (*Webauthn, error) {
384384
if c.Spec.Webauthn == nil {
385-
return nil, trace.NotFound("Webauthn is not configured in this cluster, please contact your administrator and ask them to follow https://goteleport.com/docs/access-controls/guides/webauthn/")
385+
return nil, trace.NotFound("Webauthn is not configured in this cluster, please contact your administrator and ask them to follow https://goteleport.com/docs/admin-guides/access-controls/guides/webauthn/")
386386
}
387387
return c.Spec.Webauthn, nil
388388
}
@@ -587,7 +587,7 @@ func (c *AuthPreferenceV2) CheckAndSetDefaults() error {
587587
const deprecationMessage = `` +
588588
`Second Factor "u2f" is deprecated and marked for removal, using "webauthn" instead. ` +
589589
`Please update your configuration to use WebAuthn. ` +
590-
`Refer to https://goteleport.com/docs/access-controls/guides/webauthn/`
590+
`Refer to https://goteleport.com/docs/admin-guides/access-controls/guides/webauthn/`
591591
slog.WarnContext(context.Background(), deprecationMessage)
592592
c.Spec.SecondFactor = constants.SecondFactorWebauthn
593593
}

‎lib/auth/auth_with_roles.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -5503,7 +5503,7 @@ func (a *ServerWithRoles) GenerateSnowflakeJWT(ctx context.Context, req *proto.S
55035503
if err := a.canImpersonateBuiltinRole(types.RoleDatabase); err != nil {
55045504
log.WithError(err).Warnf("User %v tried to generate database certificate but is not allowed to impersonate %q system role.",
55055505
a.context.User.GetName(), types.RoleDatabase)
5506-
return nil, trace.AccessDenied(`access denied. The user must be able to impersonate the builtin role and user "Db" in order to generate database certificates, for more info see https://goteleport.com/docs/database-access/reference/cli/#tctl-auth-sign.`)
5506+
return nil, trace.AccessDenied(`access denied. The user must be able to impersonate the builtin role and user "Db" in order to generate database certificates, for more info see https://goteleport.com/docs/reference/agent-services/database-access-reference/cli/#tctl-auth-sign.`)
55075507
}
55085508
}
55095509
return a.authServer.GenerateSnowflakeJWT(ctx, req)

‎lib/auth/init.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -702,7 +702,7 @@ func initializeAuthority(ctx context.Context, asrv *Server, caID types.CertAuthI
702702
if numKeyTypes > 1 {
703703
log.Warnf("%s CA contains a combination of %s and %s keys. If you are attempting to"+
704704
" configure HSM or KMS key storage, make sure it is configured on all auth servers in"+
705-
" this cluster and then perform a CA rotation: https://goteleport.com/docs/management/operations/ca-rotation/",
705+
" this cluster and then perform a CA rotation: https://goteleport.com/docs/admin-guides/management/operations/ca-rotation/",
706706
caID.Type, strings.Join(allKeyTypes[:numKeyTypes-1], ", "), allKeyTypes[numKeyTypes-1])
707707
}
708708

@@ -751,7 +751,7 @@ auth_service:
751751
rp_id: example.com
752752
753753
For more information:
754-
- https://goteleport.com/docs/access-controls/guides/webauthn/
754+
- https://goteleport.com/docs/admin-guides/access-controls/guides/webauthn/
755755
`
756756

757757
func initializeAuthPreference(ctx context.Context, asrv *Server, newAuthPref types.AuthPreference) error {

‎lib/auth/rotate.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -619,7 +619,7 @@ func (a *Server) syncUsableKeysAlert(ctx context.Context, usableKeysResults map[
619619
msg += "The Auth Service will continue signing certificates with raw software keys. "
620620
}
621621
msg += "These CAs must be rotated to begin using the configured key type. " +
622-
"See https://goteleport.com/docs/management/operations/ca-rotation/"
622+
"See https://goteleport.com/docs/admin-guides/management/operations/ca-rotation/"
623623

624624
alert, err := types.NewClusterAlert("ca-key-types/"+a.ServerID, msg, alertOptions...)
625625
if err != nil {

‎lib/client/db/dbcmd/error.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func ConvertCommandError(cmd *exec.Cmd, err error, peakStderr string) error {
5252
if strings.Contains(lowerCaseStderr, "access to db denied") {
5353
fmtString := "%v: '%s' exited with the above error. Use 'tsh db ls' to see your available logins, " +
5454
"or ask your Teleport administrator to grant you access." +
55-
"\nSee https://goteleport.com/docs/database-access/troubleshooting/#access-to-db-denied for more information."
55+
"\nSee https://goteleport.com/docs/enroll-resources/database-access/troubleshooting/#access-to-db-denied for more information."
5656
return trace.AccessDenied(fmtString, err, cmd.Path)
5757
}
5858
return trace.Wrap(err)

‎lib/config/configuration_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -2611,7 +2611,7 @@ func TestAppsCLF(t *testing.T) {
26112611
outApps: nil,
26122612
requireError: func(t require.TestingT, err error, i ...interface{}) {
26132613
require.True(t, trace.IsBadParameter(err))
2614-
require.ErrorContains(t, err, "application name \"-foo\" must be a valid DNS subdomain: https://goteleport.com/docs/application-access/guides/connecting-apps/#application-name")
2614+
require.ErrorContains(t, err, "application name \"-foo\" must be a valid DNS subdomain: https://goteleport.com/docs/enroll-resources/application-access/guides/connecting-apps/#application-name")
26152615
},
26162616
},
26172617
{

‎lib/config/database.go

+20-25
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ var databaseConfigTemplateFuncs = template.FuncMap{
4343
// databaseAgentConfigurationTemplate database configuration template.
4444
var databaseAgentConfigurationTemplate = template.Must(template.New("").Funcs(databaseConfigTemplateFuncs).Parse(`#
4545
# Teleport database agent configuration file.
46-
# Configuration reference: https://goteleport.com/docs/database-access/reference/configuration/
46+
# Configuration reference: https://goteleport.com/docs/reference/agent-services/database-access-reference/configuration/
4747
#
4848
version: v3
4949
teleport:
@@ -62,7 +62,7 @@ db_service:
6262
enabled: true
6363
6464
# Matchers for database resources created with "tctl create" command or by the discovery service.
65-
# For more information about dynamic registration: https://goteleport.com/docs/database-access/guides/dynamic-registration/
65+
# For more information about dynamic registration: https://goteleport.com/docs/enroll-resources/database-access/guides/dynamic-registration/
6666
{{- if .DynamicResourcesLabels }}
6767
resources:
6868
{{- range $index, $resourceLabel := .DynamicResourcesLabels }}
@@ -97,12 +97,7 @@ db_service:
9797
aws:
9898
{{- else }}
9999
# For more information about AWS auto-discovery:
100-
# RDS/Aurora: https://goteleport.com/docs/database-access/guides/rds/
101-
# RDS Proxy: https://goteleport.com/docs/database-access/guides/rdsproxy/
102-
# Redshift: https://goteleport.com/docs/database-access/guides/postgres-redshift/
103-
# Redshift Serverless: https://goteleport.com/docs/database-access/guides/postgres-redshift-serverless/
104-
# ElastiCache/MemoryDB: https://goteleport.com/docs/database-access/guides/redis-aws/
105-
# OpenSearch: https://goteleport.com/docs/database-access/guides/aws-opensearch/
100+
# https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
106101
#
107102
# aws:
108103
# # Database types. Valid options are:
@@ -122,7 +117,7 @@ db_service:
122117
{{- end }}
123118
{{- if .RDSDiscoveryRegions }}
124119
# RDS/Aurora databases auto-discovery.
125-
# For more information about RDS/Aurora auto-discovery: https://goteleport.com/docs/database-access/guides/rds/
120+
# For more information about RDS/Aurora auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
126121
- types: ["rds"]
127122
# AWS regions to register databases from.
128123
regions:
@@ -137,7 +132,7 @@ db_service:
137132
{{- end }}
138133
{{- if .RDSProxyDiscoveryRegions }}
139134
# RDS Proxies auto-discovery.
140-
# For more information about RDS Proxy auto-discovery: https://goteleport.com/docs/database-access/guides/rdsproxy/
135+
# For more information about RDS Proxy auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
141136
- types: ["rdsproxy"]
142137
# AWS regions to register databases from.
143138
regions:
@@ -152,7 +147,7 @@ db_service:
152147
{{- end }}
153148
{{- if .RedshiftDiscoveryRegions }}
154149
# Redshift databases auto-discovery.
155-
# For more information about Redshift auto-discovery: https://goteleport.com/docs/database-access/guides/postgres-redshift/
150+
# For more information about Redshift auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
156151
- types: ["redshift"]
157152
# AWS regions to register databases from.
158153
regions:
@@ -167,7 +162,7 @@ db_service:
167162
{{- end }}
168163
{{- if .RedshiftServerlessDiscoveryRegions }}
169164
# Redshift Serverless databases auto-discovery.
170-
# For more information about Redshift Serverless auto-discovery: https://goteleport.com/docs/database-access/guides/postgres-redshift-serverless/
165+
# For more information about Redshift Serverless auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
171166
- types: ["redshift-serverless"]
172167
# AWS regions to register databases from.
173168
regions:
@@ -182,7 +177,7 @@ db_service:
182177
{{- end }}
183178
{{- if .ElastiCacheDiscoveryRegions }}
184179
# ElastiCache databases auto-discovery.
185-
# For more information about ElastiCache auto-discovery: https://goteleport.com/docs/database-access/guides/redis-aws/
180+
# For more information about ElastiCache auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
186181
- types: ["elasticache"]
187182
# AWS regions to register databases from.
188183
regions:
@@ -197,7 +192,7 @@ db_service:
197192
{{- end }}
198193
{{- if .MemoryDBDiscoveryRegions }}
199194
# MemoryDB databases auto-discovery.
200-
# For more information about MemoryDB auto-discovery: https://goteleport.com/docs/database-access/guides/redis-aws/
195+
# For more information about MemoryDB auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
201196
- types: ["memorydb"]
202197
# AWS regions to register databases from.
203198
regions:
@@ -212,7 +207,7 @@ db_service:
212207
{{- end }}
213208
{{- if .OpenSearchDiscoveryRegions }}
214209
# OpenSearch databases auto-discovery.
215-
# For more information about OpenSearch auto-discovery: https://goteleport.com/docs/database-access/guides/aws-opensearch/
210+
# For more information about OpenSearch auto-discovery: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
216211
- types: ["opensearch"]
217212
# AWS regions to register databases from.
218213
regions:
@@ -231,9 +226,9 @@ db_service:
231226
azure:
232227
{{- else }}
233228
# For more information about Azure auto-discovery:
234-
# MySQL/PostgreSQL: https://goteleport.com/docs/database-access/guides/azure-postgres-mysql/
235-
# Redis: https://goteleport.com/docs/database-access/guides/azure-redis/
236-
# SQL Server: https://goteleport.com/docs/database-access/guides/azure-sql-server-ad/
229+
# MySQL/PostgreSQL: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-postgres-mysql/
230+
# Redis: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-redis/
231+
# SQL Server: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-sql-server-ad/
237232
#
238233
# azure:
239234
# # Database types. Valid options are:
@@ -257,7 +252,7 @@ db_service:
257252
{{- end }}
258253
{{- if or .AzureMySQLDiscoveryRegions }}
259254
# Azure MySQL databases auto-discovery.
260-
# For more information about Azure MySQL auto-discovery: https://goteleport.com/docs/database-access/guides/azure-postgres-mysql/
255+
# For more information about Azure MySQL auto-discovery: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-postgres-mysql/
261256
- types: ["mysql"]
262257
# Azure subscription IDs to match.
263258
subscriptions:
@@ -282,7 +277,7 @@ db_service:
282277
{{- end }}
283278
{{- if or .AzurePostgresDiscoveryRegions }}
284279
# Azure Postgres databases auto-discovery.
285-
# For more information about Azure Postgres auto-discovery: https://goteleport.com/docs/database-access/guides/azure-postgres-mysql/
280+
# For more information about Azure Postgres auto-discovery: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-postgres-mysql/
286281
- types: ["postgres"]
287282
# Azure subscription IDs to match.
288283
subscriptions:
@@ -307,7 +302,7 @@ db_service:
307302
{{- end }}
308303
{{- if or .AzureRedisDiscoveryRegions }}
309304
# Azure Cache For Redis databases auto-discovery.
310-
# For more information about Azure Cache for Redis auto-discovery: https://goteleport.com/docs/database-access/guides/azure-redis/
305+
# For more information about Azure Cache for Redis auto-discovery: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-redis/
311306
- types: ["redis"]
312307
# Azure subscription IDs to match.
313308
subscriptions:
@@ -332,7 +327,7 @@ db_service:
332327
{{- end }}
333328
{{- if or .AzureSQLServerDiscoveryRegions }}
334329
# Azure SQL server and Managed instances auto-discovery.
335-
# For more information about SQL server and Managed instances auto-discovery: https://goteleport.com/docs/database-access/guides/azure-sql-server-ad/
330+
# For more information about SQL server and Managed instances auto-discovery: https://goteleport.com/docs/enroll-resources/database-access/enroll-azure-databases/azure-sql-server-ad/
336331
- types: ["sqlserver"]
337332
# Azure subscription IDs to match.
338333
subscriptions:
@@ -453,7 +448,7 @@ db_service:
453448
#
454449
# databases:
455450
# # RDS database static configuration.
456-
# # RDS/Aurora databases Auto-discovery reference: https://goteleport.com/docs/database-access/guides/rds/
451+
# # RDS/Aurora databases Auto-discovery guide: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
457452
# - name: rds
458453
# description: AWS RDS/Aurora instance configuration example.
459454
# # Supported protocols for RDS/Aurora: "postgres" or "mysql"
@@ -469,7 +464,7 @@ db_service:
469464
# # RDS Instance ID. Only present on RDS databases.
470465
# instance_id: rds-instance-1
471466
# # Aurora database static configuration.
472-
# # RDS/Aurora databases Auto-discovery reference: https://goteleport.com/docs/database-access/guides/rds/
467+
# # RDS/Aurora databases Auto-discovery guide: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
473468
# - name: aurora
474469
# description: AWS Aurora cluster configuration example.
475470
# # Supported protocols for RDS/Aurora: "postgres" or "mysql"
@@ -485,7 +480,7 @@ db_service:
485480
# # Aurora Cluster ID. Only present on Aurora databases.
486481
# cluster_id: aurora-cluster-1
487482
# # Redshift database static configuration.
488-
# # For more information: https://goteleport.com/docs/database-access/guides/postgres-redshift/
483+
# # For more information: https://goteleport.com/docs/enroll-resources/auto-discovery/databases/aws/
489484
# - name: redshift
490485
# description: AWS Redshift cluster configuration example.
491486
# # Supported protocols for Redshift: "postgres".

‎lib/config/fileconf.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1149,7 +1149,7 @@ func (w *Webauthn) Parse() (*types.Webauthn, error) {
11491149
log.Warnf(`` +
11501150
`The "webauthn.disabled" setting is marked for removal and currently has no effect. ` +
11511151
`Please update your configuration to use WebAuthn. ` +
1152-
`Refer to https://goteleport.com/docs/access-controls/guides/webauthn/`)
1152+
`Refer to https://goteleport.com/docs/admin-guides/access-controls/guides/webauthn/`)
11531153
}
11541154
return &types.Webauthn{
11551155
// Allow any RPID to go through, we rely on

‎lib/devicetrust/native/device_linux.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func rewriteTPMPermissionError(err error) error {
111111
return errors.New("" +
112112
"Failed to open the TPM device. " +
113113
"Consider assigning the user to the `tss` group or creating equivalent udev rules. " +
114-
"See https://goteleport.com/docs/access-controls/device-trust/device-management/#troubleshooting.")
114+
"See https://goteleport.com/docs/admin-guides/access-controls/device-trust/device-management/#troubleshooting.")
115115
}
116116

117117
// cddFuncs is used to mock various data collection functions for testing.

‎lib/integrations/azureoidc/provision_sso.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ func setupSSO(ctx context.Context, graphClient *msgraph.Client, appObjectID stri
3131
preferredSingleSignOnMode := "saml"
3232
spPatch.PreferredSingleSignOnMode = &preferredSingleSignOnMode
3333
// Do not require explicit assignment of the app to use SSO.
34-
// This is per our manual set-up recommendations, see https://goteleport.com/docs/access-controls/sso/azuread/ .
34+
// This is per our manual set-up recommendations, see
35+
// https://goteleport.com/docs/admin-guides/access-controls/sso/azuread/ .
3536
appRoleAssignmentRequired := false
3637
spPatch.AppRoleAssignmentRequired = &appRoleAssignmentRequired
3738

0 commit comments

Comments
 (0)