LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page
  • Getting started in Cortex
  • Step 1: Log in to your workspace
  • Step 2: Configure integrations
  • Step 3: Import your first entities
  • Step 4: Create an onboarding Scorecard
  • Step 5: Explore additional resources

Was this helpful?

Export as PDF

Cortex Quick Start

Last updated 13 hours ago

Was this helpful?

We’re excited for you to start using Cortex to achieve engineering excellence! If you don’t have an account yet, .

This guide walks through setting up your account, configuring your first integrations, and connecting your — services, infrastructure, teams, and more — with Cortex. After you’ve followed these steps, reach out to the Cortex team with any questions you have.

Need additional guidance?

To ensure a smooth and successful implementation, most of our customers partner with Cortex Professional Services (PS) for expert guidance and hands-on assistance. If you've already purchased a PS engagement, your dedicated team will be reaching out soon to kick things off.

If you haven’t engaged with PS yet, don’t worry—you can still take advantage of our expertise! Reach out to learn how we can support your implementation and adoption journey so you get the most out of Cortex.

Looking for a quick introduction to Cortex? Check out the .

Getting started in Cortex

Step 1: Log in to your workspace

You can access your Cortex workspace using the workspace ID provided to you by your Cortex team. Or, if you are deploying Cortex on-premises, the Cortex team will provide you with access to an installer.

SSO setup

Your initial login will be configured to use Google for Single Sign-On (SSO).

If you do not use a Google domain email address, work with the Cortex team on initial access and .

Add users

After accessing your account, you can add users to your Cortex workspace.

We recommend having at least two users with the Admin role configured to ensure redundancy of access.

Go further

We recommend reviewing the following resources:

Step 2: Configure integrations

We recommend configuring at least one integration from each of the following categories:

    • Configuring an on-call provider allows you to map services and other entities to the proper on-call rotations and manage alerts.

    • Configuring a communication provider allows you to receive timely notifications and collaborate seamlessly with team members.

    • Connecting your teams and team members in Cortex allows you to efficiently track ownership of entities.

Go further

It would also be beneficial to configure integrations for categories such as:

Step 3: Import your first entities

After you’ve configured some basic integrations, you can start importing your entities. Connecting your entities to Cortex allows you to easily track ownership and create Scorecards to enforce standards and track progress on related projects.

Step 3.1: Define entities

Before importing entities, consider your data modeling approach.

  • Identify the key entities that you want to represent in your Cortex catalogs.

Step 3.2: Import entities

  1. Navigate to Catalogs > All entities.

  2. Click Import entities.

  3. Follow the on-screen prompts to import the entities that Cortex discovered from your integrations.

As you integrate additional tools with Cortex, it can also become possible to streamline work during an incident, efficiently track issues, monitor your code for vulnerabilities, and more. See the documentation for a full list of available integrations.

Step 3.3: Import teams and team members

Cortex supports connecting teams from the following integrations:

Go further

Step 4: Create an onboarding Scorecard

When you first start using Cortex, we recommend creating an onboarding Scorecard to ensure that your entities are configured with the basics.

To get started:

  1. From the main nav, click Scorecards.

  2. Click Create Scorecard.

  3. Cortex offers templates to help you get started with common use cases. Click the Onboarding Scorecard.

  4. Review the default integrations, levels, and rules that are included in the template. You’ll get a chance to edit these on the next page. Click Continue.

  5. Configure your Scorecard, making any modifications necessary.

    • For in-depth instructions on creating Scorecards, see Creating and editing Scorecards.

  6. When you are finished, click Save Scorecard.

Go further

Step 5: Explore additional resources

Congratulations - you are on the path to achieving engineering excellence with Cortex!

Now that you’ve completed your first steps, we recommend exploring the following topics:

    • Reach out to your Customer Success Manager for more information on enabling this feature.

    • Reach out to your Customer Success Manager for more information on enabling this feature.

Go further

: Stay informed about onboarding status for users in Cortex.

: Assign default roles to users or create and assign custom roles with granular permissions.

: You can use the IP allowlist to control where your Cortex workspace can be accessed from.

Git providers: , , , or

Configuring a git provider allows you to discover and track ownership of entities, view important information about your repositories in Cortex, and use git data in to understand key metrics.

On-call providers: , , (formerly VictorOps), or

Communication providers: or

Teams and ownership providers: , , , , , , , , , and

Infrastructure: , , , and

Issue tracking: , , , ,

Code quality and security: , , , , , ,

Read more about entities and the default entity types in the .

If needed, .

to track and store information about the entities that make up your infrastructure.

serve as both an entity representing your organization in Cortex and as owners for entities in the catalogs. Ownership is a core use case of Cortex, as organizations seek to establish clear ownership of services, data, and other entities. Ownership also drives which users will receive notifications from Cortex, including alerts for on-call changes, when an entity is re-evaluated and its Scorecard changes, and more.

Teams can be assessed via , interact with integrations, and leverage custom data. They can also be configured in a hierarchy. In addition, team data can be tracked and analyzed in . You can manually create teams in Cortex or you can pull in teams from integrations.

(formerly Azure Active Directory)

Create to segment your entities.

Enhance your entities with to provide additional context and improve searchability.

Add to entities to keep everyone informed.

You can use to establish best practices, track migration, promote accountability among teams, enforce standardization across entities, or define maturity standards.

Use to prioritize specific rules in a Scorecard and set deadlines for team members to accomplish tasks.

: You can manage your entities directly in the browser-based Cortex workspace, or you can follow a GitOps approach. We recommend starting in your Cortex workspace, then if desired, switching to GitOps before a broader rollout at your organization.

: Automate running sequential actions and development workflows based on contextual data that exist inside your workspace.

: If you have a unique use case for tools or work with third parties that Cortex does not have an integration with or needs to pull in data from internal systems, we offer the option to build a plugin.

: View key metrics and high-level data to gain insights into services, bottlenecks in the pull request lifecycle, incident response, and more.

: Learn about additional settings and features to further customize your experience: API keys, audit logs, notifications, and more.

Ready to learn more? Check out the to explore courses across core product areas and build expertise on the Cortex platform!

Onboarding management
Roles and permissions
IP allowlist
Azure DevOps
Bitbucket
GitHub
GitLab
Eng Intelligence
PagerDuty
Opsgenie
Splunk On-Call
xMatters
Slack
Microsoft Teams
Azure DevOps
BambooHR
Entra ID
GitHub
GitLab
Google
Okta
Opsgenie
ServiceNow
Workday
AWS
Azure Resources
Google
Kubernetes
BugSnag
ClickUp
Jira
Rollbar
Sentry
Checkmarx
Codecov
Mend
Snyk
SonarQube
Veracode
Wiz
Entities documentation
create custom entity types
Teams
Scorecards
Eng Intelligence
Azure DevOps
BambooHR
Entra ID
GitHub
GitLab
Google
Okta
Opsgenie
ServiceNow
Workday
groups
custom data
external documentation
Scorecards
Initiatives
GitOps
Workflows
Plugins
Eng Intelligence
Workspace settings
Cortex Academy
sign up for a demo
entities
configuring an alternate SSO provider
Create catalogs
Cortex 101 video in Cortex Academy