Skip to content

Commit

Permalink
docs linter fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
alexfornuto committed Apr 4, 2023
1 parent 5823d63 commit c5ac2f1
Show file tree
Hide file tree
Showing 37 changed files with 8 additions and 39 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions docs/pages/access-controls/guides/per-session-mfa.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,11 @@ their on-disk Teleport certificates.
Per-session MFA for Desktop Access was introduced in Teleport 9.
</Details>


## 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](
Expand All @@ -64,6 +62,7 @@ teleport:
webauthn:
rp_id: teleport.example.com
```
</Admonition>
## Configure per-session MFA
Expand Down
1 change: 0 additions & 1 deletion docs/pages/access-controls/guides/webauthn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/access-controls/idps/saml-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/access-controls/sso/okta.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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!)
Expand Down
1 change: 0 additions & 1 deletion docs/pages/application-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 0 additions & 1 deletion docs/pages/application-access/guides/tcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/azure-redis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/azure-sql-server-ad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/pages/database-access/guides/cockroachdb-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


<ScopedBlock scope={["oss", "enterprise"]}>
![Teleport Database Access CockroachDB Self-Hosted](../../../img/database-access/guides/cockroachdb_selfhosted.png)
</ScopedBlock>
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/mongodb-atlas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/mysql-cloudsql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/mysql-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/postgres-cloudsql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/postgres-redshift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/postgres-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/rds-proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/rds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/database-access/guides/sql-server-ad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/desktop-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/machine-id/guides/circleci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/pages/machine-id/guides/github-actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
1 change: 0 additions & 1 deletion docs/pages/machine-id/guides/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions docs/pages/management/admin/adding-nodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).

</Notice>

On you local machine, retrieve the CA pin of the Auth Service <ScopedBlock
Expand Down
1 change: 0 additions & 1 deletion docs/pages/management/admin/labels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ region.
(!docs/pages/includes/edition-prereqs-tabs.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.

Expand Down
1 change: 1 addition & 0 deletions docs/pages/management/export-audit-events/fluentd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ to integrate with your infrastructure.
(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- Fluentd version v(=fluentd.version=) or greater.

- Docker version v(=docker.version=).

- (!docs/pages/includes/tctl.mdx!)
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/management/guides/joining-nodes-aws-iam.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,10 @@ 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!)

## Step 1/4. Set up AWS IAM credentials

Every Node or Proxy using the IAM method to join your Teleport cluster needs AWS
IAM credentials in order to call the `sts:GetCallerIdentity` API. No specific
IAM policy or permissions are needed. Any IAM user or role can call this API.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/management/guides/joining-nodes-azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ connecting directly to the Auth Service.
installed. The Virtual Machine must have a
[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!)

## Step 1/4. Set up a Managed Identity

Every virtual machine hosting a Node or Proxy using the Azure method to join
your Teleport cluster needs a Managed Identity assigned to it. The identity
requires the `Microsoft.Compute/virtualMachines/read` permission so Teleport
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/management/security/reduce-blast-radius.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Teleport encourages users to practice defense in depth so that every component o
- [Automatically prevent some roles from requesting others](#automatically-prevent-some-roles-from-requesting-others)
- [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!)

## 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`.

Teleport lets you make it mandatory for a user to enroll an MFA device when they create an account, and to authenticate using that device when they begin a new Teleport session.
Expand Down
1 change: 0 additions & 1 deletion docs/pages/server-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ pattern** so that only a single Node can be accessed publicly.

- 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/permission-warning.mdx!)
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/server-access/guides/auditd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ You can configure Teleport's SSH Service to integrate with the Linux Auditing Sy
- A running Teleport Node. See the [Server Access Getting Started Guide](../getting-started.mdx) for how to add a Node to your Teleport cluster. On the Node, `teleport` must be running as a systemd service with root permissions.
- 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!)

## Step 1/4. Check system configuration
Expand All @@ -36,6 +35,7 @@ backlog_wait_time 60000
backlog_wait_time_actual 0
loginuid_immutable 0 unlocked
```

The first line `enabled 1` indicates that auditd is enabled, and Teleport will send events.

All events are generated on a Teleport Node.
Expand Down
1 change: 0 additions & 1 deletion docs/pages/server-access/guides/azure-discovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ managed identities.
- Azure virtual machines to join the Teleport cluster, running
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!)

## Step 1/5. Create an Azure invite token
Expand Down
1 change: 0 additions & 1 deletion docs/pages/server-access/guides/ec2-discovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ policies.
- EC2 instances running Ubuntu/Debian/RHEL/Amazon Linux 2 and SSM agent version 3.1 or greater if making use of the
default Teleport install script. (For other Linux distributions, you can
install Teleport manually.)

- (!docs/pages/includes/tctl.mdx!)

## Step 1/7. Create an EC2 invite token
Expand Down
1 change: 0 additions & 1 deletion docs/pages/server-access/guides/openssh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ We've outlined these reasons in [OpenSSH vs Teleport SSH for Servers?](https://g
- A Linux host with the OpenSSH server `sshd` installed, but not Teleport. The
SSH port on this host must be open to traffic from the Teleport Proxy Service
host.

- (!docs/pages/includes/tctl.mdx!)

## Step 1/4. Configure `sshd` to trust the Teleport CA
Expand Down

0 comments on commit c5ac2f1

Please sign in to comment.