Skip to content

Commit b4a8032

Browse files
docs: Update website to include SIGHUP, SIGTERM, and SIGINT behaviour (hashicorp#3140)
* docs: Update website to include SIGHUP, SIGTERM, and SIGINT behaviour Co-authored-by: Dan Heath <[email protected]>
1 parent 55af9f3 commit b4a8032

File tree

3 files changed

+25
-3
lines changed

3 files changed

+25
-3
lines changed

website/content/docs/configuration/controller.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,11 @@ description will be read.
106106
are anything specified by Go's [ParseDuration()](https://golang.org/pkg/time/#ParseDuration) method. Only
107107
used when an `ops` listener is set and the Controller is present. Default is 0 seconds.
108108

109+
## Signals
110+
The `SIGHUP` signal causes a controller to reload its configuration file to pick up any updates to the `database url` value. Any other updated values are ignored.
111+
112+
The `SIGTERM` and `SIGINT` signals initiate a graceful shutdown on a controller. A graceful shutdown closes listeners and servers before shutting down the controller.
113+
109114
## KMS Configuration
110115

111116
The controller requires two KMS stanzas for `root` and `worker-auth` purposes:

website/content/docs/configuration/index.mdx

+11-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ path to the file.
3636
Boundary serves traffic (API, cluster, and proxy).
3737

3838
Controllers must have at least two listener blocks defined: one marked for
39-
`api` purpose and the other marked for `cluster` purpose.
39+
`api` purpose and the other marked for `cluster` purpose.
4040

4141
Workers will have only one listener, marked for `proxy` purpose.
4242

@@ -87,6 +87,16 @@ path to the file.
8787

8888
- [`plugins`](/boundary/docs/configuration/plugins): Configures options for plugins.
8989

90+
## Signals
91+
The `SIGHUP` signal causes worker and controller processes to reload their configuration files to pick up updated values.
92+
93+
~> **Note:** You cannot reload all configuration values using the `SIGHUP` signal. Refer to the configuration pages for
94+
[workers](/boundary/docs/configuration/worker/) and [controllers](/boundary/docs/configuration/controller) for details
95+
on which values can be reloaded on `SIGHUP`.
96+
97+
The `SIGTERM` and `SIGINT` signals cause worker and controller processes to enter graceful shutdown. A graceful shutdown for a controller closes listeners and servers before shutting down the controller. A graceful shutdown for a worker waits for any sessions to drain
98+
before shutting down the worker. Workers in a graceful shutdown state do not receive any new work, including session proxying, from the control plane.
99+
90100
## Example Configurations
91101

92102
For complete example configurations see the sections for

website/content/docs/configuration/worker/index.mdx

+9-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ worker {
5858
at which the worker can be reached _by clients for proxying_. This defaults to
5959
the address of the listener marked for `proxy` purpose. This is especially
6060
useful for cloud environments that do not bind a publicly accessible IP to a
61-
NIC on the host directly, such as an Amazon EIP.
62-
61+
NIC on the host directly, such as an Amazon EIP.
62+
6363
This value can reference any of the following:
6464
- a direct address string
6565
- a file on disk (file://) from which an address will be read
@@ -85,6 +85,13 @@ worker {
8585
`initial_upstreams`. This is currently only valid for workers using the PKI
8686
registration method and for workers directly connected to HCP Boundary.
8787

88+
## Signals
89+
The `SIGHUP` signal causes a worker to reload its configuration file to pick up any updates for the `initial_upstreams` and `tags` values.
90+
Any other updated values are ignored.
91+
92+
The `SIGTERM` and `SIGINT` signals initiate a graceful shutdown on a worker. The worker waits for any sessions to drain
93+
before shutting down. Workers in a graceful shutdown state do not receive any new work, including session proxying, from the control plane.
94+
8895
## Multi-hop worker capabilities <sup>HCP only</sup>
8996
Multi-hop capabilities, including multi-hop sessions and Vault private access,
9097
is when a session or Vault credential request goes through more than one worker.

0 commit comments

Comments
 (0)