From f223ba76b55af441fbe40881c088f124268c266a Mon Sep 17 00:00:00 2001 From: Alex Fornuto Date: Tue, 16 May 2023 10:44:43 -0500 Subject: [PATCH] remove opened var when set to false (#26245) --- docs/pages/access-controls/guides/locking.mdx | 3 +-- docs/pages/access-controls/guides/per-session-mfa.mdx | 1 - docs/pages/access-controls/reference.mdx | 2 +- docs/pages/application-access/guides/dynamodb.mdx | 2 +- docs/pages/connect-your-client/tsh.mdx | 2 +- docs/pages/database-access/guides/elastic.mdx | 2 +- docs/pages/database-access/guides/redis-cluster.mdx | 2 +- docs/pages/database-access/reference/aws.mdx | 4 ++-- docs/pages/desktop-access/rbac.mdx | 2 +- .../database-access/aws-troubleshooting-max-policy-size.mdx | 2 +- docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx | 5 +---- docs/pages/includes/dns.mdx | 4 ++-- docs/pages/includes/permission-warning.mdx | 2 +- docs/pages/machine-id/getting-started.mdx | 2 +- docs/pages/machine-id/guides/ansible.mdx | 2 +- docs/pages/management/admin/labels.mdx | 4 ++-- docs/pages/management/admin/trustedclusters.mdx | 4 ++-- .../pages/management/admin/upgrading-the-teleport-binary.mdx | 2 +- docs/pages/reference/cli.mdx | 2 +- docs/pages/reference/helm-reference/teleport-cluster.mdx | 2 +- docs/pages/server-access/guides/bpf-session-recording.mdx | 2 +- docs/pages/server-access/guides/openssh.mdx | 4 ++-- 22 files changed, 26 insertions(+), 31 deletions(-) diff --git a/docs/pages/access-controls/guides/locking.mdx b/docs/pages/access-controls/guides/locking.mdx index e203a58630f..a9e701207d0 100644 --- a/docs/pages/access-controls/guides/locking.mdx +++ b/docs/pages/access-controls/guides/locking.mdx @@ -99,7 +99,6 @@ with one of the following options:
If your user is missing a lock permission, you will get an error when creating @@ -149,7 +148,7 @@ $ tctl lock --user=foo@example.com --message="Please come back tomorrow." --ttl= ``` -
+
Note that without specifying `--ttl` or `--expires`, the created lock remains in force until explicitly removed with `tctl rm`. Refer to `tctl lock --help` for the list of all supported parameters. diff --git a/docs/pages/access-controls/guides/per-session-mfa.mdx b/docs/pages/access-controls/guides/per-session-mfa.mdx index 35347239c8a..eb4f8aa49e4 100644 --- a/docs/pages/access-controls/guides/per-session-mfa.mdx +++ b/docs/pages/access-controls/guides/per-session-mfa.mdx @@ -24,7 +24,6 @@ their on-disk Teleport certificates.
+
Teleport versions prior to 8.1 don't support the roles shown below. You may create these roles after upgrading, but in the event of a cluster downgrade they will become invalid. diff --git a/docs/pages/application-access/guides/dynamodb.mdx b/docs/pages/application-access/guides/dynamodb.mdx index eadaf1ca6ef..5fbe30bee5a 100644 --- a/docs/pages/application-access/guides/dynamodb.mdx +++ b/docs/pages/application-access/guides/dynamodb.mdx @@ -96,7 +96,7 @@ spec: - arn:aws:iam::123456789000:role/ExampleTeleportDynamoDBRole ``` -
+
The `aws_role_arns` field supports template variables so they can be populated dynamically based on your users' identity provider attributes. See [Role Templates](../../access-controls/guides/role-templates.mdx) for details. diff --git a/docs/pages/connect-your-client/tsh.mdx b/docs/pages/connect-your-client/tsh.mdx index 592e1189678..315259f6716 100644 --- a/docs/pages/connect-your-client/tsh.mdx +++ b/docs/pages/connect-your-client/tsh.mdx @@ -411,7 +411,7 @@ $ tsh ls os=osx [CLI Docs -tsh ls](../reference/cli.mdx#tsh-ls) -
+
(!docs/pages/includes/node-logins.mdx!) diff --git a/docs/pages/database-access/guides/elastic.mdx b/docs/pages/database-access/guides/elastic.mdx index 8503d7a3dba..1c3597ceab5 100644 --- a/docs/pages/database-access/guides/elastic.mdx +++ b/docs/pages/database-access/guides/elastic.mdx @@ -79,7 +79,7 @@ $ curl -u elastic:your_elasticsearch_password -X POST "https://elasticsearch.exa ' ``` -
+
In a scenario where Teleport is using [single sign-on](../../access-controls/sso.mdx) you may want to define a mapping for all users to a role: diff --git a/docs/pages/database-access/guides/redis-cluster.mdx b/docs/pages/database-access/guides/redis-cluster.mdx index 0f4ff89a1a2..154402fcb8a 100644 --- a/docs/pages/database-access/guides/redis-cluster.mdx +++ b/docs/pages/database-access/guides/redis-cluster.mdx @@ -161,7 +161,7 @@ databases: Redis in cluster mode does not support the following commands. If one of the listed commands above is called Teleport returns the `ERR Teleport: command not supported` error. -
+
- `ACL` - `ASKING` - `CLIENT` diff --git a/docs/pages/database-access/reference/aws.mdx b/docs/pages/database-access/reference/aws.mdx index 8c2f424870b..db259e77cb0 100644 --- a/docs/pages/database-access/reference/aws.mdx +++ b/docs/pages/database-access/reference/aws.mdx @@ -399,7 +399,7 @@ IAM policies with the required permissions are shown below. To connect to an RDS database, the Database Service instance's IAM identity needs to have `rds-db:connect` permissions for it: -
+
```json { "Version": "2012-10-17", @@ -446,7 +446,7 @@ Redshift databases. In order to authorize Teleport to generate temporary IAM tokens, create an IAM role with the `GetClusterCredentials` permission: -
+
```json { "Version": "2012-10-17", diff --git a/docs/pages/desktop-access/rbac.mdx b/docs/pages/desktop-access/rbac.mdx index d7691f9ca67..a6bcd22b28e 100644 --- a/docs/pages/desktop-access/rbac.mdx +++ b/docs/pages/desktop-access/rbac.mdx @@ -191,7 +191,7 @@ allow: ### Automatic User Creation -
+
Teleport versions prior to 12.3 don't support the options shown below.
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 76b5f7a5d57..8818d9ab718 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 @@ -15,7 +15,7 @@ or 100 RDS databases. One way to work around this is to manually manage the IAM policy used for database connections, and use a wildcard `"*"` for `"Resource"` to reduce the policy size: -
+
Attach a policy with the following permissions to the IAM user or role: diff --git a/docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx b/docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx index 4ac4477ccb0..f1b9b098c29 100644 --- a/docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx +++ b/docs/pages/includes/diagnostics/diag-addr-prereqs-tabs.mdx @@ -31,10 +31,7 @@ them via: -
+
Verify that Teleport is now serving the diagnostics endpoint: diff --git a/docs/pages/includes/dns.mdx b/docs/pages/includes/dns.mdx index 5404d641a12..29d7a43eaa2 100644 --- a/docs/pages/includes/dns.mdx +++ b/docs/pages/includes/dns.mdx @@ -3,11 +3,11 @@ Set up two `A` DNS records: `tele.example.com` for all traffic and that your domain name is `example.com`. Use your own subdomain instead of `tele`. -
+
(!docs/pages/includes/dns-app-access.mdx!)
-
+
Execute the following commands on the host where you are running the Teleport Proxy Service: diff --git a/docs/pages/includes/permission-warning.mdx b/docs/pages/includes/permission-warning.mdx index 1a51f7824fb..ab9fb6b934f 100644 --- a/docs/pages/includes/permission-warning.mdx +++ b/docs/pages/includes/permission-warning.mdx @@ -1,4 +1,4 @@ -
+
When running Teleport in production, we recommend that you follow the practices below to avoid security incidents. These practices may differ from diff --git a/docs/pages/machine-id/getting-started.mdx b/docs/pages/machine-id/getting-started.mdx index 3472dd33fd5..f268f3a4eb6 100644 --- a/docs/pages/machine-id/getting-started.mdx +++ b/docs/pages/machine-id/getting-started.mdx @@ -264,7 +264,7 @@ Node Name Address Labels node-name 127.0.0.1:3022 arch=x86_64,group=api-servers ``` -
+
(!docs/pages/includes/node-logins.mdx!) diff --git a/docs/pages/machine-id/guides/ansible.mdx b/docs/pages/machine-id/guides/ansible.mdx index f908bbd119c..1c06777bd5a 100644 --- a/docs/pages/machine-id/guides/ansible.mdx +++ b/docs/pages/machine-id/guides/ansible.mdx @@ -64,7 +64,7 @@ $ # Replace ".example.com" below with the name of your cluster. $ tsh ls --format=json | jq -r '.[].spec.hostname + ".example.com"' > hosts ``` -
+
(!docs/pages/includes/node-logins.mdx!) diff --git a/docs/pages/management/admin/labels.mdx b/docs/pages/management/admin/labels.mdx index 7a8081b43fe..b54588ebc3a 100644 --- a/docs/pages/management/admin/labels.mdx +++ b/docs/pages/management/admin/labels.mdx @@ -165,7 +165,7 @@ Node Name Address Labels bdcb47b87ad6 ⟵ Tunnel environment=dev ``` -
+
First, check the logs for your Node to ensure the SSH Service is running. Your logs should resemble the following: @@ -248,7 +248,7 @@ you run `tsh ls`.
-
+
If you wish to use labels for RBAC purposes but don't want to see the labels in the UI, you can put them in the hidden namespace by prefixing the label's diff --git a/docs/pages/management/admin/trustedclusters.mdx b/docs/pages/management/admin/trustedclusters.mdx index b41f5ba0f1b..8aa8994d03f 100644 --- a/docs/pages/management/admin/trustedclusters.mdx +++ b/docs/pages/management/admin/trustedclusters.mdx @@ -322,7 +322,7 @@ Token Type (=presets.tokens.first=) trusted_cluster 28 Apr 22 19:19 UTC (4m48s) ``` -
+
You can revoke a join token with the following command: @@ -568,7 +568,7 @@ Create the Trusted Cluster: $ tctl create trusted_cluster.yaml ``` -
+
You can easily configure leaf nodes using the Teleport Web UI. diff --git a/docs/pages/management/admin/upgrading-the-teleport-binary.mdx b/docs/pages/management/admin/upgrading-the-teleport-binary.mdx index 9c6a1a65f1d..999428d7d8c 100644 --- a/docs/pages/management/admin/upgrading-the-teleport-binary.mdx +++ b/docs/pages/management/admin/upgrading-the-teleport-binary.mdx @@ -58,7 +58,7 @@ $ pidof teleport In our example, `235276` is a PID of the child process, and `235119` is a PID of the parent. -
+
You can use the following command, which prints the parent for each PID returned by `pidof`: diff --git a/docs/pages/reference/cli.mdx b/docs/pages/reference/cli.mdx index 9fcbb15bd6f..a7e1171b019 100644 --- a/docs/pages/reference/cli.mdx +++ b/docs/pages/reference/cli.mdx @@ -841,7 +841,7 @@ List cluster nodes: $ tsh ls [] [