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.
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:
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.
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: