Skip to content

Commit d965b8c

Browse files
authored
docs: Clarify that max duration is required (#5105)
* docs: Clarify that max duration is required * docs: Update TCP tabs * docs: Update newer usage topic
1 parent 1227ed9 commit d965b8c

File tree

4 files changed

+31
-25
lines changed

4 files changed

+31
-25
lines changed

website/content/docs/commands/targets/create.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ If you do not specify a default port, Boundary uses port 22.
7676
A value of `-1` means the connections are unlimited.
7777
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
7878
You can specify an integer number of seconds or a duration string.
79+
If you do not specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
7980
- `-storage-bucket-id=<string>` - The public ID of the storage bucket to associate with the target.
8081
- `-with-alias-authorize-session-host-id=<string>` - The host ID that an alias uses to authorize sessions for the target.
8182
- `-with-alias-scope-id=<string>` - The scope ID that you want to create the target and alias in.
@@ -121,6 +122,7 @@ If you do not specify a default port, Boundary uses port 22.
121122
A value of `-1` means the connections are unlimited.
122123
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
123124
You can specify an integer number of seconds or a duration string.
125+
If you do not specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
124126
- `-with-alias-authorize-session-host-id=<string>` - The host ID that an alias uses to authorize sessions for the target.
125127
- `-with-alias-scope-id=<string>` - The scope ID that you want to create the alias in at target creation time.
126128
The default is `global`.

website/content/docs/commands/targets/update.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ If you do not specify a default port, Boundary uses port 22.
7676
A value of `-1` means the connections are unlimited.
7777
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
7878
You can specify an integer number of seconds or a duration string.
79+
If you do not specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
7980
- `-storage-bucket-id=<string>` - The public ID of the storage bucket you want to associate with the target.
8081

8182

@@ -115,6 +116,7 @@ If you do not specify a default port, Boundary uses port 22.
115116
A value of `-1` means the connections are unlimited.
116117
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
117118
You can specify an integer number of seconds or a duration string.
119+
If you do not specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
118120
- `-worker-filter=<string>` - This option is deprecated.
119121
Use the egress or ingress filters instead.
120122

website/content/docs/concepts/domain-model/targets.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ A target has the following configurable attributes:
7474
when a session reaches the maximum duration.
7575
The default is 8 hours (28800 seconds).
7676
This value must be greater than 0.
77+
If you do not specfiy a maximum duration, Boundary uses the default value.
7778

7879
- `with-alias-authorize-session-host-id` (Optional)
7980
The authorize session host ID flag that an alias uses when you create the alias at the same time as you create the target.

website/content/docs/configuration/target-aliases/create-target-alias.mdx

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ Complete the following steps to create a new target and new alias at the same ti
9595
Alternatively, you can configure host catalogs and host sets.
9696
- **Default Port**: (Optional) Enter an optional default port for the target to use for connections.
9797
- **Default Client Port**: (Optional) Enter an optional local proxy port on which to listen when a session is started on a client.
98-
- **Maximum Duration**: (Optional) Enter an optional maximum duration for sessions on this target, in seconds.
98+
- **Maximum Duration**: (Required) Enter a maximum duration for sessions on this target, in seconds.
99+
If you do not enter a value, Boundary uses the default of 8 hours (28,800 seconds).
99100
- **Maximum Connection**: (Optional) Enter the maximum number of connections allowed per session on this target.
100101
For unlimited connections, enter `-1`.
101102
- **Workers**: (Optional) Select whether you want the worker to function as an ingress and/or egress worker.
@@ -216,7 +217,7 @@ Target aliases point directly to the target they are associated with. You can as
216217

217218
You assign [direct target addresses](/boundary/docs/concepts/domain-model/targets#address) directly to the target. They refer to a specific network resource, like an IP address. Boundary only connects to the direct target address when it establishes a connection to the associated target.
218219

219-
When you create a target alias, you can also assign it to a specific host. Assigning an alias to a specific host is useful if you want to avoid creating multiple targets for specific hosts using direct target addresses.
220+
When you create a target alias, you can also assign it to a specific host. Assigning an alias to a specific host is useful if you want to avoid creating multiple targets for specific hosts using direct target addresses.
220221

221222
For example, you could create two aliases for the same target that has been assigned a host set. One alias could refer to the target itself, and would allow Boundary to randomly select a host to connect to for a session. Another alias could point to the same target, but you could assign a host ID that Boundary should use for a session.
222223

@@ -298,9 +299,9 @@ Create the `linux-dev-servers` target.
298299
```
299300

300301
Example output:
301-
302+
302303
<CodeBlockConfig hideClipboard>
303-
304+
304305
```shell-session
305306
$ boundary targets create ssh \
306307
-description 'linux-dev.app-servers.eng target' \
@@ -309,7 +310,7 @@ Create the `linux-dev-servers` target.
309310
-default-port 22 \
310311
-with-alias-scope-id global \
311312
-with-alias-value linux-dev.app-servers.eng
312-
313+
313314
Target information:
314315
Created Time: Thu, 14 Nov 2024 13:39:36 MST
315316
Description: linux-dev.app-servers.eng target
@@ -320,13 +321,13 @@ Create the `linux-dev-servers` target.
320321
Type: ssh
321322
Updated Time: Thu, 14 Nov 2024 13:39:36 MST
322323
Version: 1
323-
324+
324325
Scope:
325326
ID: p_3ECODJDbXV
326327
Name: app-servers
327328
Parent Scope ID: o_2drCWvp3Oc
328329
Type: project
329-
330+
330331
Authorized Actions:
331332
remove-host-sources
332333
remove-credential-sources
@@ -339,16 +340,16 @@ Create the `linux-dev-servers` target.
339340
add-host-sources
340341
set-host-sources
341342
add-credential-sources
342-
343+
343344
Aliases:
344345
ID: alt_CkC6wGKLWW
345346
Value: linux-dev.app-servers.eng
346-
347+
347348
Attributes:
348349
Default Port: 22
349350
Enable Session Recording: false
350351
```
351-
352+
352353
</CodeBlockConfig>
353354

354355
Then add the `linux-dev-servers` host set (ID `hsst_56oiL0WaKu`) to the new `linux-dev-servers` target (ID `tssh_lhH5pa425G`).
@@ -396,9 +397,9 @@ Create the `dev-040.linux-dev.app-servers.eng` alias for the host `dev-040`:
396397
```
397398

398399
Example output:
399-
400+
400401
<CodeBlockConfig hideClipboard>
401-
402+
402403
```shell-session
403404
$ boundary aliases create target \
404405
-description 'Target alias for dev-040.linux-dev.app-servers.eng' \
@@ -407,7 +408,7 @@ Create the `dev-040.linux-dev.app-servers.eng` alias for the host `dev-040`:
407408
-scope-id global \
408409
-value dev-040.linux-dev.app-servers.eng \
409410
-authorize-session-host-id hst_7wGXkF8e0Q
410-
411+
411412
Alias information:
412413
Created Time: Thu, 14 Nov 2024 13:55:41 MST
413414
Description: Target alias for dev-040.linux-dev.app-servers.eng
@@ -418,25 +419,25 @@ Create the `dev-040.linux-dev.app-servers.eng` alias for the host `dev-040`:
418419
Updated Time: Thu, 14 Nov 2024 13:55:41 MST
419420
Value: dev-040.linux-dev.app-servers.eng
420421
Version: 1
421-
422+
422423
Scope:
423424
ID: global
424425
Name: global
425426
Type: global
426-
427+
427428
Authorized Actions:
428429
no-op
429430
read
430431
update
431432
delete
432-
433+
433434
Attributes:
434435
authorize_session_arguments:
435436
{
436437
"host_id": "hst_7wGXkF8e0Q"
437438
}
438439
```
439-
440+
440441
</CodeBlockConfig>
441442

442443
</Tab>
@@ -476,9 +477,9 @@ Then create the `dev-041.linux-dev.app-servers.eng` alias for the host `dev-041`
476477
```
477478

478479
Example output:
479-
480+
480481
<CodeBlockConfig hideClipboard>
481-
482+
482483
```shell-session
483484
$ boundary aliases create target \
484485
-description 'Target alias for dev-041.linux-dev.app-servers.eng' \
@@ -487,7 +488,7 @@ Then create the `dev-041.linux-dev.app-servers.eng` alias for the host `dev-041`
487488
-scope-id global \
488489
-value dev-041.linux-dev.app-servers.eng \
489490
-authorize-session-host-id hst_zlRwMMPKwp
490-
491+
491492
Alias information:
492493
Created Time: Thu, 14 Nov 2024 14:00:13 MST
493494
Description: Target alias for dev-040.linux-dev.app-servers.eng
@@ -498,25 +499,25 @@ Then create the `dev-041.linux-dev.app-servers.eng` alias for the host `dev-041`
498499
Updated Time: Thu, 14 Nov 2024 14:00:13 MST
499500
Value: dev-041.linux-dev.app-servers.eng
500501
Version: 1
501-
502+
502503
Scope:
503504
ID: global
504505
Name: global
505506
Type: global
506-
507+
507508
Authorized Actions:
508509
no-op
509510
read
510511
update
511512
delete
512-
513+
513514
Attributes:
514515
authorize_session_arguments:
515516
{
516517
"host_id": "hst_zlRwMMPKwp"
517-
}
518+
}
518519
```
519-
520+
520521
</CodeBlockConfig>
521522

522523
</Tab>

0 commit comments

Comments
 (0)