teleport/docs/4.0/faq.md
Ben Arent 3976a99771
Teleport 4.3 Docs (#3423)
* Base fork for 4.3 docs

* [docs] external email identities and Kube Users (#3628)

* Base fork for 4.3 docs

* [docs] external email identities and Kube Users (#3628)

* Remove trailing whitespace from docs files

Some editors will do this automatically on save. This causes a lot of
diffs when editing the docs in such an editor.
Clean them up once now and we'll try to keep it tidy going forward.

* Add make rules for docs whitespace and milv

docs-test-whitespace: checks for trailing whitespace in all .md files
  under docs/.
docs-fix-whitespace: removes trailing whitespace in all .md files under
  docs/.
docs-test-links: runs milv in all docs/ subdirectories that have
  milv.config.yaml.
docs-test: runs whitespace and links tests, used during `make docs`

* Document the new `--use-local-ssh-agent` flag for tsh

The flag is used to bypass the local SSH agent even when it's running.
Specifically, this helps with agents that don't support certs.

The flag was added in #3721

* Remove pam_script.so docs from SSH PAM page

With #3725 we now populate teleport-specific env vars in a way that's
accessible to `pam_exec.so`. There's no longer any reason to install
pam_script.so separately and duplicate our docs.

Updates #3692

* Using the correct --insecure-no-tls flag

* Run docs-fix-whitespace make rule in a busybox container


* Fixes #3414

Co-authored-by: Andrew Lytvynov <andrew@gravitational.com>
Co-authored-by: Gus Luxton <gus@gravitational.com>
Co-authored-by: Steven Martin <steven@gravitational.com>
Co-authored-by: Gus Luxton <webvictim@gmail.com>
2020-06-17 17:09:41 -07:00

4.6 KiB

FAQ

Can I use Teleport in production today?

Teleport has been deployed on server clusters with thousands of nodes at Fortune 500 companies. It has been through several security audits from nationally recognized technology security companies, so we are comfortable with the stability of Teleport from a security perspective.

Can Teleport be deployed in agentless mode?

Yes. Teleport can be deployed with a tiny footprint as an authentication gateway/proxy and you can keep your existing SSH servers on the nodes. But some innovating Teleport features, such as cluster introspection, will not be available unless the Teleport SSH daemon is present on all cluster nodes.

Can I use OpenSSH with a Teleport cluster?

Yes, this question comes up often and is related to the previous one. Take a look at Using OpenSSH client section in the User Manual and Using OpenSSH servers in the Admin Manual.

Can I connect to nodes behind a firewall?

Yes, Teleport supports reverse SSH tunnels out of the box. To configure behind-firewall clusters refer to Trusted Clusters section of the Admin Manual.

Can individual nodes create reverse tunnels to a proxy server without creating a new cluster?

This has been a long standing request of Teleport and it has been fixed with Teleport 4.0. Once you've upgraded your Teleport Cluster, change the node config option --auth-server to point to web proxy address (this would be public_addr and web_listen_addr in file configuration). As defined in Adding a node located behind NAT - Teleport Node Tunneling

What's Teleport scalability and hardware recommendations?

We recommend setting up Teleport with a High Availability configuration. Below is our recommended hardware for the Proxy and Auth server. If you plan to connect more than 10,000 nodes, please get in touch and we can help architect the best solution for you.

Scenario Max Recommended Count Proxy Auth server
Teleport nodes connected to auth server 10,000 2x 2-4 vCPUs/8GB RAM 2x 4-8 vCPUs/16GB RAM
Teleport nodes connected to proxy server (IoT) 2,000* 2x 2-4 vCPUs/8GB RAM 2x 4-8 vCPUs/16+GB RAM
  • Teleport 4.1 release will focus on increasing Teleport IoT supported count to 10,000

Does Web UI support copy and paste?

Yes. You can copy&paste using the mouse. For working with a keyboard, Teleport employs tmux-like "prefix" mode. To enter prefix mode, press Ctrl+A.

While in prefix mode, you can press Ctrl+V to paste, or enter text selection mode by pressing [. When in text selection mode, move around using hjkl, select text by toggling space and copy it via Ctrl+C.

What TCP ports does Teleport use?

Please refer to the Ports section of the Admin Manual.

Does Teleport support authentication via OAuth, SAML or Active Directory?

Gravitational offers this feature for the commercial versions of Teleport.

Commercial Teleport Editions

What is included in the commercial version, Teleport Enterprise?

The Teleport Enterprise offering gives users the following additional features:

  • Role-based access control, also known as RBAC.
  • Authentication via SAML and OpenID with providers like Okta, Active Directory, Auth0, etc. (aka, SSO).
  • Premium support.

We also offer implementation services, to help you integrate Teleport with your existing systems and processes.

You can read more in the Teleport Enterprise section of the docs

Does Teleport send any data to Gravitational?

The open source edition of Teleport does not send any information to Gravitational and can be used on servers without internet access. The commercial versions of Teleport may or may not be configured to send anonymized information to Gravitational, depending on the license purchased. This information contains the following:

  • Anonymized user ID: SHA256 hash of a username with a randomly generated prefix.
  • Anonymized server ID: SHA256 hash of a server IP with a randomly generated prefix.

This allows Teleport Pro to print a warning if users are exceeding the usage limits of their license. The reporting library code is on Github.

Reach out to sales@gravitational.com if you have questions about commercial edition of Teleport.