Last updated Sep 6, 2021

Rate this page:

Create, view, update, and remove components

Create a component

A component is an output artifact of your engineering team. It could be a service, a library, an application, or something else.

A component’s catalog listing in Compass is the unified view of all information about the component. The first step to build a component catalog is to create components.

To create a new component:

  1. In Compass, in the top navigation bar, click Create.
  2. Select a component type.
    • Choose the type carefully. You cannot change it after creating the component.
  3. Enter the component’s name.
  4. Select an owner for your component.
    1. Although adding a component owner is optional, we highly recommend that you add one. Without an owner, who is responsible for running, maintaining, and enhancing the component? Learn more about why adding an owner is important
    2. If the owner team does not exist, that’s okay. You can create your component now, start a new team and then assign it to the component when you are ready.
  5. Click Create.

We’ll add your component to the catalog and take you to the component’s details page, where you can add detailed information such as links to repositories and documentation, chat channels, dependencies, and more.

View a component's details

A component's details page is the single place in Compass where you’ll find everything you want to know about your component. In the details page, you’ll find what the component does, who owns it and how to contact them, its links and dependencies, scores, and more.

To view your component’s details, use any of the following methods:

  • In the component catalog, locate your component and select its name. You’ll need to go to the page specific to the type of your component. For example, if your component is a library, from the left navigation bar, select Libraries.
  • Search for the component and select its name in the search results.
  • Search for the team that owns your component. On the team’s dashboard, from the Team components list, select the component’s name.

A component’s URL never changes. Bookmark the URL of a component’s details page and use it as an easy reference in the future.

Component types

Component types help you categorize your components based on their capabilities. Every component in Compass has a type. You set a component’s type when creating its catalog listing in Compass.

A component's type is fixed. You can set it at the time of creating a component in Compass, however, you cannot change it afterwards.

The following component types are available in Compass:

Service

The Service type models an independently deployable software unit that is usually is operated by a person or a team. Services can be as large as monoliths or smaller microservices.

Library

The Library type models a reusable collection of objects, functions, and methods. A library is typically used by other components.

Application

The Application type models a fully-packaged application like a mobile application, desktop application, or a CLI type tool.

Other

The Other type generically models any software component. Use this type when your component does not categorize as any of the specific component types available in Compass.

Attributes per component types

Each component type has attributes that apply to all components of that type. Attributes help you record a component's details in its catalog listing.

The following attributes are available per component type:

AttributeService typeLibrary, Application, and Other type
OwnerAvailableAvailable
DependenciesAvailableAvailable
Repositories, Documentation, Projects, Dashboards, Other linksAvailableAvailable
Chat channelsAvailableAvailable
Tier fieldAvailableUnavailable
On-call schedulesAvailableUnavailable

To keep your component’s catalog listing up-to-date, start adding the attribute values. Learn how to add a component's details

Rate this page: