2020-07-27 10:59:08 -07:00
|
|
|
---
|
|
|
|
|
layout: docs
|
2020-10-10 16:40:06 -04:00
|
|
|
page_title: Domain Model - Host Catalogs
|
2020-07-27 10:59:08 -07:00
|
|
|
description: |-
|
2020-10-10 16:40:06 -04:00
|
|
|
The anatomy of a Boundary host catalog
|
2020-07-27 10:59:08 -07:00
|
|
|
---
|
|
|
|
|
|
2020-10-10 16:40:06 -04:00
|
|
|
# Host Catalogs
|
2020-07-27 10:59:08 -07:00
|
|
|
|
2020-10-11 17:21:27 -04:00
|
|
|
A host catalog is a resource
|
|
|
|
|
that contains [hosts][] and [host sets][].
|
|
|
|
|
A host catalog can only be defined within a [project][].
|
2020-07-27 10:59:08 -07:00
|
|
|
|
|
|
|
|
## Attributes
|
2020-10-11 17:21:27 -04:00
|
|
|
|
|
|
|
|
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)
|
|
|
|
|
|
|
|
|
|
## 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
|
2020-10-12 17:40:42 -04:00
|
|
|
|
|
|
|
|
## Service API Docs
|
|
|
|
|
|
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
|
|
2021-04-05 12:04:57 -05:00
|
|
|
- [Host Catalog Service](/api-docs/host-catalog-service)
|