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]: /docs/concepts/domain-model/host-sets
|
|
[host sets]: /docs/concepts/domain-model/host-sets
|
|
[host]: /docs/concepts/domain-model/hosts
|
|
[hosts]: /docs/concepts/domain-model/hosts
|
|
[project]: /docs/concepts/domain-model/scopes#projects
|
|
|
|
## Service API Docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Host Catalog Service](/api-docs/host-catalog-service)
|