From 915be558d2a20e6cda2bb30d9137953865d0966a Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Tue, 10 Jun 2025 17:17:46 -0400 Subject: [PATCH] docs: Add Client Agent commands to CLI docs (#5826) * docs: Add Client Agent commands to CLI docs * docs: Fix typos * docs: Update status description * Update website/content/docs/commands/client-agent/index.mdx Co-authored-by: Robin Beck * docs: Capitalize Client Agent * docs: Undo capitalization * Apply batch suggestions from code review Co-authored-by: Robin Beck --------- Co-authored-by: Robin Beck --- .../docs/commands/client-agent/index.mdx | 59 ++++++++++++ .../docs/commands/client-agent/pause.mdx | 38 ++++++++ .../docs/commands/client-agent/resume.mdx | 39 ++++++++ .../docs/commands/client-agent/sessions.mdx | 37 ++++++++ .../docs/commands/client-agent/status.mdx | 39 ++++++++ website/data/docs-nav-data.json | 91 ++++++++++++------- 6 files changed, 270 insertions(+), 33 deletions(-) create mode 100644 website/content/docs/commands/client-agent/index.mdx create mode 100644 website/content/docs/commands/client-agent/pause.mdx create mode 100644 website/content/docs/commands/client-agent/resume.mdx create mode 100644 website/content/docs/commands/client-agent/sessions.mdx create mode 100644 website/content/docs/commands/client-agent/status.mdx diff --git a/website/content/docs/commands/client-agent/index.mdx b/website/content/docs/commands/client-agent/index.mdx new file mode 100644 index 0000000000..b68c839ac7 --- /dev/null +++ b/website/content/docs/commands/client-agent/index.mdx @@ -0,0 +1,59 @@ +--- +layout: docs +page_title: client-agent - Command +description: >- + The "client-agent" command lets you interact with the Boundary Client Agent. +--- + +# client-agent + +Command: `boundary client-agent` + +The `client-agent` command lets you interact with the Boundary Client Agent. +You can check the Client Agent's status, pause it, resume it, or list the active transparent sessions the Client Agent is managing. + +## Examples + +The following command lets you check the status of the Client Agent to ensure it is running: + +```shell-session +$ boundary client-agent status +``` + +The following command retrieves information about any sessions that the Client Agent is managing: + +```shell-session +$ boundary client-agent sessions +``` + +You can temporarily disable the Client Agent by pausing it with the following command: + +```shell-session +$ boundary client-agent pause +``` + +## Usage + + + +```shell-session +Usage: boundary client-agent [options] [args] + + # ... + +Subcommands: + pause Pauses the running boundary client agent + resume Resumes the paused boundary client agent + sessions List active transparent sessions managed by the client agent. + status Get the status information of the running boundary client agent +``` + + + +For more information, examples, and usage, click on the name +of the subcommand in the sidebar or one of the links below: + +- [pause](/boundary/docs/commands/client-agent/pause) +- [resume](/boundary/docs/commands/client-agent/resume) +- [sessions](/boundary/docs/commands/client-agent/sessions) +- [status](/boundary/docs/commands/client-agent/status) diff --git a/website/content/docs/commands/client-agent/pause.mdx b/website/content/docs/commands/client-agent/pause.mdx new file mode 100644 index 0000000000..6d8628154c --- /dev/null +++ b/website/content/docs/commands/client-agent/pause.mdx @@ -0,0 +1,38 @@ +--- +layout: docs +page_title: client-agent pause - Command +description: >- + The "client-agent pause" command pauses the Client Agent so that it does not intercept DNS requests. +--- + +# client-agent pause + +Command: `boundary client-agent pause` + +The `boundary client-agent pause` command lets you temporarily stop the Client Agent. +When the Client Agent is paused, it does not intercept DNS requests and you cannot use transparent sessions. + +## Example + +The following command pauses the Client Agent: + +```shell-session +$ boundary client-agent pause +``` + +## Usage + + + +```shell-session +$ boundary client-agent pause [options] [args] +``` + + + +### Command options + +- `client-agent-port=` - Specifies the port on which the Client Agent listens. +You can also specify the port using the **BOUNDARY_CLIENT_AGENT_LISTENING_PORT** environment variable. + +@include 'cmd-option-note.mdx' diff --git a/website/content/docs/commands/client-agent/resume.mdx b/website/content/docs/commands/client-agent/resume.mdx new file mode 100644 index 0000000000..dd1154a604 --- /dev/null +++ b/website/content/docs/commands/client-agent/resume.mdx @@ -0,0 +1,39 @@ +--- +layout: docs +page_title: client-agent resume - Command +description: >- + The "client-agent resume" command resumes running the Client Agent when it is paused. +--- + +# client-agent resume + +Command: `boundary client-agent resume` + +The `boundary client-agent resume` command lets you resume the Client Agent when it is paused. +When the Client Agent is paused, it does not intercept DNS requests and you cannot use transparent sessions. +You must resume the Client Agent to use transparent sessions again after you pause it. + +## Example + +The following command resumes the Client Agent: + +```shell-session +$ boundary client-agent resume +``` + +## Usage + + + +```shell-session +$ boundary client-agent resume [options] [args] +``` + + + +### Command options + +- `client-agent-port=` - Specifies the port on which the Client Agent listens. +You can also specify the port using the **BOUNDARY_CLIENT_AGENT_LISTENING_PORT** environment variable. + +@include 'cmd-option-note.mdx' diff --git a/website/content/docs/commands/client-agent/sessions.mdx b/website/content/docs/commands/client-agent/sessions.mdx new file mode 100644 index 0000000000..67f9d815e4 --- /dev/null +++ b/website/content/docs/commands/client-agent/sessions.mdx @@ -0,0 +1,37 @@ +--- +layout: docs +page_title: client-agent sessions - Command +description: >- + The "client-agent sessions" command lists any active sessions that the Client Agent is managing. It also lists any associated brokered credentials. +--- + +# client-agent sessions + +Command: `boundary client-agent sessions` + +The `boundary client-agent sessions` command lists any sessions that the Client Agent is managing as well as any brokered credentials that are associated with those sessions. + +## Example + +The following command lists any sessions that the Client Agent is managing: + +```shell-session +$ boundary client-agent sessions +``` + +## Usage + + + +```shell-session +$ boundary client-agent sessions [options] [args] +``` + + + +### Command options + +- `client-agent-port=` - Specifies the port on which the Client Agent listens. +You can also specify the port using the **BOUNDARY_CLIENT_AGENT_LISTENING_PORT** environment variable. + +@include 'cmd-option-note.mdx' diff --git a/website/content/docs/commands/client-agent/status.mdx b/website/content/docs/commands/client-agent/status.mdx new file mode 100644 index 0000000000..003688f738 --- /dev/null +++ b/website/content/docs/commands/client-agent/status.mdx @@ -0,0 +1,39 @@ +--- +layout: docs +page_title: client-agent status - Command +description: >- + The "client-agent status" command provides the status of the Client Agent so you can ensure that it is running. +--- + +# client-agent status + +Command: `boundary client-agent status` + +You can use the `boundary client-agent status` command to ensure that the Client Agent is running. +The command provides the runtime status and information about whether the current user is authenticated. +It may also include a list of errors, if the Client Agent has encountered any. + +## Example + +The following command provides the current status of the Client Agent: + +```shell-session +$ boundary client-agent status +``` + +## Usage + + + +```shell-session +$ boundary client-agent status [options] [args] +``` + + + +### Command options + +- `client-agent-port=` - Specifies the port on which the Client Agent listens. +You can also specify the port using the **BOUNDARY_CLIENT_AGENT_LISTENING_PORT** environment variable. + +@include 'cmd-option-note.mdx' diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 88af965e0e..471f84ee71 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -879,6 +879,27 @@ } ] }, + { + "title": "authenticate", + "routes": [ + { + "title": "Overview", + "path": "commands/authenticate" + }, + { + "title": "ldap", + "path": "commands/authenticate/ldap" + }, + { + "title": "oidc", + "path": "commands/authenticate/oidc" + }, + { + "title": "password", + "path": "commands/authenticate/password" + } + ] + }, { "title": "billing", "routes": [ @@ -893,23 +914,52 @@ ] }, { - "title": "authenticate", + "title": "cache", "routes": [ { "title": "Overview", - "path": "commands/authenticate" + "path": "commands/cache" }, { - "title": "ldap", - "path": "commands/authenticate/ldap" + "title": "add-token", + "path": "commands/cache/add-token" }, { - "title": "oidc", - "path": "commands/authenticate/oidc" + "title": "start", + "path": "commands/cache/start" }, { - "title": "password", - "path": "commands/authenticate/password" + "title": "status", + "path": "commands/cache/status" + }, + { + "title": "stop", + "path": "commands/cache/stop" + } + ] + }, + { + "title": "client-agent", + "routes": [ + { + "title": "Overview", + "path": "commands/client-agent" + }, + { + "title": "pause", + "path": "commands/client-agent/pause" + }, + { + "title": "resume", + "path": "commands/client-agent/resume" + }, + { + "title": "sessions", + "path": "commands/client-agent/sessions" + }, + { + "title": "status", + "path": "commands/client-agent/status" } ] }, @@ -1054,31 +1104,6 @@ } ] }, - { - "title": "cache", - "routes": [ - { - "title": "Overview", - "path": "commands/cache" - }, - { - "title": "add-token", - "path": "commands/cache/add-token" - }, - { - "title": "start", - "path": "commands/cache/start" - }, - { - "title": "status", - "path": "commands/cache/status" - }, - { - "title": "stop", - "path": "commands/cache/stop" - } - ] - }, { "title": "database", "routes": [