40 lines
931 B
Plaintext
40 lines
931 B
Plaintext
---
|
|
layout: docs
|
|
page_title: Domain Model - Host Catalogs
|
|
sidebar_title: 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)
|
|
|
|
## 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) |