Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 25 additions & 22 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,7 @@
"entries": [
{
"title": "Getting Started",
"slug": "/choose-an-edition/teleport-enterprise/getting-started/",
"forScopes": ["enterprise"]
"slug": "/choose-an-edition/teleport-enterprise/getting-started/"
},
{
"title": "HSM",
Expand All @@ -126,7 +125,8 @@
"entries": [
{
"title": "Introduction",
"slug": "/deploy-a-cluster/introduction/"
"slug": "/deploy-a-cluster/introduction/",
"forScopes": ["oss", "enterprise"]
},
{
"title": "High Availability Deployments",
Expand Down Expand Up @@ -259,12 +259,11 @@
{
"title": "Single Sign-On (SSO)",
"slug": "/access-controls/sso/",
"forScopes": ["enterprise", "oss", "cloud"],
"forScopes": ["oss", "team", "enterprise", "cloud"],
"entries": [
{
"title": "GitHub SSO",
"slug": "/access-controls/sso/github-sso/",
"forScopes": ["enterprise", "cloud", "oss"]
"slug": "/access-controls/sso/github-sso/"
},
{
"title": "Azure Active Directory (AD)",
Expand Down Expand Up @@ -327,7 +326,8 @@
"entries": [
{
"title": "Role Requests",
"slug": "/access-controls/access-requests/role-requests/"
"slug": "/access-controls/access-requests/role-requests/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Resource Requests",
Expand All @@ -337,7 +337,7 @@
{
"title": "Role Requests in OSS Teleport",
"slug": "/access-controls/access-requests/oss-role-requests/",
"forScopes": ["oss", "enterprise", "cloud"]
"forScopes": ["oss"]
}
]
},
Expand Down Expand Up @@ -441,8 +441,7 @@
},
{
"title": "Troubleshooting",
"slug": "/management/admin/troubleshooting/",
"forScopes": ["oss", "enterprise", "cloud"]
"slug": "/management/admin/troubleshooting/"
},
{
"title": "Upgrading the Teleport Binary",
Expand All @@ -454,7 +453,8 @@
},
{
"title": "Run Teleport with Self-Signed Certificates",
"slug": "/management/admin/self-signed-certs/"
"slug": "/management/admin/self-signed-certs/",
"forScopes": ["oss", "enterprise"]
},
{
"title": "Uninstall Teleport",
Expand All @@ -477,8 +477,7 @@
},
{
"title": "Backup and Restore",
"slug": "/management/operations/backup-restore/",
"forScopes": ["oss", "enterprise"]
"slug": "/management/operations/backup-restore/"
},
{
"title": "Cert Authority Rotation",
Expand Down Expand Up @@ -509,10 +508,12 @@
{
"title": "Integrations",
"slug": "/management/guides/",
"forScopes":["oss","enterprise","cloud","team"],
"entries": [
{
"title": "Kubernetes Operator (Preview)",
"slug": "/management/guides/teleport-operator/"
"slug": "/management/guides/teleport-operator/",
"forScopes": ["enterprise","oss"]
},
{
"title": "Terraform Provider",
Expand Down Expand Up @@ -573,18 +574,15 @@
"entries": [
{
"title": "Exporting Audit Events to Fluentd",
"slug": "/management/export-audit-events/fluentd/",
"forScopes": ["enterprise", "cloud"]
"slug": "/management/export-audit-events/fluentd/"
},
{
"title": "Monitoring Audit Events with the Elastic Stack",
"slug": "/management/export-audit-events/elastic-stack/",
"forScopes": ["enterprise", "cloud"]
"slug": "/management/export-audit-events/elastic-stack/"
},
{
"title": "Monitoring Audit Events with Splunk",
"slug": "/management/export-audit-events/splunk/",
"forScopes": ["enterprise", "cloud"]
"slug": "/management/export-audit-events/splunk/"
}
]
}
Expand Down Expand Up @@ -1112,7 +1110,8 @@
},
{
"title": "How to Build an Access Request Plugin",
"slug": "/api/access-plugin/"
"slug": "/api/access-plugin/",
"forScopes": ["enterprise", "cloud"]
},
{
"title": "Automatically Register Teleport Agents",
Expand Down Expand Up @@ -1189,7 +1188,11 @@
"entries": [
{
"title": "teleport-cluster",
"slug": "/reference/helm-reference/teleport-cluster/"
"slug": "/reference/helm-reference/teleport-cluster/",
"forScopes": [
"oss",
"enterprise"
]
},
{
"title": "teleport-kube-agent",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ Once Teleport is running, you've created the Discord app, and the plugin is
configured, you can now run the plugin and test the workflow.

<Tabs>
<TabItem label="Executable" scope={["oss", "enterprise"]}>
<TabItem label="Executable">
Start the plugin:

```code
Expand All @@ -302,7 +302,7 @@ INFO Starting Teleport Access Discord Plugin 7.2.1: discord/app.go:80
INFO Plugin is ready discord/app.go:101
```
</TabItem>
<TabItem label="Helm Chart" scope={["oss", "enterprise"]}>
<TabItem label="Helm Chart">
Install the plugin:

```code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,23 @@ in your Teleport cluster.

## Step 2/7. Install the Teleport email plugin

<ScopedBlock scope={["enterprise", "oss"]}>
In this step, you will install the Teleport email plugin.

<Tabs>
<TabItem label="Teleport Enterprise" scope={["enterprise"]}>

We recommend installing Teleport plugins on the same host as the Teleport Proxy
Service. This is an ideal location as plugins have a low memory footprint, and
will require both public internet access and Teleport Auth Service access.

</ScopedBlock>

<ScopedBlock scope="cloud">
</TabItem>
<TabItem scope="cloud" label="Teleport Enterprise Cloud">

Install the Teleport email plugin on a host that can access both your
Teleport Cloud tenant and your SMTP service.

</ScopedBlock>
</TabItem>
</Tabs>

<Details title="Using a local SMTP server?">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Edit the configuration as explained below:
### `[mattermost]`

<Tabs>
<TabItem label="Executable" scope={["oss", "enterprise"]}>
<TabItem label="Executable">

**`url`**: Include the scheme (`https://`) and fully qualified domain name of
your Mattermost deployment.
Expand Down Expand Up @@ -184,7 +184,7 @@ recipients = [
```

</TabItem>
<TabItem label="Helm Chart" scope={["oss", "enterprise"]}>
<TabItem label="Helm Chart">

**`url`**: Include the scheme (`https://`) and fully qualified domain name of
your Mattermost deployment.
Expand Down Expand Up @@ -277,7 +277,7 @@ severity = "INFO" # Logger severity. Could be "INFO", "ERROR", "DEBUG" or "WARN"


<Tabs>
<TabItem label="Executable" scope={["oss", "enterprise"]}>
<TabItem label="Executable">
After modifying your configuration, run the bot with the following command:

```code
Expand All @@ -296,7 +296,7 @@ DEBU Watcher connected mattermost/main.go:260
DEBU Mattermost API health check finished ok mattermost/main.go:19
```
</TabItem>
<TabItem label="Helm Chart" scope={["oss", "enterprise"]}>
<TabItem label="Helm Chart">
After modifying your configuration, run the bot with the following command:

```code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,21 @@ PagerDuty.

- Either a Linux host or Kubernetes cluster where you will run the PagerDuty plugin.

<ScopedBlock scope={["enterprise", "oss"]}>
<Tabs>
<TabItem label="Teleport Enterprise" scope={["enterprise"]}>

We recommend installing Teleport plugins on the same host as the Teleport Proxy
Service. This is an ideal location as plugins have a low memory footprint, and
will require both public internet access and Teleport Auth Service access.

</ScopedBlock>

<ScopedBlock scope="cloud">
</TabItem>
<TabItem label="Teleport Enterprise Cloud" scope="cloud">

Install the Teleport PagerDuty plugin on a host that can access both your
Teleport Cloud tenant and PagerDuty.

</ScopedBlock>
</TabItem>
</Tabs>

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

Expand Down Expand Up @@ -522,7 +523,7 @@ The final configuration should resemble the following:
## Step 7/8. Test the PagerDuty plugin

<Tabs>
<TabItem label="Executable" scope={["oss", "enterprise"]}>
<TabItem label="Executable">
After you configure the PagerDuty plugin, run the following command to start it.
The `-d` flag will provide debug information to ensure that the plugin can
connect to PagerDuty and your Teleport cluster:
Expand All @@ -540,7 +541,7 @@ $ teleport-pagerduty start -d
# DEBU Setting up the webhook extensions pagerduty/main.go:178
```
</TabItem>
<TabItem label="Helm Chart" scope={["oss", "enterprise"]}>
<TabItem label="Helm Chart">
After modifying your configuration, run the bot with the following command:

```code
Expand Down Expand Up @@ -599,7 +600,7 @@ should still check the Teleport audit log to ensure that the right users are
reviewing the right requests.

When auditing Access Request reviews, check for events with the type `Access
Request Reviewed` in the Teleport Web UI <ScopedBlock scope={["oss",
Request Reviewed` in the Teleport Web UI <ScopedBlock scope={[
"enterprise"]}>and `access_request.review` if reviewing the audit log on the
Auth Service host</ScopedBlock>.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ Once Teleport is running, you've created the Slack app, and the plugin is
configured, you can now run the plugin and test the workflow.

<Tabs>
<TabItem label="Executable" scope={["oss", "enterprise"]}>
<TabItem label="Executable">
Start the plugin:

```code
Expand All @@ -354,7 +354,7 @@ INFO Starting Teleport Access Slack Plugin 7.2.1: slack/app.go:80
INFO Plugin is ready slack/app.go:101
```
</TabItem>
<TabItem label="Helm Chart" scope={["oss", "enterprise"]}>
<TabItem label="Helm Chart">
Install the plugin:

```code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ via ChatOps or anywhere else via our flexible Authorization Workflow API.

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)
(!docs/pages/includes/commercial-prereqs-tabs.mdx!)

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

Expand Down
9 changes: 4 additions & 5 deletions docs/pages/access-controls/compliance-frameworks/soc2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@ h1: SOC 2 Compliance for SSH, Kubernetes, Databases, Desktops, and Web Apps
Teleport is designed to meet SOC 2 requirements for the purposes of accessing infrastructure, change management, and system operations. This document outlines a high
level overview of how Teleport can be used to help your company to become SOC 2 compliant.

<ScopedBlock
scope={["oss"]}
>
<Notice type="warning">

This guide requires Teleport Cloud or Teleport Enterprise.
SOC 2 compliance features are only available for Teleport Enterprise and
Teleport Enterprise Cloud.

</ScopedBlock>
</Notice>

## Achieving SOC 2 Compliance with Teleport
SOC 2 or Service Organization Controls were developed by the American Institute of CPAs (AICPA). They are based on five trust services criteria: security, availability, processing integrity, confidentiality, and privacy.
Expand Down
21 changes: 10 additions & 11 deletions docs/pages/access-controls/guides/dual-authz.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,19 @@ Here are the most common scenarios:
- Improve the security of your system and prevent one successful phishing attack from compromising your system.
- Satisfy FedRAMP AC-3 Dual authorization control that requires approval of two authorized individuals.

In this guide, we will set up Teleport's Just-in-Time Access Requests to require the approval
of two team members for a privileged role `dbadmin`.
In this guide, we will set up Teleport's Just-in-Time Access Requests to require
the approval of two team members for a privileged role `dbadmin`.

<ScopedBlock scope="oss">
The steps below describe how to use Teleport with Mattermost. You can also
[integrate with many other providers](../access-requests.mdx).

This guide requires a commercial edition of Teleport. The open source
edition of Teleport only supports [GitHub](../../access-controls/sso/github-sso.mdx) as
an SSO provider.
<Notice type="warning">

</ScopedBlock>
This guide requires a commercial edition of Teleport. The open source edition of
Teleport only supports [GitHub](../../access-controls/sso/github-sso.mdx) as an
SSO provider.

<Admonition title="Note" type="tip">
The steps below describe how to use Teleport with Mattermost. You can also [integrate with many other providers](../access-requests.mdx).
</Admonition>
</Notice>

## Prerequisites

Expand Down Expand Up @@ -212,7 +211,7 @@ Bob can also assume granted Access Request roles using Web UI:

{/* TODO: This H2 will show up in the table of contents when this section is invisible.
We need a way to hide invisible H2s from the TOC. */}
<ScopedBlock scope={["oss", "enterprise"]}>
<ScopedBlock scope={["enterprise"]}>

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/access-controls/guides/hardware-key-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Additionally, this feature can be configured to require touch for every Teleport

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)
(!docs/pages/includes/commercial-prereqs-tabs.mdx!)

- A series 5+ YubiKey

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/access-controls/guides/moderated-sessions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ the session, and terminate the session at will.
In addition, Teleport administrators can [define rules](#join_sessions) that allow users to join each other's
sessions from `tsh` and the Web UI.

<ScopedBlock scope="oss">
<Notice type="warning">

Moderated Sessions requires Teleport Enterprise or Teleport Cloud.
Moderated Sessions requires Teleport Enterprise or Teleport Enterprise Cloud.

</ScopedBlock>
</Notice>

### Use cases

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/access-controls/guides/webauthn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ WebAuthn is disabled by default. To enable WebAuthn support, update your
Teleport configuration as below:

<Tabs>
<TabItem label="Dynamic resources" scope={["oss", "enterprise", "cloud"]}>
<TabItem label="Dynamic resources" scope={["team", "cloud"]}>

Edit the `cluster_auth_preference` resource:

Expand Down
Loading