Skip to content

Commit 8913bdd

Browse files
[v16] Docs: add discovery_group to teleport.yaml/discovery_service examples (#48826)
* Docs: add discovery_group to teleport.yaml/discovery_service examples When the discovery_group is not configured, teleport will log a warning message saying that it is recommended. Some configuration examples do not include it, so when users use that example to implement their own variation, it will output a warning message. After seeing that warning users might wonder if there's anything wrong with their `teleport.yaml`. Instead, we add a discovery_group to all examples so that users don't get that message. * explain discovery group * use partial instead
1 parent 6ee1422 commit 8913bdd

File tree

10 files changed

+18
-14
lines changed

10 files changed

+18
-14
lines changed

docs/pages/admin-guides/teleport-policy/integrations/aws-sync.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ that are set up with the `discovery_group` matching
8888
discovery_service:
8989
enabled: true
9090
discovery_group: <Var name="access-graph-disc" />
91-
9291
```
9392
9493
Notice that if you already operate a Discovery Service within your cluster,

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

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,6 @@ Here's an example database discovery configuration for the Discovery Service:
7373
```yaml
7474
discovery_service:
7575
enabled: true
76-
# discovery_group is used to group discovered resources into different
77-
# sets. This is required when you have multiple Teleport Discovery services
78-
# running. It prevents discovered services from colliding in Teleport when
79-
# managing discovered resources.
80-
# If two Discovery Services match the same resources, they must be in the
81-
# same discovery group.
82-
# If two Discovery Services match different resources, they must be in
83-
# different discovery groups.
8476
discovery_group: "disc-group"
8577
# poll_interval is the cadence at which the discovery server will run each of its
8678
# discovery cycles. The default is 5m.

docs/pages/enroll-resources/auto-discovery/kubernetes/google-cloud.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -396,6 +396,7 @@ ssh_service:
396396
enabled: off
397397
discovery_service:
398398
enabled: "yes"
399+
discovery_group: "gke-myproject"
399400
gcp:
400401
- types: ["gke"]
401402
locations: ["*"]
@@ -433,6 +434,7 @@ clusters in project `myproj-prod` running in `us-east2`, but *not* clusters in
433434
```yaml
434435
discovery_service:
435436
enabled: "yes"
437+
discovery_group: "gke-myproject"
436438
gcp:
437439
- types: ["gke"]
438440
locations: ["us-east1"]

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,6 @@ and their default values.
6262
# This section configures the Discovery Service
6363
discovery_service:
6464
enabled: "yes"
65-
# discovery_group is used to group discovered resources into different
66-
# sets. This is useful when you have multiple Teleport Discovery services
67-
# running in the same cluster but polling different cloud providers or cloud
68-
# accounts. It prevents discovered services from colliding in Teleport when
69-
# managing discovered resources.
7065
discovery_group: "prod"
7166
aws:
7267
# AWS resource types. Valid options are:

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,8 @@ the Discovery Service.
235235
In order to enable Azure instance discovery the `discovery_service.azure` section
236236
of `teleport.yaml` must include at least one entry:
237237

238+
(!docs/pages/includes/discovery/discovery-group.mdx!)
239+
238240
```yaml
239241
version: v3
240242
teleport:
@@ -250,6 +252,7 @@ ssh_service:
250252
enabled: off
251253
discovery_service:
252254
enabled: "yes"
255+
discovery_group: "azure-prod"
253256
azure:
254257
- types: ["vm"]
255258
subscriptions: ["<subscription>"]

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ run the Discovery Service.
118118
In order to enable EC2 instance discovery the `discovery_service.aws` section
119119
of `teleport.yaml` must include at least one entry:
120120

121+
(!docs/pages/includes/discovery/discovery-group.mdx!)
122+
121123
```yaml
122124
version: v3
123125
teleport:
@@ -133,6 +135,7 @@ ssh_service:
133135
enabled: off
134136
discovery_service:
135137
enabled: "yes"
138+
discovery_group: "aws-prod"
136139
aws:
137140
- types: ["ec2"]
138141
regions: ["us-east-1","us-west-1"]

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,8 @@ the Discovery Service.
231231
In order to enable GCP instance discovery the `discovery_service.gcp` section
232232
of `teleport.yaml` must include at least one entry:
233233

234+
(!docs/pages/includes/discovery/discovery-group.mdx!)
235+
234236
```yaml
235237
version: v3
236238
teleport:
@@ -246,6 +248,7 @@ ssh_service:
246248
enabled: off
247249
discovery_service:
248250
enabled: "yes"
251+
discovery_group: "gcp-prod"
249252
gcp:
250253
- types: ["gce"]
251254
# The IDs of GCP projects that VMs can join from.

docs/pages/includes/database-access/aws-troubleshooting-max-policy-size.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,12 @@ You can reduce the policy size by separating them into multiple IAM roles. Use
2323
<TabItem label="Auto-Discovery by Discovery Service">
2424
You can specify `assume_role_arn` in the AWS matchers of Discovery Service's
2525
configuration:
26+
27+
(!docs/pages/includes/discovery/discovery-group.mdx!)
28+
2629
```yaml
2730
discovery_service:
31+
discovery_group: "prod"
2832
enabled: "yes"
2933
aws:
3034
- types: ["rds"]

docs/pages/includes/server-access/custom-installer.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Multiple `installer` resources can exist and be specified in the
3939

4040
```yaml
4141
discovery_service:
42+
# ...
4243
{{ matcher }}:
4344
- types: {{ matchTypes }}
4445
tags:

docs/pages/reference/agent-services/kubernetes-application-discovery.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Discovery Service, then restart the agents running these services.
3737
Configuration for the Discovery Service is controlled by the `kubernetes` field,
3838
example:
3939

40+
(!docs/pages/includes/discovery/discovery-group.mdx!)
41+
4042
```yaml
4143
# This section configures the Discovery Service
4244
discovery_service:

0 commit comments

Comments
 (0)