You can import components into Compass in bulk from applications that are external to Compass. Bulk import lets you start tracking many components at once, without having to add each component one by one.
You can import components from:
When you connect a Bitbucket or a GitHub repository, Compass automatically scans the source code management (SCM) app for API documentation. If the scan finds API specificiations in your repository, you can view endpoints on individual component pages.
You can’t import components of the capability, cloud resource, data pipeline, machine learning model, UI element, and website types from a connected app. We're working on adding this feature for components like this.
For now, create the component manually or use the API.
We recommend that you don't exceed 20,000 components in Compass, beyond which you may notice some performance degradation. We are working on scaling the solution to increase the limits over time.
CSV file import is a quick way to add many components in bulk to Compass.
CSV files contain delimited text that represents tabulated data. Each line in the file is a record and a comma separates each field in that record. Most applications that support tabulated data, for example, Microsoft Excel, OpenOffice, and databases, support CSV files.
The CSV file import process involves:
The import process adds new components to Compass and updates existing components that have changed.
Learn how to import components from a CSV file
Bitbucket Cloud is a Git-based code hosting and collaboration tool, built for teams.
Compass currently supports Bitbucket Cloud as a tool to:
Components are software artifacts such as services, applications, and libraries. They usually live in repositories in source code management tools, such as Bitbucket Cloud. You can create a catalog listing of these components in Compass by importing them from their Bitbucket repositories.
The process to import component from Bitbucket repositories involves:
Learn how to import components from Bitbucket
GitHub is a Git-based code hosting and collaboration tool, built for teams.
Compass currently supports GitHub as a tool to:
Components are software artifacts such as services, applications, and libraries. They usually live in repositories in source code management tools, such as GitHub. You can create a catalog listing of these components in Compass by importing them from their GitHub repositories.
The process to import component from GitHub repositories involves:
Learn how to import components from GitHub
GitLab is a web-based Git repository that provides free open and private repositories, issue-following capabilities, and wikis. Compass supports GitLab SaaS but not self-managed.
Compass currently supports GitLab SaaS as a tool to:
Components are software artifacts such as services, applications, and libraries. They usually live in repositories in source code management tools, such as GitLab. You can create a catalog listing of these components in Compass by importing them from their GitLab repositories.
The process to import component from GitLab repositories involves:
Learn how to import components from GitLab
New Relic is an observability platform that enables engineering teams to monitor the performance of their deployed software.
If your team uses New Relic for application performance monitoring (APM), you can import your monitored services directly into Compass. This is an easy way to begin building your component catalog in Compass.
The process to integrate and import services from New Relic involves:
Rate this page: