diff --git a/docs/pages/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx b/docs/pages/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx index fa60093e599..0c82da06946 100644 --- a/docs/pages/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx +++ b/docs/pages/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform.mdx @@ -350,6 +350,22 @@ This setting should always be used unless you have a specific need to use separa For the simplest, cheapest deployment, enable both ACM and TLS routing to funnel all traffic through a single Application Load Balancer with an AWS-managed certificate. +### teleport_auth_type + +```code +$ export TF_VAR_teleport_auth_type="local" +``` + +This value can be used to change the default authentication type used for the Teleport cluster. This is useful for persisting a +default authentication type across AMI upgrades when you have a SAML, OIDC or GitHub connector configured in DynamoDB. +The default is `local`. + +- Teleport Community Edition supports `local` or `github` +- Teleport Enterprise Edition supports `local`, `github`, `oidc` or `saml` +- Teleport Enterprise FIPS deployments have local authentication disabled, so should use `github`, `oidc` or `saml` + +See the [Teleport authentication reference](../../reference/authentication.mdx) for more information. + ## Reference deployment defaults ### Instances diff --git a/docs/pages/deploy-a-cluster/deployments/aws-starter-cluster-terraform.mdx b/docs/pages/deploy-a-cluster/deployments/aws-starter-cluster-terraform.mdx index 05d02cd375a..297db08e246 100644 --- a/docs/pages/deploy-a-cluster/deployments/aws-starter-cluster-terraform.mdx +++ b/docs/pages/deploy-a-cluster/deployments/aws-starter-cluster-terraform.mdx @@ -363,6 +363,21 @@ This setting should always be used unless you have a specific need to use separa When using this `starter-cluster` deployment, if ACM is enabled, TLS routing will automatically be enabled too. +### teleport_auth_type + +```code +$ export TF_VAR_teleport_auth_type="local" +``` + +This value can be used to change the default authentication type used for the Teleport cluster. This is useful for persisting a +default authentication type across AMI upgrades when you have a SAML, OIDC or GitHub connector configured in DynamoDB. +The default is `local`. + +- Teleport Community Edition supports `local` or `github` +- Teleport Enterprise Edition supports `local`, `github`, `oidc` or `saml` +- Teleport Enterprise FIPS deployments have local authentication disabled, so should use `github`, `oidc` or `saml` + +See the [Teleport authentication reference](../../reference/authentication.mdx) for more information. ## Reference deployment defaults diff --git a/examples/aws/terraform/ha-autoscale-cluster/Makefile b/examples/aws/terraform/ha-autoscale-cluster/Makefile index 0b07616e54c..b29688680ee 100644 --- a/examples/aws/terraform/ha-autoscale-cluster/Makefile +++ b/examples/aws/terraform/ha-autoscale-cluster/Makefile @@ -64,6 +64,15 @@ TF_VAR_use_acm ?= false # - you must use `tsh proxy` commands for Kubernetes/database access TF_VAR_use_tls_routing ?= false +# (optional) Change the default authentication type used for the Teleport cluster. +# See https://goteleport.com/docs/reference/authentication for more information. +# This is useful for persisting a different default authentication type across AMI upgrades when you have a SAML, OIDC +# or GitHub connector configured in DynamoDB. The default if not set is "local". +# Teleport Community Edition supports "local" or "github" +# Teleport Enterprise Edition supports "local", "github", "oidc" or "saml" +# Teleport Enterprise FIPS deployments have local authentication disabled, so should use "github", "oidc" or "saml" +TF_VAR_teleport_auth_type ?= "local" + export # Plan launches terraform plan diff --git a/examples/aws/terraform/ha-autoscale-cluster/README.md b/examples/aws/terraform/ha-autoscale-cluster/README.md index 83d98918349..3b7bc39fa1b 100644 --- a/examples/aws/terraform/ha-autoscale-cluster/README.md +++ b/examples/aws/terraform/ha-autoscale-cluster/README.md @@ -107,6 +107,15 @@ export TF_VAR_email="support@example.com" # Setup grafana password for "admin" user. Grafana will be served on https://cluster.example.com:8443 after install export TF_VAR_grafana_pass="CHANGE_THIS_VALUE" +# This value can be used to change the default authentication type used for the Teleport cluster. +# See https://goteleport.com/docs/reference/authentication for more information. +# This is useful for persisting a different default authentication type across AMI upgrades when you have a SAML, OIDC +# or GitHub connector configured in DynamoDB. The default is "local". +# Teleport Community Edition supports "local" or "github" +# Teleport Enterprise Edition supports "local", "github", "oidc" or "saml" +# Teleport Enterprise FIPS deployments have local authentication disabled, so should use "github", "oidc" or "saml" +export TF_VAR_teleport_auth_type="local" + # plan make plan ``` diff --git a/examples/aws/terraform/ha-autoscale-cluster/auth-user-data.tpl b/examples/aws/terraform/ha-autoscale-cluster/auth-user-data.tpl index 3c1c82003ca..107966e6f97 100644 --- a/examples/aws/terraform/ha-autoscale-cluster/auth-user-data.tpl +++ b/examples/aws/terraform/ha-autoscale-cluster/auth-user-data.tpl @@ -3,6 +3,7 @@ cat >/etc/teleport.d/conf </etc/teleport.d/conf <