From 225f133cc967f993ec51b0205b97b395d731181c Mon Sep 17 00:00:00 2001 From: Marco Dinis Date: Mon, 4 Nov 2024 15:53:14 +0000 Subject: [PATCH] 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. --- .../enroll-resources/auto-discovery/kubernetes/google-cloud.mdx | 2 ++ .../enroll-resources/auto-discovery/servers/azure-discovery.mdx | 1 + .../enroll-resources/auto-discovery/servers/ec2-discovery.mdx | 1 + .../enroll-resources/auto-discovery/servers/gcp-discovery.mdx | 1 + .../database-access/aws-troubleshooting-max-policy-size.mdx | 1 + docs/pages/includes/server-access/custom-installer.mdx | 1 + 6 files changed, 7 insertions(+) diff --git a/docs/pages/enroll-resources/auto-discovery/kubernetes/google-cloud.mdx b/docs/pages/enroll-resources/auto-discovery/kubernetes/google-cloud.mdx index b26f94f22566c..43a9eaa3d8161 100644 --- a/docs/pages/enroll-resources/auto-discovery/kubernetes/google-cloud.mdx +++ b/docs/pages/enroll-resources/auto-discovery/kubernetes/google-cloud.mdx @@ -396,6 +396,7 @@ ssh_service: enabled: off discovery_service: enabled: "yes" + discovery_group: "gke-myproject" gcp: - types: ["gke"] locations: ["*"] @@ -433,6 +434,7 @@ clusters in project `myproj-prod` running in `us-east2`, but *not* clusters in ```yaml discovery_service: enabled: "yes" + discovery_group: "gke-myproject" gcp: - types: ["gke"] locations: ["us-east1"] diff --git a/docs/pages/enroll-resources/auto-discovery/servers/azure-discovery.mdx b/docs/pages/enroll-resources/auto-discovery/servers/azure-discovery.mdx index e9fcc2fef6a7d..4196cfc159862 100644 --- a/docs/pages/enroll-resources/auto-discovery/servers/azure-discovery.mdx +++ b/docs/pages/enroll-resources/auto-discovery/servers/azure-discovery.mdx @@ -250,6 +250,7 @@ ssh_service: enabled: off discovery_service: enabled: "yes" + discovery_group: "azure-prod" azure: - types: ["vm"] subscriptions: [""] diff --git a/docs/pages/enroll-resources/auto-discovery/servers/ec2-discovery.mdx b/docs/pages/enroll-resources/auto-discovery/servers/ec2-discovery.mdx index c85ed32e1e98f..c6b25da60f1aa 100644 --- a/docs/pages/enroll-resources/auto-discovery/servers/ec2-discovery.mdx +++ b/docs/pages/enroll-resources/auto-discovery/servers/ec2-discovery.mdx @@ -133,6 +133,7 @@ ssh_service: enabled: off discovery_service: enabled: "yes" + discovery_group: "aws-prod" aws: - types: ["ec2"] regions: ["us-east-1","us-west-1"] diff --git a/docs/pages/enroll-resources/auto-discovery/servers/gcp-discovery.mdx b/docs/pages/enroll-resources/auto-discovery/servers/gcp-discovery.mdx index 3b050c5d9de26..6a351f169e2ff 100644 --- a/docs/pages/enroll-resources/auto-discovery/servers/gcp-discovery.mdx +++ b/docs/pages/enroll-resources/auto-discovery/servers/gcp-discovery.mdx @@ -246,6 +246,7 @@ ssh_service: enabled: off discovery_service: enabled: "yes" + discovery_group: "gcp-prod" gcp: - types: ["gce"] # The IDs of GCP projects that VMs can join from. diff --git a/docs/pages/includes/database-access/aws-troubleshooting-max-policy-size.mdx b/docs/pages/includes/database-access/aws-troubleshooting-max-policy-size.mdx index 55d0e8bad6a54..dd4017786888a 100644 --- a/docs/pages/includes/database-access/aws-troubleshooting-max-policy-size.mdx +++ b/docs/pages/includes/database-access/aws-troubleshooting-max-policy-size.mdx @@ -25,6 +25,7 @@ You can reduce the policy size by separating them into multiple IAM roles. Use configuration: ```yaml discovery_service: + discovery_group: "prod" enabled: "yes" aws: - types: ["rds"] diff --git a/docs/pages/includes/server-access/custom-installer.mdx b/docs/pages/includes/server-access/custom-installer.mdx index c3f1bdc309133..f3d5f3e987993 100644 --- a/docs/pages/includes/server-access/custom-installer.mdx +++ b/docs/pages/includes/server-access/custom-installer.mdx @@ -39,6 +39,7 @@ Multiple `installer` resources can exist and be specified in the ```yaml discovery_service: + discovery_group: prod {{ matcher }}: - types: {{ matchTypes }} tags: