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.

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

docs: Clarify that max duration is required #5105

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions website/content/docs/commands/targets/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ If you do not specify a default port, Boundary uses port 22.
A value of `-1` means the connections are unlimited.
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
You can specify an integer number of seconds or a duration string.
If you do not specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
- `-storage-bucket-id=<string>` - The public ID of the storage bucket to associate with the target.
- `-with-alias-authorize-session-host-id=<string>` - The host ID that an alias uses to authorize sessions for the target.
- `-with-alias-scope-id=<string>` - The scope ID that you want to create the target and alias in.
Expand Down Expand Up @@ -121,6 +122,7 @@ If you do not specify a default port, Boundary uses port 22.
A value of `-1` means the connections are unlimited.
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
You can specify an integer number of seconds or a duration string.
If you do not specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
- `-with-alias-authorize-session-host-id=<string>` - The host ID that an alias uses to authorize sessions for the target.
- `-with-alias-scope-id=<string>` - The scope ID that you want to create the alias in at target creation time.
The default is `global`.
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/commands/targets/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ If you do not specify a default port, Boundary uses port 22.
A value of `-1` means the connections are unlimited.
- `-session-max-seconds=<string>` - The maximum lifetime of the session, including all connections.
You can specify an integer number of seconds or a duration string.
If you do not specfiy a maximum duration, Boundary uses the default value of 8 hours (28800 seconds).
- `-storage-bucket-id=<string>` - The public ID of the storage bucket you want to associate with the target.


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

Expand Down
3 changes: 2 additions & 1 deletion website/content/docs/concepts/aliases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@ Complete the following steps to create a new target and new alias at the same ti
Alternatively, you can configure host catalogs and host sets.
- **Default Port**: (Optional) Enter an optional default port for the target to use for connections.
- **Default Client Port**: (Optional) Enter an optional local proxy port on which to listen when a session is started on a client.
- **Maximum Duration**: (Optional) Enter an optional maximum duration for sessions on this target, in seconds.
- **Maximum Duration**: (Required) Enter a maximum duration for sessions on this target, in seconds.
If you do not enter a value, Boundary uses the default of 8 hours (28,800 seconds).
- **Maximum Connection**: (Optional) Enter the maximum number of connections allowed per session on this target.
For unlimited connections, enter `-1`.
- **Workers**: (Optional) Select whether you want the worker to function as an ingress and/or egress worker.
Expand Down
1 change: 1 addition & 0 deletions website/content/docs/concepts/domain-model/targets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ A target has the following configurable attributes:
when a session reaches the maximum duration.
The default is 8 hours (28800 seconds).
This value must be greater than 0.
If you do not specfiy a maximum duration, Boundary uses the default value.

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