Dan HeathandRobin Beck
5ce6515156
* docs: IA reorganization * docs: Updates * docs: Updates * docs: Fix links * docs: Updates * docs: Fix a typo * docs: Fix client agent topic * docs: Update Client Agent nav * docs: Fix conflict * docs: Fix a typo in Client Agent docs (#5853) * docs: Fix client agent topic * docs: Updates * docs: Updates * docs: Updates * docs: Updates * docs: Fixes get started and operations links * docs: Update nav * docs: Partials * docs: Unix partials * docs: Worker partials * docs: Updates * docs: Update workers and targets * docs: Updates * docs: Updates * docs: Fixes link * docs: Updates after sync review * docs: Updates from review feedback * docs: Move worker filter examples * docs: Fix links * docs: Updates for filters based on working session * docs: Fixes broken links * docs: Add links to other filter topics * docs: Update list intro * docs: Adds link * docs: Fixes redirects * docs: Fixes redirects * docs: Deleted mysql page from TOC * docs: Add versioned redirect * docs: Adds versioned redirects * docs: Adds versioned redirects * docs: Update redirects * docs: Update redirects * docs: Redirect fixes * docs: Update redirect format * docs: Fix a typo * docs: Fixes redirects * docs: Fixes redirect * docs: Adds links out to client agent troubleshooting * uses /etc/boundary.d/ as recommended installation directory (#6003) * docs: Updates legacy io links * docs: Fixes redirects * docs: Fix redirect * docs: Restoring deleted file --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
55 lines
1.5 KiB
Plaintext
55 lines
1.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Host resource
|
|
description: >-
|
|
Learn about using host resources to represent computing elements that are reachable from Boundary. You can organize hosts in host sets and host catalogs.
|
|
---
|
|
|
|
# Hosts
|
|
|
|
A host is a resource
|
|
that represents a computing element with a network address
|
|
reachable from Boundary.
|
|
A host belongs to a [host catalog][].
|
|
Hosts can only be associated with [host sets][]
|
|
from the same host catalog as the host.
|
|
|
|
## Plugin-based host information
|
|
|
|
Plugin-based hosts are read-only. They are synced by an installed plugin on
|
|
the boundary system using the configuration provided it from the
|
|
host catalog and host set at an interval (configurable in the
|
|
host set).
|
|
|
|
## Attributes
|
|
|
|
A host has the following configurable attributes:
|
|
|
|
- `name` - (optional)
|
|
If set, the `name` must be unique within the host's parent host catalog.
|
|
|
|
- `description` - (optional)
|
|
|
|
### Static host attributes
|
|
|
|
Static host types have the following additional attribute:
|
|
|
|
- `address` - (required)
|
|
Must be at least 3 characters long and not greater than 255 characters.
|
|
|
|
## Referenced by
|
|
|
|
- [Host catalog][]
|
|
- [Host set][]
|
|
|
|
[host catalog]: /boundary/docs/domain-model/host-catalogs
|
|
[host catalogs]: /boundary/docs/domain-model/host-catalogs
|
|
[host set]: /boundary/docs/domain-model/host-sets
|
|
[host sets]: /boundary/docs/domain-model/host-sets
|
|
|
|
## Service API docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Host service](/boundary/api-docs/host-service)
|