Rate this page:
Components in Compass have details such as a name, description, owner, and tier (for services only), links to resources, and contacts. By adding add all the available details to a component’s catalog listing, and by updating those detail when necessary, you can always keep the component's information current.
Every component must have a name. Additionally, Compass assigns a default tier to service components when you create them in Compass. Adding other basic details, such as a description and an owner, is optional. But, we highly recommend you add those details.
We'll show you how to add or update a component's basic details in Compass.
To add or update a component’s basic details:
A component has several resources, such as repositories, documentation, projects, and more. If this information is scattered, people who use the component often struggle to find it when they need to know about the component.
Adding these resources to the component’s details provides other users with a central location to find the information they need.
Compass provides the following link types, where you can add links to the component’s resources:
Here, we'll show you how to add or update a component's links from the component's details page in Compass.
To add links to a component’s resources:
A component’s chat channel, such as a Slack or Microsoft Teams channel, is where users can reach the owner team for information about the component.
Owner teams have multiple areas of responsibility, such as development or support, and might have different chat channels for different purposes. By defining a chat channel, you can inform the component’s users of the best place to contact the owner team.
Here, we'll show you how to add or update a component's chat channel from the component's details page in Compass's.
To add a chat channel to a component:
A component’s on-call schedule, such as an Opsgenie or Pagerduty schedule, is where users can reach the people who handle incidents related to it.
An on-call schedule ensures that the right person is always available to manage incidents and outages. By defining an on-call schedule, you can inform the component’s users who to escalate to when something goes wrong with it. Users know which alarm to ring, thus shortening the time to resolution.
Here, we'll show you how to add or update a component's on-call schedule from the component's details page in Compass.
To add a component's on-call schedule:
A component’s labels are keywords or tags that apply additional information to the component. Labels make it easier to group components or search for specific components in the catalog.
Annotating components with custom labels gives you extra context and provides important information about the component. A label can denote whatever you like. Some examples could be the component’s programming language or the cloud provider it uses. Or, maybe you’d like to specify a group of services that go together or the department it belongs to, or even that the component is obsolete.
You can add labels to a component from the component’s details page in Compass.
To add labels to a component:
The labels are immediately added to your component.
You can remove a component’s labels from its details page in Compass.
To remove a component’s labels:
The labels are immediately removed from your component, but remain applied to any other components that have them.
A component has several resources, such as repositories, documentation, project, and more. When you add links to these resources in a component’s catalog listing in Compass, that information stays in a centralized location where users can easily find it.
Compass provides several link types to categorize different types of resources.
The source code repository, where you store the component’s code.
Documentation that is relevant to the component, such as runbooks, internal process documentation, specifications, and more.
The relevant projects for the component, for example, Jira projects.
Dashboards that display metrics and information about a component, for example, observability, usage, or finances.
Links to any other relevant resources that provide valuable information about the component.
Chat channels, such as Slack or Microsoft Teams channels, where users can reach the owner team for information about the component.
On-call schedules, such as Opsgenie or PagerDuty schedules, where users can identify the people who handle incidents related to it.
Compass supports all schemes that have a valid URL format.
Some examples of valid URL formats are:
Some examples of invalid URL formats are:
Rate this page: