Skip to main content

Frontmatter fields

Each resource in CloudCatalog will contain frontmatter this data is used by CloudCatalog to render your resource correctly.

Some of these fields are editable, and some are read-only.

Fields owned by CloudCatalog

In the frontmatter the fields AWS and catalog are fields owned by CloudCatalog, change at your own risk.

Reimporting resources into CloudCatalog will override these values.

Optional fields​

name​

Friendly name for your resource.

Example
---
name: MyAwesomeResource
---

description​

Short summary of your resource.

Example
---
description: My awesome new resource
---

owners​

An array of users or teams ids that own the resource.

Example
---
owners:
  - dboyne
  - mSmith
  - my-awesome-team
---

service​

The service id of the service that the resource belongs too.

Services

Every resource can belong to a service. You will need to create a service before you can add the resource to the service.

Example
---
service: payment-service
---