Last updated Sep 6, 2021

Rate this page:

Add or remove component dependencies

What are component dependencies?

A component dependency is a relationship between two components, where one component relies on another for functionality or availability.

A distributed architecture has a collection of components that depend on one another. As you add more components to your architecture, the number of dependencies increases, leading to a complex orchestration of components. When components depend on one another, several factors such as downtime, deployment, security issues, and status of a component affect its dependent components. In a complex architecture, it is difficult to identify the impacts.

Mapping component dependencies enables you to identify the things that impact a component or those that a component impacts. It helps you to:

  • understand your infrastructure and how components connect
  • determine if you are affected by downtime or when an incident occurs
  • provide faster incident resolution when you see the impact of components depending on one another

Add a dependency to a component

You can add a component dependency from the Dependencies section on the component’s details page.

Currently, Compass supports the Depends on dependency type. Learn more about the available component dependency types

If you manage your component via config-as-code, you must also use config-as-code to add or remove dependencies. You won’t be able to do so via the Compass UI. Learn how to update your component managed via config-as-code

To add a dependency to a component:

  1. In Compass, go to your component’s details view. Learn how to view a component's details
  2. Select Dependencies from the left navigation.
  3. If this is the first dependency, follow these steps:
    1. Search and select the component that you depend on from the Select a component list.
    2. Select Add dependency.
  4. If the component already has dependencies, follow these steps:
    1. Select the add icon + from at top of the Depends on list.
    2. Search and select the component you depend on from the Select a component list.
    3. Select Add.

The component's dependency is recorded in Compass.

A component can depend on a maximum of 50 other components and it can have a maximum of 100 other components depend on it.

Remove a dependency from a component

You can remove the record of a component’s dependency on another component from the Dependencies section on the component’s details page.

If you manage your component via config-as-code, you must also use config-as-code to add or remove dependencies. You won’t be able to do so via the Compass UI. Learn how to update your component managed via config-as-code

To remove a dependency from a component:

  1. In Compass, go to your component’s details view. Learn how to view a component's details
  2. Select Dependencies from the left navigation.
  3. Hover on the component you want to remove from the Depends on list. Then, select the remove icon X.
  4. Select Remove on the confirmation dialog.

The component dependency is no longer recorded in Compass.

Available component dependency types

Your Compass site comes with the following dependency type:

Depends on

Describes the relationship of a component on another component that is necessary for it to operate.

For example, you could describe that an application component dependsOn a library component as part of its build.

Any type of component can depend on any other type of component in Compass.

A component can depend on a maximum of 50 other components and it can have a maximum of 100 other components depend on it.

Rate this page: