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.

Sign up for GitHub

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: Add interoperability matrix #5478

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: Add interoperability matrix #5478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
145ce03
docs: Add interoperability matrix
Dan-Heath Jan 27, 2025
e2db6fd
docs: Remove one table version
Dan-Heath Jan 29, 2025
ee7d8f0
docs: New format
Dan-Heath Jan 29, 2025
00141af
docs: Update table format
Dan-Heath Feb 3, 2025
b74397d
docs: Revisions and beta label
Dan-Heath Feb 4, 2025
5d22b53
docs: Add link, WARP caveat
Dan-Heath Feb 5, 2025
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
5 changes: 4 additions & 1 deletion website/content/docs/api-clients/client-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,8 @@ You can also remove the existing server host key from the `~/.ssh/known_hosts` f
## Conflicting software

Some software is known to cause conflicts with the Boundary Client Agent.
Refer to the [transparent sessions interoperability matrix](/boundary/docs/configuration/target-aliases/interoperability-matrix) for a list of the third-party products that have been tested for use with the Boundary Client Agent.

The following sections are an incomplete list of potential conflicts and any available workarounds for issues.

### Docker Desktop (MacOS)
Expand Down Expand Up @@ -650,7 +652,8 @@ Learn more: https://cfl.re/CF_DNS_PROXY_FAILURE
```

You can still install both the Cloudflare WARP client and the Boundary Client Agent on the same machine.
As long as you don't run both at the same time, they should work as expected.
The two products can coexist as long as the WARP client starts first.
Starting the WARP client first binds it to alternate IPs and leaves the domain available for Boundary.

### Huntress EDR client

Expand Down
234 changes: 234 additions & 0 deletions website/content/docs/configuration/target-aliases/interoperability-matrix.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
---
layout: docs
page_title: Transparent sessions interoperability matrix
description: >-
Refer to a matrix to determine which partner products and applications are supported by the Boundary components required for transparent sessions.
---

# Transparent sessions interoperability matrix

@include 'alerts/enterprise-only.mdx'

@include 'alerts/beta.mdx'

Transparent sessions require you to use the Boundary installer to install the Boundary Client Agent.
To support a variety of use cases, HashiCorp verifies implementation and integrations with partner products and applications.

HashiCorp has tested and confirmed that you can use the following third-party products with the specific versions of the installer, Client Agent, and any operating systems listed in the table.
Products may operate with other versions as well, but they have not been tested.
We will update the list of products as we test them.

<table>
<thead>
<tr>
<th style={{verticalAlign: 'middle'}}>Product</th>
<th style={{verticalAlign: 'middle'}}>Version</th>
<th style={{verticalAlign: 'middle'}}>Installer versions</th>
<th style={{veritcalAlign: 'middle'}}>Client Agent versions</th>
<th style={{verticalAlign: 'middle'}}>OS versions</th>
<th style={{veritcalAlign: 'middle'}}>Notes</th>
</tr>
</thead>
<tbody>

<tr>
<td style={{verticalAlign: 'middle'}}>
CloudFlare WARP client
</td>
<td style={{verticalAlign: 'middle'}}>
2024.12.554.0
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
MacOS 14.6
<br /><br />
Windows 11 Pro, version 24H2
</td>
<td style={{verticalAlign: 'middle'}}>
Refer to <a href="/boundary/docs/api-clients/client-agent#cloudflare-warp-client">Conflicting software</a>
</td>
</tr>

<tr>
<td style={{verticalAlign: 'middle'}}>
Crowdstrike Falcon
</td>
<td style={{verticalAlign: 'middle'}}>
&nbsp;
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
N/A
</td>
<td style={{verticalAlign: 'middle'}}>
N/A
</td>
<td style={{verticalAlign: 'middle'}}>
&nbsp;
</td>
</tr>

<tr>
<td style={{verticalAlign: 'middle'}}>
Huntress
</td>
<td style={{verticalAlign: 'middle'}}>
<b>MacOS</b>: 0.13.228
<br /><br />
<b>Windows</b>: 0.13.234
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
MacOS 14.6
<br /><br />
Windows 11 Pro, version 24H2
</td>
<td style={{verticalAlign: 'middle'}}>
Refer to <a href="/boundary/docs/api-clients/client-agent#huntress-edr-client">Conflicting software</a>
</td>
</tr>

<tr>
<td style={{verticalAlign: 'middle'}}>
OpenVPN
</td>
<td style={{verticalAlign: 'middle'}}>
<b>MacOS</b>: OpenVPN v3 client 3.5.0 (5200)
<br/ ><br />
<b>Server</b>: OpenVPN 2.6.12 on AWS EC2 Ubuntu cluster (x86)
<br /><br />
<b>Windows</b>: OpenVPN v3 client 3.5.1 (3946)
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
MacOS 14.7.1 (arm64)
<br /><br />
Windows 11 Pro, version 24H2 (arm64)
</td>
<td style={{verticalAlign: 'middle'}}>
&nbsp;
</td>
</tr>

<tr>
<td style={{verticalAlign: 'middle'}}>
SentinelOne Singularity
</td>
<td style={{verticalAlign: 'middle'}}>
&nbsp;
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.2
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.2
</td>
<td style={{verticalAlign: 'middle'}}>
MacOS 15.2
<br /><br />
Windows 11
</td>
<td style={{verticalAlign: 'middle'}}>
&nbsp;
</td>
</tr>

<tr>
<td style={{verticalAlign: 'middle'}}>
Tailscale
</td>
<td style={{verticalAlign: 'middle'}}>
1.78.1
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
MacOS 15
<br /><br />
Windows 11
</td>
<td style={{verticalAlign: 'middle'}}>
&nbsp;
</td>
</tr>

<tr>
<td style={{verticalAlign: 'middle'}}>
WireGuard
</td>
<td style={{verticalAlign: 'middle'}}>
<b>MacOS</b>: WireGuard client version 1.0.16 (27)
<br /><br />
<b>Windows</b>: WireGuard client version 0.5.3
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
MacOS 14.7.1 (arm64)
<br /><br />
Windows 11 Pro, version 24H2 (arm64)
</td>
<td style={{verticalAlign: 'middle'}}>
&nbsp;
</td>
</tr>

<tr>
<td style={{verticalAlign: 'middle'}}>
ZeroTier
</td>
<td style={{verticalAlign: 'middle'}}>
1.14.0
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
0.1.1
</td>
<td style={{verticalAlign: 'middle'}}>
MacOS 15
<br /><br />
Windows 11
</td>
<td style={{verticalAlign: 'middle'}}>
&nbsp;
</td>
</tr>

</tbody>
</table>


## More information

For more information, refer to the following topics:

- [Transparent sessions](/boundary/docs/concepts/transparent-sessions)
- [Configure transparent sessions](/boundary/docs/configuration/target-aliases/transparent-sessions)
- [Boundary Client Agent](/boundary/docs/api-clients/client-agent)
4 changes: 3 additions & 1 deletion website/content/docs/configuration/target-aliases/transparent-sessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Make sure to select the options **Boundary Client Agent**, **CLI**, and **Deskto
$ boundary client-agent status
```

Refer to the [transparent sessions interoperability matrix](/boundary/docs/configuration/target-aliases/interoperability-matrix) for a list of the third-party products that have been tested for use with the Boundary installer and Client Agent.

## Configure targets

The following section details how to configure targets and test the transparent sessions public beta feature.
Expand All @@ -43,7 +45,7 @@ The following section details how to configure targets and test the transparent
If you use a cluster that was created earlier than release 0.16.0, you must add the grant `list-resolvable-aliases` so that the client agent can populate the local alias cache.

As an example, you could add the grant:

`type=user;actions=list-resolvable-aliases;ids=*`.

</Tip>
Expand Down
9 changes: 9 additions & 0 deletions website/data/docs-nav-data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,6 +614,15 @@
"color": "neutral"
},
"path": "configuration/target-aliases/transparent-sessions"
},
{
"title": "Transparent sessions interoperability matrix",
"badge": {
"text": "HCP/ENT BETA",
"type": "outlined",
"color": "neutral"
},
"path": "configuration/target-aliases/interoperability-matrix"
}
]
},
Expand Down