- Notifications
You must be signed in to change notification settings - Fork1.1k
docs: edit Boundary documentation to reflect current functionality#20403
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
37 commits Select commitHold shift + click to select a range
2e8f879 created new docs page for agent boundaries, linked to from security.md
jcjiang97d3f23 added boundaries section to index.md
jcjiang84913d9 added examples of how to integrate CLI into workspace
jcjiang6ffa954 Added additional content to architecture and premium sections, ready …
jcjiang98861c9 add manifest entry
david-fraley490728d fix manifest path
david-fraleyfacfa7d add title
david-fraley9377904 fmt
david-fraleye019af8 more format stuff
david-fraley7312199 typo fix
david-fraleyf53411a added section on unprivileged vs. privileged mode
jcjiang5e39783 fixed formatting (maybe?)
jcjiang2a21a7f removed modules instructions and other sections that are not necessar…
jcjiangd4ced50 Update docs/ai-coder/agent-boundary.md
jcjiang256a1f0 fixed changes as suggested by david
jcjiangd6c6ca3 Merge branch 'boundaries-docs' of https://github.com/coder/coder into…
jcjiang471ea1a Merge branch 'main' into boundaries-docs
jcjiangeba82a7 Merge branch 'main' into boundaries-docs
jcjiang1580e2f fix whitespace
david-fraleyc2a3408 more whitespace fix
david-fraley3a7da3c pls no more whitespace fixes
david-fraley37a992d fixing linting issues
jcjiang076d8e8 Merge branch 'boundaries-docs' of https://github.com/coder/coder into…
jcjiangc38dd45 whitespace
jcjiang28498e5 try to remove the space
david-fraleyb237dd1 more whitespace
david-fraley1374cc7 Revised boundary docs to reflect current functionality
jcjiangf0507c4 updated version to take into account change to terraform README
jcjiang8e84383 Merge branch 'main' into boundaries-docs
jcjiang18a1c64 fixed some formatting
jcjiang3056f16 Merge branch 'boundaries-docs' of https://github.com/coder/coder into…
jcjiang7583c63 made changes to content for accuracy!
jcjiang6061d79 Merge branch 'main' into boundaries-docs
jcjiangc3c7b4d fixed formatting issue
jcjianga86b82c changed boundaries to early access
jcjiang25d63e7 Merge branch 'boundaries-docs' of https://github.com/coder/coder into…
jcjiang0f45f54 pls no white space
jcjiangFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
141 changes: 35 additions & 106 deletionsdocs/ai-coder/agent-boundary.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -4,118 +4,47 @@ Agent Boundaries are process-level firewalls that restrict and audit what autono | ||
| Example of Agent Boundaries blocking a process. | ||
| ## Supported Agents | ||
| Agent Boundaries support the securing of any terminal-based agent, including your own custom agents. | ||
| ## Features | ||
| Agent Boundaries offer network policy enforcement, which blocks domains and HTTP verbs to prevent exfiltration, and writes logs to the workspace. | ||
| ## Getting Started with Boundary | ||
| The easiest way to use Agent Boundaries is through existing Coder modules, such as the [Claude Code module](https://registry.coder.com/modules/coder/claude-code). It can also be ran directly in the terminal by installing the [CLI](https://github.com/coder/boundary). | ||
| Below is an example of how to configure Agent Boundaries for usage in your workspace. | ||
| ```tf | ||
| module "claude-code" { | ||
| source = "dev.registry.coder.com/coder/claude-code/coder" | ||
| enable_boundary = true | ||
| boundary_version = "main" | ||
| boundary_log_dir = "/tmp/boundary_logs" | ||
| boundary_log_level = "WARN" | ||
| boundary_additional_allowed_urls = ["GET *google.com"] | ||
| boundary_proxy_port = "8087" | ||
| version = "3.2.1" | ||
| } | ||
| ``` | ||
| - `boundary_version` defines what version of Boundary is being applied. This is set to `main`, which points to the main branch of `coder/boundary`. | ||
| - `boundary_log_dir` is the directory where log files are written to when the workspace spins up. | ||
| - `boundary_log_level` defines the verbosity at which requests are logged. Boundary uses the following verbosity levels: | ||
| - `WARN`: logs only requests that have been blocked by Boundary | ||
| - `INFO`: logs all requests at a high level | ||
| - `DEBUG`: logs all requests in detail | ||
| - `boundary_additional_allowed_urls`: defines the URLs that the agent can access, in additional to the default URLs required for the agent to work | ||
| - `github.com` means only the specific domain is allowed | ||
| - `*.github.com` means only the subdomains are allowed - the specific domain is excluded | ||
| - `*github.com` means both the specific domain and all subdomains are allowed | ||
jcjiang marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| - You can also also filter on methods, hostnames, and paths - for example, `GET,HEAD *github.com/coder`. | ||
| You can also run Agent Boundaries directly in your workspace and configure it per template. You can do so by installing the [binary](https://github.com/coder/boundary) into the workspace image or at start-up. You can do so with the following command: | ||
| ```hcl | ||
| curl -fsSL https://raw.githubusercontent.com/coder/boundary/main/install.sh | bash | ||
| ``` | ||
2 changes: 1 addition & 1 deletiondocs/manifest.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.