From 26ebd21d5e1cecfb176cd560a3e19b40a420079f Mon Sep 17 00:00:00 2001 From: alexfornuto Date: Mon, 3 Apr 2023 10:57:10 -0500 Subject: [PATCH 1/3] remove details blocks in tctl partial --- docs/pages/includes/tctl.mdx | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/docs/pages/includes/tctl.mdx b/docs/pages/includes/tctl.mdx index 4b697ba811210..d759381f6a341 100644 --- a/docs/pages/includes/tctl.mdx +++ b/docs/pages/includes/tctl.mdx @@ -1,9 +1,4 @@ -
+ To connect to Teleport, log in to your cluster using `tsh`, then use `tctl` remotely: @@ -20,13 +15,8 @@ You can run subsequent `tctl` commands in this guide on your local machine. For full privileges, you can also run `tctl` commands on your Auth Service host. -
-
+ + To connect to Teleport, log in to your cluster using `tsh`, then use `tctl` remotely: @@ -41,4 +31,4 @@ $ tctl status You must run subsequent `tctl` commands in this guide on your local machine. -
+ From eb827b50fb1e1e1282ff580e267a9be50f09ac3c Mon Sep 17 00:00:00 2001 From: alexfornuto Date: Mon, 3 Apr 2023 11:04:03 -0500 Subject: [PATCH 2/3] add bullet point when calling tctl partial --- .../access-request-plugins/ssh-approval-discord.mdx | 2 +- .../access-request-plugins/ssh-approval-email.mdx | 2 +- .../access-request-plugins/ssh-approval-jira.mdx | 2 +- .../access-request-plugins/ssh-approval-mattermost.mdx | 2 +- .../access-request-plugins/ssh-approval-pagerduty.mdx | 2 +- .../access-controls/access-requests/resource-requests.mdx | 2 +- docs/pages/access-controls/access-requests/role-requests.mdx | 2 +- docs/pages/access-controls/getting-started.mdx | 4 ++-- docs/pages/access-controls/guides/dual-authz.mdx | 2 +- docs/pages/access-controls/guides/hardware-key-support.mdx | 2 +- docs/pages/access-controls/guides/impersonation.mdx | 2 +- docs/pages/access-controls/guides/locking.mdx | 2 +- docs/pages/access-controls/guides/per-session-mfa.mdx | 2 +- docs/pages/access-controls/guides/role-templates.mdx | 2 +- docs/pages/access-controls/guides/webauthn.mdx | 2 +- docs/pages/access-controls/idps/saml-grafana.mdx | 2 +- docs/pages/access-controls/idps/saml-guide.mdx | 2 +- docs/pages/access-controls/login-rules/guide.mdx | 2 +- docs/pages/access-controls/sso/adfs.mdx | 2 +- docs/pages/access-controls/sso/azuread.mdx | 2 +- docs/pages/access-controls/sso/github-sso.mdx | 2 +- docs/pages/access-controls/sso/gitlab.mdx | 2 +- docs/pages/access-controls/sso/google-workspace.mdx | 2 +- docs/pages/access-controls/sso/oidc.mdx | 2 +- docs/pages/access-controls/sso/okta.mdx | 2 +- docs/pages/access-controls/sso/one-login.mdx | 2 +- docs/pages/api/rbac.mdx | 2 +- docs/pages/application-access/cloud-apis/azure.mdx | 2 +- docs/pages/application-access/cloud-apis/google-cloud.mdx | 2 +- docs/pages/application-access/getting-started.mdx | 2 +- docs/pages/application-access/guides/dynamodb.mdx | 2 +- docs/pages/application-access/guides/tcp.mdx | 2 +- docs/pages/database-access/getting-started.mdx | 2 +- docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx | 2 +- docs/pages/database-access/guides/aws-dynamodb.mdx | 2 +- docs/pages/database-access/guides/azure-redis.mdx | 2 +- docs/pages/database-access/guides/azure-sql-server-ad.mdx | 2 +- docs/pages/database-access/guides/cassandra-self-hosted.mdx | 2 +- docs/pages/database-access/guides/cockroachdb-self-hosted.mdx | 2 +- docs/pages/database-access/guides/dynamic-registration.mdx | 2 +- docs/pages/database-access/guides/elastic.mdx | 2 +- docs/pages/database-access/guides/mongodb-atlas.mdx | 2 +- docs/pages/database-access/guides/mongodb-self-hosted.mdx | 2 +- docs/pages/database-access/guides/mysql-cloudsql.mdx | 2 +- docs/pages/database-access/guides/mysql-self-hosted.mdx | 2 +- docs/pages/database-access/guides/postgres-cloudsql.mdx | 2 +- docs/pages/database-access/guides/postgres-redshift.mdx | 2 +- docs/pages/database-access/guides/postgres-self-hosted.mdx | 2 +- docs/pages/database-access/guides/rds-proxy.mdx | 2 +- docs/pages/database-access/guides/rds.mdx | 2 +- docs/pages/database-access/guides/redis-aws.mdx | 2 +- docs/pages/database-access/guides/redis-cluster.mdx | 2 +- docs/pages/database-access/guides/redis.mdx | 2 +- docs/pages/database-access/guides/snowflake.mdx | 2 +- docs/pages/database-access/guides/sql-server-ad.mdx | 2 +- docs/pages/desktop-access/directory-sharing.mdx | 2 +- docs/pages/desktop-access/getting-started.mdx | 2 +- docs/pages/desktop-access/reference/cli.mdx | 2 +- docs/pages/kubernetes-access/discovery/google-cloud.mdx | 2 +- docs/pages/kubernetes-access/getting-started.mdx | 2 +- docs/pages/kubernetes-access/manage-access/rbac.mdx | 2 +- .../register-clusters/dynamic-registration.mdx | 2 +- .../pages/kubernetes-access/register-clusters/iam-joining.mdx | 2 +- .../register-clusters/register-via-deployment.mdx | 2 +- .../kubernetes-access/register-clusters/static-kubeconfig.mdx | 2 +- docs/pages/machine-id/guides/applications.mdx | 2 +- docs/pages/machine-id/guides/circleci.mdx | 2 +- docs/pages/machine-id/guides/databases.mdx | 2 +- docs/pages/machine-id/guides/github-actions-kubernetes.mdx | 2 +- docs/pages/machine-id/guides/github-actions.mdx | 2 +- docs/pages/machine-id/guides/gitlab.mdx | 2 +- docs/pages/machine-id/guides/jenkins.mdx | 2 +- docs/pages/machine-id/guides/kubernetes.mdx | 2 +- docs/pages/management/admin/adding-nodes.mdx | 2 +- docs/pages/management/admin/labels.mdx | 2 +- docs/pages/management/admin/troubleshooting.mdx | 2 +- docs/pages/management/admin/users.mdx | 2 +- docs/pages/management/export-audit-events/datadog.mdx | 2 +- docs/pages/management/export-audit-events/fluentd.mdx | 2 +- docs/pages/management/export-audit-events/splunk.mdx | 2 +- docs/pages/management/guides/joining-nodes-aws-ec2.mdx | 2 +- docs/pages/management/guides/joining-nodes-aws-iam.mdx | 2 +- docs/pages/management/guides/joining-nodes-azure.mdx | 2 +- docs/pages/management/guides/terraform-provider.mdx | 2 +- docs/pages/management/operations/ca-rotation.mdx | 2 +- docs/pages/management/security/reduce-blast-radius.mdx | 2 +- docs/pages/reference/resources.mdx | 2 +- docs/pages/server-access/getting-started.mdx | 2 +- docs/pages/server-access/guides/auditd.mdx | 2 +- docs/pages/server-access/guides/azure-discovery.mdx | 2 +- docs/pages/server-access/guides/bpf-session-recording.mdx | 2 +- docs/pages/server-access/guides/ec2-discovery.mdx | 2 +- docs/pages/server-access/guides/host-user-creation.mdx | 2 +- docs/pages/server-access/guides/openssh.mdx | 2 +- docs/pages/server-access/guides/restricted-session.mdx | 2 +- 95 files changed, 96 insertions(+), 96 deletions(-) diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx index 7b5d3ac673181..54449e43e8702 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx @@ -17,7 +17,7 @@ compromising productivity. "manager server" permission. - Either a Linux host or Kubernetes cluster where you will run the Discord plugin. -(!/docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/8. Define RBAC resources diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx index ffed4cc27d172..8735c2a63f09a 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx @@ -25,7 +25,7 @@ regularly. -(!/docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/7. Define RBAC resources diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-jira.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-jira.mdx index 134a4c2f3baea..0081e1f07fc84 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-jira.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-jira.mdx @@ -14,7 +14,7 @@ Jira tickets. - Jira Server or Jira Cloud installation with an owner privileges, specifically to set up webhooks, issue types, and workflows -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/6. Create a user and role for access diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx index d4f4383ac3922..3e02f140ac5c4 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx @@ -17,7 +17,7 @@ compromising productivity. Mattermost v7.0.1. - Either a Linux host or Kubernetes cluster where you will run the Mattermost plugin. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/8. Define RBAC resources diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx index 79cb9e713c177..52e5eb1ccee03 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx @@ -45,7 +45,7 @@ Teleport Cloud tenant and PagerDuty. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/8. Create services diff --git a/docs/pages/access-controls/access-requests/resource-requests.mdx b/docs/pages/access-controls/access-requests/resource-requests.mdx index 03411d4917832..8b6f8c1ef1954 100644 --- a/docs/pages/access-controls/access-requests/resource-requests.mdx +++ b/docs/pages/access-controls/access-requests/resource-requests.mdx @@ -28,7 +28,7 @@ available in Teleport Enterprise. (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) All `teleport` instances in the cluster must be running Teleport `v10.0.0` or diff --git a/docs/pages/access-controls/access-requests/role-requests.mdx b/docs/pages/access-controls/access-requests/role-requests.mdx index e703b6c7fc649..0a70c664b67b4 100644 --- a/docs/pages/access-controls/access-requests/role-requests.mdx +++ b/docs/pages/access-controls/access-requests/role-requests.mdx @@ -12,7 +12,7 @@ via ChatOps or anywhere else via our flexible Authorization Workflow API. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## RBAC Setup diff --git a/docs/pages/access-controls/getting-started.mdx b/docs/pages/access-controls/getting-started.mdx index ab847056040d7..0e308d1cb921e 100644 --- a/docs/pages/access-controls/getting-started.mdx +++ b/docs/pages/access-controls/getting-started.mdx @@ -14,9 +14,9 @@ wrap up with creating your own role. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/permission-warning.mdx!) +- (!docs/pages/includes/tctl.mdx!) -(!docs/pages/includes/tctl.mdx!) +(!docs/pages/includes/permission-warning.mdx!) ## Step 1/3. Add local users with preset roles diff --git a/docs/pages/access-controls/guides/dual-authz.mdx b/docs/pages/access-controls/guides/dual-authz.mdx index 5d85d9d68bfd1..abe12a9444150 100644 --- a/docs/pages/access-controls/guides/dual-authz.mdx +++ b/docs/pages/access-controls/guides/dual-authz.mdx @@ -41,7 +41,7 @@ of two team members for a privileged role `dbadmin`. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Set up a Teleport bot diff --git a/docs/pages/access-controls/guides/hardware-key-support.mdx b/docs/pages/access-controls/guides/hardware-key-support.mdx index 31d3be24d9be8..533ccadb4af6b 100644 --- a/docs/pages/access-controls/guides/hardware-key-support.mdx +++ b/docs/pages/access-controls/guides/hardware-key-support.mdx @@ -62,7 +62,7 @@ Additionally, this feature can be configured to require touch for every Teleport Teleport clients use PIV slot 9a for the `hardware_key` option and 9c for the `hardware_key_touch` option, and will overwrite other keys and certs in these slots as needed. This may interfere with other PIV applications, like `yubikey-agent`, so we recommend only using one PIV application at a time. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/2. Enforce Hardware Key Support diff --git a/docs/pages/access-controls/guides/impersonation.mdx b/docs/pages/access-controls/guides/impersonation.mdx index 2489761616817..9ee8285164a2e 100644 --- a/docs/pages/access-controls/guides/impersonation.mdx +++ b/docs/pages/access-controls/guides/impersonation.mdx @@ -15,7 +15,7 @@ non-interactive CI/CD user Jenkins and a security scanner. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3: Create a CI/CD user and corresponding role diff --git a/docs/pages/access-controls/guides/locking.mdx b/docs/pages/access-controls/guides/locking.mdx index 33658ae9e43df..e203a58630f69 100644 --- a/docs/pages/access-controls/guides/locking.mdx +++ b/docs/pages/access-controls/guides/locking.mdx @@ -39,7 +39,7 @@ A lock can target the following objects or attributes: (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/2. Create a lock diff --git a/docs/pages/access-controls/guides/per-session-mfa.mdx b/docs/pages/access-controls/guides/per-session-mfa.mdx index fa03f4eebe1c0..c0fd17a6276f5 100644 --- a/docs/pages/access-controls/guides/per-session-mfa.mdx +++ b/docs/pages/access-controls/guides/per-session-mfa.mdx @@ -43,7 +43,7 @@ their on-disk Teleport certificates. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - [WebAuthn configured](webauthn.mdx) on this cluster - Second factor hardware device, such as YubiKey or SoloKey diff --git a/docs/pages/access-controls/guides/role-templates.mdx b/docs/pages/access-controls/guides/role-templates.mdx index 1f3b7f0534ef5..96b26cc21bc5e 100644 --- a/docs/pages/access-controls/guides/role-templates.mdx +++ b/docs/pages/access-controls/guides/role-templates.mdx @@ -20,7 +20,7 @@ other policies. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Local users diff --git a/docs/pages/access-controls/guides/webauthn.mdx b/docs/pages/access-controls/guides/webauthn.mdx index 153d5c7dbeaa8..17558b924d2bd 100644 --- a/docs/pages/access-controls/guides/webauthn.mdx +++ b/docs/pages/access-controls/guides/webauthn.mdx @@ -21,7 +21,7 @@ UI). - A Web browser with [WebAuthn support]( https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Enable WebAuthn support diff --git a/docs/pages/access-controls/idps/saml-grafana.mdx b/docs/pages/access-controls/idps/saml-grafana.mdx index 4ee41d3032c06..07675c1495a50 100644 --- a/docs/pages/access-controls/idps/saml-grafana.mdx +++ b/docs/pages/access-controls/idps/saml-grafana.mdx @@ -21,7 +21,7 @@ not just those running behind the Teleport App Service. (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Configure a Teleport role with access to SAML service provider objects diff --git a/docs/pages/access-controls/idps/saml-guide.mdx b/docs/pages/access-controls/idps/saml-guide.mdx index e31b2fd253f52..5f131406d9a83 100644 --- a/docs/pages/access-controls/idps/saml-guide.mdx +++ b/docs/pages/access-controls/idps/saml-guide.mdx @@ -17,7 +17,7 @@ authenticate to external services. (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - If you're new to SAML, consider reviewing our [SAML Identity Provider Reference](./saml-reference.mdx) before proceeding. diff --git a/docs/pages/access-controls/login-rules/guide.mdx b/docs/pages/access-controls/login-rules/guide.mdx index 98f4362d488b1..7c9350ec2aae8 100644 --- a/docs/pages/access-controls/login-rules/guide.mdx +++ b/docs/pages/access-controls/login-rules/guide.mdx @@ -14,7 +14,7 @@ first Login Rule to your Teleport cluster. (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) Before you get started you’ll need a running Teleport Enterprise or Cloud cluster on version `11.3.1` or greater. diff --git a/docs/pages/access-controls/sso/adfs.mdx b/docs/pages/access-controls/sso/adfs.mdx index 10178ac810a1c..7d3c75fd3183a 100644 --- a/docs/pages/access-controls/sso/adfs.mdx +++ b/docs/pages/access-controls/sso/adfs.mdx @@ -21,7 +21,7 @@ like: (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) (!docs/pages/includes/enterprise/samlauthentication.mdx!) diff --git a/docs/pages/access-controls/sso/azuread.mdx b/docs/pages/access-controls/sso/azuread.mdx index 6bb637aa2faee..767bc741d3537 100644 --- a/docs/pages/access-controls/sso/azuread.mdx +++ b/docs/pages/access-controls/sso/azuread.mdx @@ -23,7 +23,7 @@ Before you get started you’ll need: (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) (!docs/pages/includes/enterprise/samlauthentication.mdx!) diff --git a/docs/pages/access-controls/sso/github-sso.mdx b/docs/pages/access-controls/sso/github-sso.mdx index 638aef50b4bb9..7474efe150c85 100644 --- a/docs/pages/access-controls/sso/github-sso.mdx +++ b/docs/pages/access-controls/sso/github-sso.mdx @@ -17,7 +17,7 @@ from either GitHub Cloud or GitHub Enterprise Server. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Create a GitHub OAuth app diff --git a/docs/pages/access-controls/sso/gitlab.mdx b/docs/pages/access-controls/sso/gitlab.mdx index 71ef8261a99e5..160225fa6ef8e 100644 --- a/docs/pages/access-controls/sso/gitlab.mdx +++ b/docs/pages/access-controls/sso/gitlab.mdx @@ -22,7 +22,7 @@ like: (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Enable default OIDC authentication diff --git a/docs/pages/access-controls/sso/google-workspace.mdx b/docs/pages/access-controls/sso/google-workspace.mdx index 6eb98480b0824..83d2d4b0ae681 100644 --- a/docs/pages/access-controls/sso/google-workspace.mdx +++ b/docs/pages/access-controls/sso/google-workspace.mdx @@ -24,7 +24,7 @@ Before you get started you’ll need: (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Enable default OIDC authentication diff --git a/docs/pages/access-controls/sso/oidc.mdx b/docs/pages/access-controls/sso/oidc.mdx index b39aed6f53268..af4f6e10fdd37 100644 --- a/docs/pages/access-controls/sso/oidc.mdx +++ b/docs/pages/access-controls/sso/oidc.mdx @@ -19,7 +19,7 @@ administrators to define policies like: (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Enable default OIDC authentication diff --git a/docs/pages/access-controls/sso/okta.mdx b/docs/pages/access-controls/sso/okta.mdx index 5e454b21289ce..f9b790868520d 100644 --- a/docs/pages/access-controls/sso/okta.mdx +++ b/docs/pages/access-controls/sso/okta.mdx @@ -24,7 +24,7 @@ Teleport administrators to define policies like: - A Teleport role with access to edit and maintain `saml` resources. This is available in the default `editor` role. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) (!docs/pages/includes/enterprise/samlauthentication.mdx!) diff --git a/docs/pages/access-controls/sso/one-login.mdx b/docs/pages/access-controls/sso/one-login.mdx index 37146b9293a75..fe5941589db6c 100644 --- a/docs/pages/access-controls/sso/one-login.mdx +++ b/docs/pages/access-controls/sso/one-login.mdx @@ -20,7 +20,7 @@ like: (!docs/pages/includes/commercial-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) (!docs/pages/includes/enterprise/samlauthentication.mdx!) diff --git a/docs/pages/api/rbac.mdx b/docs/pages/api/rbac.mdx index 7f4f7f7b67dc1..5307468910c44 100644 --- a/docs/pages/api/rbac.mdx +++ b/docs/pages/api/rbac.mdx @@ -59,7 +59,7 @@ Teleport roles based on an external RBAC system. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up your Kubernetes cluster diff --git a/docs/pages/application-access/cloud-apis/azure.mdx b/docs/pages/application-access/cloud-apis/azure.mdx index 16d28b6187f95..3e28a1c1e7c35 100644 --- a/docs/pages/application-access/cloud-apis/azure.mdx +++ b/docs/pages/application-access/cloud-apis/azure.mdx @@ -48,7 +48,7 @@ prevent unauthorized access to your organization's Azure identities. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Grant an identity to your VM diff --git a/docs/pages/application-access/cloud-apis/google-cloud.mdx b/docs/pages/application-access/cloud-apis/google-cloud.mdx index a7b2751e6b3a6..5c0017f448355 100644 --- a/docs/pages/application-access/cloud-apis/google-cloud.mdx +++ b/docs/pages/application-access/cloud-apis/google-cloud.mdx @@ -55,7 +55,7 @@ guide. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Configure Google Cloud diff --git a/docs/pages/application-access/getting-started.mdx b/docs/pages/application-access/getting-started.mdx index 7b844b7c4dad3..2902ca27c436d 100644 --- a/docs/pages/application-access/getting-started.mdx +++ b/docs/pages/application-access/getting-started.mdx @@ -21,7 +21,7 @@ Let's connect to Grafana using Teleport Application Access in three steps: (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - A Docker installation, which we will use to launch Grafana in a container. Alternatively, if you have another web application you'd like to protect with Application Access, you can use that instead. - A host where you will run the Teleport Application Service. diff --git a/docs/pages/application-access/guides/dynamodb.mdx b/docs/pages/application-access/guides/dynamodb.mdx index 708e26434efb3..ffcf5b3ef4091 100644 --- a/docs/pages/application-access/guides/dynamodb.mdx +++ b/docs/pages/application-access/guides/dynamodb.mdx @@ -37,7 +37,7 @@ This guide will help you to: (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) If you have not yet deployed the Auth Service and Proxy Service, you should follow one of our [getting started guides](../getting-started.mdx) or try our Teleport Application Access [interactive learning track](https://play.instruqt.com/teleport/invite/rgvuva4gzkon). diff --git a/docs/pages/application-access/guides/tcp.mdx b/docs/pages/application-access/guides/tcp.mdx index 93546c082650b..c8d7a04bb5044 100644 --- a/docs/pages/application-access/guides/tcp.mdx +++ b/docs/pages/application-access/guides/tcp.mdx @@ -11,7 +11,7 @@ servers or databases not yet natively supported in Database Access. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - TCP application to connect to. In this guide we'll use a PostgreSQL running in Docker as an example. You can also use any TCP-based application you may diff --git a/docs/pages/database-access/getting-started.mdx b/docs/pages/database-access/getting-started.mdx index abe9ec1913206..97fc01248e671 100644 --- a/docs/pages/database-access/getting-started.mdx +++ b/docs/pages/database-access/getting-started.mdx @@ -35,7 +35,7 @@ release. - A host, e.g., an EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up Aurora diff --git a/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx b/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx index c14a5a0dd0564..77d22104ebce6 100644 --- a/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx +++ b/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx @@ -35,7 +35,7 @@ This guide will help you to: - The `cqlsh` Cassandra client installed and added to your system's `PATH` environment variable. - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/aws-dynamodb.mdx b/docs/pages/database-access/guides/aws-dynamodb.mdx index 9309b50b56067..8a18bcf50b7de 100644 --- a/docs/pages/database-access/guides/aws-dynamodb.mdx +++ b/docs/pages/database-access/guides/aws-dynamodb.mdx @@ -32,7 +32,7 @@ This guide will help you to: This guide assumes an EC2 instance when creating and applying IAM roles, and must be adjusted accordingly for custom configurations. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) This guide provides an example configuration of IAM access roles as a model, diff --git a/docs/pages/database-access/guides/azure-redis.mdx b/docs/pages/database-access/guides/azure-redis.mdx index d0b8f51402bff..99842b1e0a922 100644 --- a/docs/pages/database-access/guides/azure-redis.mdx +++ b/docs/pages/database-access/guides/azure-redis.mdx @@ -29,7 +29,7 @@ This guide will help you to: - `redis-cli` version `6.2` or newer installed and added to your system's `PATH` environment variable. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create a Teleport user diff --git a/docs/pages/database-access/guides/azure-sql-server-ad.mdx b/docs/pages/database-access/guides/azure-sql-server-ad.mdx index 7210ee700c5d4..81423da5f9b21 100644 --- a/docs/pages/database-access/guides/azure-sql-server-ad.mdx +++ b/docs/pages/database-access/guides/azure-sql-server-ad.mdx @@ -39,7 +39,7 @@ This guide will help you to: - SQL Server running on Azure. - The Teleport Database Service running on an Azure virtual instance. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/8. Create a Teleport user diff --git a/docs/pages/database-access/guides/cassandra-self-hosted.mdx b/docs/pages/database-access/guides/cassandra-self-hosted.mdx index 7edc53d919258..bec997f8d855e 100644 --- a/docs/pages/database-access/guides/cassandra-self-hosted.mdx +++ b/docs/pages/database-access/guides/cassandra-self-hosted.mdx @@ -34,7 +34,7 @@ This guide will help you to: - Self-hosted Cassandra or ScyllaDB instance. - The `cqlsh` Cassandra client installed and added to your system's `PATH` environment variable. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx b/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx index 26fdc0032aa78..14d68be09bc5d 100644 --- a/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx +++ b/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx @@ -35,7 +35,7 @@ This guide will help you to: - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/dynamic-registration.mdx b/docs/pages/database-access/guides/dynamic-registration.mdx index 8da5713d3548d..3373419c38f00 100644 --- a/docs/pages/database-access/guides/dynamic-registration.mdx +++ b/docs/pages/database-access/guides/dynamic-registration.mdx @@ -91,7 +91,7 @@ To create a database resource, run: $ tctl create database.yaml ``` -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) After the resource has been created, it will appear among the list of available databases (in `tsh db ls` or UI) as long as at least one Database Service diff --git a/docs/pages/database-access/guides/elastic.mdx b/docs/pages/database-access/guides/elastic.mdx index 437dc96af3b82..44113c78f4785 100644 --- a/docs/pages/database-access/guides/elastic.mdx +++ b/docs/pages/database-access/guides/elastic.mdx @@ -28,7 +28,7 @@ This guide will help you to configure secured access to an Elasticsearch databas See [Installation](../../installation.mdx) for details. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/mongodb-atlas.mdx b/docs/pages/database-access/guides/mongodb-atlas.mdx index 9318026a230b8..668e52f45f6a9 100644 --- a/docs/pages/database-access/guides/mongodb-atlas.mdx +++ b/docs/pages/database-access/guides/mongodb-atlas.mdx @@ -25,7 +25,7 @@ In this guide you will: - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/mongodb-self-hosted.mdx b/docs/pages/database-access/guides/mongodb-self-hosted.mdx index 87dc20a7f7ebb..7141e4875ac63 100644 --- a/docs/pages/database-access/guides/mongodb-self-hosted.mdx +++ b/docs/pages/database-access/guides/mongodb-self-hosted.mdx @@ -31,7 +31,7 @@ In this guide you will: April 2021 so if you're still using an older version, consider upgrading. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Install and configure Teleport diff --git a/docs/pages/database-access/guides/mysql-cloudsql.mdx b/docs/pages/database-access/guides/mysql-cloudsql.mdx index 977b750e581dd..dc907e1b43556 100644 --- a/docs/pages/database-access/guides/mysql-cloudsql.mdx +++ b/docs/pages/database-access/guides/mysql-cloudsql.mdx @@ -31,7 +31,7 @@ Teleport Database Access for Cloud SQL MySQL is available starting from the - A host, e.g., a Compute Engine instance, where you will run the Teleport Database Service -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create a service account for the Teleport Database Service diff --git a/docs/pages/database-access/guides/mysql-self-hosted.mdx b/docs/pages/database-access/guides/mysql-self-hosted.mdx index e71f4f72afe4d..7f01453154a13 100644 --- a/docs/pages/database-access/guides/mysql-self-hosted.mdx +++ b/docs/pages/database-access/guides/mysql-self-hosted.mdx @@ -24,7 +24,7 @@ This guide will help you to: - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/postgres-cloudsql.mdx b/docs/pages/database-access/guides/postgres-cloudsql.mdx index b2855b29b5e41..50389e611b689 100644 --- a/docs/pages/database-access/guides/postgres-cloudsql.mdx +++ b/docs/pages/database-access/guides/postgres-cloudsql.mdx @@ -26,7 +26,7 @@ This guide will help you to: - A host, e.g., a Compute Engine instance, where you will run the Teleport Database Service -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/7. Enable Cloud SQL IAM authentication diff --git a/docs/pages/database-access/guides/postgres-redshift.mdx b/docs/pages/database-access/guides/postgres-redshift.mdx index 8f8ec94754325..4bee50312b2d0 100644 --- a/docs/pages/database-access/guides/postgres-redshift.mdx +++ b/docs/pages/database-access/guides/postgres-redshift.mdx @@ -27,7 +27,7 @@ This guide will help you to: - A host, e.g., an EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create a Teleport user diff --git a/docs/pages/database-access/guides/postgres-self-hosted.mdx b/docs/pages/database-access/guides/postgres-self-hosted.mdx index 795a3d5080abc..1830a6abcec9c 100644 --- a/docs/pages/database-access/guides/postgres-self-hosted.mdx +++ b/docs/pages/database-access/guides/postgres-self-hosted.mdx @@ -25,7 +25,7 @@ This guide will help you to: - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/rds-proxy.mdx b/docs/pages/database-access/guides/rds-proxy.mdx index c03f3715f57df..ffc33ddbd61bc 100644 --- a/docs/pages/database-access/guides/rds-proxy.mdx +++ b/docs/pages/database-access/guides/rds-proxy.mdx @@ -26,7 +26,7 @@ Teleport currently supports RDS Proxy instances with engine family - A host, e.g., an EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create a Database Service configuration diff --git a/docs/pages/database-access/guides/rds.mdx b/docs/pages/database-access/guides/rds.mdx index dbb9ac6204952..5c65779275d0d 100644 --- a/docs/pages/database-access/guides/rds.mdx +++ b/docs/pages/database-access/guides/rds.mdx @@ -36,7 +36,7 @@ This guide will help you to: - A host, e.g., an EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/6. Create a Teleport user diff --git a/docs/pages/database-access/guides/redis-aws.mdx b/docs/pages/database-access/guides/redis-aws.mdx index 69f755c536e9d..b0b8d935cd6de 100644 --- a/docs/pages/database-access/guides/redis-aws.mdx +++ b/docs/pages/database-access/guides/redis-aws.mdx @@ -27,7 +27,7 @@ This guide will help you to: - A host, e.g., an EC2 instance, where you will run the Teleport Database Service. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/6. Create a Teleport user diff --git a/docs/pages/database-access/guides/redis-cluster.mdx b/docs/pages/database-access/guides/redis-cluster.mdx index 078f573b51b97..c9ca66e3332ff 100644 --- a/docs/pages/database-access/guides/redis-cluster.mdx +++ b/docs/pages/database-access/guides/redis-cluster.mdx @@ -40,7 +40,7 @@ This guide will help you to: Redis `7.0` and RESP3 (REdis Serialization Protocol) are currently not supported. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/6. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/redis.mdx b/docs/pages/database-access/guides/redis.mdx index 2f6a8d96e346d..3bebb8c7dc41b 100644 --- a/docs/pages/database-access/guides/redis.mdx +++ b/docs/pages/database-access/guides/redis.mdx @@ -45,7 +45,7 @@ This guide will help you to: Redis `7.0` and RESP3 (REdis Serialization Protocol) are currently not supported. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/snowflake.mdx b/docs/pages/database-access/guides/snowflake.mdx index 8825a60d8dee4..f0b542ca787b1 100644 --- a/docs/pages/database-access/guides/snowflake.mdx +++ b/docs/pages/database-access/guides/snowflake.mdx @@ -38,7 +38,7 @@ This guide will help you to: See [Installation](../../installation.mdx) for details. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/sql-server-ad.mdx b/docs/pages/database-access/guides/sql-server-ad.mdx index 92743aff71ed9..420eea2746161 100644 --- a/docs/pages/database-access/guides/sql-server-ad.mdx +++ b/docs/pages/database-access/guides/sql-server-ad.mdx @@ -45,7 +45,7 @@ Directory authentication. - A Linux node joined to the same Active Directory domain as the database. This guide will walk you through the joining steps if you don't have one. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/7. Create a Teleport user diff --git a/docs/pages/desktop-access/directory-sharing.mdx b/docs/pages/desktop-access/directory-sharing.mdx index 8200ed73c2539..d3a87e50e8f6b 100644 --- a/docs/pages/desktop-access/directory-sharing.mdx +++ b/docs/pages/desktop-access/directory-sharing.mdx @@ -36,7 +36,7 @@ after the session ends. You can see a full compatibility table in the [Mozilla Developer Network documentation](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API#browser_compatibility). -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Share a directory diff --git a/docs/pages/desktop-access/getting-started.mdx b/docs/pages/desktop-access/getting-started.mdx index 0257dfa4c6e1f..c78a33d048135 100644 --- a/docs/pages/desktop-access/getting-started.mdx +++ b/docs/pages/desktop-access/getting-started.mdx @@ -38,7 +38,7 @@ an [Active Directory domain](./active-directory.mdx). - A server or virtual machine running a Windows operating system with Remote Desktop enabled and the RDP port available to the Linux server. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Prepare Windows diff --git a/docs/pages/desktop-access/reference/cli.mdx b/docs/pages/desktop-access/reference/cli.mdx index a244da40c8353..474c0da1e16ff 100644 --- a/docs/pages/desktop-access/reference/cli.mdx +++ b/docs/pages/desktop-access/reference/cli.mdx @@ -5,7 +5,7 @@ description: CLI reference for Teleport Desktop Access. The following `tctl` commands are used to manage Teleport Desktop Access. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) Generate a join token for a Windows Desktop Service: diff --git a/docs/pages/kubernetes-access/discovery/google-cloud.mdx b/docs/pages/kubernetes-access/discovery/google-cloud.mdx index 73c379521e506..1befef790c74f 100644 --- a/docs/pages/kubernetes-access/discovery/google-cloud.mdx +++ b/docs/pages/kubernetes-access/discovery/google-cloud.mdx @@ -31,7 +31,7 @@ Auto-Discovery for GKE. services. You can run this host on any cloud provider or even use a local machine. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Obtain Google Cloud credentials diff --git a/docs/pages/kubernetes-access/getting-started.mdx b/docs/pages/kubernetes-access/getting-started.mdx index 39b311bb2bd92..b981dc3d0d0f9 100644 --- a/docs/pages/kubernetes-access/getting-started.mdx +++ b/docs/pages/kubernetes-access/getting-started.mdx @@ -27,7 +27,7 @@ Standalone Teleport Cluster](./register-clusters/static-kubeconfig.mdx). (!docs/pages/includes/kubernetes-access/helm-k8s.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Deployment overview diff --git a/docs/pages/kubernetes-access/manage-access/rbac.mdx b/docs/pages/kubernetes-access/manage-access/rbac.mdx index fe69c5d6b4416..8326f84ea7fb3 100644 --- a/docs/pages/kubernetes-access/manage-access/rbac.mdx +++ b/docs/pages/kubernetes-access/manage-access/rbac.mdx @@ -20,7 +20,7 @@ Kubernetes clusers, groups, users, and resources. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) To run the local demo environment, ensure that you have the following tools installed on your workstation: diff --git a/docs/pages/kubernetes-access/register-clusters/dynamic-registration.mdx b/docs/pages/kubernetes-access/register-clusters/dynamic-registration.mdx index 391abe1b304c0..0833f82c45fe3 100644 --- a/docs/pages/kubernetes-access/register-clusters/dynamic-registration.mdx +++ b/docs/pages/kubernetes-access/register-clusters/dynamic-registration.mdx @@ -32,7 +32,7 @@ registration, then create, list, update, and delete Kubernetes clusters via permissions to create namespaces, secrets, service accounts, cluster roles, and cluster role bindings in the cluster. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Set up the Teleport Kubernetes Service diff --git a/docs/pages/kubernetes-access/register-clusters/iam-joining.mdx b/docs/pages/kubernetes-access/register-clusters/iam-joining.mdx index 1546b70f94e38..dccfea7922e9d 100644 --- a/docs/pages/kubernetes-access/register-clusters/iam-joining.mdx +++ b/docs/pages/kubernetes-access/register-clusters/iam-joining.mdx @@ -27,7 +27,7 @@ to automatically join the cluster on subsequent restarts. (!docs/pages/includes/helm.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Create a Kubernetes service account with an IAM identity diff --git a/docs/pages/kubernetes-access/register-clusters/register-via-deployment.mdx b/docs/pages/kubernetes-access/register-clusters/register-via-deployment.mdx index d5a974e821d17..f936b94eeefcf 100644 --- a/docs/pages/kubernetes-access/register-clusters/register-via-deployment.mdx +++ b/docs/pages/kubernetes-access/register-clusters/register-via-deployment.mdx @@ -27,7 +27,7 @@ Teleport Kubernetes Service on each cluster you want to register. (!docs/pages/includes/helm.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Connecting clusters diff --git a/docs/pages/kubernetes-access/register-clusters/static-kubeconfig.mdx b/docs/pages/kubernetes-access/register-clusters/static-kubeconfig.mdx index 66860352c8056..7b6067e8399fd 100644 --- a/docs/pages/kubernetes-access/register-clusters/static-kubeconfig.mdx +++ b/docs/pages/kubernetes-access/register-clusters/static-kubeconfig.mdx @@ -24,7 +24,7 @@ authenticate to the API server of your chosen Kubernetes cluster. - The [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) command line tool installed on your workstation. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Generate a kubeconfig file diff --git a/docs/pages/machine-id/guides/applications.mdx b/docs/pages/machine-id/guides/applications.mdx index abfe5908fc5ae..ac760e0cbab32 100644 --- a/docs/pages/machine-id/guides/applications.mdx +++ b/docs/pages/machine-id/guides/applications.mdx @@ -26,7 +26,7 @@ If you're not already familiar with Machine ID, follow the [Getting Started Guide](../getting-started.mdx) to familiarize yourself with Machine ID. You'll also need `tctl` access to initially configure the bot. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) Lastly, ensure the `tbot` binary is installed on your Machine ID client system. The client system is any system from which you want to access your Teleport diff --git a/docs/pages/machine-id/guides/circleci.mdx b/docs/pages/machine-id/guides/circleci.mdx index 37c2ca2786f88..5e73942ac2b66 100644 --- a/docs/pages/machine-id/guides/circleci.mdx +++ b/docs/pages/machine-id/guides/circleci.mdx @@ -25,7 +25,7 @@ control. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - A running instance of the Teleport SSH Service that you have registered with your Teleport cluster. For instructions on setting this up, see the diff --git a/docs/pages/machine-id/guides/databases.mdx b/docs/pages/machine-id/guides/databases.mdx index 97741e505e5fe..361e6aa7eafbb 100644 --- a/docs/pages/machine-id/guides/databases.mdx +++ b/docs/pages/machine-id/guides/databases.mdx @@ -34,7 +34,7 @@ If you have not already set up Machine ID, follow the [Machine ID Getting Started Guide](../getting-started.mdx) to familiarize yourself with Machine ID. You'll need `tctl` access to initially configure the bot. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) Lastly, ensure both the `tbot` and `tsh` executables are available on your application host. See [Installation](../../installation.mdx) for details. diff --git a/docs/pages/machine-id/guides/github-actions-kubernetes.mdx b/docs/pages/machine-id/guides/github-actions-kubernetes.mdx index ed2a1e1e43ca3..5af4508bd67e8 100644 --- a/docs/pages/machine-id/guides/github-actions-kubernetes.mdx +++ b/docs/pages/machine-id/guides/github-actions-kubernetes.mdx @@ -27,7 +27,7 @@ Actions runners as well as GitHub Enterprise Server. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - A Kubernetes cluster connected to your Teleport cluster. If you do not already have one configured, try our diff --git a/docs/pages/machine-id/guides/github-actions.mdx b/docs/pages/machine-id/guides/github-actions.mdx index cb6dcd353b61f..73b1b5743057f 100644 --- a/docs/pages/machine-id/guides/github-actions.mdx +++ b/docs/pages/machine-id/guides/github-actions.mdx @@ -27,7 +27,7 @@ Actions runners as well as GitHub Enterprise Server. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - A node that is a part of the Teleport cluster with [Server Access](https://goteleport.com/docs/server-access/introduction/). - Your user should have the privileges to create token resources. diff --git a/docs/pages/machine-id/guides/gitlab.mdx b/docs/pages/machine-id/guides/gitlab.mdx index f9022f188d3b0..f1f0bbf3bcb35 100644 --- a/docs/pages/machine-id/guides/gitlab.mdx +++ b/docs/pages/machine-id/guides/gitlab.mdx @@ -29,7 +29,7 @@ control. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - A running instance of the Teleport SSH Service registered with your Teleport cluster. For instructions on setting this up, see the [Getting Started diff --git a/docs/pages/machine-id/guides/jenkins.mdx b/docs/pages/machine-id/guides/jenkins.mdx index a1ad3bd3342ab..35d2ad6c3f3cc 100644 --- a/docs/pages/machine-id/guides/jenkins.mdx +++ b/docs/pages/machine-id/guides/jenkins.mdx @@ -34,7 +34,7 @@ proxy_service: ``` -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Architecture diff --git a/docs/pages/machine-id/guides/kubernetes.mdx b/docs/pages/machine-id/guides/kubernetes.mdx index d3087cec5ac2a..09033798e1ad9 100644 --- a/docs/pages/machine-id/guides/kubernetes.mdx +++ b/docs/pages/machine-id/guides/kubernetes.mdx @@ -28,7 +28,7 @@ If you're not already familiar with Machine ID, follow the [Getting Started Guide](../getting-started.mdx) to familiarize yourself with Machine ID. You'll also need `tctl` access to initially configure the bot. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) Next, ensure the `tbot` binary is installed on your Machine ID client system. The client system is any system from which you want to access your Teleport diff --git a/docs/pages/management/admin/adding-nodes.mdx b/docs/pages/management/admin/adding-nodes.mdx index 090b2797425d7..20f50cd9afedb 100644 --- a/docs/pages/management/admin/adding-nodes.mdx +++ b/docs/pages/management/admin/adding-nodes.mdx @@ -11,7 +11,7 @@ This guide explains how to add Teleport Nodes to your cluster. - A Linux server that you will use to host your Teleport Node. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Install Teleport on your Node diff --git a/docs/pages/management/admin/labels.mdx b/docs/pages/management/admin/labels.mdx index 0ba6c5699e3ef..570f20f2c5ce0 100644 --- a/docs/pages/management/admin/labels.mdx +++ b/docs/pages/management/admin/labels.mdx @@ -37,7 +37,7 @@ region. (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - A host where you will run a Teleport Node. In this guide, we will apply labels to this Node. diff --git a/docs/pages/management/admin/troubleshooting.mdx b/docs/pages/management/admin/troubleshooting.mdx index ca99faf426db0..e4f98e9585e60 100644 --- a/docs/pages/management/admin/troubleshooting.mdx +++ b/docs/pages/management/admin/troubleshooting.mdx @@ -19,7 +19,7 @@ the Application Service and Database Service. - A host where you have installed and configured the `teleport` binary. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Enable verbose logging diff --git a/docs/pages/management/admin/users.mdx b/docs/pages/management/admin/users.mdx index 97008bc2c0614..7bb98f1115798 100644 --- a/docs/pages/management/admin/users.mdx +++ b/docs/pages/management/admin/users.mdx @@ -20,7 +20,7 @@ This guide shows you how to: (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Adding local users diff --git a/docs/pages/management/export-audit-events/datadog.mdx b/docs/pages/management/export-audit-events/datadog.mdx index 589c7e857242b..cf4a7a6246799 100644 --- a/docs/pages/management/export-audit-events/datadog.mdx +++ b/docs/pages/management/export-audit-events/datadog.mdx @@ -63,7 +63,7 @@ d-->h(Datadog) The instructions below demonstrate a local test of the Event Handler plugin on your workstation. You will need to adjust paths, ports, and domains for other environments. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/6. Install the Event Handler plugin diff --git a/docs/pages/management/export-audit-events/fluentd.mdx b/docs/pages/management/export-audit-events/fluentd.mdx index 95320910136b3..0c75e77912c7d 100644 --- a/docs/pages/management/export-audit-events/fluentd.mdx +++ b/docs/pages/management/export-audit-events/fluentd.mdx @@ -46,7 +46,7 @@ to integrate with your infrastructure. - Fluentd version v(=fluentd.version=) or greater. - Docker version v(=docker.version=). -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) - On your workstation, create a folder called `event-handler`, to hold configuration files and plugin state: diff --git a/docs/pages/management/export-audit-events/splunk.mdx b/docs/pages/management/export-audit-events/splunk.mdx index d2c4feb382a91..567ddd13d969c 100644 --- a/docs/pages/management/export-audit-events/splunk.mdx +++ b/docs/pages/management/export-audit-events/splunk.mdx @@ -38,7 +38,7 @@ visualization and alerting. - On Splunk Enterprise, port `8088` should be open to traffic from the host running the Teleport Event Handler and Universal Forwarder. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up the Teleport Event Handler plugin diff --git a/docs/pages/management/guides/joining-nodes-aws-ec2.mdx b/docs/pages/management/guides/joining-nodes-aws-ec2.mdx index 1ec0d624cd157..65dc9e47544d4 100644 --- a/docs/pages/management/guides/joining-nodes-aws-ec2.mdx +++ b/docs/pages/management/guides/joining-nodes-aws-ec2.mdx @@ -89,7 +89,7 @@ more in the following guide: -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up AWS IAM credentials diff --git a/docs/pages/management/guides/joining-nodes-aws-iam.mdx b/docs/pages/management/guides/joining-nodes-aws-iam.mdx index ba036f3fc0f3d..a95ae71a9aaaa 100644 --- a/docs/pages/management/guides/joining-nodes-aws-iam.mdx +++ b/docs/pages/management/guides/joining-nodes-aws-iam.mdx @@ -65,7 +65,7 @@ connecting directly to the Auth Service. - An AWS EC2 instance to act as a Teleport Node, with the Teleport binary installed. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up AWS IAM credentials Every Node or Proxy using the IAM method to join your Teleport cluster needs AWS diff --git a/docs/pages/management/guides/joining-nodes-azure.mdx b/docs/pages/management/guides/joining-nodes-azure.mdx index bc5386e5d6e6f..ce0a407e98c90 100644 --- a/docs/pages/management/guides/joining-nodes-azure.mdx +++ b/docs/pages/management/guides/joining-nodes-azure.mdx @@ -41,7 +41,7 @@ connecting directly to the Auth Service. [Managed Identity](https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview) assigned to it with permission to read virtual machine info. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up a Managed Identity Every virtual machine hosting a Node or Proxy using the Azure method to join diff --git a/docs/pages/management/guides/terraform-provider.mdx b/docs/pages/management/guides/terraform-provider.mdx index 6340ae44991cf..6573397552e4c 100644 --- a/docs/pages/management/guides/terraform-provider.mdx +++ b/docs/pages/management/guides/terraform-provider.mdx @@ -20,7 +20,7 @@ This guide will explain how to: # Terraform v(=terraform.version=) ``` -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) Create a folder called `teleport-terraform` to hold some temporary files: diff --git a/docs/pages/management/operations/ca-rotation.mdx b/docs/pages/management/operations/ca-rotation.mdx index 23e9fc26865ab..e3bb23299feef 100644 --- a/docs/pages/management/operations/ca-rotation.mdx +++ b/docs/pages/management/operations/ca-rotation.mdx @@ -7,7 +7,7 @@ description: How to rotate Teleport's certificate authority (!docs/pages/includes/edition-prereqs-tabs.mdx!) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Certificate Authority rotation diff --git a/docs/pages/management/security/reduce-blast-radius.mdx b/docs/pages/management/security/reduce-blast-radius.mdx index 9ef1b896b3b83..5a9cc496e5c3c 100644 --- a/docs/pages/management/security/reduce-blast-radius.mdx +++ b/docs/pages/management/security/reduce-blast-radius.mdx @@ -12,7 +12,7 @@ Teleport encourages users to practice defense in depth so that every component o - [Restrict role requests based on user traits](#restrict-role-requests-based-on-user-traits) - [Set up your RBAC without admin roles](#set-up-your-rbac-without-admin-roles) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Make MFA mandatory for `tsh login` If a user sets up an account to authenticate to their Teleport cluster with only a password, an adversary can gain access to the password using brute-force attacks, person-in-the-middle attacks, or phishing. But even if a user's password is compromised, you can stop an attacker from authenticating with it when they run `tsh login`. diff --git a/docs/pages/reference/resources.mdx b/docs/pages/reference/resources.mdx index d9524a0896d77..7fa009bbdf959 100644 --- a/docs/pages/reference/resources.mdx +++ b/docs/pages/reference/resources.mdx @@ -26,7 +26,7 @@ users. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ### `tctl` concepts diff --git a/docs/pages/server-access/getting-started.mdx b/docs/pages/server-access/getting-started.mdx index af040a9dd06ff..7f4099468d5c2 100644 --- a/docs/pages/server-access/getting-started.mdx +++ b/docs/pages/server-access/getting-started.mdx @@ -30,7 +30,7 @@ This guide introduces some of these common scenarios and how to interact with Te - One host running a Linux environment (such as Ubuntu 20.04, CentOS 8.0, or Debian 10). This will serve as a Teleport Node. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) (!docs/pages/includes/permission-warning.mdx!) diff --git a/docs/pages/server-access/guides/auditd.mdx b/docs/pages/server-access/guides/auditd.mdx index 7f8dd3c79d428..4b0f8ed3a9536 100644 --- a/docs/pages/server-access/guides/auditd.mdx +++ b/docs/pages/server-access/guides/auditd.mdx @@ -14,7 +14,7 @@ You can configure Teleport's SSH Service to integrate with the Linux Auditing Sy - Linux kernel 2.6.6+ compiled with `CONFIG_AUDIT`. Most Linux distributions have this option enabled by default. - `auditctl` to check auditd status (optional). -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Check system configuration diff --git a/docs/pages/server-access/guides/azure-discovery.mdx b/docs/pages/server-access/guides/azure-discovery.mdx index e4fa7225bf0d5..ad23daf18285d 100644 --- a/docs/pages/server-access/guides/azure-discovery.mdx +++ b/docs/pages/server-access/guides/azure-discovery.mdx @@ -18,7 +18,7 @@ managed identities. Ubuntu/Debian/RHEL if making use of the default Teleport install script. (For other Linux distributions, you can install Teleport manually.) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create an Azure invite token diff --git a/docs/pages/server-access/guides/bpf-session-recording.mdx b/docs/pages/server-access/guides/bpf-session-recording.mdx index 3bf0a5b028177..60206b5f490df 100644 --- a/docs/pages/server-access/guides/bpf-session-recording.mdx +++ b/docs/pages/server-access/guides/bpf-session-recording.mdx @@ -93,7 +93,7 @@ library preloading, and environment variables may not be captured in session rec -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/2. Configure a Teleport Node diff --git a/docs/pages/server-access/guides/ec2-discovery.mdx b/docs/pages/server-access/guides/ec2-discovery.mdx index 6be6dc531d427..069fb2a28741c 100644 --- a/docs/pages/server-access/guides/ec2-discovery.mdx +++ b/docs/pages/server-access/guides/ec2-discovery.mdx @@ -22,7 +22,7 @@ policies. default Teleport install script. (For other Linux distributions, you can install Teleport manually.) -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/7. Create an EC2 invite token diff --git a/docs/pages/server-access/guides/host-user-creation.mdx b/docs/pages/server-access/guides/host-user-creation.mdx index b54399f399c9c..e8dfb9242bf3d 100644 --- a/docs/pages/server-access/guides/host-user-creation.mdx +++ b/docs/pages/server-access/guides/host-user-creation.mdx @@ -29,7 +29,7 @@ since it must execute these commands in order to create transient users: - `getent` - `visudo` -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/2. Configure a role diff --git a/docs/pages/server-access/guides/openssh.mdx b/docs/pages/server-access/guides/openssh.mdx index 1a1a30044e1f4..2eebcddc22fd3 100644 --- a/docs/pages/server-access/guides/openssh.mdx +++ b/docs/pages/server-access/guides/openssh.mdx @@ -27,7 +27,7 @@ We've outlined these reasons in [OpenSSH vs Teleport SSH for Servers?](https://g SSH port on this host must be open to traffic from the Teleport Proxy Service host. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Configure `sshd` to trust the Teleport CA diff --git a/docs/pages/server-access/guides/restricted-session.mdx b/docs/pages/server-access/guides/restricted-session.mdx index 1f4b707c6ebd9..dd5227b28364f 100644 --- a/docs/pages/server-access/guides/restricted-session.mdx +++ b/docs/pages/server-access/guides/restricted-session.mdx @@ -37,7 +37,7 @@ Teleport supports network restrictions with more types coming in the future. -(!docs/pages/includes/tctl.mdx!) +- (!docs/pages/includes/tctl.mdx!) ## Network Restrictions From eb8c77f5c7efae370e1b587a8059cedbbc357fdb Mon Sep 17 00:00:00 2001 From: alexfornuto Date: Tue, 4 Apr 2023 12:50:01 -0500 Subject: [PATCH 3/3] docs linter fixes --- .../access-request-plugins/ssh-approval-discord.mdx | 1 - .../access-request-plugins/ssh-approval-mattermost.mdx | 1 - docs/pages/access-controls/guides/per-session-mfa.mdx | 3 +-- docs/pages/access-controls/guides/webauthn.mdx | 1 - docs/pages/access-controls/idps/saml-guide.mdx | 2 +- docs/pages/access-controls/sso/okta.mdx | 1 - docs/pages/application-access/getting-started.mdx | 1 - docs/pages/application-access/guides/tcp.mdx | 1 - docs/pages/database-access/guides/azure-redis.mdx | 1 - docs/pages/database-access/guides/azure-sql-server-ad.mdx | 1 - docs/pages/database-access/guides/cassandra-self-hosted.mdx | 1 - .../pages/database-access/guides/cockroachdb-self-hosted.mdx | 2 -- docs/pages/database-access/guides/mongodb-atlas.mdx | 1 - docs/pages/database-access/guides/mysql-cloudsql.mdx | 1 - docs/pages/database-access/guides/mysql-self-hosted.mdx | 1 - docs/pages/database-access/guides/postgres-cloudsql.mdx | 1 - docs/pages/database-access/guides/postgres-redshift.mdx | 1 - docs/pages/database-access/guides/postgres-self-hosted.mdx | 1 - docs/pages/database-access/guides/rds-proxy.mdx | 1 - docs/pages/database-access/guides/rds.mdx | 1 - docs/pages/database-access/guides/sql-server-ad.mdx | 1 - docs/pages/desktop-access/getting-started.mdx | 1 - .../register-clusters/static-kubeconfig.mdx | 1 - docs/pages/machine-id/guides/circleci.mdx | 1 - docs/pages/machine-id/guides/github-actions.mdx | 1 - docs/pages/machine-id/guides/gitlab.mdx | 1 - docs/pages/management/admin/adding-nodes.mdx | 3 +-- docs/pages/management/admin/labels.mdx | 1 - docs/pages/management/export-audit-events/fluentd.mdx | 1 + docs/pages/management/guides/joining-nodes-aws-iam.mdx | 2 +- docs/pages/management/guides/joining-nodes-azure.mdx | 2 +- docs/pages/management/security/reduce-blast-radius.mdx | 2 +- docs/pages/server-access/getting-started.mdx | 5 ++--- docs/pages/server-access/guides/auditd.mdx | 2 +- docs/pages/server-access/guides/azure-discovery.mdx | 1 - docs/pages/server-access/guides/ec2-discovery.mdx | 1 - docs/pages/server-access/guides/openssh.mdx | 1 - 37 files changed, 10 insertions(+), 41 deletions(-) diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx index 54449e43e8702..c75b0e30e8166 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx @@ -16,7 +16,6 @@ compromising productivity. - Admin account on your Discord server. Installing a bot requires at least the "manager server" permission. - Either a Linux host or Kubernetes cluster where you will run the Discord plugin. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/8. Define RBAC resources diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx index 3e02f140ac5c4..02c75c2944163 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx @@ -16,7 +16,6 @@ compromising productivity. - A Mattermost account with admin privileges. This plugin has been tested with Mattermost v7.0.1. - Either a Linux host or Kubernetes cluster where you will run the Mattermost plugin. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/8. Define RBAC resources diff --git a/docs/pages/access-controls/guides/per-session-mfa.mdx b/docs/pages/access-controls/guides/per-session-mfa.mdx index c0fd17a6276f5..4f9da7652788a 100644 --- a/docs/pages/access-controls/guides/per-session-mfa.mdx +++ b/docs/pages/access-controls/guides/per-session-mfa.mdx @@ -38,13 +38,11 @@ their on-disk Teleport certificates. Per-session MFA for Desktop Access was introduced in Teleport 9. - ## Prerequisites (!docs/pages/includes/edition-prereqs-tabs.mdx!) - (!docs/pages/includes/tctl.mdx!) - - [WebAuthn configured](webauthn.mdx) on this cluster - Second factor hardware device, such as YubiKey or SoloKey - A Web browser with [WebAuthn support]( @@ -64,6 +62,7 @@ teleport: webauthn: rp_id: teleport.example.com ``` + ## Configure per-session MFA diff --git a/docs/pages/access-controls/guides/webauthn.mdx b/docs/pages/access-controls/guides/webauthn.mdx index 17558b924d2bd..91eebded132e7 100644 --- a/docs/pages/access-controls/guides/webauthn.mdx +++ b/docs/pages/access-controls/guides/webauthn.mdx @@ -20,7 +20,6 @@ UI). - WebAuthn hardware device, such as YubiKey or SoloKey - A Web browser with [WebAuthn support]( https://developers.yubico.com/WebAuthn/WebAuthn_Browser_Support/) - - (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Enable WebAuthn support diff --git a/docs/pages/access-controls/idps/saml-guide.mdx b/docs/pages/access-controls/idps/saml-guide.mdx index 5f131406d9a83..a91db6dba732e 100644 --- a/docs/pages/access-controls/idps/saml-guide.mdx +++ b/docs/pages/access-controls/idps/saml-guide.mdx @@ -18,9 +18,9 @@ authenticate to external services. (!docs/pages/includes/commercial-prereqs-tabs.mdx!) - (!docs/pages/includes/tctl.mdx!) - - If you're new to SAML, consider reviewing our [SAML Identity Provider Reference](./saml-reference.mdx) before proceeding. + ## Example external application We'll be using [samltest.id](https://samltest.id/) to create a test consumer of diff --git a/docs/pages/access-controls/sso/okta.mdx b/docs/pages/access-controls/sso/okta.mdx index f9b790868520d..d0a9aa0b16623 100644 --- a/docs/pages/access-controls/sso/okta.mdx +++ b/docs/pages/access-controls/sso/okta.mdx @@ -23,7 +23,6 @@ Teleport administrators to define policies like: - A Teleport role with access to edit and maintain `saml` resources. This is available in the default `editor` role. - - (!docs/pages/includes/tctl.mdx!) (!docs/pages/includes/enterprise/samlauthentication.mdx!) diff --git a/docs/pages/application-access/getting-started.mdx b/docs/pages/application-access/getting-started.mdx index 2902ca27c436d..102807b06fd49 100644 --- a/docs/pages/application-access/getting-started.mdx +++ b/docs/pages/application-access/getting-started.mdx @@ -22,7 +22,6 @@ Let's connect to Grafana using Teleport Application Access in three steps: (!docs/pages/includes/edition-prereqs-tabs.mdx!) - (!docs/pages/includes/tctl.mdx!) - - A Docker installation, which we will use to launch Grafana in a container. Alternatively, if you have another web application you'd like to protect with Application Access, you can use that instead. - A host where you will run the Teleport Application Service. diff --git a/docs/pages/application-access/guides/tcp.mdx b/docs/pages/application-access/guides/tcp.mdx index c8d7a04bb5044..c6853dd4a3fbb 100644 --- a/docs/pages/application-access/guides/tcp.mdx +++ b/docs/pages/application-access/guides/tcp.mdx @@ -12,7 +12,6 @@ servers or databases not yet natively supported in Database Access. (!docs/pages/includes/edition-prereqs-tabs.mdx!) - (!docs/pages/includes/tctl.mdx!) - - TCP application to connect to. In this guide we'll use a PostgreSQL running in Docker as an example. You can also use any TCP-based application you may already have. diff --git a/docs/pages/database-access/guides/azure-redis.mdx b/docs/pages/database-access/guides/azure-redis.mdx index 99842b1e0a922..4f7bcdbbdb2ae 100644 --- a/docs/pages/database-access/guides/azure-redis.mdx +++ b/docs/pages/database-access/guides/azure-redis.mdx @@ -28,7 +28,6 @@ This guide will help you to: Service. - `redis-cli` version `6.2` or newer installed and added to your system's `PATH` environment variable. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create a Teleport user diff --git a/docs/pages/database-access/guides/azure-sql-server-ad.mdx b/docs/pages/database-access/guides/azure-sql-server-ad.mdx index 81423da5f9b21..467151ad7f34f 100644 --- a/docs/pages/database-access/guides/azure-sql-server-ad.mdx +++ b/docs/pages/database-access/guides/azure-sql-server-ad.mdx @@ -38,7 +38,6 @@ This guide will help you to: - SQL Server running on Azure. - The Teleport Database Service running on an Azure virtual instance. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/8. Create a Teleport user diff --git a/docs/pages/database-access/guides/cassandra-self-hosted.mdx b/docs/pages/database-access/guides/cassandra-self-hosted.mdx index bec997f8d855e..2613ab7fe6c09 100644 --- a/docs/pages/database-access/guides/cassandra-self-hosted.mdx +++ b/docs/pages/database-access/guides/cassandra-self-hosted.mdx @@ -33,7 +33,6 @@ This guide will help you to: - Self-hosted Cassandra or ScyllaDB instance. - The `cqlsh` Cassandra client installed and added to your system's `PATH` environment variable. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx b/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx index 14d68be09bc5d..739134650910b 100644 --- a/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx +++ b/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx @@ -19,7 +19,6 @@ This guide will help you to: 2. Configure mutual TLS authentication between Teleport and your CockroachDB cluster. 3. Connect to your CockroachDB cluster via Teleport. - ![Teleport Database Access CockroachDB Self-Hosted](../../../img/database-access/guides/cockroachdb_selfhosted.png) @@ -34,7 +33,6 @@ This guide will help you to: - CockroachDB cluster. - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/mongodb-atlas.mdx b/docs/pages/database-access/guides/mongodb-atlas.mdx index 668e52f45f6a9..febab1dd80657 100644 --- a/docs/pages/database-access/guides/mongodb-atlas.mdx +++ b/docs/pages/database-access/guides/mongodb-atlas.mdx @@ -24,7 +24,6 @@ In this guide you will: - [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) cluster. - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/mysql-cloudsql.mdx b/docs/pages/database-access/guides/mysql-cloudsql.mdx index dc907e1b43556..93afe819803f2 100644 --- a/docs/pages/database-access/guides/mysql-cloudsql.mdx +++ b/docs/pages/database-access/guides/mysql-cloudsql.mdx @@ -30,7 +30,6 @@ Teleport Database Access for Cloud SQL MySQL is available starting from the - Google Cloud account - A host, e.g., a Compute Engine instance, where you will run the Teleport Database Service - - (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create a service account for the Teleport Database Service diff --git a/docs/pages/database-access/guides/mysql-self-hosted.mdx b/docs/pages/database-access/guides/mysql-self-hosted.mdx index 7f01453154a13..3ac02ef68606e 100644 --- a/docs/pages/database-access/guides/mysql-self-hosted.mdx +++ b/docs/pages/database-access/guides/mysql-self-hosted.mdx @@ -23,7 +23,6 @@ This guide will help you to: - A self-hosted MySQL or MariaDB instance. - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/postgres-cloudsql.mdx b/docs/pages/database-access/guides/postgres-cloudsql.mdx index 50389e611b689..6ae1868421b9e 100644 --- a/docs/pages/database-access/guides/postgres-cloudsql.mdx +++ b/docs/pages/database-access/guides/postgres-cloudsql.mdx @@ -25,7 +25,6 @@ This guide will help you to: - Command-line client `psql` installed and added to your system's `PATH` environment variable. - A host, e.g., a Compute Engine instance, where you will run the Teleport Database Service - - (!docs/pages/includes/tctl.mdx!) ## Step 1/7. Enable Cloud SQL IAM authentication diff --git a/docs/pages/database-access/guides/postgres-redshift.mdx b/docs/pages/database-access/guides/postgres-redshift.mdx index 4bee50312b2d0..520758c197b94 100644 --- a/docs/pages/database-access/guides/postgres-redshift.mdx +++ b/docs/pages/database-access/guides/postgres-redshift.mdx @@ -26,7 +26,6 @@ This guide will help you to: - Command-line client `psql` installed and added to your system's `PATH` environment variable. - A host, e.g., an EC2 instance, where you will run the Teleport Database Service. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create a Teleport user diff --git a/docs/pages/database-access/guides/postgres-self-hosted.mdx b/docs/pages/database-access/guides/postgres-self-hosted.mdx index 1830a6abcec9c..c40f278203a2e 100644 --- a/docs/pages/database-access/guides/postgres-self-hosted.mdx +++ b/docs/pages/database-access/guides/postgres-self-hosted.mdx @@ -24,7 +24,6 @@ This guide will help you to: - Command-line client `psql` installed and added to your system's `PATH` environment variable. - A host, e.g., an Amazon EC2 instance, where you will run the Teleport Database Service. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Set up the Teleport Database Service diff --git a/docs/pages/database-access/guides/rds-proxy.mdx b/docs/pages/database-access/guides/rds-proxy.mdx index ffc33ddbd61bc..b6ade327a6de9 100644 --- a/docs/pages/database-access/guides/rds-proxy.mdx +++ b/docs/pages/database-access/guides/rds-proxy.mdx @@ -25,7 +25,6 @@ Teleport currently supports RDS Proxy instances with engine family - Any RDS Proxy instances intended for connection through Teleport must have TLS enabled. - A host, e.g., an EC2 instance, where you will run the Teleport Database Service. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/5. Create a Database Service configuration diff --git a/docs/pages/database-access/guides/rds.mdx b/docs/pages/database-access/guides/rds.mdx index 5c65779275d0d..608577f327530 100644 --- a/docs/pages/database-access/guides/rds.mdx +++ b/docs/pages/database-access/guides/rds.mdx @@ -35,7 +35,6 @@ This guide will help you to: IAM policies. - A host, e.g., an EC2 instance, where you will run the Teleport Database Service. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/6. Create a Teleport user diff --git a/docs/pages/database-access/guides/sql-server-ad.mdx b/docs/pages/database-access/guides/sql-server-ad.mdx index 420eea2746161..bafe5d90e66ed 100644 --- a/docs/pages/database-access/guides/sql-server-ad.mdx +++ b/docs/pages/database-access/guides/sql-server-ad.mdx @@ -44,7 +44,6 @@ Directory authentication. - A Windows machine joined to the same Active Directory domain as the database. - A Linux node joined to the same Active Directory domain as the database. This guide will walk you through the joining steps if you don't have one. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/7. Create a Teleport user diff --git a/docs/pages/desktop-access/getting-started.mdx b/docs/pages/desktop-access/getting-started.mdx index c78a33d048135..de5e8f388ea26 100644 --- a/docs/pages/desktop-access/getting-started.mdx +++ b/docs/pages/desktop-access/getting-started.mdx @@ -37,7 +37,6 @@ an [Active Directory domain](./active-directory.mdx). You can reuse an existing server running any other Teleport instance. - A server or virtual machine running a Windows operating system with Remote Desktop enabled and the RDP port available to the Linux server. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Prepare Windows diff --git a/docs/pages/kubernetes-access/register-clusters/static-kubeconfig.mdx b/docs/pages/kubernetes-access/register-clusters/static-kubeconfig.mdx index 7b6067e8399fd..aced14c6e5fef 100644 --- a/docs/pages/kubernetes-access/register-clusters/static-kubeconfig.mdx +++ b/docs/pages/kubernetes-access/register-clusters/static-kubeconfig.mdx @@ -23,7 +23,6 @@ authenticate to the API server of your chosen Kubernetes cluster. Kubernetes Service. This can run outside of your Kubernetes cluster. - The [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) command line tool installed on your workstation. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/4. Generate a kubeconfig file diff --git a/docs/pages/machine-id/guides/circleci.mdx b/docs/pages/machine-id/guides/circleci.mdx index 5e73942ac2b66..921867de1f417 100644 --- a/docs/pages/machine-id/guides/circleci.mdx +++ b/docs/pages/machine-id/guides/circleci.mdx @@ -26,7 +26,6 @@ control. (!docs/pages/includes/edition-prereqs-tabs.mdx!) - (!docs/pages/includes/tctl.mdx!) - - A running instance of the Teleport SSH Service that you have registered with your Teleport cluster. For instructions on setting this up, see the [Getting Started Guide](../../server-access/introduction.mdx). The SSH node must diff --git a/docs/pages/machine-id/guides/github-actions.mdx b/docs/pages/machine-id/guides/github-actions.mdx index 73b1b5743057f..c6a1cbdbd1dc7 100644 --- a/docs/pages/machine-id/guides/github-actions.mdx +++ b/docs/pages/machine-id/guides/github-actions.mdx @@ -28,7 +28,6 @@ Actions runners as well as GitHub Enterprise Server. (!docs/pages/includes/edition-prereqs-tabs.mdx!) - (!docs/pages/includes/tctl.mdx!) - - A node that is a part of the Teleport cluster with [Server Access](https://goteleport.com/docs/server-access/introduction/). - Your user should have the privileges to create token resources. - A GitHub repository with GitHub Actions enabled. This guide uses the example `gravitational/example` diff --git a/docs/pages/machine-id/guides/gitlab.mdx b/docs/pages/machine-id/guides/gitlab.mdx index f1f0bbf3bcb35..b236b50266683 100644 --- a/docs/pages/machine-id/guides/gitlab.mdx +++ b/docs/pages/machine-id/guides/gitlab.mdx @@ -30,7 +30,6 @@ control. (!docs/pages/includes/edition-prereqs-tabs.mdx!) - (!docs/pages/includes/tctl.mdx!) - - A running instance of the Teleport SSH Service registered with your Teleport cluster. For instructions on setting this up, see the [Getting Started Guide](../../server-access/introduction.mdx). The SSH node must include a user diff --git a/docs/pages/management/admin/adding-nodes.mdx b/docs/pages/management/admin/adding-nodes.mdx index 20f50cd9afedb..43fce9d49a953 100644 --- a/docs/pages/management/admin/adding-nodes.mdx +++ b/docs/pages/management/admin/adding-nodes.mdx @@ -10,7 +10,6 @@ This guide explains how to add Teleport Nodes to your cluster. (!docs/pages/includes/edition-prereqs-tabs.mdx!) - A Linux server that you will use to host your Teleport Node. - - (!docs/pages/includes/tctl.mdx!) ## Step 1/3. Install Teleport on your Node @@ -45,7 +44,7 @@ print a warning message. The CA pin becomes invalid if a Teleport administrator performs the CA rotation by executing [`tctl auth rotate`](../../reference/cli.mdx#tctl-auth-rotate). - + On you local machine, retrieve the CA pin of the Auth Service