Dan Heath
3f4cd53d16
* docs: Update headings for new style rule * docs: Fix headings - Get started * docs: Fix headings - Install * docs: Fix headings - Concepts * docs: Fix typos * docs: Fix headings - Configuration * docs: Fix headings - Operations * docs: Fix headings - Troubleshoot * docs: Fix headings - Clients and Develop * docs: Fix headings - HCP and ENT * docs: Fix headings - Release notes * docs: Fix typos * docs: Fix capitalization in TOC
53 lines
1.3 KiB
Plaintext
53 lines
1.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Domain model - host catalogs
|
|
description: |-
|
|
The anatomy of a Boundary host catalog
|
|
---
|
|
|
|
# Host catalogs
|
|
|
|
A host catalog is a resource
|
|
that contains [hosts][] and [host sets][].
|
|
A host catalog can only be defined within a [project][].
|
|
|
|
## Attributes
|
|
|
|
A host catalog has the following configurable attributes:
|
|
|
|
- `name` - (optional)
|
|
If set, the `name` must be unique within the host catalog's [project][].
|
|
|
|
- `description` - (optional)
|
|
|
|
### Plugin host catalog information and attributes
|
|
|
|
- `plugin_id` - (required)
|
|
Must reference an installed plugin.
|
|
|
|
- `attributes` - (optional)
|
|
A collection of fields which the plugin uses to interface with the backing
|
|
service.
|
|
|
|
- `secrets` - (optional)
|
|
A collection of sensitive fields, like credentials, which the plugin uses to
|
|
interface with the backing service. These fields are write-only.
|
|
|
|
## Referenced by
|
|
|
|
- [Host][]
|
|
- [Host Set][]
|
|
- [Project][]
|
|
|
|
[host set]: /boundary/docs/concepts/domain-model/host-sets
|
|
[host sets]: /boundary/docs/concepts/domain-model/host-sets
|
|
[host]: /boundary/docs/concepts/domain-model/hosts
|
|
[hosts]: /boundary/docs/concepts/domain-model/hosts
|
|
[project]: /boundary/docs/concepts/domain-model/scopes#projects
|
|
|
|
## Service API docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Host Catalog Service](/boundary/api-docs/host-catalog-service)
|