Files
threshold/website/content/docs/concepts/connection-workflows/index.mdx
T
0bd699c999 Dheath 0.18.0 assembly (#5175)
* docs: TS public beta docs

* docs: Updates

* docs: Move Client Agent sections

* docs: Updates

* docs: Fix typo

* docs: Remove x86

* docs: Add lead in sentence for links

* docs: FAQ updates

* docs: Edits and file name fixes

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>

* docs: Add alias refresh interval

* docs: Remove recurse only option

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* Update website/content/docs/concepts/transparent-sessions.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* docs: Updates from code review

* docs: Update support request

* docs: Fix a typo

* Update website/content/docs/api-clients/client-agent.mdx

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

* docs: Delete log example, create tabs

* client-agent: rework configuration docs

The section in the configuration talking about reloading the config
was repetitive and verbose. Combine the different sections into
two separate sections, one for updating general values and
one for reloading values, on MacOS only.

This also removes the specific Log section.

* docs: Minor rewrites

* client-agent: consistently use $ for shell sessions

* aliases: discourage single-word aliases

The use of single-word aliases breaks Transparent Sessions
on Windows, so we should discourage it. See ICU-15255 for more information.

* transparent-sessions: add known issues

Add two new known issues.

* client-agent: add troubleshooting section

* transparent-sessions: emphasize troubleshooting guide

* correct links

I haven't actually validated these links, but they
are now consistent with the rest of the links.

* Review comments

* client-agent: clarify that not all sessions are listed by command

* transparent-session: add known issue regarding Windows installer

* docs: Minor rewrites

* docs: Fix a typo

* docs: Add AssumeRole support

* docs: Add Backblaze support

* docs: Minor revision

* docs: Update MinIO reqs

* docs: Add supported Hitachi version

* docs: Trigger a new build

* docs: Clarify Desktop compatibility with control plane

* Update website/content/docs/enterprise/supported-versions.mdx

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* docs: Release notes 0.18.0

* docs: Add link to Client Agent docs

* docs: Update ts definition

* docs: Remove stray line

* docs: Fix minor issues with the assembly branch

* docs: Move section

* docs: Add section

* docs: Remove duplicate section

---------

Co-authored-by: Irena Rindos <irenarindos@users.noreply.github.com>
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
2024-10-15 08:21:31 -04:00

80 lines
4.5 KiB
Plaintext

---
layout: docs
page_title: Connection workflows
description: |-
Workflows that you can use to connect to targets. Learn how connect helpers, the `-exec` flag, and SSH ProxyCommand can help facilitate connections to targets.
---
# Connection workflows
This topic provides an overview of the possible workflows you may use to connect to targets with Boundary.
## Boundary connect
When you run the `boundary connect` command against a target, Boundary establishes a local authenticated proxy to the address on the target's default port.
The `boundary connect` command has a number of useful options, such as `-listen-port` which lets you choose the port on which the command listens for an incoming connection.
Refer to the [`boundary connect`](/boundary/docs/commands/connect) documentation for a list of the available options and usage examples.
To practice using the `boundary connect` command in a development environment, refer to the **Connect to your first target** tutorial for either [HCP Boundary](/boundary/tutorials/hcp-getting-started/hcp-getting-started-connect) or the [self-managed versions](/boundary/tutorials/oss-getting-started/oss-getting-started-connect) of Boundary.
## Transparent sessions
@include 'alerts/enterprise-only.mdx'
@include 'alerts/beta.mdx'
Transparent sessions shift Boundary from an active connection model to a passive connection model.
Instead of interacting with the Boundary CLI or Desktop client and having to remember specific IDs or ephemeral ports to connect to targets, Boundary operates in the background.
If a user is authenticated and authorized, Boundary intercepts DNS calls and routes traffic through a session automatically.
Refer to the [transparent sessions](/boundary/docs/concepts/transparent-sessions) documentation for more information.
## Connect helpers
Boundary features connect helpers that assist with making connections to targets using certain protocols.
Connect helpers automatically accept key prompts for you.
They are supported for the following connection types:
- HTTP
- Kubernetes
- PostgreSQL
- RDP
- SSH
Refer to the [Connect helpers](/boundary/docs/concepts/connection-workflows/connect-helpers) documentation for more information.
## Exec flag
In addition to the built-in connect helpers, `boundary connect` can accommodate executing clients even when there is no built-in support for a specific client using the `-exec` flag.
The `-exec` flag lets you wrap Boundary TCP sessions in your preferred client.
You can use this flag to create an authenticated proxy to almost anything.
Refer to the [Exec flag](/boundary/docs/concepts/connection-workflows/exec-flag) documentation for more information.
## SSH ProxyCommand
The most common pattern for using Boundary to SSH is with the built-in `boundary connect ssh` command.
However, there are more idiomatic approaches that can be employed to make Boundary transparent to users, and at the same time simplify common developer and operator workflows.
Using `ProxyCommand` to execute a proxy when invoking the SSH client is a common practice.
SSH `ProxyCommand` lets you proxy an SSH connection to a target according to a configuration file that you create.
You can configure the file to connect to the target ID or the target domain.
Refer to the [SSH ProxyCommand](/boundary/docs/concepts/connection-workflows/workflow-ssh-proxycommand) documentation for more information.
## Multi-hop sessions
@include 'alerts/enterprise-only.mdx'
Most organizations want to provide access to infrastructure without exposing private networks.
Many organizations also have complex network topologies requiring inbound traffic to route through multiple network enclaves to reach the target system.
Multi-hop sessions allow you to chain together two or more workers across multiple networks to form reverse proxy connections between the user and the target, even in complex networks with strict outbound-only policies.
You can deploy multi-hop workers in scenarios where inbound network traffic is
not allowed.
A worker in a private network can send outbound communication to its upstream worker, and create a reverse proxy to establish a session.
You can configure target worker filters with multi-hop workers to allow for fine-grained control on which workers handle ingress and egress for session traffic to a target.
Ingress worker filters determine which workers you connect with to initiate a session, and egress worker filters determine which workers are used to access targets.
Refer to the [Multi-hop sessions](/boundary/docs/concepts/connection-workflows/multi-hop) documentation for more information.