mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-01 21:52:02 +08:00
Paul Gottschling
91c89b6126
* Organize docs guide sections chronologically This change aims to make docs navigation easier by organizing some docs sections according to the sequence of steps a user would take to set up Teleport. The current docs organization uses a variety of categories and schemes to organize the docs. For example, there is a "Home" section that includes the Changelog, Installation page, and Getting Started guides; a "Setup" section that includes references and admin guides; and edition-specific sections (Enterprise, Cloud). For a user who is setting up Teleport--or who has already done some setup work and wants more advanced instructions--it's difficult to know where in the docs to find the right information. This change organizes our how-to guides into the following categories that describe the process of setting up Teleport: - Try out Teleport - Deploy a Cluster (including choosing an edition) - Configure Access (including SSO, RBAC, and Access Requests) - Manage your Cluster (admin guides, operations, etc.) - Use Teleport (this section already exists) I moved the Reference section after this chronology, since users can access the reference guides anywhere in the setup process. As part of the change, I have also moved the content from the "Enterprise" and "Cloud" sections into "Deploy a Cluster", since this content has to do with how to deploy a specific edition of Teleport. Note that this change does _not_ attempt to reorganize our protocol-specific sections. While adding resources is part of the Teleport setup process, we have a lot of content in our protocol-specific sections, and moving it all into a single section related to adding resources to a cluster would (a) exceed the maximum depth for subsections in the nav bar and (b) cause more confusion than it alleviates. * Respond to PR feedback - Create a "Compliance Frameworks" section of "Configure Access" with the FedRAMP and SOC 2 guides - Rename "Use Teleport" to "Connect your Client" - Move the database GUI client guide into "Connect your Client" * Add redirects * Fix linter issues
22 lines
914 B
Plaintext
22 lines
914 B
Plaintext
---
|
|
title: "Teleport Signals Reference"
|
|
description: "Signals you can send to a running teleport process."
|
|
---
|
|
|
|
You can send the following signals to a `teleport` process to trigger different
|
|
functionality.
|
|
|
|
To send a signal, execute the following command on the host where `teleport` is
|
|
running, replacing `SIG` with the name of the signal.
|
|
|
|
```code
|
|
$ kill -SIG
|
|
```
|
|
|
|
| Signal | Teleport Daemon Behavior |
|
|
| - | - |
|
|
| `USR1` | Dumps diagnostics/debugging information into syslog. |
|
|
| `QUIT`| Graceful shutdown. The daemon will wait until connections are dropped. |
|
|
| `TERM` , `INT` or `KILL` | Immediate non-graceful shutdown. All existing connections will be dropped. |
|
|
| `USR2` | Forks a new Teleport daemon to serve new connections. |
|
|
| `HUP` | Forks a new Teleport daemon to serve new connections **and** initiates the graceful shutdown of the existing process when there are no more clients connected to it. | |