Last updated Sep 16, 2021

Rate this page:

Add, update, or remove a component's details

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.

Add or update a component's basic details

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.

If you manage your component via config-as-code, you must also use config-as-code to add or update the component’s details. You won’t be able to add any new details or update existing details via the Compass UI. Learn how to update your component managed via config-as-code

To add or update a component’s basic details:

  1. If you are not already there, navigate to your component's details page in Compass.
  2. Update its name through inline edit. Select the name, update the text, and save your changes.
    • A component's name cannot be blank.
  3. Add or update the description through inline edit. Select the description, update the text, and save your changes.
  4. (For service components only) Update the tier value, if required. Select the tier list and choose a value.
  5. Add or update the owner team.

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:

  • Repository
  • Documentation
  • Projects
  • Dashboards
  • Other links

Learn more about the available link types

Here, we'll show you how to add or update a component's links from the component's details page in Compass.

If you manage your component via config-as-code, you must also use config-as-code to add or update the component’s links. You won’t be able to add any new links or update existing links via the Compass UI. Learn how to update your component managed via config-as-code

To add links to a component’s resources:

  1. If you are not already there, navigate to your component's details page in Compass.
    • A component's details has the Repositories, Documentation, Projects, Dashboards, and Other links sections for different link types.
  2. Select the field under the section for the particular link type that you want to add.
    • For example, if you're adding a link to a repository, select the field under Repositories. If you haven’t added any links so far, select + Add the repository where the code is stored for this component. If you’ve added at least one link previously, select + Add repository.
  3. Enter the URL.
  4. Optionally, enter the Link text, which is a display name for the link, in plain text.
    • Compass first tries to resolve the title from the URL. If successful, the resolved title appears as the link text. If not, it displays the link text you provided. If you did not provide any link text, the URL itself appears as the link text.
  5. Select Add.

You can add a maximum of five links per link type, per component.

Add a component's chat channel

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.

If you manage your component via config-as-code, you must also use config-as-code to add or update the component’s chat channel. You won’t be able to add any new chat channels or update existing channels channels via the Compass UI. Learn how to update your component managed via config-as-code

To add a chat channel to a component:

  1. If you are not already there, navigate to your component's details page in Compass.
  2. On the Component contacts card in the right sidebar, select + Add chat links.
  3. Enter a URL.
  4. Optionally, enter a display name for the link, in plain text, which Compass will show instead of the URL.
    • Compass first tries to resolve the title from the URL. If successful, the resolved title appears as the link text. If not, it displays the link text you provided. If you did not provide any link text, the URL itself appears as the link text.
  5. Select Add.

You can add links to a maximum of five chat channels per component.

Add a component's on-call schedule

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.

  • An on-call schedule is available only for service components. It is not available for other component types.
  • If you manage your component via config-as-code, you must also use config-as-code to add or update the component’s on-call schedule. You won’t be able to add any new on-call schedules or update existing on-call schedules via the Compass UI. Learn how to update your component managed via config-as-code

To add a component's on-call schedule:

  1. If you are not already there, navigate to your component's details page in Compass.
  2. On the Component contacts card in the right sidebar, select + Add on-call schedules.
  3. Enter the URL of the on-call schedule.
  4. Optionally, enter a display name for the link, in plain text, which Compass will show instead of the URL.
    • Compass first tries to resolve the title from the URL. If successful, the resolved title appears as the link text. If not, it displays the link text you provided. If you did not provide any link text, the URL itself appears as the link text.
  5. Select Add.

You can add links for a maximum of five on-call schedules per component.

Add or remove a component's labels

What are component labels?

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.

Add labels to a component

You can add labels to a component from the component’s details page in Compass.

To add labels to a component:

  1. If you are not already there, navigate to your component's details page in Compass.
  2. Select the field under the Labels section.
    • If you haven’t added any labels so far, select + Add labels to describe this component and start typing.
    • If you have added at least one label for the component, click inside the field and start typing.
  3. Select an existing label from the list or select Add to create a new label.
  4. Repeat the process for each label you want to add.

The labels are immediately added to your component.

  • You can add a maximum of ten labels per component.
  • The maximum length of each label is 40 characters. Anything longer is truncated.
  • Compass automatically converts upper case characters in the label to lower case characters and spaces to hyphens, for example, lAbEl 01 becomes label-01.

Remove a component's labels

You can remove a component’s labels from its details page in Compass.

To remove a component’s labels:

  1. If you are not already there, navigate to your component's details page in Compass.
  2. Select the field under the Labels section.
  3. Click on the remove icon (Remove icon) on each label you want to delete.

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.

All links must have a valid URL format. See some examples of valid and invalid URL formats.

Repository

The source code repository, where you store the component’s code.

Documentation

Documentation that is relevant to the component, such as runbooks, internal process documentation, specifications, and more.

Projects

The relevant projects for the component, for example, Jira projects.

Dashboards

Dashboards that display metrics and information about a component, for example, observability, usage, or finances.

Other links

Links to any other relevant resources that provide valuable information about the component.

Chat channels

Chat channels, such as Slack or Microsoft Teams channels, where users can reach the owner team for information about the component.

On-call schedules

On-call schedules, such as Opsgenie or PagerDuty schedules, where users can identify the people who handle incidents related to it.

The On-call schedules link type is available only for service components. It is unavailable for all other types.

Valid and invalid URL formats

Compass supports all schemes that have a valid URL format.

Some examples of valid URL formats are:

  • http://example.com
  • https://www.example.com
  • ftp://10.10.10.10
  • git://example.com/user/project-name.git

Some examples of invalid URL formats are:

  • atlassian.com (the http:// URL scheme is missing)
  • javascript://test (due to security reasons)
  • git@bitbucket.org:workspace/repository.git (the URI is valid, however, the URL scheme is missing and bitbucket.org:workspace is an invalid authority)

Rate this page: