Dan HeathandRobin Beck
22a9074724
* docs: Update meta content - Concepts * docs: Revisions * Update website/content/docs/concepts/domain-model/credentials.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Update website/content/docs/concepts/domain-model/scopes.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Update exec flag description * Update website/content/docs/concepts/filtering/events.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Update domain model descriptions * docs: Update domain model titles * docs: Edits for consistency --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
53 lines
1.4 KiB
Plaintext
53 lines
1.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Host catalog resource
|
|
description: >-
|
|
Learn about using the host catalog resource to organize and manage hosts and host sets within a project based on their function, environment, or other criteria.
|
|
---
|
|
|
|
# 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)
|