Rate this page:
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:
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.
You can also create components while you are on your team’s dashboard or on one of the components list pages. When you're there, select + Create component, provide the component's details, and select Create.
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:
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.
When you view a component, you'll first see the overview page. This page groups the key details about the component.
Basic details: This section is the first place the users look when they view a component’s details. It shows the component’s basic details such as its name and description. For service-type component's the tier appears here.
Owner team: The owner team’s card showing the team’s information appears here. An owner team has a defined responsibility towards managing a component. You can assign or change a component’s ownership from this section.
Component contacts: Links to the owner team’s chat channel appear here. Additionally, for services, links to the component's on-call roster also appear here. These links give you access to the people who can provide help with the component or support you during an incident.
Scorecards: The scorecards you apply to a component appear here. Scorecards show a component’s health based on set criteria.
Resource links, labels, and metrics: Links to a component’s resources, such as repositories, documentation, projects, and more, appear in this section. More details, such as labels and metrics are also available here.
Component navigation: Pages providing more information about the component appear here. Some of these pages are available by default, for example Activity or Dependencies. Whereas, some pages become available when you install different apps on Compass, for example, Swagger UI.
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 can't change it afterwards.
The following component types are available in Compass:
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.
The Library type models a reusable collection of objects, functions, and methods. A library is typically used by other components.
The Application type models a fully-packaged application like a mobile application, desktop application, or a CLI type tool.
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.
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:
|Attribute||Service type||Library, Application, and Other type|
|Repositories, Documentation, Projects, Dashboards, Other links||Available||Available|
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: