Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Teleport cloud license info and other updates #11093

Merged
merged 11 commits into from
Mar 23, 2022
Merged

Teleport cloud license info and other updates #11093

Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
105906b
Teleport cloud license info and other info
stevenGravy Mar 12, 2022
b551141
minor word change
stevenGravy Mar 12, 2022
08739dc
Phrasing update
stevenGravy Mar 16, 2022
70e6e4f
download language update
stevenGravy Mar 16, 2022
152c7fd
Removed Admonition
stevenGravy Mar 16, 2022
7f1d368
update verbiage on lack of licensed products
stevenGravy Mar 16, 2022
7624a40
correction
stevenGravy Mar 16, 2022
d8eefcd
verbiage update
stevenGravy Mar 17, 2022
eda189a
verbiage change
stevenGravy Mar 17, 2022
ed6fd9f
change Admonition for teleport cloud
stevenGravy Mar 17, 2022
d89d0ab
Merge branch 'master' into stevenGravy/docs/licensefile
stevenGravy Mar 23, 2022
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
20 changes: 12 additions & 8 deletions docs/pages/setup/reference/license.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@ title: Enterprise License File
description: Teleport enterprise license file configuration parameters and requirements
---

Commercial Teleport subscriptions require a valid license. The license file can
Commercial self-hosted Teleport subscriptions require a valid license. The license file can
be downloaded from the [Teleport Customer
Portal](https://dashboard.gravitational.com/web/login).
Portal](https://dashboard.gravitational.com/web/login). When downloading the file, the products you are licensed to use will be listed in the browser.

<Admonition type="note" title="Not applicable to Teleport Cloud">
stevenGravy marked this conversation as resolved.
Show resolved Hide resolved
stevenGravy marked this conversation as resolved.
Show resolved Hide resolved
Teleport Cloud manages licensing for customers, and there is no need to manage license files yourself.
</Admonition>

The Teleport license file contains an X.509 certificate and the corresponding
private key in PEM format. Place the downloaded file on your Teleport Auth
Expand All @@ -21,9 +25,9 @@ The `license_file` path can be either absolute or relative to the configured
`data_dir`. If the license file path is not set, Teleport will look for the
`license.pem` file in the configured `data_dir`.

<Admonition
type="tip"
title="NOTE"
>
Only Auth Servers require the license. Proxies and Nodes that do not also have Auth role enabled do not need the license.
</Admonition>
Only Auth Servers require the license. Proxies and Nodes that do not also have Auth role enabled do not need the license.
stevenGravy marked this conversation as resolved.
Show resolved Hide resolved
Attempts to use unlicenced products will result in a error message and users will be unable to use those products. Here is an example message if attempting to use database access and not included in the license.
stevenGravy marked this conversation as resolved.
Show resolved Hide resolved
```code
this Teleport cluster is not licensed for database access, please contact the cluster administrator
```