# Port Documentation > Port is an internal developer portal (IDP) platform that gives engineering teams a software catalog, self-service actions, automations, scorecards, and 100+ integrations connected to their existing tools. API base URLs: EU https://api.port.io, US https://api.us.port.io. - [Port Documentation](/index.md) ## getting-started ### connect-tools The first step of the onboarding process is to connect your tools to Port. - [Connect your tools](/getting-started/connect-tools.md): The first step of the onboarding process is to connect your tools to Port. ### default-components Every Port account comes with a set of default blueprints, used to represent common concepts in your organization. - [Default blueprints](/getting-started/default-components.md): Every Port account comes with a set of default blueprints, used to represent common concepts in your organization. ### end-user-onboarding This page is intended for end-users of Port - stakeholders within the organization who will be using Port in their daily work (e.g. developers, SREs, r&d managers, etc.). - [End-user onboarding](/getting-started/end-user-onboarding.md): This page is intended for end-users of Port - stakeholders within the organization who will be using Port in their daily work (e.g. developers, SREs, r&d managers, etc.). ### onboarding-workshop Following the in-app onboarding process, Port offers a modular, self-paced workshop hosted on GitHub to help you and others in your organization get the most value from Port. - [Onboarding workshop](/getting-started/onboarding-workshop.md): Following the in-app onboarding process, Port offers a modular, self-paced workshop hosted on GitHub to help you and others in your organization get the most value from Port. ### overview Start here to connect your first tool, build your service catalog, and set up automatic data discovery in Port. Takes about 30 minutes. - [Getting started](/getting-started/overview.md): Start here to connect your first tool, build your service catalog, and set up automatic data discovery in Port. Takes about 30 minutes. ### set-up-automatic-discovery As part of the onboarding process, Port allows you to create new services, workloads, environments, users, and teams via the UI. - [Set up automatic data mapping](/getting-started/set-up-automatic-discovery.md): As part of the onboarding process, Port allows you to create new services, workloads, environments, users, and teams via the UI. ### set-up-service-catalog Now that your tools are connected to your portal, you can start creating your service catalog and add some users and teams to your organization. - [Set up your service catalog](/getting-started/set-up-service-catalog.md): Now that your tools are connected to your portal, you can start creating your service catalog and add some users and teams to your organization. ## build-your-software-catalog ### catalog-auto-discovery The auto discovery capability uses Port AI to discover entities and their relations. - [Catalog auto discovery](/build-your-software-catalog/catalog-auto-discovery.md): The auto discovery capability uses Port AI to discover entities and their relations. ### custom-integration Port allows you to create custom integrations to ingest data from any tool or platform. You can model the data in Port any way you like, and ingest data using one of the supported methods described in this page. - [Create a custom integration](/build-your-software-catalog/custom-integration.md): Port allows you to create custom integrations to ingest data from any tool or platform. You can model the data in Port any way you like, and ingest data using one of the supported methods described in this page. #### api Port's API is a generic interface to model your software catalog, ingest data, invoke actions, query scorecards and more. - [API](/build-your-software-catalog/custom-integration/api.md): Port's API is a generic interface to model your software catalog, ingest data, invoke actions, query scorecards and more. ##### advanced The following advanced query parameters are available: - [Advanced](/build-your-software-catalog/custom-integration/api/advanced.md): The following advanced query parameters are available: ##### ci-cd By using Port's CI/CD integrations you can always keep your software catalog up to date by making updates directly from your CI/CD. - [CI/CD](/build-your-software-catalog/custom-integration/api/ci-cd.md): By using Port's CI/CD integrations you can always keep your software catalog up to date by making updates directly from your CI/CD. - [Azure Pipelines](/build-your-software-catalog/custom-integration/api/ci-cd/azure-pipelines.md): Using Azure Pipelines, you can easily create/update and query entities in Port. - [Examples](/build-your-software-catalog/custom-integration/api/ci-cd/azure-pipelines/examples.md): Basic create/update example - [CircleCI workflows](/build-your-software-catalog/custom-integration/api/ci-cd/circleci-workflow.md): Using CircleCI workflows, you can easily create/update and query entities in Port. - [Examples](/build-your-software-catalog/custom-integration/api/ci-cd/circleci-workflow/examples.md): Basic create/update example - [Codefresh Workflow Template](/build-your-software-catalog/custom-integration/api/ci-cd/codefresh-workflow-template.md): Our Codefresh workflow template allows you to create/update and query entities in Port directly from your Codefresh workflow templates. - [Examples](/build-your-software-catalog/custom-integration/api/ci-cd/codefresh-workflow-template/examples.md): Basic create/update example - [GitHub Workflow](/build-your-software-catalog/custom-integration/api/ci-cd/github-workflow.md): Port's GitHub action allows you to create/update and query entities in Port directly from your GitHub workflows. - [Examples](/build-your-software-catalog/custom-integration/api/ci-cd/github-workflow/examples.md): Import Gradle dependencies - [Gitlab CI Pipelines](/build-your-software-catalog/custom-integration/api/ci-cd/gitlab-pipelines.md): Using Gitlab CI Pipelines, you can easily create/update and query entities in Port. - [Examples](/build-your-software-catalog/custom-integration/api/ci-cd/gitlab-pipelines/examples.md): Basic create/update example - [Jenkins Deployment](/build-your-software-catalog/custom-integration/api/ci-cd/jenkins-deployment.md): Port provides an Ocean integration for Jenkins, which allows you to automatically sync your Jenkins resources with Port and provides more configuration options. This is the recommended way to integrate Port with Jenkins. - [Examples](/build-your-software-catalog/custom-integration/api/ci-cd/jenkins-deployment/examples.md): Basic create/update example #### gitops Port allows you to use Gitops to manage Port entities, making your code repositories the source of truth for the various infrastructure assets you want to manage. - [Integrate assets using GitOps](/build-your-software-catalog/custom-integration/gitops.md): Port allows you to use Gitops to manage Port entities, making your code repositories the source of truth for the various infrastructure assets you want to manage. #### iac Port offers several Infrastructure-as-Code (IaC) methods to ingest data and define your software catalog data model alongside your IaC configurations. - [IaC](/build-your-software-catalog/custom-integration/iac.md): Port offers several Infrastructure-as-Code (IaC) methods to ingest data and define your software catalog data model alongside your IaC configurations. ##### pulumi Our integration with Pulumi allows you to combine the state of your infrastructure with the entities representing them in Port. - [Pulumi](/build-your-software-catalog/custom-integration/iac/pulumi.md): Our integration with Pulumi allows you to combine the state of your infrastructure with the entities representing them in Port. ##### terraform Our integration with Terraform allows you to combine the state of your infrastructure with the entities representing them in Port. - [Terraform](/build-your-software-catalog/custom-integration/iac/terraform.md): Our integration with Terraform allows you to combine the state of your infrastructure with the entities representing them in Port. #### ocean-custom-integration ##### configuration Prerequisites, resource mapping, and advanced configuration for the Ocean custom integration - [Configuration](/build-your-software-catalog/custom-integration/ocean-custom-integration/configuration.md): Prerequisites, resource mapping, and advanced configuration for the Ocean custom integration ##### installation-types - [Hosted by Port](/build-your-software-catalog/custom-integration/ocean-custom-integration/installation-types/hosted-by-port.md): Install the Ocean custom integration hosted by Port - [Build your integration](/build-your-software-catalog/custom-integration/ocean-custom-integration/installation-types/self-hosted/build-your-integration.md): Interactive guide to configure and install your integration - [Custom authentication](/build-your-software-catalog/custom-integration/ocean-custom-integration/installation-types/self-hosted/custom-authentication.md): Configure OAuth2, JWT, and other dynamic token-based authentication flows - [Setup](/build-your-software-catalog/custom-integration/ocean-custom-integration/installation-types/self-hosted/setup.md): Install the Ocean custom integration in your own infrastructure ##### overview Understanding the Ocean custom integration - [Overview](/build-your-software-catalog/custom-integration/ocean-custom-integration/overview.md): Understanding the Ocean custom integration #### S3-integrations Port allows you to ingest any data source by using Airbyte, storing the data temporarily in S3 bucket, and then triggering ingestion via a Webhook. - [S3 Bucket](/build-your-software-catalog/custom-integration/S3-integrations.md): Port allows you to ingest any data source by using Airbyte, storing the data temporarily in S3 bucket, and then triggering ingestion via a Webhook. #### webhook By using Port's generic webhook integration you can ingest data into the software catalog from any source or service that provides outgoing webhooks, even if Port doesn't provide a native integration for that source. - [Webhook](/build-your-software-catalog/custom-integration/webhook.md): By using Port's generic webhook integration you can ingest data into the software catalog from any source or service that provides outgoing webhooks, even if Port doesn't provide a native integration for that source. ##### examples Check out the following examples for using Port's webhook integration to ingest resources into your software catalog: - [Examples](/build-your-software-catalog/custom-integration/webhook/examples.md): Check out the following examples for using Port's webhook integration to ingest resources into your software catalog: - [Codecov](/build-your-software-catalog/custom-integration/webhook/examples/codecov.md): Ingest CodeCov coverage into your catalog - [Falco Sidekick](/build-your-software-catalog/custom-integration/webhook/examples/falco.md): Ingest Falco alerts into your catalog - [Grafana](/build-your-software-catalog/custom-integration/webhook/examples/grafana.md): Ingest Grafana alerts into your catalog - [JFrog](/build-your-software-catalog/custom-integration/webhook/examples/jfrog.md): Ingest JFrog artifacts, Docker tags and builds into your catalog - [Packages](/build-your-software-catalog/custom-integration/webhook/examples/packages.md): Here are some examples of how to use Port's webhook integration to ingest software packages: - [Golang](/build-your-software-catalog/custom-integration/webhook/examples/packages/go.md): Ingest Golang packages into your catalog - [Java](/build-your-software-catalog/custom-integration/webhook/examples/packages/java.md): Ingest Maven Dependencies into your catalog - [Python](/build-your-software-catalog/custom-integration/webhook/examples/packages/python.md): Ingest Python packages into your catalog - [SOAP API](/build-your-software-catalog/custom-integration/webhook/examples/packages/soap.md): Ingest SOAP API definitions into your catalog - [Terraform State](/build-your-software-catalog/custom-integration/webhook/examples/packages/terraform.md): Ingest Terraform resources into your catalog - [Prometheus](/build-your-software-catalog/custom-integration/webhook/examples/prometheus.md): Ingest Prometheus alerts into your catalog - [Split](/build-your-software-catalog/custom-integration/webhook/examples/split.md): Ingest Split IO Impressions into your catalog - [StackHawk](/build-your-software-catalog/custom-integration/webhook/examples/stackhawk.md): Ingest StackHawk application vulnerabilities into Port ### customize-integrations #### common jq use-cases Common JQ patterns for integration mappings, self-service action backends, and filters. - [Common jq use-cases](/build-your-software-catalog/customize-integrations/common jq use-cases.md): Common JQ patterns for integration mappings, self-service action backends, and filters. #### configure-data-model An integration's data model defines the properties and relationships of the data ingested from the integrated tool. It allows you to specify: - [Configure your data model](/build-your-software-catalog/customize-integrations/configure-data-model.md): An integration's data model defines the properties and relationships of the data ingested from the integrated tool. It allows you to specify: ##### Iac - [Pulumi-Managed Blueprint Example](/build-your-software-catalog/customize-integrations/configure-data-model/Iac/pulumi-managed-blueprint.md): Comprehensive blueprint with properties, relations and mirror properties - [Terraform-Managed Blueprint Example](/build-your-software-catalog/customize-integrations/configure-data-model/Iac/terraform-managed-blueprint.md): Comprehensive blueprint with properties, relations and mirror properties ##### migrate-data When evolving your software catalog, you may need to migrate existing entities to reflect changes in your blueprint structure. Port provides a simple approach to migrate all entities of a blueprint efficiently and safely. - [Migrate Blueprint Data](/build-your-software-catalog/customize-integrations/configure-data-model/migrate-data.md): When evolving your software catalog, you may need to migrate existing entities to reflect changes in your blueprint structure. Port provides a simple approach to migrate all entities of a blueprint efficiently and safely. ##### relate-blueprints Relations define connections between blueprints, consequently connecting the entities based on these blueprints. - [Relate Blueprints](/build-your-software-catalog/customize-integrations/configure-data-model/relate-blueprints.md): Relations define connections between blueprints, consequently connecting the entities based on these blueprints. ##### setup-blueprint Blueprints are the most basic building block in Port. They are used to represent assets in your organization, and the relationships between them. - [Set up blueprints](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint.md): Blueprints are the most basic building block in Port. They are used to represent assets in your organization, and the relationships between them. - [Properties](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties.md): Properties are customizable data fields of blueprints, used to save and display information from external data sources. - [Aggregation Property](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/aggregation-property.md): Aggregation properties allow you to calculate metrics based on the relations in your catalog. - [Array](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/array.md): Array is a data type used to save lists of data - [Boolean](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/boolean.md): Boolean is a primitive data type that has one of two possible values - true and false - [➕ Calculation Property](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property.md): Calculation property allows you to construct new data from existing properties of an entity - [Examples](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/examples.md): Here are a few examples of calculation properties use cases: - [Datetime](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/datetime.md): Datetime is a data type used to reference a date and time - [Email](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/email.md): Email is a data type used to save Email addresses - [Embedded URL](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/embedded-url.md): The embedded URL property is used to embed and display a webpage within an entity in Port. - [Authentication](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/embedded-url/authentication.md): With this feature, you can embed another website that's protected by SSO authentication. - [Enum](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/enum.md): Enum is a data type used to define a named set of constant values. - [Labeled URL](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/labeled-url-object.md): Labeled URL is an object type used to store URLs with custom display labels - [Markdown](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/markdown.md): The Markdown property is used to display Markdown content within an entity in Port. - [Meta-Properties](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/meta-properties.md): A meta-property is a property that exists on every entity in Port by default. - [Mirror Property](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/mirror-property.md): Mirror Property allows you to map data from related entities to your entity - [Number](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/number.md): Number is a primitive data type used to save numeric data - [Object](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/object.md): Object is a data type used to save object definitions in JSON - [Proto](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/proto.md): Proto is a data type used to save proto definitions in Port - [String](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/string.md): Configure string properties on Port blueprints, including enum values, formats, and validation rules. String is a primitive data type used to save text data. - [Swagger UI](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/swagger.md): The Swagger UI property is used to import and display OpenAPI and/or AsyncAPI specification files within an entity in Port. - [Team](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/team.md): Team is a data type used to reference teams that exist in Port - [Timer](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/timer.md): Timer is a data type used to define an expiration date/lifespan of a specific entity - [URL](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/url.md): URL is a data type used to save links to websites - [User](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/user.md): User is a data type used to reference users that exist in Port - [Yaml](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/yaml.md): Yaml is a data type used to save object definitions in YAML #### configure-mapping The mapping of an integration's data source defines the ingested data and its destination. It allows you to specify: - [Configure mapping](/build-your-software-catalog/customize-integrations/configure-mapping.md): The mapping of an integration's data source defines the ingested data and its destination. It allows you to specify: ### manage-port-across-environments Managing multiple environments (such as development, staging, and production) is a fundamental practice in modern software delivery. Each environment serves a distinct purpose, and promoting resources across these environments must be done in a controlled, repeatable way. - [Manage Port across environments](/build-your-software-catalog/manage-port-across-environments.md): Managing multiple environments (such as development, staging, and production) is a fundamental practice in modern software delivery. Each environment serves a distinct purpose, and promoting resources across these environments must be done in a controlled, repeatable way. ### overview Build your software catalog in Port by modeling resources with blueprints and entities, then ingesting data from your tools to populate and connect them. - [Overview](/build-your-software-catalog/overview.md): Build your software catalog in Port by modeling resources with blueprints and entities, then ingesting data from your tools to populate and connect them. ### set-catalog-rbac Port provides granular control to ensure that every user only sees the parts of the catalog that are relevant to them. - [Set catalog RBAC](/build-your-software-catalog/set-catalog-rbac.md): Port provides granular control to ensure that every user only sees the parts of the catalog that are relevant to them. #### examples In this section we'll show you a few examples of ways to use catalog permissions in your organization, and how to apply them. - [Examples](/build-your-software-catalog/set-catalog-rbac/examples.md): In this section we'll show you a few examples of ways to use catalog permissions in your organization, and how to apply them. ### sync-data-to-catalog Port is designed to be flexible. It can be integrated with any tool, and can be used to build a software catalog that reflects your exact data model. - [Install an integration](/build-your-software-catalog/sync-data-to-catalog.md): Port is designed to be flexible. It can be integrated with any tool, and can be used to build a software catalog that reflects your exact data model. #### ai-agents ##### claude Ingest Claude Code usage and analytics into Port to track AI coding tool adoption across your engineering organization. - [Claude AI](/build-your-software-catalog/sync-data-to-catalog/ai-agents/claude.md): Ingest Claude Code usage and analytics into Port to track AI coding tool adoption across your engineering organization. ##### cursor Port's Cursor integration allows you to ingest Cursor usage metrics into your software catalog using the Ocean Custom Integration framework. - [Cursor](/build-your-software-catalog/sync-data-to-catalog/ai-agents/cursor.md): Port's Cursor integration allows you to ingest Cursor usage metrics into your software catalog using the Ocean Custom Integration framework. ##### github-copilot Ingest GitHub Copilot usage and metrics into Port to track AI coding tool adoption across your engineering organization. - [GitHub Copilot](/build-your-software-catalog/sync-data-to-catalog/ai-agents/github-copilot.md): Ingest GitHub Copilot usage and metrics into Port to track AI coding tool adoption across your engineering organization. ##### n8n Port's n8n integration ingests n8n resources into your software catalog using the Ocean Custom Integration framework. It focuses on three key data sources: users, projects, and workflows. - [n8n](/build-your-software-catalog/sync-data-to-catalog/ai-agents/n8n.md): Port's n8n integration ingests n8n resources into your software catalog using the Ocean Custom Integration framework. It focuses on three key data sources: users, projects, and workflows. ##### openai Port's OpenAI integration ingests foundational OpenAI usage metrics into your software catalog using the Ocean Custom Integration framework. It focuses on two reliable data sources: daily cost summaries and model-level usage statistics. - [OpenAI](/build-your-software-catalog/sync-data-to-catalog/ai-agents/openai.md): Port's OpenAI integration ingests foundational OpenAI usage metrics into your software catalog using the Ocean Custom Integration framework. It focuses on two reliable data sources: daily cost summaries and model-level usage statistics. ##### zapier Port's Zapier integration lets you ingest Zapier apps and zaps into your software catalog using the Ocean Custom Integration framework. - [Zapier](/build-your-software-catalog/sync-data-to-catalog/ai-agents/zapier.md): Port's Zapier integration lets you ingest Zapier apps and zaps into your software catalog using the Ocean Custom Integration framework. #### apm-alerting Port's APM & alerting integrations make it easy to keep your software catalog up to date based on information stored in your preferred APM & alerting tool. - [APM & alerting](/build-your-software-catalog/sync-data-to-catalog/apm-alerting.md): Port's APM & alerting integrations make it easy to keep your software catalog up to date based on information stored in your preferred APM & alerting tool. ##### azure-monitor Port's Azure Monitor integration allows you to ingest Azure Monitor resources into your software catalog using the Ocean Custom Integration framework. After installing this integration, you can visualize metrics, alerts, activity logs, and diagnostic settings from your Azure resources. - [Azure Monitor](/build-your-software-catalog/sync-data-to-catalog/apm-alerting/azure-monitor.md): Port's Azure Monitor integration allows you to ingest Azure Monitor resources into your software catalog using the Ocean Custom Integration framework. After installing this integration, you can visualize metrics, alerts, activity logs, and diagnostic settings from your Azure resources. ##### datadog Sync Datadog monitors, services, SLOs, and host data into Port's software catalog, and use it across scorecards, dashboards, and automations. - [Datadog](/build-your-software-catalog/sync-data-to-catalog/apm-alerting/datadog.md): Sync Datadog monitors, services, SLOs, and host data into Port's software catalog, and use it across scorecards, dashboards, and automations. - [Examples](/build-your-software-catalog/sync-data-to-catalog/apm-alerting/datadog/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in ##### dynatrace Sync Dynatrace monitoring data, problems, and services into Port's software catalog. - [Dynatrace](/build-your-software-catalog/sync-data-to-catalog/apm-alerting/dynatrace.md): Sync Dynatrace monitoring data, problems, and services into Port's software catalog. ##### newrelic Sync New Relic monitoring data, alerts, and services into Port's software catalog. - [New Relic](/build-your-software-catalog/sync-data-to-catalog/apm-alerting/newrelic.md): Sync New Relic monitoring data, alerts, and services into Port's software catalog. ##### prometheus Port's Prometheus integration allows you to ingest Prometheus monitoring and alerting data into your software catalog using the Ocean Custom Integration framework. After installing this integration, you can visualize your Prometheus alerts, alerting rules, and scrape targets using Port's dashboards. - [Prometheus](/build-your-software-catalog/sync-data-to-catalog/apm-alerting/prometheus.md): Port's Prometheus integration allows you to ingest Prometheus monitoring and alerting data into your software catalog using the Ocean Custom Integration framework. After installing this integration, you can visualize your Prometheus alerts, alerting rules, and scrape targets using Port's dashboards. ##### sentry Sync Sentry projects, issues, and error tracking data into Port's software catalog. - [Sentry](/build-your-software-catalog/sync-data-to-catalog/apm-alerting/sentry.md): Sync Sentry projects, issues, and error tracking data into Port's software catalog. #### argocd Sync Argo CD applications, deployments, and clusters into Port's software catalog. - [Argo CD](/build-your-software-catalog/sync-data-to-catalog/argocd.md): Sync Argo CD applications, deployments, and clusters into Port's software catalog. ##### example To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. - [Examples](/build-your-software-catalog/sync-data-to-catalog/argocd/example.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. #### cicd ##### jenkins Sync Jenkins jobs, builds, and pipelines into Port's software catalog. - [Jenkins](/build-your-software-catalog/sync-data-to-catalog/cicd/jenkins.md): Sync Jenkins jobs, builds, and pipelines into Port's software catalog. ##### octopus-deploy Sync Octopus Deploy projects, releases, and deployments into Port's software catalog. - [Octopus Deploy Integration](/build-your-software-catalog/sync-data-to-catalog/cicd/octopus-deploy.md): Sync Octopus Deploy projects, releases, and deployments into Port's software catalog. - [Ingest additional resources](/build-your-software-catalog/sync-data-to-catalog/cicd/octopus-deploy/mapping-extra-resources.md): In addition to the supported resources listed in the integration page, other resources can be ingested, as described on this page. #### cloud-cost Port's cloud cost integrations make it easy to keep your software catalog up to date based on information stored in your preferred cloud cost tool. - [Cloud cost](/build-your-software-catalog/sync-data-to-catalog/cloud-cost.md): Port's cloud cost integrations make it easy to keep your software catalog up to date based on information stored in your preferred cloud cost tool. ##### kubecost Sync Kubecost cost allocation and Kubernetes spend data into Port's software catalog. - [Kubecost](/build-your-software-catalog/sync-data-to-catalog/cloud-cost/kubecost.md): Sync Kubecost cost allocation and Kubernetes spend data into Port's software catalog. - [Advanced configuration for Kubecost objects](/build-your-software-catalog/sync-data-to-catalog/cloud-cost/kubecost/advanced.md): This guide provides information for configuring how Kubecost objects are ingested into your Kubecost installation. The Kubecost integration uses a YAML configuration to describe the process of loading data into the developer portal. ##### opencost Sync OpenCost Kubernetes cost and resource spend data into Port's software catalog. - [OpenCost](/build-your-software-catalog/sync-data-to-catalog/cloud-cost/opencost.md): Sync OpenCost Kubernetes cost and resource spend data into Port's software catalog. #### cloud-providers Port's cloud integrations make it easy to keep your software catalog up to date based on information stored in your cloud provider. - [Cloud providers](/build-your-software-catalog/sync-data-to-catalog/cloud-providers.md): Port's cloud integrations make it easy to keep your software catalog up to date based on information stored in your cloud provider. ##### aws-v3 - [Hosted by Port](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installation/hosted-by-port.md): AWS Hosted by Port is available through Port's Ocean SaaS framework. - [IAM role architecture](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installation/hosted-by-port/iam-role-architecture.md): AWS Hosted by Port uses a strategically designed IAM role that provides comprehensive read-only access to all AWS services. The role is created automatically by the CloudFormation template and uses the AWS managed ReadOnlyAccess policy for future-proofing and operational simplicity. - [Self-hosted installation](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installation/self-hosted.md): The self-hosted AWS integration runs in your environment and syncs your AWS resources into your Port catalog. You deploy it yourself and create the IAM roles that grant it read-only access. - [IAM role architecture](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installation/self-hosted/iam-role-architecture.md): This page describes the IAM setup for self-hosted AWS integration deployments. With self-hosted deployments you manage IAM resources directly; the hosted version manages them for you. - [Multiple accounts installation](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installation/self-hosted/multiple-accounts.md): This page shows you how to deploy the AWS integration to sync resources from multiple AWS accounts into your Port catalog. The integration runs in one account (your integration account) and assumes IAM roles in each member account to discover and sync their resources. - [Single account installation](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installation/self-hosted/single-account.md): This page shows you how to deploy the AWS integration to sync resources from a single AWS account into your Port catalog. The integration runs as a container that authenticates with AWS, discovers resources, and syncs them on a schedule you configure. - [Overview](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/Overview.md): Port's AWS integration allows you to import your AWS resources into Port, with flexible deployment options to match your needs. - [AWS resource and property reference](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference.md): Welcome to the reference guide for AWS resource, actions and properties, as supported by AWS CloudFormation and used in Port integrations. - [Amazon Elastic Compute Cloud (EC2)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud.md): AWS::Instance - [Amazon Elastic Container Registry (ECR)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry.md): AWS::Repository - [Amazon Elastic Container Service (ECS)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service.md): AWS::Cluster - [Amazon Elastic Kubernetes Service (EKS)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service.md): AWS::Cluster - [Amazon ElastiCache](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elasticache.md): AWS::Cluster - [Amazon Managed Streaming for Apache Kafka (MSK)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-managed-streaming-for-apache-kafka.md): AWS::Cluster - [Amazon Relational Database Service (RDS)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service.md): AWS::DBInstance - [Amazon Simple Queue Service (SQS)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service.md): AWS::Queue - [Amazon Simple Storage Service (S3)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service.md): AWS::Bucket - [AWS Account](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account.md): AWS::Info - [AWS Lambda](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda.md): AWS::Function - [AWS Organizations](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations.md): AWS::Account ##### aws Sync AWS resources into Port's software catalog using the self-hosted AWS integration. - [AWS on-premise](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws.md): Sync AWS resources into Port's software catalog using the self-hosted AWS integration. - [AWS exporter](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/aws-exporter.md): This exporter is deprecated, Port will discontinue support for organizations using it by Q2 2025. - [Event-based updates](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/aws-exporter/event-based-updates.md): Our AWS integration allows you to trigger a sync of your AWS resources with Port based on real-time events (in addition to the standard scheduled sync). - [Examples](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/aws-exporter/examples.md): Use the index on the right side of the page to find an example for the resource/s you’re looking to export. - [Connect ECR repository to a service](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/aws-exporter/examples/connect-ecr-repo-to-service-using-tags.md): This guide aims to show how to connect an ECR repository to an existing service in Port. - [Installation](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/aws-exporter/installation.md): For your first deployment of the AWS exporter, we recommend starting with the Helm/scheduled installation method to perform the initial data sync. Once the initial data sync is complete, you can switch to the Terraform deployment method for real-time data sync. - [Examples](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/examples.md): This page contains the base examples for mapping AWS resources to Port. - [Mapping Extra Resources](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/examples/mapping_extra_resources.md): As you've probably looked at the Examples page, you've noticed that the AWS Integration supports some AWS resources, but most of them are not documented in the Examples page. - [Live events setup](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/live-events.md): Port's AWS integration supports real-time event processing, allowing for accurate representation of your AWS infrastructure inside Port. This guide explains how to set up live events for your AWS resources. - [Multi account support](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws/multi_account.md): This guide will provide you with the necessary tools for enabling our Ocean AWS on-premise Integration to digest multiple account's data. ##### azure Sync Azure cloud resources into Port's software catalog. - [Azure](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure.md): Sync Azure cloud resources into Port's software catalog. - [Azure Resource Graph (Beta)](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/azure-resource-graph.md): This integration is in closed beta and is not available for general use. Please contact Port's support team to request access. - [Resource Templates](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/resource_templates.md): This page contains the base examples for mapping Azure resources to Port. - [Advanced Templates](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/resource_templates/advanced.md): Mapping storage resources - [Mapping Extra Resources](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/resource_templates/mapping_extra_resources.md): As you've probably looked at the Resource Templates page, you've noticed that the Azure Exporter supports many Azure resources, but not all of them are documented in the Resource Templates page. ##### gcp Sync Google Cloud (GCP) resources into Port's software catalog. - [GCP](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/gcp.md): Sync Google Cloud (GCP) resources into Port's software catalog. - [Examples](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/gcp/examples.md): This page contains the base examples for mapping GCP resources to Port. - [Map Extra Resources](/build-your-software-catalog/sync-data-to-catalog/cloud-providers/gcp/examples/mapping_extra_resources.md): As you've probably looked at the Examples page, you've noticed that the GCP Integration supports some GCP resources, but most of them are documented in the Examples page. #### code-quality-security Port's code quality & security integrations make it easy to keep your software catalog up to date based on information stored in your preferred code quality & security tool. - [Code quality & security](/build-your-software-catalog/sync-data-to-catalog/code-quality-security.md): Port's code quality & security integrations make it easy to keep your software catalog up to date based on information stored in your preferred code quality & security tool. ##### aikido Sync Aikido security findings and vulnerabilities into Port's software catalog. - [Aikido](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/aikido.md): Sync Aikido security findings and vulnerabilities into Port's software catalog. ##### armorcode Sync ArmorCode security findings and ASPM data into Port's software catalog. - [ArmorCode](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/armorcode.md): Sync ArmorCode security findings and ASPM data into Port's software catalog. ##### checkmarx Sync Checkmarx One scan results and security findings into Port's software catalog. - [Checkmarx One](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/checkmarx.md): Sync Checkmarx One scan results and security findings into Port's software catalog. - [Resource mapping examples](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/checkmarx/examples.md): Map Checkmarx projects ##### snyk Sync Snyk vulnerabilities, projects, and security findings into Port's software catalog. - [Snyk](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/snyk.md): Sync Snyk vulnerabilities, projects, and security findings into Port's software catalog. ##### sonarqube Sync SonarQube code quality metrics, issues, and projects into Port's software catalog. - [SonarQube](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/sonarqube.md): Sync SonarQube code quality metrics, issues, and projects into Port's software catalog. - [Examples](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/sonarqube/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. ##### wiz Sync Wiz cloud security issues and findings into Port's software catalog. - [Wiz](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/wiz.md): Sync Wiz cloud security issues and findings into Port's software catalog. - [Examples](/build-your-software-catalog/sync-data-to-catalog/code-quality-security/wiz/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. #### event-processing ##### kafka Sync Kafka clusters, topics, and brokers into Port's software catalog. - [Kafka](/build-your-software-catalog/sync-data-to-catalog/event-processing/kafka.md): Sync Kafka clusters, topics, and brokers into Port's software catalog. #### feature-management ##### launchdarkly LaunchDarkly integration in Port - [LaunchDarkly](/build-your-software-catalog/sync-data-to-catalog/feature-management/launchdarkly.md): LaunchDarkly integration in Port #### git Port's Git integrations make it easy to keep your software catalog up to date based on information stored in your Git provider. In addition, our integrations make it possible to manage the software catalog using GitOps. - [Git](/build-your-software-catalog/sync-data-to-catalog/git.md): Port's Git integrations make it easy to keep your software catalog up to date based on information stored in your Git provider. In addition, our integrations make it possible to manage the software catalog using GitOps. ##### azure-devops Sync Azure DevOps repositories, pull requests, and pipelines into Port's software catalog. - [Azure DevOps](/build-your-software-catalog/sync-data-to-catalog/git/azure-devops.md): Sync Azure DevOps repositories, pull requests, and pipelines into Port's software catalog. - [Advanced](/build-your-software-catalog/sync-data-to-catalog/git/azure-devops/advanced.md): The Azure Devops integration supports additional flags to provide additional configuration, making it easier to configure its behavior to your liking. - [Capabilities](/build-your-software-catalog/sync-data-to-catalog/git/azure-devops/capabilities.md): Enrich entities with file contents - [Examples](/build-your-software-catalog/sync-data-to-catalog/git/azure-devops/examples.md): This page contains mapping examples, showing how to ingest various Azure Devops resources into Port. - [GitOps](/build-your-software-catalog/sync-data-to-catalog/git/azure-devops/gitops.md): Port's Azure DevOps integration makes it possible to manage Port entities with a GitOps approach, making your code projects into the source of truth for the various infrastructure assets you want to manage. - [Mapping Extensions](/build-your-software-catalog/sync-data-to-catalog/git/azure-devops/mapping_extensions.md): Introduction ##### bitbucket - [Bitbucket app (deprecated)](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-app.md): Port's Bitbucket App integration allows you to model Bitbucket resources in your software catalog and ingest data into them. - [Advanced](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-app/advanced.md): The Bitbucket integration supports additional flags to provide additional configuration, making it easier to configure its behavior to your liking. - [Examples](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-app/examples.md): Mapping repositories, file contents and pull requests - [GitOps](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-app/gitops.md): Port's Bitbucket integration makes it possible to manage Port entities with a GitOps approach, making your code repositories into the source of truth for the various infrastructure assets you want to manage. - [Bitbucket Cloud](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-cloud.md): Sync Bitbucket Cloud repositories, pull requests, and projects into Port's software catalog. - [Advanced](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-cloud/advanced.md): The Bitbucket integration supports additional flags to provide additional configuration, making it easier to configure its behavior to your liking. - [Capabilities](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-cloud/capabilities.md): Ingest Git objects - [Examples](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-cloud/examples.md): Repositories, file contents and pull requests - [GitOps](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-cloud/gitops.md): Port's Bitbucket integration makes it possible to manage Port entities with a GitOps approach, making your code repositories into the source of truth for the various infrastructure assets you want to manage. - [Bitbucket (self-hosted)](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-server.md): Sync Bitbucket (self-hosted) repositories, pull requests, and projects into Port's software catalog. - [GitOps](/build-your-software-catalog/sync-data-to-catalog/git/bitbucket/bitbucket-server/gitops.md): Port's Bitbucket (Self-Hosted) makes it possible to manage Port entities with a GitOps approach, making your code repositories into the source of truth for the various infrastructure assets you want to manage. ##### custom-gitops-integration If Port's available GitOps providers do not fit your use-case, you can create a custom GitOps integration by using our API. - [Custom GitOps Integration](/build-your-software-catalog/sync-data-to-catalog/git/custom-gitops-integration.md): If Port's available GitOps providers do not fit your use-case, you can create a custom GitOps integration by using our API. ##### github-ocean Sync GitHub repositories, pull requests, workflows, and deployments into Port's software catalog using the GitHub Ocean integration. - [GitHub (Ocean)](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean.md): Sync GitHub repositories, pull requests, workflows, and deployments into Port's software catalog using the GitHub Ocean integration. - [Capabilities](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/capabilities.md): This page describes the data ingestion capabilities of Port's GitHub integration. - [Examples](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples.md): This page provides practical examples for mapping various GitHub resources to Port. - [GitOps](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/gitops.md): Port's GitHub integration allows you to manage Port entities with a GitOps approach, making your code repositories the source of truth for your infrastructure assets. - [Key changes](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/migration/key-changes.md): This page covers the improvements and mapping changes introduced in the GitHub Ocean integration compared to the legacy GitHub app. Use it as a reference when updating your integration configuration. - [Migration steps](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/migration/migration-steps.md): This guide walks you through migrating from Port's legacy GitHub cloud app to the improved GitHub integration powered by Ocean. ##### gitlab-v2 Sync GitLab projects, merge requests, and pipelines into Port's software catalog using the v2 integration. - [GitLab v2](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2.md): Sync GitLab projects, merge requests, and pipelines into Port's software catalog using the v2 integration. - [Advanced](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/advanced.md): The GitLab integration supports additional flags to provide extra configuration options, making it easier to customize its behavior to suit your needs. - [Capabilities](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/capabilities.md): This page describes the data ingestion capabilities of Port's GitLab integration. - [Examples](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/examples.md): This page contains mapping configuration examples for the GitLab integration. - [GitOps](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/gitops.md): Port's GitLab integration makes it possible to manage Port entities with a GitOps approach, making your code projects into the source of truth for the various infrastructure assets you want to manage. - [Mapping extensions](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/mapping_extensions.md): Overview - [Migration guide to the v2 integration](/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/migration.md): This guide walks through the process of migrating from Port's GitLab integration to the new GitLab-v2 integration. ##### gitlab Sync GitLab projects, merge requests, and pipelines into Port's software catalog. - [GitLab](/build-your-software-catalog/sync-data-to-catalog/git/gitlab.md): Sync GitLab projects, merge requests, and pipelines into Port's software catalog. - [Advanced](/build-your-software-catalog/sync-data-to-catalog/git/gitlab/advanced.md): The GitLab integration supports additional flags to provide additional configuration, making it easier to configure its behavior to your liking. - [Capabilities](/build-your-software-catalog/sync-data-to-catalog/git/gitlab/capabilities.md): This page describes the data ingestion capabilities of Port's GitLab integration. - [Examples](/build-your-software-catalog/sync-data-to-catalog/git/gitlab/examples.md): This page provides practical examples for mapping various GitLab resources to Port. - [GitOps](/build-your-software-catalog/sync-data-to-catalog/git/gitlab/gitops.md): Port's GitLab integration makes it possible to manage Port entities with a GitOps approach, making your code projects into the source of truth for the various infrastructure assets you want to manage. - [Mapping Extensions](/build-your-software-catalog/sync-data-to-catalog/git/gitlab/mapping_extensions.md): Introduction ##### gitops-using-port-crd You can use GitOps, Port's K8s exporter and Port's Entity CRDs to export custom entities in to Port. - [GitOps using Port CRDs](/build-your-software-catalog/sync-data-to-catalog/git/gitops-using-port-crd.md): You can use GitOps, Port's K8s exporter and Port's Entity CRDs to export custom entities in to Port. ##### working-with-monorepos After connecting your Git provider to Port, Port will automatically create an entity for each repository in the organization in which you installed the integration. - [Working with monorepos](/build-your-software-catalog/sync-data-to-catalog/git/working-with-monorepos.md): After connecting your Git provider to Port, Port will automatically create an entity for each repository in the organization in which you installed the integration. #### identity-providers ##### azure-ad Port's Microsoft Entra ID (formerly Azure AD) integration allows you to model Entra ID resources in your software catalog and ingest data into them using the Ocean Custom Integration framework. - [Microsoft Entra ID](/build-your-software-catalog/sync-data-to-catalog/identity-providers/azure-ad.md): Port's Microsoft Entra ID (formerly Azure AD) integration allows you to model Entra ID resources in your software catalog and ingest data into them using the Ocean Custom Integration framework. ##### okta Sync Okta users, groups, and applications into Port's software catalog. - [Okta](/build-your-software-catalog/sync-data-to-catalog/identity-providers/okta.md): Sync Okta users, groups, and applications into Port's software catalog. #### incident-management Port's incident management integrations make it easy to keep your software catalog up to date based on information stored in your preferred incident management tool. - [Incident management](/build-your-software-catalog/sync-data-to-catalog/incident-management.md): Port's incident management integrations make it easy to keep your software catalog up to date based on information stored in your preferred incident management tool. ##### firehydrant Sync FireHydrant incidents, services, and on-call data into Port's software catalog. - [FireHydrant](/build-your-software-catalog/sync-data-to-catalog/incident-management/firehydrant.md): Sync FireHydrant incidents, services, and on-call data into Port's software catalog. ##### incident-io Port's Incident.io integration allows you to model Incident.io resources in your software catalog and ingest data into them using the Ocean Custom Integration framework. - [Incident.io](/build-your-software-catalog/sync-data-to-catalog/incident-management/incident-io.md): Port's Incident.io integration allows you to model Incident.io resources in your software catalog and ingest data into them using the Ocean Custom Integration framework. ##### jira-service-management Port's Jira Service Management integration allows you to model JSM service desk resources in your software catalog and ingest data using the Ocean Custom Integration framework. This guide focuses on three Service Desk REST API endpoints: listing service desks, customer requests, and organizations. - [Jira Service Management (JSM)](/build-your-software-catalog/sync-data-to-catalog/incident-management/jira-service-management.md): Port's Jira Service Management integration allows you to model JSM service desk resources in your software catalog and ingest data using the Ocean Custom Integration framework. This guide focuses on three Service Desk REST API endpoints: listing service desks, customer requests, and organizations. ##### opsgenie Sync Opsgenie alerts, incidents, services, and on-call schedules into Port's software catalog. - [Opsgenie](/build-your-software-catalog/sync-data-to-catalog/incident-management/opsgenie.md): Sync Opsgenie alerts, incidents, services, and on-call schedules into Port's software catalog. - [Examples](/build-your-software-catalog/sync-data-to-catalog/incident-management/opsgenie/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. ##### pagerduty Sync PagerDuty services, incidents, and on-call schedules into Port's software catalog. - [PagerDuty](/build-your-software-catalog/sync-data-to-catalog/incident-management/pagerduty.md): Sync PagerDuty services, incidents, and on-call schedules into Port's software catalog. - [Examples](/build-your-software-catalog/sync-data-to-catalog/incident-management/pagerduty/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. ##### rootly Port's Rootly integration allows you to ingest Rootly incident management resources into your software catalog using the Ocean Custom Integration framework. - [Rootly](/build-your-software-catalog/sync-data-to-catalog/incident-management/rootly.md): Port's Rootly integration allows you to ingest Rootly incident management resources into your software catalog using the Ocean Custom Integration framework. ##### servicenow Sync ServiceNow incidents, services, and CMDB data into Port's software catalog. - [ServiceNow](/build-your-software-catalog/sync-data-to-catalog/incident-management/servicenow.md): Sync ServiceNow incidents, services, and CMDB data into Port's software catalog. ##### statuspage Sync Statuspage pages, components, and incidents into Port's software catalog. - [Statuspage](/build-your-software-catalog/sync-data-to-catalog/incident-management/statuspage.md): Sync Statuspage pages, components, and incidents into Port's software catalog. - [Examples](/build-your-software-catalog/sync-data-to-catalog/incident-management/statuspage/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. #### kubernetes-stack ##### komodor Sync Komodor Kubernetes services, deployments, and health data into Port's software catalog. - [Komodor](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/komodor.md): Sync Komodor Kubernetes services, deployments, and health data into Port's software catalog. ##### kubernetes Sync Kubernetes workloads, namespaces, and resources into Port's software catalog. - [Kubernetes](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes.md): Sync Kubernetes workloads, namespaces, and resources into Port's software catalog. - [Advanced](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/advanced.md): The K8s exporter supports additional flags and the option to provide additional configuration sources, making it easier to configure its behavior to your liking. - [Basic example](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/basic-example.md): Basic Example - [Custom CRDs](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/custom-crds.md): In addition to built-in Kubernetes API resources, it is possible to use Port's Kubernetes exporter to export and map CRDs from your Kubernetes cluster. - [Port Entity CRD](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/port-crd.md): Port's K8s exporter allows exporting data from any resource in your Kubernetes clusters, including Custom Resource Definitions(CRDs). - [Templates](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/templates.md): To allow for a quick start when implementing Port's k8s exporter, custom pre-built templates were created. These configurations will map common use-cases for when working with kubernetes. - [FluxCD](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/templates/fluxcd.md): FluxCD quickstart - [Kubernetes (advanced)](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/templates/full-kubernetes-exporter.md): Advanced Kubernetes installation - [Istio](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/templates/istio.md): Istio quickstart - [Knative](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/templates/knative.md): Knative quickstart - [Kyverno](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/templates/kyverno.md): Kyverno quickstart - [Red Hat Openshift](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/templates/openshift.md): Openshift quickstart - [Trivy Operator](/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/templates/trivy.md): Trivy quickstart #### other ##### amplication Sync Amplication services and generated resources into Port's software catalog. - [Amplication](/build-your-software-catalog/sync-data-to-catalog/other/amplication.md): Sync Amplication services and generated resources into Port's software catalog. ##### backstage Import Backstage catalog entities into Port's software catalog. - [Backstage](/build-your-software-catalog/sync-data-to-catalog/other/backstage.md): Import Backstage catalog entities into Port's software catalog. ##### slack Port's Slack integration allows you to model Slack resources in your software catalog and ingest data into them using the Ocean Custom Integration framework. - [Slack](/build-your-software-catalog/sync-data-to-catalog/other/slack.md): Port's Slack integration allows you to model Slack resources in your software catalog and ingest data into them using the Ocean Custom Integration framework. #### project-management Port's project management integrations make it easy to keep your software catalog up to date based on information stored in your preferred project management tool. - [Project management](/build-your-software-catalog/sync-data-to-catalog/project-management.md): Port's project management integrations make it easy to keep your software catalog up to date based on information stored in your preferred project management tool. ##### jira-server Sync Jira Server (self-hosted) projects and issues into Port's software catalog. - [Jira Server (self-hosted)](/build-your-software-catalog/sync-data-to-catalog/project-management/jira-server.md): Sync Jira Server (self-hosted) projects and issues into Port's software catalog. - [Examples](/build-your-software-catalog/sync-data-to-catalog/project-management/jira-server/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. ##### jira Sync Jira projects, issues, and teams into Port's software catalog. - [Jira](/build-your-software-catalog/sync-data-to-catalog/project-management/jira.md): Sync Jira projects, issues, and teams into Port's software catalog. - [Examples](/build-your-software-catalog/sync-data-to-catalog/project-management/jira/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. ##### linear Sync Linear teams, issues, and projects into Port's software catalog. - [Linear](/build-your-software-catalog/sync-data-to-catalog/project-management/linear.md): Sync Linear teams, issues, and projects into Port's software catalog. #### terraform-cloud Terraform integration in Port - [Terraform Cloud & Terraform Enterprise](/build-your-software-catalog/sync-data-to-catalog/terraform-cloud.md): Terraform integration in Port ##### examples To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. - [Examples](/build-your-software-catalog/sync-data-to-catalog/terraform-cloud/examples.md): To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground. ## actions-and-automations ### create-self-service-experiences Create self-service actions that let developers trigger workflows from Port, such as scaffolding services, provisioning resources, and running day-2 operations, with forms, guardrails, and approvals. - [Self-service actions](/actions-and-automations/create-self-service-experiences.md): Create self-service actions that let developers trigger workflows from Port, such as scaffolding services, provisioning resources, and running day-2 operations, with forms, guardrails, and approvals. #### send-link-to-action Port allows you to generate links that pre-fill action inputs, making it easy to share action execution URLs with your developers. - [Share a pre-filled action URL](/actions-and-automations/create-self-service-experiences/send-link-to-action.md): Port allows you to generate links that pre-fill action inputs, making it easy to share action execution URLs with your developers. #### set-self-service-actions-rbac Port provides granular control to make sure every user can only execute and invoke the actions that are relevant for them. - [Set actions RBAC](/actions-and-automations/create-self-service-experiences/set-self-service-actions-rbac.md): Port provides granular control to make sure every user can only execute and invoke the actions that are relevant for them. ##### dynamic-permissions Dynamic permissions allow you to control who can execute or approve self-service actions based on data in your software catalog. Unlike static permissions, where you explicitly list roles, users, or teams, dynamic permissions let you define logic that evaluates at runtime. - [Dynamic permissions](/actions-and-automations/create-self-service-experiences/set-self-service-actions-rbac/dynamic-permissions.md): Dynamic permissions allow you to control who can execute or approve self-service actions based on data in your software catalog. Unlike static permissions, where you explicitly list roles, users, or teams, dynamic permissions let you define logic that evaluates at runtime. - [Examples](/actions-and-automations/create-self-service-experiences/set-self-service-actions-rbac/dynamic-permissions/examples.md): The following examples demonstrate common patterns for dynamic permissions. #### setup-the-backend A self-service action's backend is the logic that runs when the action is triggered. The implementation of the backend is done by you, using one of the various backend types that Port supports. - [Set up backend](/actions-and-automations/create-self-service-experiences/setup-the-backend.md): A self-service action's backend is the logic that runs when the action is triggered. The implementation of the backend is done by you, using one of the various backend types that Port supports. #### setup-ui-for-action After selecting the blueprint you want to add an action to, we need to define the action's frontend - its structure and interface. - [Set up frontend](/actions-and-automations/create-self-service-experiences/setup-ui-for-action.md): After selecting the blueprint you want to add an action to, we need to define the action's frontend - its structure and interface. ##### advanced-form-configurations Advanced input settings allow you to create more customizable experiences for users who perform self-service actions. This is done by creating adaptive inputs that change according to data about the entity, the user, and other inputs. - [Advanced input configurations](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/advanced-form-configurations.md): Advanced input settings allow you to create more customizable experiences for users who perform self-service actions. This is done by creating adaptive inputs that change according to data about the entity, the user, and other inputs. ##### user-inputs Each action has a userInputs section in its definition. In this section, you can define all of the user inputs you want your developers and users to fill when invoking the action. - [User Inputs](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs.md): Each action has a userInputs section in its definition. In this section, you can define all of the user inputs you want your developers and users to fill when invoking the action. - [Array](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/array.md): Array is an input for lists of data - [Datetime](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/datetime.md): Datetime is an input used to reference a date and time - [Email](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/email.md): Email is an input used to save Email addresses - [Entity](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/entity.md): Entity is an input used to reference existing entities from the software catalog when triggering actions - [Number](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/number.md): Number is a basic input for numeric data - [Object](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/object.md): Object is a basic input for JSON data - [Secret](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/secret.md): A secret input encrypts its value before sending it to your backend and never stores or logs it. Choose Port-managed encryption or your own public key. - [Team](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/team.md): Team is an input used to reference teams that exist in Port - [Text](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/text.md): Text is a basic input for textual information - [Toggle (Boolean)](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/toggle.md): Toggle is a basic input that has one of two possible values - true and false - [URL](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/url.md): URL is an input used to save links to websites - [User](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/user.md): User is an input used to reference users that exist in Port - [Yaml](/actions-and-automations/create-self-service-experiences/setup-ui-for-action/user-inputs/yaml.md): Yaml is an input used to save object definitions in YAML ### define-automations Naturally, your developer portal holds valuable information about your organization’s techstack, environments and dependencies. Port enables you to use this data to automate workflows and business logic, simplifying routine processes and making your organization more efficient and secure. - [Define automations](/actions-and-automations/define-automations.md): Naturally, your developer portal holds valuable information about your organization’s techstack, environments and dependencies. Port enables you to use this data to automate workflows and business logic, simplifying routine processes and making your organization more efficient and secure. #### examples This section provides examples of automation definitions in Port. - [Examples](/actions-and-automations/define-automations/examples.md): This section provides examples of automation definitions in Port. #### setup-action The automation's backend is the logic that you want to execute when a trigger event occurs. It will run on all entities tied to the blueprint specified in the automation's definition, whenever the trigger event occurs. - [Set up backend](/actions-and-automations/define-automations/setup-action.md): The automation's backend is the logic that you want to execute when a trigger event occurs. It will run on all entities tied to the blueprint specified in the automation's definition, whenever the trigger event occurs. #### setup-trigger After specifying your automation’s basic details, the next step in the automation definition process is to choose a trigger for the automation. Triggers are events in your software catalog that initiate an automation when they occur. - [Set up trigger](/actions-and-automations/define-automations/setup-trigger.md): After specifying your automation’s basic details, the next step in the automation definition process is to choose a trigger for the automation. Triggers are events in your software catalog that initiate an automation when they occur. ### overview One of Port's core offerings is the ability to automate and simplify the processes and routines of your developers. - [Overview](/actions-and-automations/overview.md): One of Port's core offerings is the ability to automate and simplify the processes and routines of your developers. ### reflect-action-progress Once a self-service action or automation has been executed, an actionRun object will be created in Port. - [Interact with action runs](/actions-and-automations/reflect-action-progress.md): Once a self-service action or automation has been executed, an actionRun object will be created in Port. ### setup-backend Port's self-service actions and automations support a variety of backends that can be used when triggered. - [Backend types](/actions-and-automations/setup-backend.md): Port's self-service actions and automations support a variety of backends that can be used when triggered. #### azure-pipeline The Azure backend can trigger Azure pipelines for both self-service actions and automations, using incoming webhook triggers. - [Azure pipeline](/actions-and-automations/setup-backend/azure-pipeline.md): The Azure backend can trigger Azure pipelines for both self-service actions and automations, using incoming webhook triggers. ##### trigger-non-default-branch By default, Azure DevOps pipelines triggered through Port self-service actions run from the repository's default branch (typically main or master). - [Trigger pipelines in non-default branch](/actions-and-automations/setup-backend/azure-pipeline/trigger-non-default-branch.md): By default, Azure DevOps pipelines triggered through Port self-service actions run from the repository's default branch (typically main or master). ##### troubleshooting Common questions and solutions for Azure DevOps integration and pipelines in Port. - [Azure DevOps troubleshooting](/actions-and-automations/setup-backend/azure-pipeline/troubleshooting.md): Common questions and solutions for Azure DevOps integration and pipelines in Port. #### create-update-entity In some cases, we don't want to run complex logic via a workflow or pipeline, but rather want our backend to simply create or update an entity in our software catalog. - [Create/update entity](/actions-and-automations/setup-backend/create-update-entity.md): In some cases, we don't want to run complex logic via a workflow or pipeline, but rather want our backend to simply create or update an entity in our software catalog. #### github-ocean The GitHub Ocean backend allows you to trigger GitHub workflows for your self-service actions and automations, using the GitHub Ocean integration. - [GitHub workflow via Ocean](/actions-and-automations/setup-backend/github-ocean.md): The GitHub Ocean backend allows you to trigger GitHub workflows for your self-service actions and automations, using the GitHub Ocean integration. #### github-workflow The GitHub backend allows you to trigger GitHub workflows for your self-service actions and automations, using Port's GitHub application. - [GitHub workflow](/actions-and-automations/setup-backend/github-workflow.md): The GitHub backend allows you to trigger GitHub workflows for your self-service actions and automations, using Port's GitHub application. ##### auto-discovery Actions auto discovery automates the process of discovering and syncing GitHub workflow actions with Port. - [Auto discovery](/actions-and-automations/setup-backend/github-workflow/auto-discovery.md): Actions auto discovery automates the process of discovering and syncing GitHub workflow actions with Port. #### gitlab-pipeline The GitLab backend allows you to trigger GitLab pipelines for your self-service actions and automations. - [GitLab pipeline](/actions-and-automations/setup-backend/gitlab-pipeline.md): The GitLab backend allows you to trigger GitLab pipelines for your self-service actions and automations. ##### saas If you use the cloud (SaaS) version of GitLab in your organization, the simplest way to trigger your pipelines from Port is to use the webhook backend. - [GitLab SaaS](/actions-and-automations/setup-backend/gitlab-pipeline/saas.md): If you use the cloud (SaaS) version of GitLab in your organization, the simplest way to trigger your pipelines from Port is to use the webhook backend. ##### self-hosted If you use the self-hosted version of GitLab in your organization, you will need to use the Port execution agent to trigger your pipelines from Port. - [Self-hosted GitLab](/actions-and-automations/setup-backend/gitlab-pipeline/self-hosted.md): If you use the self-hosted version of GitLab in your organization, you will need to use the Port execution agent to trigger your pipelines from Port. #### jenkins-pipeline The Jenkins backend allows you to trigger Jenkins pipelines for your self-service actions and automations, using webhooks. - [Jenkins pipeline](/actions-and-automations/setup-backend/jenkins-pipeline.md): The Jenkins backend allows you to trigger Jenkins pipelines for your self-service actions and automations, using webhooks. #### kafka Port manages a Kafka topic per customer that publishes the execution run requests. - [Kafka topic](/actions-and-automations/setup-backend/kafka.md): Port manages a Kafka topic per customer that publishes the execution run requests. #### security This page includes additional configurations required to allow Port to interact with your backend when using self-service actions. - [Security](/actions-and-automations/setup-backend/security.md): This page includes additional configurations required to allow Port to interact with your backend when using self-service actions. #### send-slack-message The Send Slack message backend type allows you to send a message to a Slack channel, using a webhook URL. - [Send Slack message](/actions-and-automations/setup-backend/send-slack-message.md): The Send Slack message backend type allows you to send a message to a Slack channel, using a webhook URL. #### webhook The webhook backend allows you to trigger your own custom webhooks, for both self-service actions and automations. - [Webhook](/actions-and-automations/setup-backend/webhook.md): The webhook backend allows you to trigger your own custom webhooks, for both self-service actions and automations. ##### circle-ci Port's Circle CI integration allows you to trigger new pipelines in Circle CI directly from Port. - [Circle CI Actions](/actions-and-automations/setup-backend/webhook/circle-ci.md): Port's Circle CI integration allows you to trigger new pipelines in Circle CI directly from Port. ##### cloudbuild-pipeline This page will guide you through the process of triggering your Cloud Build pipelines from Port, using Webhook Actions. - [Triggering Cloud Build using webhooks](/actions-and-automations/setup-backend/webhook/cloudbuild-pipeline.md): This page will guide you through the process of triggering your Cloud Build pipelines from Port, using Webhook Actions. ##### examples - [Software templates](/actions-and-automations/setup-backend/webhook/examples/software-templates.md): A software template allows you to generate a customized skeleton of a new resource (e.g. service), usually based on community best practices. - [Terraform: No-Code resource provisioning](/actions-and-automations/setup-backend/webhook/examples/terraform-no-code-resource-provisioning.md): Port's Terraform provider, combined with Port's self-service actions can be used to expose IaC no-code resource provisioning operations to users. These provisioning operations can automate the lifecycle of different cloud resources. ##### local-debugging-webhook In this guide, we will show you how to debug Webhook Self-Service Actions that are sent from Port locally. - [Debug webhooks locally](/actions-and-automations/setup-backend/webhook/local-debugging-webhook.md): In this guide, we will show you how to debug Webhook Self-Service Actions that are sent from Port locally. ##### port-execution-agent Port's execution agent provides you with a secure and convenient way to listen and act on invocations of self-service actions, workflow runs, and changes in the software catalog. - [Port execution agent](/actions-and-automations/setup-backend/webhook/port-execution-agent.md): Port's execution agent provides you with a secure and convenient way to listen and act on invocations of self-service actions, workflow runs, and changes in the software catalog. - [Control the payload](/actions-and-automations/setup-backend/webhook/port-execution-agent/control-the-payload.md): Port offers two ways to control the payload sent to your backend: - [Argo workflow](/actions-and-automations/setup-backend/webhook/port-execution-agent/examples/trigger-an-argo-workflow.md): This example helps internal developer teams to trigger an Argo Workflow using Port's self service actions. We will create a blueprint for argoWorkflow that will be connected to a backend action. We will then add some configuration files (invocations.json) to control the payload and trigger your Argo Workflows directly from Port using the sync execution method. - [CircleCI pipline](/actions-and-automations/setup-backend/webhook/port-execution-agent/examples/trigger-circleCI-pipeline.md): This example helps internal developer teams to trigger CircleCI pipelines using Port's self service actions. In particular, you will create a blueprint for circleCI Project that will be connected to a backend action. You will then add some configuration files (invocations.json) to control the payload and trigger your CircleCI pipeline directly from Port using the sync execution method. - [OpsGenie incident](/actions-and-automations/setup-backend/webhook/port-execution-agent/examples/trigger-opsgenie-incident.md): This example helps internal developer teams to trigger Opsgenie incidents using Port's self service actions. In particular, you will create a blueprint for opsgenieIncident that will be connected to a backend action. You will then add some configuration files (invocations.json) to control the payload and trigger your Opsgenie incident directly from Port using the sync execution method. - [Terraform Cloud run](/actions-and-automations/setup-backend/webhook/port-execution-agent/examples/trigger-terraform-cloud-run.md): This example helps internal developer teams to trigger an Terraform Cloud run using Port's self service actions. We will create a blueprint for Terraform Cloud Workspace that will be connected to a backend action. We will then add some configuration files (invocations.json) to control the payload and trigger your Terraform Cloud run directly from Port using the sync execution method. - [Windmill job](/actions-and-automations/setup-backend/webhook/port-execution-agent/examples/trigger-windmill-job.md): This example helps internal developer teams to trigger Windmill job using Port's self service actions. In particular, you will create a blueprint for windmillJob that will be connected to a backend action. You will then add some configuration files (invocations.json) to control the payload and trigger your Windmill job directly from Port using async/sync execution method. - [ArgoCD](/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/argocd.md): This page will walk you through the installation of the Port execution agent in your Kubernetes cluster using ArgoCD, utilizing its Helm Capabilities. - [Docker](/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/docker.md): This page we will walk you through the installation of the Port execution agent using docker. - [Helm](/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/helm.md): This page will walk you through the installation of the Port execution agent in your Kubernetes cluster using Helm. - [Usage](/actions-and-automations/setup-backend/webhook/port-execution-agent/usage.md): To make use of the Port execution agent, you need to configure: ##### signature-verification In this guide, we will show how to validate that a message your webhook has received was sent by Port. - [Validate webhook signatures](/actions-and-automations/setup-backend/webhook/signature-verification.md): In this guide, we will show how to validate that a message your webhook has received was sent by Port. ##### terraform-cloud Port's Terraform Cloud integration allows you to trigger Terraform Cloud runs directly from Port. - [Terraform cloud actions](/actions-and-automations/setup-backend/webhook/terraform-cloud.md): Port's Terraform Cloud integration allows you to trigger Terraform Cloud runs directly from Port. ## scorecards ### concepts-and-structure This page demonstrates the concepts of scorecards and their structure in Port. - [Concepts and structure](/scorecards/concepts-and-structure.md): This page demonstrates the concepts of scorecards and their structure in Port. ### examples #### automation-use-cases This page provides examples of automations that trigger when scorecard rule results are updated. These examples demonstrate how to notify teams via Slack or Microsoft Teams when rule results change, and how to automatically create GitHub issues when rule results degrade from Passed to Not passed. - [Automation use-cases](/scorecards/examples/automation-use-cases.md): This page provides examples of automations that trigger when scorecard rule results are updated. These examples demonstrate how to notify teams via Slack or Microsoft Teams when rule results change, and how to automatically create GitHub issues when rule results degrade from Passed to Not passed. #### extend-data-model Scorecards can track more than pass or fail compliance. By extending their data models and using automations, you can build SLA aware workflows and visual dashboards that help teams stay accountable and proactive. - [Extend the default scorecards](/scorecards/examples/extend-data-model.md): Scorecards can track more than pass or fail compliance. By extending their data models and using automations, you can build SLA aware workflows and visual dashboards that help teams stay accountable and proactive. #### scorecard-use-cases Scorecards help you track compliance, enforce standards, and maintain quality across your software catalog. This page demonstrates practical scorecard examples and automations that respond to scorecard rule result changes. - [Scorecard use-cases](/scorecards/examples/scorecard-use-cases.md): Scorecards help you track compliance, enforce standards, and maintain quality across your software catalog. This page demonstrates practical scorecard examples and automations that respond to scorecard rule result changes. ### manage-scorecards Define scorecards - [Manage scorecards](/scorecards/manage-scorecards.md): Define scorecards ### manage-using-3rd-party-apps Your developer portal contains valuable data about your entities, including their compliance with your standards (using scorecards or initiatives). For example, you can easily determine the production readiness (scorecard) of a microservice (an entity). - [Manage using 3rd-party apps](/scorecards/manage-using-3rd-party-apps.md): Your developer portal contains valuable data about your entities, including their compliance with your standards (using scorecards or initiatives). For example, you can easily determine the production readiness (scorecard) of a microservice (an entity). #### github The Port message sender allows you to automatically create GitHub issues for entities with violated scorecard rules, and close them once the violations are fixed. - [Open/close GitHub issues](/scorecards/manage-using-3rd-party-apps/github.md): The Port message sender allows you to automatically create GitHub issues for entities with violated scorecard rules, and close them once the violations are fixed. #### jira The Port message sender allows you to automatically create Jira issues for entities with violated scorecard rules, and close them once the violations are fixed. - [Open/close JIRA issues](/scorecards/manage-using-3rd-party-apps/jira.md): The Port message sender allows you to automatically create Jira issues for entities with violated scorecard rules, and close them once the violations are fixed. #### slack Your developer portal contains valuable data about your entities, including their compliance with your standards (using scorecards or initiatives). For example, you can easily determine the production readiness (scorecard) of a microservice (an entity). - [Send Slack messages](/scorecards/manage-using-3rd-party-apps/slack.md): Your developer portal contains valuable data about your entities, including their compliance with your standards (using scorecards or initiatives). For example, you can easily determine the production readiness (scorecard) of a microservice (an entity). ### overview Scorecards help you ensure every component and process meets your engineering standards. They enable you to continuously monitor quality, security, and compliance across your software catalog, and easily act on insights through Port actions and automations. - [Scorecards](/scorecards/overview.md): Scorecards help you ensure every component and process meets your engineering standards. They enable you to continuously monitor quality, security, and compliance across your software catalog, and easily act on insights through Port actions and automations. ## search-and-query ### advanced Search route query parameters - [Advanced](/search-and-query/advanced.md): Search route query parameters ### examples This page provides practical examples of using Port's search and query syntax across different features. - [Examples](/search-and-query/examples.md): This page provides practical examples of using Port's search and query syntax across different features. ### global-search Port's global search provides a quick way to find entities, actions, blueprints, and more across your software catalog. - [Global search](/search-and-query/global-search.md): Port's global search provides a quick way to find entities, actions, blueprints, and more across your software catalog. ### operators #### comparison-operators This page details the available comparison operators when writing rules as part of the search route. - [Comparison operators](/search-and-query/operators/comparison-operators.md): This page details the available comparison operators when writing rules as part of the search route. #### relation-operators This page details the available relation operators when writing rules as part of the search route. - [Relation operators](/search-and-query/operators/relation-operators.md): This page details the available relation operators when writing rules as part of the search route. ### overview Port's search and query syntax for filtering and retrieving catalog entities. Used in catalog pages, dashboards, scorecards, self-service action conditions, and the API. - [Overview](/search-and-query/overview.md): Port's search and query syntax for filtering and retrieving catalog entities. Used in catalog pages, dashboards, scorecards, self-service action conditions, and the API. ### structure-and-syntax This page details the structure and syntax used to build search queries in Port, including how to construct search requests, define rules, use combinators, and apply operators to filter entities. - [Structure & syntax](/search-and-query/structure-and-syntax.md): This page details the structure and syntax used to build search queries in Port, including how to construct search requests, define rules, use combinators, and apply operators to filter entities. ## guides This section contains guides and examples that will help you learn and implement various use cases with Port. - [Guides](/guides.md): This section contains guides and examples that will help you learn and implement various use cases with Port. ### all #### acknowledge-incident Learn how to acknowledge incidents in Port with our easy-to-follow guide, ensuring swift responses and streamlined operations - [Acknowledge Incident In PagerDuty](/guides/all/acknowledge-incident.md): Learn how to acknowledge incidents in Port with our easy-to-follow guide, ensuring swift responses and streamlined operations #### add-ec2-volume Overview - [Add a Disk to an AWS EC2 Instance](/guides/all/add-ec2-volume.md): Overview #### add-rca-context-to-ai-agents Learn how to enhance AI agents with custom context like Root Cause Analysis documents using entities - [Add RCA context to AI agents](/guides/all/add-rca-context-to-ai-agents.md): Learn how to enhance AI agents with custom context like Root Cause Analysis documents using entities #### ai-powered-github-workflow-documentation Automatically generate and maintain human-readable documentation for GitHub Actions workflows using Port's AI agents and automation system - [Auto-generate GitHub workflow documentation](/guides/all/ai-powered-github-workflow-documentation.md): Automatically generate and maintain human-readable documentation for GitHub Actions workflows using Port's AI agents and automation system #### ai-powered-rca-postmortem-generation Generate comprehensive RCA and postmortem documents using AI, incident context, and Port self-service actions. - [AI-powered RCA and postmortem generation](/guides/all/ai-powered-rca-postmortem-generation.md): Generate comprehensive RCA and postmortem documents using AI, incident context, and Port self-service actions. #### ai-powered-work-item-preparation Use AI to enrich work items with context, recommendations, and scorecard readiness signals. - [AI-powered work item preparation](/guides/all/ai-powered-work-item-preparation.md): Use AI to enrich work items with context, recommendations, and scorecard readiness signals. #### apply-labels-to-github-pr-based-on-sonar-scans Learn how to automatically label your GitHub pull request based on SonarQube scan reports - [Auto-label your GitHub PRs with Sonar Scans](/guides/all/apply-labels-to-github-pr-based-on-sonar-scans.md): Learn how to automatically label your GitHub pull request based on SonarQube scan reports #### approval-workflow-for-gitlab-deployment Learn how to chain self service actions and automations to manage deployment in GitLab and ServiceNow - [Approval Workflows for Service Deployment](/guides/all/approval-workflow-for-gitlab-deployment.md): Learn how to chain self service actions and automations to manage deployment in GitLab and ServiceNow #### auto-approve-and-merge-dependabot-prs Learn how to automatically approve and merge your GitHub pull request created by Dependabot - [Auto approve and merge Dependabot PRs](/guides/all/auto-approve-and-merge-dependabot-prs.md): Learn how to automatically approve and merge your GitHub pull request created by Dependabot #### auto-assign-bugs-to-owners Automatically assign Jira bugs to owning teams and services with Port automations and AI. - [Auto-assign bugs to owners with AI](/guides/all/auto-assign-bugs-to-owners.md): Automatically assign Jira bugs to owning teams and services with Port automations and AI. #### auto-enhance-pr-descriptions-with-ai Automatically enhance PR descriptions with AI-generated, template-compliant content using Port AI agents and coding assistants - [Auto-enhance PR descriptions with AI](/guides/all/auto-enhance-pr-descriptions-with-ai.md): Automatically enhance PR descriptions with AI-generated, template-compliant content using Port AI agents and coding assistants #### auto-remediate-insecure-cloud-resources-with-ai Learn how to automatically detect and remediate insecure cloud resources using Port's AI capabilities and Claude Code to generate infrastructure-as-code patches. - [Auto-remediate insecure cloud resources with AI](/guides/all/auto-remediate-insecure-cloud-resources-with-ai.md): Learn how to automatically detect and remediate insecure cloud resources using Port's AI capabilities and Claude Code to generate infrastructure-as-code patches. #### automate-slack-alert-for-overdue-prs Set up automated Slack alerts for overdue PRs in Port, ensuring timely reviews and efficient project management. - [Automate Slack Alert for Overdue PRs](/guides/all/automate-slack-alert-for-overdue-prs.md): Set up automated Slack alerts for overdue PRs in Port, ensuring timely reviews and efficient project management. #### automate-user-role-update Automatically assign an Admin role to users upon joining the admins group. - [Automate admin role assignment](/guides/all/automate-user-role-update.md): Automatically assign an Admin role to users upon joining the admins group. #### automatically-approve-action-using-automation Learn how to set up automated approvals for self service actions, improving efficiency and reducing manual overhead. - [Automate self-service action approvals](/guides/all/automatically-approve-action-using-automation.md): Learn how to set up automated approvals for self service actions, improving efficiency and reducing manual overhead. #### automatically-resolve-tickets-with-coding-agents Learn how to automatically generate GitHub issues from Jira tickets, assign them to coding agents like Copilot, and link pull requests back to Jira — using either a Port workflow or actions, automations, and an AI agent. - [Automatically resolve tickets with coding agents](/guides/all/automatically-resolve-tickets-with-coding-agents.md): Learn how to automatically generate GitHub issues from Jira tickets, assign them to coding agents like Copilot, and link pull requests back to Jira — using either a Port workflow or actions, automations, and an AI agent. #### automatically-resolve-tickets-with-n8n-port-context Learn how to use Port as a context lake in n8n workflows to automatically generate GitHub issues from Jira tickets with rich organizational context and assign them to coding agents. - [Automatically resolve tickets with n8n and Port context](/guides/all/automatically-resolve-tickets-with-n8n-port-context.md): Learn how to use Port as a context lake in n8n workflows to automatically generate GitHub issues from Jira tickets with rich organizational context and assign them to coding agents. #### automatically-set-relations-between-entities-with-automation Save time and reduce errors by automating entity relations without writing integration code. Learn how to automatically link service entities to their owning teams. - [Automatically set relations between entities with automation](/guides/all/automatically-set-relations-between-entities-with-automation.md): Save time and reduce errors by automating entity relations without writing integration code. Learn how to automatically link service entities to their owning teams. #### azure-resource-tagging-initiative Learn how to track and enforce Azure resource tagging compliance using Port scorecards, dashboards, and self-service actions. - [Track Azure Resource tagging compliance](/guides/all/azure-resource-tagging-initiative.md): Learn how to track and enforce Azure resource tagging compliance using Port scorecards, dashboards, and self-service actions. #### broadcast-api-consumers-message Learn how to broadcast messages to API consumers in Port, enhancing communication and system transparency. - [Broadcast message to API consumers](/guides/all/broadcast-api-consumers-message.md): Learn how to broadcast messages to API consumers in Port, enhancing communication and system transparency. #### build-ai-agent-registry Learn how to build a centralized AI Agent Registry in Port to discover, govern, and manage AI agents deployed across AWS Bedrock and Azure AI Foundry. - [Build an AI Agent Registry](/guides/all/build-ai-agent-registry.md): Learn how to build a centralized AI Agent Registry in Port to discover, govern, and manage AI agents deployed across AWS Bedrock and Azure AI Foundry. #### build-port-actions-with-mcp Use AI to create Port self-service actions and automations through natural language conversations, enabling workflow orchestration without manual configuration - [Build actions and automations with AI](/guides/all/build-port-actions-with-mcp.md): Use AI to create Port self-service actions and automations through natural language conversations, enabling workflow orchestration without manual configuration #### build-port-data-model-with-mcp Use AI to build and manage your Port software catalog through natural language conversations, creating blueprints, entities, relations, actions, and scorecards - [Build your software catalog with MCP](/guides/all/build-port-data-model-with-mcp.md): Use AI to build and manage your Port software catalog through natural language conversations, creating blueprints, entities, relations, actions, and scorecards #### build-port-scorecards-with-mcp Use AI to create and manage Port scorecards through natural language conversations, defining quality standards and compliance rules without manual configuration - [Define scorecards with AI](/guides/all/build-port-scorecards-with-mcp.md): Use AI to create and manage Port scorecards through natural language conversations, defining quality standards and compliance rules without manual configuration #### calculate-blast-radius-with-ai Calculate deployment blast radius and production risk using AI, service dependencies, and Port self-service actions. - [Calculate blast radius with AI](/guides/all/calculate-blast-radius-with-ai.md): Calculate deployment blast radius and production risk using AI, service dependencies, and Port self-service actions. #### centralize-ai-coding-rules-with-port Centralize AI coding rules in Port and sync them to AGENTS.md for GitHub Copilot. - [Centralize AI Coding Rules with Port](/guides/all/centralize-ai-coding-rules-with-port.md): Centralize AI coding rules in Port and sync them to AGENTS.md for GitHub Copilot. #### change-on-call-user Quickly change the on-call user in Port with this guide, ensuring continuous coverage and smooth operations. - [Change the on-call In PagerDuty](/guides/all/change-on-call-user.md): Quickly change the on-call user in Port with this guide, ensuring continuous coverage and smooth operations. #### change-pagerduty-incident-owner Effortlessly change the PagerDuty incident owner in Port, ensuring incidents are managed by the right team members. - [Change Incident Owner In Pagerduty](/guides/all/change-pagerduty-incident-owner.md): Effortlessly change the PagerDuty incident owner in Port, ensuring incidents are managed by the right team members. #### change-replica-count Learn how to change the replica count in Port, optimizing resource allocation and maintaining system stability. - [Change Deployment Replica Count](/guides/all/change-replica-count.md): Learn how to change the replica count in Port, optimizing resource allocation and maintaining system stability. #### change-status-and-assignee-of-jira-ticket Quickly change the status and assignee of Jira tickets in Port, streamlining your project management process. - [Change status and assignee of Jira ticket](/guides/all/change-status-and-assignee-of-jira-ticket.md): Quickly change the status and assignee of Jira tickets in Port, streamlining your project management process. #### connect-dynatrace-team-with-entities Learn how to map Dynatrace teams to monitored entities in Port - [Assign teams to monitored entities](/guides/all/connect-dynatrace-team-with-entities.md): Learn how to map Dynatrace teams to monitored entities in Port #### connect-github-codeowners-with-service-team-and-user Learn how to connect GitHub Codeowners with repositories, teams and users in Port, ensuring seamless collaboration and code ownership. - [Connect GitHub CODEOWNERS with Repository, Team & User](/guides/all/connect-github-codeowners-with-service-team-and-user.md): Learn how to connect GitHub Codeowners with repositories, teams and users in Port, ensuring seamless collaboration and code ownership. #### connect-github-pr-with-jira-issue Effortlessly connect GitHub PRs with Jira issues in Port, enhancing traceability and improving project workflows. - [Connect GitHub Pull Request with Jira Issue](/guides/all/connect-github-pr-with-jira-issue.md): Effortlessly connect GitHub PRs with Jira issues in Port, enhancing traceability and improving project workflows. #### connect-github-pr-with-sonar-analysis Learn how to connect GitHub PRs with Sonar analysis in Port, ensuring code quality and streamlined review processes. - [Connect GitHub PR to SonarQube analysis](/guides/all/connect-github-pr-with-sonar-analysis.md): Learn how to connect GitHub PRs with Sonar analysis in Port, ensuring code quality and streamlined review processes. #### copy-pipeline-template-to-target-repo Learn how to copy pipeline template from one repository to another using Port Actions. - [Copy Pipeline Template to Target Repo](/guides/all/copy-pipeline-template-to-target-repo.md): Learn how to copy pipeline template from one repository to another using Port Actions. #### create-an-ec2-instance Learn how to create an EC2 instance in Port with this step-by-step guide, enabling scalable cloud infrastructure setup. - [Create an AWS EC2 instance using GitHub Actions](/guides/all/create-an-ec2-instance.md): Learn how to create an EC2 instance in Port with this step-by-step guide, enabling scalable cloud infrastructure setup. #### create-an-ec2-instance-gitlab Follow this guide to create an EC2 instance for GitLab in Port, ensuring a seamless and scalable CI/CD environment. - [Create an AWS EC2 instance using GitLab CI](/guides/all/create-an-ec2-instance-gitlab.md): Follow this guide to create an EC2 instance for GitLab in Port, ensuring a seamless and scalable CI/CD environment. #### create-an-opsgenie-incident Learn how to create an Opsgenie incident in Port with this guide, ensuring rapid response and effective incident management. - [Create Opsgenie Incident](/guides/all/create-an-opsgenie-incident.md): Learn how to create an Opsgenie incident in Port with this guide, ensuring rapid response and effective incident management. #### create-and-track-dora-metrics-in-your-portal This guide demonstrates how to setup and use DORA metrics in your portal. - [Create & track DORA metrics in your portal](/guides/all/create-and-track-dora-metrics-in-your-portal.md): This guide demonstrates how to setup and use DORA metrics in your portal. #### create-and-use-surveys-in-your-portal This guide will walk you through the setup and use of surveys in your portal. - [Create & use surveys in your portal](/guides/all/create-and-use-surveys-in-your-portal.md): This guide will walk you through the setup and use of surveys in your portal. #### create-azure-devops-work-item Learn how to create an Azure DevOps work item in Port - [Create an Azure DevOps Work Item](/guides/all/create-azure-devops-work-item.md): Learn how to create an Azure DevOps work item in Port #### create-azure-resource Learn how to create Azure resources in Port, enabling efficient cloud management and scalable infrastructure deployment. - [Deploy Azure Resource using Terraform](/guides/all/create-azure-resource.md): Learn how to create Azure resources in Port, enabling efficient cloud management and scalable infrastructure deployment. #### create-azure-resource-ado Follow this guide to create Azure resources for ADO in Port, ensuring seamless integration and cloud management. - [Create Azure Resource with Terraform](/guides/all/create-azure-resource-ado.md): Follow this guide to create Azure resources for ADO in Port, ensuring seamless integration and cloud management. #### create-cloud-resource-using-iac Learn how to create cloud resources using Infrastructure as Code (IaC) in Port for efficient and automated deployments. - [Create cloud resources using IaC](/guides/all/create-cloud-resource-using-iac.md): Learn how to create cloud resources using Infrastructure as Code (IaC) in Port for efficient and automated deployments. #### create-dev-env Learn how to create a development environment in Port, streamlining your workflow for efficient project setup and testing. - [Manage a Developer Environment Lifecycle](/guides/all/create-dev-env.md): Learn how to create a development environment in Port, streamlining your workflow for efficient project setup and testing. #### create-eks-cluster-and-deploy-app Learn how to create an EKS cluster and deploy your application in Port for scalable and efficient cloud infrastructure. - [Create an EKS cluster and deploy a Node.js app](/guides/all/create-eks-cluster-and-deploy-app.md): Learn how to create an EKS cluster and deploy your application in Port for scalable and efficient cloud infrastructure. #### create-github-pull-request Create GitHub pull requests from Port using Jenkins pipelines for automated infrastructure changes - [Create GitHub pull requests from Port](/guides/all/create-github-pull-request.md): Create GitHub pull requests from Port using Jenkins pipelines for automated infrastructure changes #### create-incident-io-incident Learn how to create an incident.io incident in Port, ensuring timely resolution and effective incident management. - [Create an incident.io Incident](/guides/all/create-incident-io-incident.md): Learn how to create an incident.io incident in Port, ensuring timely resolution and effective incident management. #### create-jira-issue-from-datadog-alert Automatically create Jira issues from monitoring and security alerts in Port using an alert-triggered automation and a Jira webhook. Uses Datadog as the example; swap the source blueprint for Dependabot, New Relic, Snyk, and other tools. - [Create a Jira issue from a monitoring alert](/guides/all/create-jira-issue-from-datadog-alert.md): Automatically create Jira issues from monitoring and security alerts in Port using an alert-triggered automation and a Jira webhook. Uses Datadog as the example; swap the source blueprint for Dependabot, New Relic, Snyk, and other tools. #### create-jira-issue-gitlab Create a self-service action in Port that opens a Jira issue using a GitLab CI pipeline, allowing developers to report bugs or create tickets without leaving Port. - [Create a Jira issue using GitLab CI](/guides/all/create-jira-issue-gitlab.md): Create a self-service action in Port that opens a Jira issue using a GitLab CI pipeline, allowing developers to report bugs or create tickets without leaving Port. #### create-k8s-namespace Follow this guide to create a Kubernetes namespace in Port, enabling organized and efficient resource management. - [Create a Kubernetes namespace](/guides/all/create-k8s-namespace.md): Follow this guide to create a Kubernetes namespace in Port, enabling organized and efficient resource management. #### create-new-aws-account-gitlab Learn how to automate AWS account creation through Port using GitLab CI/CD, enabling streamlined cloud infrastructure provisioning with self-service actions. - [Automate AWS Account Creation with GitLab](/guides/all/create-new-aws-account-gitlab.md): Learn how to automate AWS account creation through Port using GitLab CI/CD, enabling streamlined cloud infrastructure provisioning with self-service actions. #### create-organizational-hierarchy-views Learn how to model and visualize hierarchy tiers in your organization. - [Create organizational hierarchy views](/guides/all/create-organizational-hierarchy-views.md): Learn how to model and visualize hierarchy tiers in your organization. #### create-pagerduty-incident-from-newrelic-alert Learn how to trigger a PagerDuty incident from New Relic alert in Port with this guide, ensuring prompt and effective incident management. - [Create a PagerDuty incident from a New Relic alert](/guides/all/create-pagerduty-incident-from-newrelic-alert.md): Learn how to trigger a PagerDuty incident from New Relic alert in Port with this guide, ensuring prompt and effective incident management. #### create-pagerduty-service Follow this guide to create a PagerDuty service in Port, ensuring efficient incident management and response. - [Create a PagerDuty Service](/guides/all/create-pagerduty-service.md): Follow this guide to create a PagerDuty service in Port, ensuring efficient incident management and response. #### create-roi-dashboard Create a dashboard that tracks the ROI of actions in Port - [Create an actions ROI dashboard](/guides/all/create-roi-dashboard.md): Create a dashboard that tracks the ROI of actions in Port #### create-slack-channel-for-reported-incident Learn how to automatically create a Slack channel and GitHub issue when a PagerDuty incident is reported, enabling real-time team communication and incident documentation. - [Auto-create Slack channel & GitHub issue for PagerDuty incidents](/guides/all/create-slack-channel-for-reported-incident.md): Learn how to automatically create a Slack channel and GitHub issue when a PagerDuty incident is reported, enabling real-time team communication and incident documentation. #### deploy-azure-resource Follow this guide to deploy Azure resources in Port, ensuring efficient cloud management and streamlined operations. - [Deploy resource in Azure Cloud with Terraform](/guides/all/deploy-azure-resource.md): Follow this guide to deploy Azure resources in Port, ensuring efficient cloud management and streamlined operations. #### deploy-cloudformation-template Learn how to deploy CloudFormation templates in Port, enabling automated and efficient cloud resource management. - [Deploy AWS resources using AWS CloudFormation](/guides/all/deploy-cloudformation-template.md): Learn how to deploy CloudFormation templates in Port, enabling automated and efficient cloud resource management. #### deploy-s3-bucket-crossplane Learn how to deploy an S3 bucket using Crossplane in Port, enabling flexible and efficient cloud resource management. - [Deploy S3 Bucket using Crossplane](/guides/all/deploy-s3-bucket-crossplane.md): Learn how to deploy an S3 bucket using Crossplane in Port, enabling flexible and efficient cloud resource management. #### deploy-service-using-aws-codedeploy Learn how to trigger an AWS CodeDeploy application in Port. - [Deploy a service using AWS CodeDeploy](/guides/all/deploy-service-using-aws-codedeploy.md): Learn how to trigger an AWS CodeDeploy application in Port. #### eks-as-a-service-action Learn how to manage EKS as a service in Port, ensuring efficient orchestration and scalable Kubernetes deployments. - [EKS as a service action (EKSaaS)](/guides/all/eks-as-a-service-action.md): Learn how to manage EKS as a service in Port, ensuring efficient orchestration and scalable Kubernetes deployments. #### enforce-ai-coding-security-standards Learn how to enforce AI coding security standards by checking for comprehensive Cursor security rules and GitHub Copilot instructions using Port scorecards and GitHub integration. - [Enforce AI coding security standards](/guides/all/enforce-ai-coding-security-standards.md): Learn how to enforce AI coding security standards by checking for comprehensive Cursor security rules and GitHub Copilot instructions using Port scorecards and GitHub integration. #### enrich-tasks-with-ai Enrich tasks with AI-powered context, providing developers with automated insights, related issues, and potential collaborators. - [Enrich tasks with AI-powered context](/guides/all/enrich-tasks-with-ai.md): Enrich tasks with AI-powered context, providing developers with automated insights, related issues, and potential collaborators. #### ensure-production-readiness Follow this guide to ensure production readiness in Port, optimizing your deployments for reliability and performance. - [Ensure production readiness](/guides/all/ensure-production-readiness.md): Follow this guide to ensure production readiness in Port, optimizing your deployments for reliability and performance. #### escalate-an-incident Learn how to escalate an incident in Port, ensuring timely resolution and effective incident management. - [Escalate an Incident in PagerDuty](/guides/all/escalate-an-incident.md): Learn how to escalate an incident in Port, ensuring timely resolution and effective incident management. #### execution-basic-runner-using-aws-lambda Learn how to execute a basic runner using AWS Lambda in Port, enabling scalable and efficient task automation. - [Setting up a basic execution runner using AWS Lambda](/guides/all/execution-basic-runner-using-aws-lambda.md): Learn how to execute a basic runner using AWS Lambda in Port, enabling scalable and efficient task automation. #### find-internal-documentation-with-ai Learn how to find internal documentation with AI - [Find internal documentation with AI](/guides/all/find-internal-documentation-with-ai.md): Learn how to find internal documentation with AI #### generate-incident-updates-with-ai Learn how to leverage Port's AI capabilities to enhance incident management with contextual incident updates and automated Slack notifications. - [Generate incident updates with AI](/guides/all/generate-incident-updates-with-ai.md): Learn how to leverage Port's AI capabilities to enhance incident management with contextual incident updates and automated Slack notifications. #### generate-incident-updates-with-n8n-and-port Use Port as a context lake in n8n workflows to automatically generate contextual incident updates and send enriched Slack notifications - [Generate incident updates with n8n and Port](/guides/all/generate-incident-updates-with-n8n-and-port.md): Use Port as a context lake in n8n workflows to automatically generate contextual incident updates and send enriched Slack notifications #### generate-zendesk-ticket-summaries-with-ai Summarize Zendesk tickets with AI using a reusable Port MCP prompt (backed by self-service actions). Requires Port remote MCP installed and connected in your IDE. No AI agents or automations required. - [Summarize Zendesk tickets with AI](/guides/all/generate-zendesk-ticket-summaries-with-ai.md): Summarize Zendesk tickets with AI using a reusable Port MCP prompt (backed by self-service actions). Requires Port remote MCP installed and connected in your IDE. No AI agents or automations required. #### heal-unhealthy-k8s-pods Learn how to use Port's AI capabilities to detect unhealthy Kubernetes pods and automatically trigger remediation actions to restore service health. - [Auto-heal unhealthy kubernetes pods](/guides/all/heal-unhealthy-k8s-pods.md): Learn how to use Port's AI capabilities to detect unhealthy Kubernetes pods and automatically trigger remediation actions to restore service health. #### humanitec-integration Learn how to integrate Humanitec with Port, enabling seamless application deployment and environment management. - [Humanitec integration](/guides/all/humanitec-integration.md): Learn how to integrate Humanitec with Port, enabling seamless application deployment and environment management. #### iam-permissions-guide Understand IAM permissions in Port with this comprehensive guide, ensuring secure and effective access management. - [IAM permission management](/guides/all/iam-permissions-guide.md): Understand IAM permissions in Port with this comprehensive guide, ensuring secure and effective access management. #### ignore-snyk-vulnerability Learn how to ignore a synk vulnerability - [Ignore Snyk Vulnerability](/guides/all/ignore-snyk-vulnerability.md): Learn how to ignore a synk vulnerability #### implement-rbac-for-ai-agents-with-n8n-and-port Learn how to implement role-based access control (RBAC) for multi-agent systems using Port and n8n, enabling dynamic tool access control for AI agents based on user roles and permissions. - [RBAC for AI agents with n8n and Port](/guides/all/implement-rbac-for-ai-agents-with-n8n-and-port.md): Learn how to implement role-based access control (RBAC) for multi-agent systems using Port and n8n, enabling dynamic tool access control for AI agents based on user roles and permissions. #### import-and-manage-integration Learn how to import and manage integrations in Port, streamlining your workflows and enhancing system connectivity. - [Manage integration mapping using Terraform](/guides/all/import-and-manage-integration.md): Learn how to import and manage integrations in Port, streamlining your workflows and enhancing system connectivity. #### incident-blueprint Learn how to implement the incident blueprint pattern for self-healing incident workflows - [Implement the incident blueprint pattern](/guides/all/incident-blueprint.md): Learn how to implement the incident blueprint pattern for self-healing incident workflows #### ingest-checkmarx-kics-scan-into-your-catalog Ingests Checkmarx KICS scan results in your Checkmarx KICS file using Port's GitHub file ingesting feature. - [Ingest Checkmarx KICS scan into your catalog](/guides/all/ingest-checkmarx-kics-scan-into-your-catalog.md): Ingests Checkmarx KICS scan results in your Checkmarx KICS file using Port's GitHub file ingesting feature. #### ingest-claude-code-security-reviews Ingest Claude Code security review findings and visualize them in Port dashboards. - [Ingest Claude Code security reviews](/guides/all/ingest-claude-code-security-reviews.md): Ingest Claude Code security review findings and visualize them in Port dashboards. #### ingest-cloud-resources-using-datadog Learn how to ingest cloud resources using Datadog in Port, enhancing visibility and performance monitoring. - [Ingest cloud resources with Datadog](/guides/all/ingest-cloud-resources-using-datadog.md): Learn how to ingest cloud resources using Datadog in Port, enhancing visibility and performance monitoring. #### ingest-cloud-resources-using-dynatrace Learn how to ingest cloud resources using Dynatrace in Port, enhancing visibility and performance monitoring. - [Ingest cloud resources with Dynatrace](/guides/all/ingest-cloud-resources-using-dynatrace.md): Learn how to ingest cloud resources using Dynatrace in Port, enhancing visibility and performance monitoring. #### ingest-cloud-resources-using-newrelic Learn how to ingest cloud resources using New Relic in Port, enhancing visibility and performance monitoring. - [Ingest Cloud Resources with New Relic](/guides/all/ingest-cloud-resources-using-newrelic.md): Learn how to ingest cloud resources using New Relic in Port, enhancing visibility and performance monitoring. #### ingest-dependencies-from-package-json-to-service Overview - [Ingest dependencies from a package.json file and relate them to a service](/guides/all/ingest-dependencies-from-package-json-to-service.md): Overview #### ingest-dotnet-framework-versions Ingest .NET framework versions from .csproj files and track them across your repositories using Port - [Ingest .NET framework versions from repositories](/guides/all/ingest-dotnet-framework-versions.md): Ingest .NET framework versions from .csproj files and track them across your repositories using Port #### ingest-gitlab-vulnerabilities-into-your-catalog Ingest GitLab security vulnerabilities into Port using the Ocean Custom Integration, enabling centralized visibility into SAST, DAST, dependency scanning, and container scanning findings per team and service. - [Ingest GitLab security vulnerabilities into Port](/guides/all/ingest-gitlab-vulnerabilities-into-your-catalog.md): Ingest GitLab security vulnerabilities into Port using the Ocean Custom Integration, enabling centralized visibility into SAST, DAST, dependency scanning, and container scanning findings per team and service. #### ingest-javascript-packages-into-your-catalog Ingests all Javascript packages in `package.json` file using Port's GitHub file ingesting feature. - [Ingest Javascript packages into your catalog](/guides/all/ingest-javascript-packages-into-your-catalog.md): Ingests all Javascript packages in `package.json` file using Port's GitHub file ingesting feature. #### ingest-linearb-metrics-into-your-catalog Consolidate LinearB engineering metrics into Port's Engineering Intelligence platform, leveraging Port's native analytics alongside imported data for a unified view of engineering performance. - [Ingest LinearB metrics into Port](/guides/all/ingest-linearb-metrics-into-your-catalog.md): Consolidate LinearB engineering metrics into Port's Engineering Intelligence platform, leveraging Port's native analytics alongside imported data for a unified view of engineering performance. #### ingest-prompts-skills-from-github-using-gitops Learn how to ingest AI prompts and skills from GitHub using GitOps by mapping repo files to Port blueprints. - [Ingest prompts and skills from GitHub using GitOps](/guides/all/ingest-prompts-skills-from-github-using-gitops.md): Learn how to ingest AI prompts and skills from GitHub using GitOps by mapping repo files to Port blueprints. #### ingest-security-issues-from-sarif-files-to-services This guide will demonstrate how to ingest security issues from .sarif files and relate them to the corresponding service entities in Port. - [Ingest security issues from .sarif files and relate them to services](/guides/all/ingest-security-issues-from-sarif-files-to-services.md): This guide will demonstrate how to ingest security issues from .sarif files and relate them to the corresponding service entities in Port. #### ingest-slack-data-via-airbyte-s3-and-webhook This guide will demonstrate how to ingest Slack channels and channel membership data into Port using Airbyte, S3 and a webhook integration. - [Ingest Slack channels data into Port via Airbyte, S3 and webhook](/guides/all/ingest-slack-data-via-airbyte-s3-and-webhook.md): This guide will demonstrate how to ingest Slack channels and channel membership data into Port using Airbyte, S3 and a webhook integration. #### ingest-software-bill-of-materials-sbom-into-your-catalog Ingests software bill of material (SBOM) in your `SBOM.json` or `SBOM.xml` file using Port's GitHub file ingesting feature - [Ingest software bill of material (SBOM) into your catalog](/guides/all/ingest-software-bill-of-materials-sbom-into-your-catalog.md): Ingests software bill of material (SBOM) in your `SBOM.json` or `SBOM.xml` file using Port's GitHub file ingesting feature #### ingest-swagger-paths-into-your-catalog Ingest API paths from an OpenAPI spec in a GitHub repository into Port - [Ingest API paths from an OpenAPI spec in a GitHub repository into Port](/guides/all/ingest-swagger-paths-into-your-catalog.md): Ingest API paths from an OpenAPI spec in a GitHub repository into Port #### ingest-swarmia-metrics-into-your-catalog Consolidate Swarmia DORA and pull request metrics into Port's Engineering Intelligence platform, leveraging Port's native analytics alongside imported data for a unified view of engineering performance. - [Ingest Swarmia metrics into Port](/guides/all/ingest-swarmia-metrics-into-your-catalog.md): Consolidate Swarmia DORA and pull request metrics into Port's Engineering Intelligence platform, leveraging Port's native analytics alongside imported data for a unified view of engineering performance. #### ingest-trivy-vulnerabilities-into-your-catalog Ingests Trivy vulnerabilities in your Trivy scan results file using Port's GitHub file ingesting feature. - [Ingest Trivy vulnerabilities into your catalog](/guides/all/ingest-trivy-vulnerabilities-into-your-catalog.md): Ingests Trivy vulnerabilities in your Trivy scan results file using Port's GitHub file ingesting feature. #### ingest-vulnerability-alerts-from-orca-security-using-a-custom-webhook-integration Ingest vulnerability alerts from Orca Security using a custom webhook integration - [Ingest vulnerability alerts from Orca Security](/guides/all/ingest-vulnerability-alerts-from-orca-security-using-a-custom-webhook-integration.md): Ingest vulnerability alerts from Orca Security using a custom webhook integration #### interact-with-pagerduty-incidents Learn how to create or trigger PagerDuty incidents from Port using synced webhooks or GitHub workflows, and keep your catalog in sync. - [Interact with PagerDuty incidents](/guides/all/interact-with-pagerduty-incidents.md): Learn how to create or trigger PagerDuty incidents from Port using synced webhooks or GitHub workflows, and keep your catalog in sync. #### interact-with-servicenow Learn how to interact with ServiceNow records and delete ServiceNow incidents using Port's self-service actions - [Interact with ServiceNow records](/guides/all/interact-with-servicenow.md): Learn how to interact with ServiceNow records and delete ServiceNow incidents using Port's self-service actions #### keep-azure-catalog-upto-date-with-incremental-syncing Learn how to keep your Azure catalog up to date by syncing only changed resources into Port using GitHub Actions or a local script. - [Keep your Azure catalog up to date with incremental syncing](/guides/all/keep-azure-catalog-upto-date-with-incremental-syncing.md): Learn how to keep your Azure catalog up to date by syncing only changed resources into Port using GitHub Actions or a local script. #### let-developers-enrich-services-using-gitops Learn how developers can enrich repositories using GitOps in Port, enabling efficient and automated service management. - [Enrich services using GitOps](/guides/all/let-developers-enrich-services-using-gitops.md): Learn how developers can enrich repositories using GitOps in Port, enabling efficient and automated service management. #### lock-and-unlock-services-in-port Learn how to implement comprehensive service locking in Port with self-service actions and automated deployment checks in GitHub workflows. - [Lock and unlock services](/guides/all/lock-and-unlock-services-in-port.md): Learn how to implement comprehensive service locking in Port with self-service actions and automated deployment checks in GitHub workflows. #### manage-ai-instructions Learn how to centralize AI instructions in Port and automatically sync them to GitHub repositories, ensuring consistency and governance across your development teams. - [Manage AI Instructions with Port](/guides/all/manage-ai-instructions.md): Learn how to centralize AI instructions in Port and automatically sync them to GitHub repositories, ensuring consistency and governance across your development teams. #### manage-and-surface-technical-docs Learn how to manage and surface technical documentation in Port by ingesting markdown from a Git source, displaying it on service or repository pages, and optionally adding the TechDocs plugin. - [Manage and surface technical documentation in Port](/guides/all/manage-and-surface-technical-docs.md): Learn how to manage and surface technical documentation in Port by ingesting markdown from a Git source, displaying it on service or repository pages, and optionally adding the TechDocs plugin. #### manage-and-visualize-acm-certificates Learn how to monitor and manage your AWS ACM certificates using self-service actions in Port. - [Manage and visualize your ACM certificates](/guides/all/manage-and-visualize-acm-certificates.md): Learn how to monitor and manage your AWS ACM certificates using self-service actions in Port. #### manage-and-visualize-aws-autoscaling-groups Learn how to manage your AWS Auto Scaling Groups using self-service actions in Port. - [Manage your AWS Auto Scaling Groups](/guides/all/manage-and-visualize-aws-autoscaling-groups.md): Learn how to manage your AWS Auto Scaling Groups using self-service actions in Port. #### manage-and-visualize-aws-sqs-queues Learn how to monitor and manage your AWS SQS queues using dashboards and self-service actions in Port. - [Manage and visualize your AWS SQS queues](/guides/all/manage-and-visualize-aws-sqs-queues.md): Learn how to monitor and manage your AWS SQS queues using dashboards and self-service actions in Port. #### manage-and-visualize-azure-virtual-machines Learn how to monitor and manage your Azure Virtual Machines using self-service actions in Port. - [Manage your Azure Virtual Machines](/guides/all/manage-and-visualize-azure-virtual-machines.md): Learn how to monitor and manage your Azure Virtual Machines using self-service actions in Port. #### manage-and-visualize-azure-web-apps Learn how to monitor and manage your Azure web apps using self-service actions in Port. - [Manage and visualize your Azure web apps](/guides/all/manage-and-visualize-azure-web-apps.md): Learn how to monitor and manage your Azure web apps using self-service actions in Port. #### manage-and-visualize-ecs-tasks Learn how to monitor and manage your AWS ECS tasks and services using dashboards and self-service actions in Port. - [Manage and visualize your ECS tasks](/guides/all/manage-and-visualize-ecs-tasks.md): Learn how to monitor and manage your AWS ECS tasks and services using dashboards and self-service actions in Port. #### manage-and-visualize-gcp-compute-engine-instances Learn how to monitor and manage your GCP Compute Engine instances using dashboards and self-service actions in Port. - [Manage and visualize your GCP Compute Engine instances](/guides/all/manage-and-visualize-gcp-compute-engine-instances.md): Learn how to monitor and manage your GCP Compute Engine instances using dashboards and self-service actions in Port. #### manage-and-visualize-jira-issues Learn how to monitor and manage your Jira issues using dashboards and self-service actions in Port. - [Manage and visualize your Jira issues](/guides/all/manage-and-visualize-jira-issues.md): Learn how to monitor and manage your Jira issues using dashboards and self-service actions in Port. #### manage-and-visualize-pagerduty-incidents Learn how to manage your PagerDuty incidents with self-service actions and monitor them using dashboards in Port. - [Manage and visualize your PagerDuty incidents](/guides/all/manage-and-visualize-pagerduty-incidents.md): Learn how to manage your PagerDuty incidents with self-service actions and monitor them using dashboards in Port. #### manage-and-visualize-your-launchdarkly-feature-flags Learn how to manage and visualize your LaunchDarkly feature flags using dashboards and self-service actions in Port. - [Manage and visualize your LaunchDarkly feature flags](/guides/all/manage-and-visualize-your-launchdarkly-feature-flags.md): Learn how to manage and visualize your LaunchDarkly feature flags using dashboards and self-service actions in Port. #### manage-clusters Master the management of clusters in Port with this guide, ensuring efficient and scalable infrastructure operations. - [Create and manage Kubernetes clusters](/guides/all/manage-clusters.md): Master the management of clusters in Port with this guide, ensuring efficient and scalable infrastructure operations. #### manage-ec2-instances Learn how to manage EC2 instances in Port, ensuring optimal performance and efficient cloud resource management. - [Manage An AWS EC2 Instance](/guides/all/manage-ec2-instances.md): Learn how to manage EC2 instances in Port, ensuring optimal performance and efficient cloud resource management. #### manage-firehydrant-incidents Learn how to create or trigger FireHydrant incidents from Port using synced webhooks or GitHub workflows, and keep your catalog in sync. - [Manage FireHydrant incidents](/guides/all/manage-firehydrant-incidents.md): Learn how to create or trigger FireHydrant incidents from Port using synced webhooks or GitHub workflows, and keep your catalog in sync. #### manage-kubernetes-namespaces Learn how to manage Kubernetes namespaces through Port with automated workflows, approval processes, and chained self-service actions. - [Manage Kubernetes namespaces](/guides/all/manage-kubernetes-namespaces.md): Learn how to manage Kubernetes namespaces through Port with automated workflows, approval processes, and chained self-service actions. #### manage-mcp-registry Learn how to build and manage a centralized MCP server registry in Port for governance, discovery, and team collaboration - [Manage MCP Server Registry](/guides/all/manage-mcp-registry.md): Learn how to build and manage a centralized MCP server registry in Port for governance, discovery, and team collaboration #### manage-pagerduty-on-call-schedules Learn how to manage and track PagerDuty on-call schedules across teams and services with dashboards and self-service actions. - [Manage PagerDuty on-call schedules](/guides/all/manage-pagerduty-on-call-schedules.md): Learn how to manage and track PagerDuty on-call schedules across teams and services with dashboards and self-service actions. #### manage-pull-requests Learn how to effectively manage pull requests in Port, streamlining code reviews and collaboration processes. - [Manage GitHub Pull Requests](/guides/all/manage-pull-requests.md): Learn how to effectively manage pull requests in Port, streamlining code reviews and collaboration processes. #### manage-resources-using-k8s-crds Learn how to manage resources using Kubernetes CRDs in Port, enabling customized and efficient resource handling. - [Manage resources using Kubernetes CRDs](/guides/all/manage-resources-using-k8s-crds.md): Learn how to manage resources using Kubernetes CRDs in Port, enabling customized and efficient resource handling. #### manage-your-eks-clusters Learn how to manage your AWS EKS clusters using self-service actions in Port. - [Manage your EKS clusters](/guides/all/manage-your-eks-clusters.md): Learn how to manage your AWS EKS clusters using self-service actions in Port. #### manage-your-kubernetes-deployment Learn how to monitor and manage your Kubernetes deployments and pods using self-service actions in Port. - [Manage your Kubernetes deployments](/guides/all/manage-your-kubernetes-deployment.md): Learn how to monitor and manage your Kubernetes deployments and pods using self-service actions in Port. #### map-git-users-to-port-accounts Automatically map GitHub, GitLab, and Azure DevOps users to their Port user accounts for seamless integration - [Map Git users to Port user accounts](/guides/all/map-git-users-to-port-accounts.md): Automatically map GitHub, GitLab, and Azure DevOps users to their Port user accounts for seamless integration #### map-hibob-users-to-port-accounts Ingest and map HiBob users to their Port user accounts for seamless integration - [Ingest and map HiBob users to Port user accounts](/guides/all/map-hibob-users-to-port-accounts.md): Ingest and map HiBob users to their Port user accounts for seamless integration #### map-jira-users-to-port-accounts Automatically map Jira users to their Port user accounts for seamless integration - [Map Jira users to Port user accounts](/guides/all/map-jira-users-to-port-accounts.md): Automatically map Jira users to their Port user accounts for seamless integration #### map-prs-to-services-in-monorepo Automatically map pull requests to services in a monorepo using file path analysis - [Map PRs to services in a monorepo](/guides/all/map-prs-to-services-in-monorepo.md): Automatically map pull requests to services in a monorepo using file path analysis #### map-servicenow-users-to-port-accounts Ingest and map ServiceNow users to their Port user accounts for seamless integration - [Ingest and map ServiceNow users to Port user accounts](/guides/all/map-servicenow-users-to-port-accounts.md): Ingest and map ServiceNow users to their Port user accounts for seamless integration #### map-slack-users-to-port-accounts Ingest and map Slack users to their Port user accounts for seamless integration - [Ingest and map Slack users to Port user accounts](/guides/all/map-slack-users-to-port-accounts.md): Ingest and map Slack users to their Port user accounts for seamless integration #### measure-ai-feedback Learn how to collect and analyze feedback on AI tools using Port actions, automations, and AI agents to measure effectiveness and guide adoption decisions. - [Measure AI feedback](/guides/all/measure-ai-feedback.md): Learn how to collect and analyze feedback on AI tools using Port actions, automations, and AI agents to measure effectiveness and guide adoption decisions. #### measure-and-track-delivery-performance Learn how to measure and track delivery performance as part of your engineering intelligence framework using key metrics like PR cycle time, PR throughput, deployment frequency, and overdue PRs. - [Gain visibility into delivery performance](/guides/all/measure-and-track-delivery-performance.md): Learn how to measure and track delivery performance as part of your engineering intelligence framework using key metrics like PR cycle time, PR throughput, deployment frequency, and overdue PRs. #### measure-pipeline-reliability Learn how to measure CI/CD pipeline reliability at service and team level, including failure rates, failure trends, and failing pipeline identification, using Port's integrations and dashboards. - [Measure pipeline reliability](/guides/all/measure-pipeline-reliability.md): Learn how to measure CI/CD pipeline reliability at service and team level, including failure rates, failure trends, and failing pipeline identification, using Port's integrations and dashboards. #### measure-pr-delivery-metrics Learn how to measure PR and MR delivery metrics at service and team level, including cycle time, throughput, stale PRs/MRs, and reviewer coverage, using Port's GitHub Ocean or GitLab integration and dashboards. - [Measure PR delivery metrics](/guides/all/measure-pr-delivery-metrics.md): Learn how to measure PR and MR delivery metrics at service and team level, including cycle time, throughput, stale PRs/MRs, and reviewer coverage, using Port's GitHub Ocean or GitLab integration and dashboards. #### measure-pull-request-standards Implement working agreements and measure pull request standards using Port scorecards and aggregation properties, tracking team performance based on PR metrics like review time, approval count, and merge latency. - [Measuring pull request standards](/guides/all/measure-pull-request-standards.md): Implement working agreements and measure pull request standards using Port scorecards and aggregation properties, tracking team performance based on PR metrics like review time, approval count, and merge latency. #### measure-reliability-and-stability Learn how to measure reliability and stability of your delivery pipeline by tracking workflow failure rates and PRs blocked by failing CI/CD using Port's GitHub integration. - [Measure delivery reliability and stability](/guides/all/measure-reliability-and-stability.md): Learn how to measure reliability and stability of your delivery pipeline by tracking workflow failure rates and PRs blocked by failing CI/CD using Port's GitHub integration. #### measure-sprint-health-with-jira Learn how to measure and visualize sprint health at the team level using Jira sprint data, aggregation properties, dashboards, and scorecards in Port. - [Measure sprint health with Jira](/guides/all/measure-sprint-health-with-jira.md): Learn how to measure and visualize sprint health at the team level using Jira sprint data, aggregation properties, dashboards, and scorecards in Port. #### measure-standards Learn how to measure standards compliance across your software delivery, tracking quality, security, and organizational alignment using Port's GitHub integration and scorecards. - [Track standards adherence](/guides/all/measure-standards.md): Learn how to measure standards compliance across your software delivery, tracking quality, security, and organizational alignment using Port's GitHub integration and scorecards. #### migrate-project-from-bibucket-to-github Migrate repositories from Bitbucket to GitHub using Port self-service actions and GitHub Actions - [Migrate repositories from Bitbucket to GitHub using Port self-service actions](/guides/all/migrate-project-from-bibucket-to-github.md): Migrate repositories from Bitbucket to GitHub using Port self-service actions and GitHub Actions #### migrate-project-from-github-to-gitlab Migrate repositories from GitHub to GitLab using Port self-service actions and GitHub Actions - [Migrate repositories from GitHub to GitLab using Port self-service actions](/guides/all/migrate-project-from-github-to-gitlab.md): Migrate repositories from GitHub to GitLab using Port self-service actions and GitHub Actions #### monitor-integrations Learn how to monitor and manage your Port Ocean integrations for improved visibility and performance tracking. - [Monitor integrations](/guides/all/monitor-integrations.md): Learn how to monitor and manage your Port Ocean integrations for improved visibility and performance tracking. #### move-port-configurations-between-environments-with-port-ai-and-github-mcp Back up Port blueprints and actions to GitHub from one environment and import them into another environment using Port AI and GitHub MCP. - [Sync Port configurations between environments using Port AI and MCP](/guides/all/move-port-configurations-between-environments-with-port-ai-and-github-mcp.md): Back up Port blueprints and actions to GitHub from one environment and import them into another environment using Port AI and GitHub MCP. #### notify-users-upon-approval-of-action Learn how to automatically notify users in Slack when their self-service actions in Port are approved or declined - [Notify users upon approval of self-service actions](/guides/all/notify-users-upon-approval-of-action.md): Learn how to automatically notify users in Slack when their self-service actions in Port are approved or declined #### nudge-pr-reviewers Learn how to nudge PR reviewers in Port, ensuring timely code reviews and efficient project progression. - [Nudge Pull Request Reviewers](/guides/all/nudge-pr-reviewers.md): Learn how to nudge PR reviewers in Port, ensuring timely code reviews and efficient project progression. #### onboard-developers-from-internal-docs-using-port-mcp Set up onboarding guidance in Port and Cursor using Port MCP, a connected Notion MCP connector, and a custom onboarding skill. - [Onboard developers using internal docs and Port MCP](/guides/all/onboard-developers-from-internal-docs-using-port-mcp.md): Set up onboarding guidance in Port and Cursor using Port MCP, a connected Notion MCP connector, and a custom onboarding skill. #### open-github-issue Learn how to create a GitHub issue in Port, streamlining issue categorization and tracking. - [Create a GitHub issue](/guides/all/open-github-issue.md): Learn how to create a GitHub issue in Port, streamlining issue categorization and tracking. #### open-jira-issue-with-automatic-label Learn how to open Jira issues with automatic labels in Port, streamlining issue categorization and tracking. - [Open Jira issue with automatic label](/guides/all/open-jira-issue-with-automatic-label.md): Learn how to open Jira issues with automatic labels in Port, streamlining issue categorization and tracking. #### open-linear-issue Learn how to create a Linear issue in Port, streamlining issue categorization and tracking. - [Create a Linear issue](/guides/all/open-linear-issue.md): Learn how to create a Linear issue in Port, streamlining issue categorization and tracking. #### open-slack-channel Learn how to open a Slack channel in Port, enhancing team collaboration and communication with this easy guide. - [Create Slack channel for Incident Management](/guides/all/open-slack-channel.md): Learn how to open a Slack channel in Port, enhancing team collaboration and communication with this easy guide. #### orchestrate-incident-response-with-ai Learn how to implement an AI-powered incident response system that automatically orchestrates Slack channels, Zoom meetings, Jira tickets, and team notifications when incidents occur. - [Orchestrate incident response with AI](/guides/all/orchestrate-incident-response-with-ai.md): Learn how to implement an AI-powered incident response system that automatically orchestrates Slack channels, Zoom meetings, Jira tickets, and team notifications when incidents occur. #### owasp-top-10-scorecard Build an OWASP Top 10 security scorecard in Port using vulnerability data from Snyk. - [Build an OWASP Top 10 Scorecard](/guides/all/owasp-top-10-scorecard.md): Build an OWASP Top 10 security scorecard in Port using vulnerability data from Snyk. #### promote-to-production Create a self-service action that promotes a staging image to production using a GitHub Actions workflow and GitOps pull requests. For the Port Workflows (beta) approach, see the "Promote to production workflow" guide. - [Promote a deployment to production using GitHub Actions](/guides/all/promote-to-production.md): Create a self-service action that promotes a staging image to production using a GitHub Actions workflow and GitOps pull requests. For the Port Workflows (beta) approach, see the "Promote to production workflow" guide. #### promote-to-production-workflow Build a "Promote to production" flow using Port Workflows (beta) and Port AI, with safety checks, deployment tracking, automated PagerDuty incident creation, and team notifications. For the GitHub Actions self-service action approach, see the "Promote a deployment to production using GitHub Actions" guide. - [Promote to production workflow](/guides/all/promote-to-production-workflow.md): Build a "Promote to production" flow using Port Workflows (beta) and Port AI, with safety checks, deployment tracking, automated PagerDuty incident creation, and team notifications. For the GitHub Actions self-service action approach, see the "Promote a deployment to production using GitHub Actions" guide. #### pull-github-metrics-and-build-visualizations Learn how to pull GitHub metrics data and build comprehensive visualizations in Port to track engineering performance. - [Pull GitHub metrics and build visualizations](/guides/all/pull-github-metrics-and-build-visualizations.md): Learn how to pull GitHub metrics data and build comprehensive visualizations in Port to track engineering performance. #### push-image-to-ecr Learn how to push images to ECR in Port, ensuring efficient container management and streamlined deployments. - [Build ECR image](/guides/all/push-image-to-ecr.md): Learn how to push images to ECR in Port, ensuring efficient container management and streamlined deployments. #### query-dora-metrics-using-port-mcp Learn how to query DORA metrics using Port's MCP server with natural language commands in your IDE, enabling data-driven engineering insights without leaving your development environment. - [Query DORA metrics using Port MCP](/guides/all/query-dora-metrics-using-port-mcp.md): Learn how to query DORA metrics using Port's MCP server with natural language commands in your IDE, enabling data-driven engineering insights without leaving your development environment. #### remediate-ci-cd-failures-with-port-cursor-workflow Automatically remediate failed CI workflow runs by orchestrating Port, Cursor automations, and Slack notifications. - [Remediate CI/CD failures with Port AI & Cursor](/guides/all/remediate-ci-cd-failures-with-port-cursor-workflow.md): Automatically remediate failed CI workflow runs by orchestrating Port, Cursor automations, and Slack notifications. #### remediate-vulnerability-with-ai Use Port AI agents with Claude Code to enrich security vulnerabilities and trigger automated fixes - [Remediate vulnerabilities with AI](/guides/all/remediate-vulnerability-with-ai.md): Use Port AI agents with Claude Code to enrich security vulnerabilities and trigger automated fixes #### remediate-vulnerability-with-n8n-and-port Use Port as a context lake for n8n workflows to enrich vulnerability management with service metadata, ownership, and dependencies - [Remediate security vulnerability with n8n and Port AI](/guides/all/remediate-vulnerability-with-n8n-and-port.md): Use Port as a context lake for n8n workflows to enrich vulnerability management with service metadata, ownership, and dependencies #### report-a-bug Learn how to report a bug in Port, ensuring prompt issue resolution and improving overall platform reliability. - [Report a bug](/guides/all/report-a-bug.md): Learn how to report a bug in Port, ensuring prompt issue resolution and improving overall platform reliability. #### resolve-incident Learn how to resolve incidents in Port, ensuring quick and effective issue management for seamless operations. - [Resolve an Incident in PagerDuty](/guides/all/resolve-incident.md): Learn how to resolve incidents in Port, ensuring quick and effective issue management for seamless operations. #### restart-argocd-app Learn how to restart an ArgoCD app in Port, ensuring smooth application operations and minimal downtime. - [Restart Argo CD Application](/guides/all/restart-argocd-app.md): Learn how to restart an ArgoCD app in Port, ensuring smooth application operations and minimal downtime. #### rollback-argocd-deployment Create a self-service action in Port that rolls back an ArgoCD deployment using a GitHub Actions workflow, with manual approval for production environments. - [Roll back an ArgoCD deployment via GitHub Actions](/guides/all/rollback-argocd-deployment.md): Create a self-service action in Port that rolls back an ArgoCD deployment using a GitHub Actions workflow, with manual approval for production environments. #### route-scorecard-failures-to-jira-issues Turn failing scorecard rules into routed Jira issues with Port automations and AI agents. - [Route scorecard failures to Jira issues with AI](/guides/all/route-scorecard-failures-to-jira-issues.md): Turn failing scorecard rules into routed Jira issues with Port automations and AI agents. #### s3-bucket Learn how to manage S3 buckets in Port, ensuring efficient cloud storage organization and access management. - [Manage an S3 Bucket Lifecycle](/guides/all/s3-bucket.md): Learn how to manage S3 buckets in Port, ensuring efficient cloud storage organization and access management. #### s3-using-webhook Learn how to manage S3 buckets using webhooks in Port, enabling automated and efficient cloud operations. - [Create an S3 bucket using Self-Service Actions](/guides/all/s3-using-webhook.md): Learn how to manage S3 buckets using webhooks in Port, enabling automated and efficient cloud operations. #### scaffold-a-new-service Learn how to scaffold a new service in Port with this guide, ensuring efficient setup and streamlined development. - [Scaffold a new service](/guides/all/scaffold-a-new-service.md): Learn how to scaffold a new service in Port with this guide, ensuring efficient setup and streamlined development. #### self-heal-scorecards-with-ai Learn how to use Port's AI capabilities to detect scorecard degradation and automatically use a coding agent like GitHub Copilot to fix it. - [Auto-fix services when scorecards degrade](/guides/all/self-heal-scorecards-with-ai.md): Learn how to use Port's AI capabilities to detect scorecard degradation and automatically use a coding agent like GitHub Copilot to fix it. #### send-slack-message-to-user Learn how to send Slack messages to users using Port's Slack app and automations - [Send Slack messages using Port's Slack app and automations](/guides/all/send-slack-message-to-user.md): Learn how to send Slack messages to users using Port's Slack app and automations #### send-typeform-survey-results-to-port Learn how to send TypeForm survey response to Port - [Send TypeForm survey results to Port](/guides/all/send-typeform-survey-results-to-port.md): Learn how to send TypeForm survey response to Port #### set-up-deployments-dora-gitlab The Create & track DORA metrics in your portal guide walks you through the installation of the DORA metrics experience in Port, using GitHub and PagerDuty as the default deployment and incident methods. - [Set up deployments using GitLab merge requests or jobs](/guides/all/set-up-deployments-dora-gitlab.md): The Create & track DORA metrics in your portal guide walks you through the installation of the DORA metrics experience in Port, using GitHub and PagerDuty as the default deployment and incident methods. #### setup-branch-protection-rules Learn how to drive DevOps and DevSecOps governance in your organization by enforcing branch protection rules using scorecards - [Enforce branch protection rules with scorecards](/guides/all/setup-branch-protection-rules.md): Learn how to drive DevOps and DevSecOps governance in your organization by enforcing branch protection rules using scorecards #### setup-delivery-performance-scorecard Set up Delivery Performance scorecards in Port to grade services, teams, groups, and organizations on PR/MR throughput, cycle time, and stale PR/MR management using Bronze, Silver, and Gold maturity levels. - [Set up delivery performance scorecards](/guides/all/setup-delivery-performance-scorecard.md): Set up Delivery Performance scorecards in Port to grade services, teams, groups, and organizations on PR/MR throughput, cycle time, and stale PR/MR management using Bronze, Silver, and Gold maturity levels. #### setup-dora-metrics Learn how to measure DORA metrics at service and team level, including deployment frequency, lead time for changes, change failure rate, and mean time to recovery, using Port's GitHub integration and dashboards. - [Track DORA metrics](/guides/all/setup-dora-metrics.md): Learn how to measure DORA metrics at service and team level, including deployment frequency, lead time for changes, change failure rate, and mean time to recovery, using Port's GitHub integration and dashboards. #### setup-dora-metrics-jira The Create & track DORA metrics in your portal guide walks you through installing the DORA metrics experience in Port, using GitHub and PagerDuty as the default deployment and incident methods. - [Set up deployments and incidents using Jira issues](/guides/all/setup-dora-metrics-jira.md): The Create & track DORA metrics in your portal guide walks you through installing the DORA metrics experience in Port, using GitHub and PagerDuty as the default deployment and incident methods. #### setup-dora-scorecards Set up DORA scorecards in Port to grade services and teams on deployment frequency, lead time for changes, change failure rate, and mean time to recovery using Bronze, Silver, and Gold maturity levels aligned with DORA benchmarks. - [Set up DORA scorecards](/guides/all/setup-dora-scorecards.md): Set up DORA scorecards in Port to grade services and teams on deployment frequency, lead time for changes, change failure rate, and mean time to recovery using Bronze, Silver, and Gold maturity levels aligned with DORA benchmarks. #### setup-engineering-intelligence-data-model Set up the foundational data model for Engineering Intelligence in Port. Create blueprints for organizations, teams, services, and repositories across GitHub, GitLab, and Azure DevOps. - [Create foundational Engineering Intelligence data model](/guides/all/setup-engineering-intelligence-data-model.md): Set up the foundational data model for Engineering Intelligence in Port. Create blueprints for organizations, teams, services, and repositories across GitHub, GitLab, and Azure DevOps. #### setup-incident-manager-ai-agent Set up an Incident Manager AI agent to help developers track and manage incidents efficiently - [Set up the Incident Manager AI agent](/guides/all/setup-incident-manager-ai-agent.md): Set up an Incident Manager AI agent to help developers track and manage incidents efficiently #### setup-pci-dss-code-compliance Build a comprehensive PCI DSS Code Security Scorecard in Port - [PCI DSS code security scorecard](/guides/all/setup-pci-dss-code-compliance.md): Build a comprehensive PCI DSS Code Security Scorecard in Port #### setup-pipeline-reliability-scorecard Set up Pipeline Reliability scorecards in Port to grade services, teams, groups, and organizations on CI/CD workflow failure rates and reliability trends using Bronze, Silver, and Gold maturity levels. - [Set up pipeline reliability scorecards](/guides/all/setup-pipeline-reliability-scorecard.md): Set up Pipeline Reliability scorecards in Port to grade services, teams, groups, and organizations on CI/CD workflow failure rates and reliability trends using Bronze, Silver, and Gold maturity levels. #### setup-platform-request-triage-ai-agent Set up a Platform Request Triage AI agent to help developers submit and track requests to the platform team. - [Set up the Platform Request Triage AI agent](/guides/all/setup-platform-request-triage-ai-agent.md): Set up a Platform Request Triage AI agent to help developers submit and track requests to the platform team. #### setup-portal-announcements Learn how to track SLOs and SLIs for your services using Port - [Set up announcements in your portal](/guides/all/setup-portal-announcements.md): Learn how to track SLOs and SLIs for your services using Port #### setup-pr-enricher-ai-agent Set up a Pull Request Enricher AI agent to automatically comment on pull requests with additional context - [Set up the Pull Request Enricher AI agent](/guides/all/setup-pr-enricher-ai-agent.md): Set up a Pull Request Enricher AI agent to automatically comment on pull requests with additional context #### setup-production-readiness-scorecard Set up a Service Production Readiness scorecard in Port to grade services on documentation, ownership, repository hygiene, and activity using Bronze, Silver, and Gold maturity levels. - [Set up a service production readiness scorecard](/guides/all/setup-production-readiness-scorecard.md): Set up a Service Production Readiness scorecard in Port to grade services on documentation, ownership, repository hygiene, and activity using Bronze, Silver, and Gold maturity levels. #### setup-service-explorer-ai-agent Set up a Service Explorer AI agent with MCP to help developers discover services, understand ownership, and access documentation for quick onboarding - [Set up the Service Explorer AI agent](/guides/all/setup-service-explorer-ai-agent.md): Set up a Service Explorer AI agent with MCP to help developers discover services, understand ownership, and access documentation for quick onboarding #### setup-slack-reminders Learn how to set up Slack reminders in Port, ensuring timely notifications and improved team productivity. - [Slack reminders for scorecards](/guides/all/setup-slack-reminders.md): Learn how to set up Slack reminders in Port, ensuring timely notifications and improved team productivity. #### setup-task-manager-ai-agent Set up a Task Manager AI agent to help developers track and manage tasks efficiently - [Set up the Task Manager AI agent](/guides/all/setup-task-manager-ai-agent.md): Set up a Task Manager AI agent to help developers track and manage tasks efficiently #### smart-pr-reviewer-assignment-using-port-ai Automatically assign qualified PR reviewers using Port AI, CODEOWNERS, ownership data, and capacity constraints. - [Smart PR reviewer assignment using AI](/guides/all/smart-pr-reviewer-assignment-using-port-ai.md): Automatically assign qualified PR reviewers using Port AI, CODEOWNERS, ownership data, and capacity constraints. #### streamline-iac-with-ai Use Port AI agents with AI coding assistants to streamline Infrastructure as Code (IaC) by automatically provisioning cloud resources like S3 buckets - [Streamline IaC with AI](/guides/all/streamline-iac-with-ai.md): Use Port AI agents with AI coding assistants to streamline Infrastructure as Code (IaC) by automatically provisioning cloud resources like S3 buckets #### surface-resource-actions-from-jira-with-ai Use Port's AI agent to analyze Jira issues and surface relevant self-service actions for cloud resources and permissions. - [Surface resource actions from Jira with AI](/guides/all/surface-resource-actions-from-jira-with-ai.md): Use Port's AI agent to analyze Jira issues and surface relevant self-service actions for cloud resources and permissions. #### sync-argocd-app Learn how to sync an ArgoCD app in Port, ensuring your deployments are up-to-date and accurately reflected. - [Synchronize Argo CD Application](/guides/all/sync-argocd-app.md): Learn how to sync an ArgoCD app in Port, ensuring your deployments are up-to-date and accurately reflected. #### sync-port-properties-to-github-custom-properties Send Port entity property values to GitHub repository custom properties using automations and a GitHub workflow. - [Sync Port properties to GitHub custom properties](/guides/all/sync-port-properties-to-github-custom-properties.md): Send Port entity property values to GitHub repository custom properties using automations and a GitHub workflow. #### sync-service-entities-to-incident-io Learn how to sync your Port service entities into incident.io catalog for better visibility. - [Sync Port services to incident.io](/guides/all/sync-service-entities-to-incident-io.md): Learn how to sync your Port service entities into incident.io catalog for better visibility. #### terraform-plan-and-apply-aws-resource Learn how to use Terraform to plan and apply AWS resources in Port, ensuring efficient infrastructure management and deployment. - [Provision Cloud Resource using Terraform Plan and Apply](/guides/all/terraform-plan-and-apply-aws-resource.md): Learn how to use Terraform to plan and apply AWS resources in Port, ensuring efficient infrastructure management and deployment. #### track-ai-adoption-and-impact Learn how to track AI adoption across engineering teams and assess the impact of AI usage on delivery metrics like PR throughput and cycle time using Port's GitHub integration. - [Track AI adoption and impact](/guides/all/track-ai-adoption-and-impact.md): Learn how to track AI adoption across engineering teams and assess the impact of AI usage on delivery metrics like PR throughput and cycle time using Port's GitHub integration. #### track-ai-coding-assistants-costs Build a unified dashboard to analyze and compare AI coding tool costs across Cursor, Claude, and GitHub Copilot using data already ingested into Port. - [Track AI coding assistants costs](/guides/all/track-ai-coding-assistants-costs.md): Build a unified dashboard to analyze and compare AI coding tool costs across Cursor, Claude, and GitHub Copilot using data already ingested into Port. #### track-ai-driven-pull-requests Learn how to track and monitor AI-driven pull requests in your development workflow using Port's software catalog and automation capabilities. - [Track AI-driven pull requests](/guides/all/track-ai-driven-pull-requests.md): Learn how to track and monitor AI-driven pull requests in your development workflow using Port's software catalog and automation capabilities. #### track-and-show-mtbf-for-services Track Mean Time Between Failures (MTBF) for your Pagerduty services to measure reliability and identify improvement opportunities - [Track and show MTBF for services](/guides/all/track-and-show-mtbf-for-services.md): Track Mean Time Between Failures (MTBF) for your Pagerduty services to measure reliability and identify improvement opportunities #### track-gitlab-project-maturity-with-scorecards Learn how to drive DevOps and DevSecOps governance in your organization by enforcing code maturity standards using scorecards with GitLab file search - [Enforce code maturity with GitLab file search](/guides/all/track-gitlab-project-maturity-with-scorecards.md): Learn how to drive DevOps and DevSecOps governance in your organization by enforcing code maturity standards using scorecards with GitLab file search #### track-health-of-jira-projects Learn how to enforce project maturity and operational readiness by tracking Jira issue hygiene, compliance risks, and incident response with Port scorecards. - [Set up Jira project health scorecards](/guides/all/track-health-of-jira-projects.md): Learn how to enforce project maturity and operational readiness by tracking Jira issue hygiene, compliance risks, and incident response with Port scorecards. #### track-leaked-github-secrets-in-port Learn how to send leaked application secrets from GitHub to Port using Gitleaks - [Track leaked GitHub secrets in Port](/guides/all/track-leaked-github-secrets-in-port.md): Learn how to send leaked application secrets from GitHub to Port using Gitleaks #### track-slos-and-slis-for-services Learn how to track SLOs and SLIs for your services using Port - [Track SLOs and SLIs for your services](/guides/all/track-slos-and-slis-for-services.md): Learn how to track SLOs and SLIs for your services using Port #### track-team-work-allocation-with-jira Learn how to measure and visualize work allocation across Roadmap, Tech Debt, and Support categories at the team level using Jira labels and Port dashboards. - [Track team work allocation with Jira](/guides/all/track-team-work-allocation-with-jira.md): Learn how to measure and visualize work allocation across Roadmap, Tech Debt, and Support categories at the team level using Jira labels and Port dashboards. #### triage-incidents-with-ai Triage incidents with AI for severity, business impact, affected services, and response team recommendations. - [Triage incidents with AI](/guides/all/triage-incidents-with-ai.md): Triage incidents with AI for severity, business impact, affected services, and response team recommendations. #### triage-incidents-with-mcp Triage incidents using AI, Sentry MCP, GitHub MCP, and Slack — fetch live errors, query code context, and post a structured root-cause summary directly from Port AI. - [Triage incidents using external MCP tools](/guides/all/triage-incidents-with-mcp.md): Triage incidents using AI, Sentry MCP, GitHub MCP, and Slack — fetch live errors, query code context, and post a structured root-cause summary directly from Port AI. #### triage-tickets-to-coding-agents Learn how to implement an AI-powered triage system that automatically evaluates Jira tickets, enriches them with missing context, and ensures only well-defined tasks reach your coding agents. - [Improve specifications with Port AI](/guides/all/triage-tickets-to-coding-agents.md): Learn how to implement an AI-powered triage system that automatically evaluates Jira tickets, enriches them with missing context, and ensures only well-defined tasks reach your coding agents. #### trigger-claude-code-from-port Learn how to trigger Claude Code from Port to enable AI-powered coding assistance in your development workflow while tracking its usage. - [Trigger Claude Code from Port](/guides/all/trigger-claude-code-from-port.md): Learn how to trigger Claude Code from Port to enable AI-powered coding assistance in your development workflow while tracking its usage. #### trigger-datadog-incident Learn how to trigger a Datadog incident in Port, ensuring effective monitoring and prompt issue response. - [Trigger Datadog Incident](/guides/all/trigger-datadog-incident.md): Learn how to trigger a Datadog incident in Port, ensuring effective monitoring and prompt issue response. #### trigger-gemini-assistant-from-port Learn how to trigger Google Gemini Assistant from Port to enable AI-powered coding assistance in your development workflow while tracking its execution. - [Trigger Google Gemini Assistant from Port](/guides/all/trigger-gemini-assistant-from-port.md): Learn how to trigger Google Gemini Assistant from Port to enable AI-powered coding assistance in your development workflow while tracking its execution. #### trigger-github-copilot-from-port Learn how to set up GitHub Copilot triggers from Port to enable AI-powered coding assistance in your development workflow. - [Trigger GitHub Copilot from Port](/guides/all/trigger-github-copilot-from-port.md): Learn how to set up GitHub Copilot triggers from Port to enable AI-powered coding assistance in your development workflow. #### trigger-servicenow-incident Learn how to trigger a ServiceNow incident in Port, ensuring prompt issue resolution and effective incident management. - [Trigger ServiceNow Incident](/guides/all/trigger-servicenow-incident.md): Learn how to trigger a ServiceNow incident in Port, ensuring prompt issue resolution and effective incident management. #### trigger-spacelift-stack Learn how to trigger a Spacelift stack in Port to automate infrastructure workflows - [Trigger a Spacelift stack](/guides/all/trigger-spacelift-stack.md): Learn how to trigger a Spacelift stack in Port to automate infrastructure workflows #### verify-service Learn how to keep your service catalog data up to date with Port's automation and self-service features - [Remind service owners to update their catalog data](/guides/all/verify-service.md): Learn how to keep your service catalog data up to date with Port's automation and self-service features #### visualize-and-manage-aws-ec2-instances Learn how to monitor and manage your AWS EC2 instances using dashboards and self-service actions in Port. - [Visualize and manage your EC2 instances](/guides/all/visualize-and-manage-aws-ec2-instances.md): Learn how to monitor and manage your AWS EC2 instances using dashboards and self-service actions in Port. #### visualize-and-manage-azure-devops-deployments Learn how to monitor and manage your Azure DevOps deployments using dashboards and self-service actions in Port. - [Visualize and manage your Azure DevOps deployments](/guides/all/visualize-and-manage-azure-devops-deployments.md): Learn how to monitor and manage your Azure DevOps deployments using dashboards and self-service actions in Port. #### visualize-and-manage-github-deployments Learn how to monitor and manage your GitHub deployments using dashboards and self-service actions in Port. - [Visualize and manage your GitHub deployments](/guides/all/visualize-and-manage-github-deployments.md): Learn how to monitor and manage your GitHub deployments using dashboards and self-service actions in Port. #### visualize-and-manage-gitlab-deployments Learn how to monitor and manage your GitLab deployments using dashboards and self-service actions in Port. - [Visualize and manage your GitLab deployments](/guides/all/visualize-and-manage-gitlab-deployments.md): Learn how to monitor and manage your GitLab deployments using dashboards and self-service actions in Port. #### visualize-and-manage-servicenow-incidents Learn how to monitor and manage your ServiceNow incidents using dashboards and self-service actions in Port. - [Visualize and manage your ServiceNow incidents](/guides/all/visualize-and-manage-servicenow-incidents.md): Learn how to monitor and manage your ServiceNow incidents using dashboards and self-service actions in Port. #### visualize-and-manage-statuspage-incidents Learn how to monitor and manage your Statuspage incidents and components using dashboards and self-service actions in Port. - [Visualize and manage your Statuspage incidents and components](/guides/all/visualize-and-manage-statuspage-incidents.md): Learn how to monitor and manage your Statuspage incidents and components using dashboards and self-service actions in Port. #### visualize-claude-metrics Learn how to create dashboards to monitor Claude API usage, track costs, analyze model performance, and measure workspace-level metrics. - [Visualize Claude metrics](/guides/all/visualize-claude-metrics.md): Learn how to create dashboards to monitor Claude API usage, track costs, analyze model performance, and measure workspace-level metrics. #### visualize-cursor-metrics Learn how to create dashboards to monitor Cursor AI usage, track adoption, analyze costs, and measure developer productivity. - [Visualize Cursor metrics](/guides/all/visualize-cursor-metrics.md): Learn how to create dashboards to monitor Cursor AI usage, track adoption, analyze costs, and measure developer productivity. #### visualize-github-copilot-metrics Learn how to visualize GitHub Copilot adoption, suggestion acceptance, and engineering impact at the user, team, and organization level using Port's GitHub Copilot integration and dashboards. - [Visualize GitHub Copilot metrics](/guides/all/visualize-github-copilot-metrics.md): Learn how to visualize GitHub Copilot adoption, suggestion acceptance, and engineering impact at the user, team, and organization level using Port's GitHub Copilot integration and dashboards. #### visualize-jira-lead-time Track and visualize Jira lead time metrics at the service and team level, including weekly and monthly averages, using Port dashboards. - [Visualize lead time using Jira](/guides/all/visualize-jira-lead-time.md): Track and visualize Jira lead time metrics at the service and team level, including weekly and monthly averages, using Port dashboards. #### visualize-okta-security-insights Learn how to build a security analytics dashboard for Okta identity and access management using Port's integration - [Visualize Okta security insights](/guides/all/visualize-okta-security-insights.md): Learn how to build a security analytics dashboard for Okta identity and access management using Port's integration #### visualize-service-argocd-runtime Learn how to visualize ArgoCD service runtime in Port, enhancing monitoring and management of your Kubernetes applications. - [Visualize your services' Kubernetes runtime using ArgoCD](/guides/all/visualize-service-argocd-runtime.md): Learn how to visualize ArgoCD service runtime in Port, enhancing monitoring and management of your Kubernetes applications. #### visualize-service-k8s-runtime Learn how to visualize Kubernetes service runtime in Port, improving monitoring and management of your cloud-native applications. - [Visualize your services' k8s runtime](/guides/all/visualize-service-k8s-runtime.md): Learn how to visualize Kubernetes service runtime in Port, improving monitoring and management of your cloud-native applications. #### visualize-your-aws-storage-configuration Learn how to monitor and manage your AWS data and storage security, including S3 bucket and RDS configurations using dashboards and self-service actions. - [Manage and visualize your AWS S3 buckets and RDS instances](/guides/all/visualize-your-aws-storage-configuration.md): Learn how to monitor and manage your AWS data and storage security, including S3 bucket and RDS configurations using dashboards and self-service actions. #### visualize-your-github-dependabot-alerts Learn how to monitor GitHub Dependabot alerts and gain security insights using dashboards. - [Visualize your GitHub dependency security alerts](/guides/all/visualize-your-github-dependabot-alerts.md): Learn how to monitor GitHub Dependabot alerts and gain security insights using dashboards. #### visualize-your-github-identity-and-access-management Learn how to gain insights into GitHub identity and access management across your organization - [Visualize your GitHub identity and access management](/guides/all/visualize-your-github-identity-and-access-management.md): Learn how to gain insights into GitHub identity and access management across your organization #### visualize-your-github-repository-activity Learn how to gain insights into GitHub repositories and developer activity by tracking pull requests, issues, and visibility. - [Visualize your GitHub repository and developer activity](/guides/all/visualize-your-github-repository-activity.md): Learn how to gain insights into GitHub repositories and developer activity by tracking pull requests, issues, and visibility. #### visualize-your-wiz-vulnerabilities Learn how to monitor Wiz issues and gain security insights using dashboards. - [Visualize your Wiz security issues](/guides/all/visualize-your-wiz-vulnerabilities.md): Learn how to monitor Wiz issues and gain security insights using dashboards. #### work-item-blueprint This guide demonstrates the recommended pattern for managing development workflows in Port using a dedicated work_item blueprint that is separate from origin entities like Jira issues or GitHub issues. - [Implement the work item blueprint pattern](/guides/all/work-item-blueprint.md): This guide demonstrates the recommended pattern for managing development workflows in Port using a dedicated work_item blueprint that is separate from origin entities like Jira issues or GitHub issues. ## ai-interfaces ### AGENTS This is a hidden guide for AI agents to understand how to maintain and update the AI interfaces documentation in Port Docs. - [AGENTS.md - AI Documentation Maintenance Guide](/ai-interfaces/AGENTS.md): This is a hidden guide for AI agents to understand how to maintain and update the AI interfaces documentation in Port Docs. ### ai-agents #### build-an-ai-agent AI Agents are built on top of Port AI and leverage its underlying capabilities for data access, security, and execution. This guide focuses on agent-specific building techniques. - [Build an AI agent](/ai-interfaces/ai-agents/build-an-ai-agent.md): AI Agents are built on top of Port AI and leverage its underlying capabilities for data access, security, and execution. This guide focuses on agent-specific building techniques. #### interact-with-ai-agents AI Agents are specialized implementations built on top of Port AI, designed for machine-to-machine communication and autonomous operations within defined domains. - [Interact with AI agents](/ai-interfaces/ai-agents/interact-with-ai-agents.md): AI Agents are specialized implementations built on top of Port AI, designed for machine-to-machine communication and autonomous operations within defined domains. #### overview AI Agents are specialized implementations built on top of Port AI, designed for specific domains and machine-to-machine communication. For general AI capabilities and human interaction, see Port AI. - [AI agents overview](/ai-interfaces/ai-agents/overview.md): AI Agents are specialized implementations built on top of Port AI, designed for specific domains and machine-to-machine communication. For general AI capabilities and human interaction, see Port AI. ### ai-chat-widget The AI Chat Widget provides a customizable interface for interacting with Port AI directly within your dashboards. Platform engineers can configure the widget's prompts, conversation starters, and available developer tools to create tailored AI chat experiences for developers. - [AI Chat Widget](/ai-interfaces/ai-chat-widget.md): The AI Chat Widget provides a customizable interface for interacting with Port AI directly within your dashboards. Platform engineers can configure the widget's prompts, conversation starters, and available developer tools to create tailored AI chat experiences for developers. ### context-lake #### overview Port's Context Lake is your unified engineering knowledge layer—connecting data from across your entire toolchain into a single, semantically-rich source of truth. It's not a separate feature, but rather the powerful result of Port's core capabilities working together to provide organizational context that AI agents, developers, and workflows can understand and act upon. - [Context Lake](/ai-interfaces/context-lake/overview.md): Port's Context Lake is your unified engineering knowledge layer—connecting data from across your entire toolchain into a single, semantically-rich source of truth. It's not a separate feature, but rather the powerful result of Port's core capabilities working together to provide organizational context that AI agents, developers, and workflows can understand and act upon. ### integrations-vs-mcp Port gives you two ways to connect external tools: integrations and MCP connectors. They solve different problems and are designed to complement each other — in many cases, you can benefit from both connected for the same tool. - [Integrations vs. MCP connectors](/ai-interfaces/integrations-vs-mcp.md): Port gives you two ways to connect external tools: integrations and MCP connectors. They solve different problems and are designed to complement each other — in many cases, you can benefit from both connected for the same tool. ### mcp-connectors MCP Connectors turn Port into a unified MCP gateway, routing requests from developers and AI agents to external MCP servers while applying Port's governance, RBAC, and audit controls. Platform engineers configure which MCP servers are available and which tools are exposed. Developers and AI agents access everything through a single interface. - [MCP connectors](/ai-interfaces/mcp-connectors.md): MCP Connectors turn Port into a unified MCP gateway, routing requests from developers and AI agents to external MCP servers while applying Port's governance, RBAC, and audit controls. Platform engineers configure which MCP servers are available and which tools are exposed. Developers and AI agents access everything through a single interface. #### github-mcp-connector This page covers setting up the GitHub MCP connector. The GitHub MCP connector relies on the general MCP connectors features - refer to that page for an overview of how MCP connectors work. - [GitHub MCP connector](/ai-interfaces/mcp-connectors/github-mcp-connector.md): This page covers setting up the GitHub MCP connector. The GitHub MCP connector relies on the general MCP connectors features - refer to that page for an overview of how MCP connectors work. ### overview Port's AI interfaces provide intelligent assistance across your entire software development lifecycle. All AI features are currently in open beta. - [AI Interfaces Overview](/ai-interfaces/overview.md): Port's AI interfaces provide intelligent assistance across your entire software development lifecycle. All AI features are currently in open beta. ### port-ai #### api-interaction Port AI can be accessed programmatically through Port's API, enabling integration into custom applications and workflows. This provides the most flexible way to incorporate Port AI capabilities into your existing tools and processes. - [Port AI API Interaction](/ai-interfaces/port-ai/api-interaction.md): Port AI can be accessed programmatically through Port's API, enabling integration into custom applications and workflows. This provides the most flexible way to incorporate Port AI capabilities into your existing tools and processes. #### context-engineering Context engineering is the practice of constructing an optimal information environment that provides the right amount of directions, tools, and knowledge for AI systems to successfully solve problems. Unlike prompt engineering, which focuses on crafting individual requests, context engineering ensures AI has access to relevant, structured data and capabilities needed for consistent, accurate results. - [Context Engineering with Port AI](/ai-interfaces/port-ai/context-engineering.md): Context engineering is the practice of constructing an optimal information environment that provides the right amount of directions, tools, and knowledge for AI systems to successfully solve problems. Unlike prompt engineering, which focuses on crafting individual requests, context engineering ensures AI has access to relevant, structured data and capabilities needed for consistent, accurate results. #### llm-providers-management ##### overview Manage and configure the Large Language Model (LLM) providers that power all AI interactions in Port. This feature gives you control over which AI models are used across Port AI Assistant, AI Agents, and other AI-powered features. - [LLM Provider Management](/ai-interfaces/port-ai/llm-providers-management/overview.md): Manage and configure the Large Language Model (LLM) providers that power all AI interactions in Port. This feature gives you control over which AI models are used across Port AI Assistant, AI Agents, and other AI-powered features. ##### providers - [AWS Bedrock setup](/ai-interfaces/port-ai/llm-providers-management/providers/aws-bedrock.md): AWS Bedrock requires IAM policy configuration and an authentication method before you can register it as an LLM provider in Port. Complete the steps below before proceeding to Step 2: Store API Keys in Secrets in the main setup guide. - [OpenAI compatible setup](/ai-interfaces/port-ai/llm-providers-management/providers/openai-compatible.md): Port's openai-compatible provider type connects to an HTTP endpoint that implements the OpenAI chat completions API. You supply a base URL, optional custom headers, and a catalog of model names your server actually exposes. This page walks through LiteLLM as a concrete example. LiteLLM is a common choice because it can route many upstream models through one OpenAI-compatible surface. See the LiteLLM docs for product-specific behavior and deployment options. - [Vertex Anthropic setup](/ai-interfaces/port-ai/llm-providers-management/providers/vertex-anthropic.md): Port's vertex-anthropic provider connects to Claude models hosted on Google Vertex AI through the Vertex Anthropic partner integration. You register the model IDs your project exposes and authenticate with a GCP service account. Complete the steps below before Step 2: store API keys in secrets in the main setup guide. - [Vertex Gemini setup](/ai-interfaces/port-ai/llm-providers-management/providers/vertex-gemini.md): Port's vertex-gemini provider connects to Google Vertex AI Gemini models. You register the model IDs your project exposes, then authenticate with either a GCP service account or Vertex AI Express Mode (API key). Complete the steps below before Step 2: store API keys in secrets in the main setup guide. ##### selecting-llm-provider When interacting with Port AI through the API, you can select which provider and model to use for specific requests. This gives you fine-grained control over AI processing on a per-request basis. - [Selecting LLM Provider](/ai-interfaces/port-ai/llm-providers-management/selecting-llm-provider.md): When interacting with Port AI through the API, you can select which provider and model to use for specific requests. This gives you fine-grained control over AI processing on a per-request basis. ##### setup-and-configuration This guide covers all technical details for setting up and configuring LLM providers, including permissions, changing defaults, validation flow, and troubleshooting common issues. - [Setup & Configuration](/ai-interfaces/port-ai/llm-providers-management/setup-and-configuration.md): This guide covers all technical details for setting up and configuring LLM providers, including permissions, changing defaults, validation flow, and troubleshooting common issues. #### memory Memory allows Port AI to learn and remember your preferences across conversations. Over time, the AI adapts to your working style, providing more personalized and relevant responses without requiring you to repeat yourself. - [Memory](/ai-interfaces/port-ai/memory.md): Memory allows Port AI to learn and remember your preferences across conversations. Over time, the AI adapts to your working style, providing more personalized and relevant responses without requiring you to repeat yourself. #### overview Port AI is the foundational AI system that enables intelligent interaction with your Port data through natural language. As an MCP (Model Context Protocol) client, Port AI accepts prompts and tools, runs autonomous processes to query your software catalog, and returns comprehensive responses. - [Port AI](/ai-interfaces/port-ai/overview.md): Port AI is the foundational AI system that enables intelligent interaction with your Port data through natural language. As an MCP (Model Context Protocol) client, Port AI accepts prompts and tools, runs autonomous processes to query your software catalog, and returns comprehensive responses. #### security-and-data-controls Port is committed to developing AI responsibly, maintaining high standards of data privacy and security across all our AI interfaces. This page addresses common questions about security, data handling, permissions, and controls for Port's AI capabilities. - [AI Security and Data Controls](/ai-interfaces/port-ai/security-and-data-controls.md): Port is committed to developing AI responsibly, maintaining high standards of data privacy and security across all our AI interfaces. This page addresses common questions about security, data handling, permissions, and controls for Port's AI capabilities. ### port-ai-assistant The Port AI Assistant is the fastest way to start using AI with Port - no configuration required. Available through the button, it provides instant, intelligent answers about your software catalog, actions, and Port's capabilities. - [Port AI Assistant](/ai-interfaces/port-ai-assistant.md): The Port AI Assistant is the fastest way to start using AI with Port - no configuration required. Available through the button, it provides instant, intelligent answers about your software catalog, actions, and Port's capabilities. ### port-mcp-server #### available-tools The Port MCP Server exposes different sets of tools based on your role and use case. The tools you see will depend on your permissions in Port. - [Available tools](/ai-interfaces/port-mcp-server/available-tools.md): The Port MCP Server exposes different sets of tools based on your role and use case. The tools you see will depend on your permissions in Port. #### overview-and-installation Install and configure the Port MCP server so AI agents and LLMs can interact with your Port developer portal using natural language. Covers OAuth and client-credentials authentication for local and CI use. - [Port MCP server](/ai-interfaces/port-mcp-server/overview-and-installation.md): Install and configure the Port MCP server so AI agents and LLMs can interact with your Port developer portal using natural language. Covers OAuth and client-credentials authentication for local and CI use. #### prompts Prebuilt prompts for the Port MCP server that help AI agents query and act on your Port catalog. - [Prompts](/ai-interfaces/port-mcp-server/prompts.md): Prebuilt prompts for the Port MCP server that help AI agents query and act on your Port catalog. #### token-based-authentication When integrating the Port MCP Server with AI agents in automated environments like CI/CD pipelines, the authentication approach differs from interactive local usage. This guide explains how to establish secure connections between AI agents and the Port MCP Server without requiring user interaction. - [Token-based connection to Port MCP server](/ai-interfaces/port-mcp-server/token-based-authentication.md): When integrating the Port MCP Server with AI agents in automated environments like CI/CD pipelines, the authentication approach differs from interactive local usage. This guide explains how to establish secure connections between AI agents and the Port MCP Server without requiring user interaction. ### port-n8n-node Port provides a custom n8n node (n8n-nodes-portio-experimental) that simplifies integration with Port's AI agents and API. Instead of making manual HTTP requests for authentication, invocation, and response retrieval, the Port node handles all of this automatically, making it easy to build powerful automation workflows that leverage Port's Context Lake. - [Port n8n node](/ai-interfaces/port-n8n-node.md): Port provides a custom n8n node (n8n-nodes-portio-experimental) that simplifies integration with Port's AI agents and API. Instead of making manual HTTP requests for authentication, invocation, and response retrieval, the Port node handles all of this automatically, making it easy to build powerful automation workflows that leverage Port's Context Lake. ### skills Skills are domain-specific guidance packages that help Port AI handle specialized tasks more effectively. When the AI encounters a task that matches a skill's description, it loads the skill's step-by-step instructions to ensure consistent, thorough handling. - [Skills](/ai-interfaces/skills.md): Skills are domain-specific guidance packages that help Port AI handle specialized tasks more effectively. When the AI encounters a task that matches a skill's description, it loads the skill's step-by-step instructions to ensure consistent, thorough handling. ### slack-app Port's Slack app brings your developer portal experience into your team's daily communication flow — allowing you to interact with Port directly from Slack and receive real-time notifications from Port right where your team collaborates. The Slack app uses the Port AI API to provide intelligent answers about your software catalog, similar to the Port AI Assistant. - [Slack Application](/ai-interfaces/slack-app.md): Port's Slack app brings your developer portal experience into your team's daily communication flow — allowing you to interact with Port directly from Slack and receive real-time notifications from Port right where your team collaborates. The Slack app uses the Port AI API to provide intelligent answers about your software catalog, similar to the Port AI Assistant. ## category ### llm-provider-management Manage and configure the Large Language Model (LLM) providers that power all AI interactions in Port. This feature gives you control over which AI models are used across Port AI Assistant, AI Agents, and other AI-powered features. - [LLM Provider Management](/category/llm-provider-management.md): Manage and configure the Large Language Model (LLM) providers that power all AI interactions in Port. This feature gives you control over which AI models are used across Port AI Assistant, AI Agents, and other AI-powered features. ## customize-pages-dashboards-and-plugins ### customization Port offers various customization options to help you tailor the developer portal to your organization's branding and style as well as communicate important information to your users. - [Customization & accessibility](/customize-pages-dashboards-and-plugins/customization.md): Port offers various customization options to help you tailor the developer portal to your organization's branding and style as well as communicate important information to your users. ### dashboards #### custom-widgets Custom widgets are specialized widgets that provide additional functionality beyond data visualization, such as executing actions, displaying external content, or showing formatted markdown. - [Custom widgets](/customize-pages-dashboards-and-plugins/dashboards/custom-widgets.md): Custom widgets are specialized widgets that provide additional functionality beyond data visualization, such as executing actions, displaying external content, or showing formatted markdown. #### data-widgets Data widgets are visualization widgets that display data from your software catalog, including charts, tables, and entity information. - [Data widgets](/customize-pages-dashboards-and-plugins/dashboards/data-widgets.md): Data widgets are visualization widgets that display data from your software catalog, including charts, tables, and entity information. #### overview Port supports various visualizations in the form of widgets, allowing you to display data from your software catalog using graphic elements, making it easier to make sense of large datasets. - [Overview](/customize-pages-dashboards-and-plugins/dashboards/overview.md): Port supports various visualizations in the form of widgets, allowing you to display data from your software catalog using graphic elements, making it easier to make sense of large datasets. #### personal-widgets Personal widgets are user-specific widgets that display information tailored to the logged-in user, such as their entities, recently viewed items, and recently used actions. - [Personal widgets](/customize-pages-dashboards-and-plugins/dashboards/personal-widgets.md): Personal widgets are user-specific widgets that display information tailored to the logged-in user, such as their entities, recently viewed items, and recently used actions. ### page #### catalog-page A catalog page displays a table of all existing entities created from a blueprint. - [Catalog page](/customize-pages-dashboards-and-plugins/page/catalog-page.md): A catalog page displays a table of all existing entities created from a blueprint. #### dashboard-page Dashboards are collections of widgets that allow you to display entity data using graphic elements. - [Dashboard page](/customize-pages-dashboards-and-plugins/page/dashboard-page.md): Dashboards are collections of widgets that allow you to display entity data using graphic elements. #### entity-page Each entity has a dedicated page that contains 4 tabs (by default): - [Entity page](/customize-pages-dashboards-and-plugins/page/entity-page.md): Each entity has a dedicated page that contains 4 tabs (by default): #### folders Port allows you to create folders in your software catalog that can be used to group pages by topic, team, or any other criteria that fits the needs of your organization. - [Folders](/customize-pages-dashboards-and-plugins/page/folders.md): Port allows you to create folders in your software catalog that can be used to group pages by topic, team, or any other criteria that fits the needs of your organization. #### page-permissions Page permissions are used to control access to catalog pages and dashboard pages in the software catalog. - [Page permissions](/customize-pages-dashboards-and-plugins/page/page-permissions.md): Page permissions are used to control access to catalog pages and dashboard pages in the software catalog. ### plugins A plugin is a self-contained web UI, built from HTML, JavaScript, or a framework such as React, that you develop locally and upload to Port. Plugins power custom widgets that render inside dashboards and entity pages using the same catalog data and permissions as the rest of the platform. - [Plugins](/customize-pages-dashboards-and-plugins/plugins.md): A plugin is a self-contained web UI, built from HTML, JavaScript, or a framework such as React, that you develop locally and upload to Port. Plugins power custom widgets that render inside dashboards and entity pages using the same catalog data and permissions as the rest of the platform. ## docs-ai-assistant Port's AI assistant is here to help you get the most out of your portal by answering your questions, creating resources, and assisting with troubleshooting. - [Docs AI assistant](/docs-ai-assistant.md): Port's AI assistant is here to help you get the most out of your portal by answering your questions, creating resources, and assisting with troubleshooting. ## glossary Definitions of Port-specific terms - Blueprint, Entity, Ocean, Scorecard, Self-service action - and how they differ from standard DevOps terminology. - [Glossary](/glossary.md): Definitions of Port-specific terms - Blueprint, Entity, Ocean, Scorecard, Self-service action - and how they differ from standard DevOps terminology. ## integrations-index Port offers a wide variety of integrations for popular tools and platforms. These integrations come with default data models and mappings configured by us to provide you with a fast plug & play experience. - [Integrations index](/integrations-index.md): Port offers a wide variety of integrations for popular tools and platforms. These integrations come with default data models and mappings configured by us to provide you with a fast plug & play experience. ## observability ### audit-log The audit log page gives you a complete, time-ordered record of every change made in your Port organization. Use it to understand who did what, when, and whether it succeeded - whether you are troubleshooting a broken integration, investigating an unexpected catalog change, or meeting compliance requirements. - [Audit log](/observability/audit-log.md): The audit log page gives you a complete, time-ordered record of every change made in your Port organization. Use it to understand who did what, when, and whether it succeeded - whether you are troubleshooting a broken integration, investigating an unexpected catalog change, or meeting compliance requirements. ### usage-dashboard The usage dashboard provides visibility into how your Port environment is being used across your organization. Data is updated once a day, providing the latest insights you need to optimize adoption, identify engagement opportunities, and maximize the value your teams get from Port. - [Portal usage dashboard](/observability/usage-dashboard.md): The usage dashboard provides visibility into how your Port environment is being used across your organization. Data is updated once a day, providing the latest insights you need to optimize adoption, identify engagement opportunities, and maximize the value your teams get from Port. ## security Port is an internal developer portal platform and as such we place the utmost importance on data security, privacy and compliance, so that you can trust that your security needs are met. - [Security & compliance](/security.md): Port is an internal developer portal platform and as such we place the utmost importance on data security, privacy and compliance, so that you can trust that your security needs are met. ## solutions ### agentic-resource-management #### create-golden-paths Golden paths are a foundational element of effective platform engineering. - [Create golden paths](/solutions/agentic-resource-management/create-golden-paths.md): Golden paths are a foundational element of effective platform engineering. #### day-2-resource-lifecycle Managing the lifecycle of cloud resources is a critical aspect of platform engineering, often referred to as "Day 2 operations." After resources are provisioned—whether they're databases, compute instances, storage buckets, or Kubernetes namespaces—they require ongoing management to ensure reliability, security, and cost-effectiveness. - [Day 2 - manage resource lifecycle](/solutions/agentic-resource-management/day-2-resource-lifecycle.md): Managing the lifecycle of cloud resources is a critical aspect of platform engineering, often referred to as "Day 2 operations." After resources are provisioned—whether they're databases, compute instances, storage buckets, or Kubernetes namespaces—they require ongoing management to ensure reliability, security, and cost-effectiveness. #### overview Provision cloud resources, microservices, secrets, and permissions through a single self-service layer, used by developers and AI agents alike. Platform teams define golden paths and approval workflows; every request, human or automated, follows company standards. - [Agentic resource management](/solutions/agentic-resource-management/overview.md): Provision cloud resources, microservices, secrets, and permissions through a single self-service layer, used by developers and AI agents alike. Platform teams define golden paths and approval workflows; every request, human or automated, follows company standards. #### self-service-environments Automating the creation of development environments is crucial for engineering teams. Manual setup is slow, error-prone, and often leads to inconsistencies that can delay development and cause integration headaches. By enabling self-service environment provisioning, teams can spin up the resources they need—on demand and with the right guardrails—freeing up developers to focus on building features instead of wrangling infrastructure. - [Self-service environments](/solutions/agentic-resource-management/self-service-environments.md): Automating the creation of development environments is crucial for engineering teams. Manual setup is slow, error-prone, and often leads to inconsistencies that can delay development and cause integration headaches. By enabling self-service environment provisioning, teams can spin up the resources they need—on demand and with the right guardrails—freeing up developers to focus on building features instead of wrangling infrastructure. #### setup-approval-workflows Effective platform engineering requires oversight at every level—whether it's a human developer requesting a production database or an AI agent automatically scaling infrastructure. Without proper controls, self-service can quickly become a security and compliance nightmare. Port provides three complementary layers of governance: Role-Based Access Control (RBAC) for user permissions, approval workflows for human oversight, and dynamic permissions for context-aware access control. - [Set up approval workflows](/solutions/agentic-resource-management/setup-approval-workflows.md): Effective platform engineering requires oversight at every level—whether it's a human developer requesting a production database or an AI agent automatically scaling infrastructure. Without proper controls, self-service can quickly become a security and compliance nightmare. Port provides three complementary layers of governance: Role-Based Access Control (RBAC) for user permissions, approval workflows for human oversight, and dynamic permissions for context-aware access control. ### agentic-work-management #### overview Agentic work management is Port's platform layer for running AI agents safely across engineering. We do not provide the agents. We provide the registries, governance, and orchestration that let your teams adopt agents from Cursor, Claude Code, or any MCP-compatible tool, without losing visibility or control. - [Agentic work management](/solutions/agentic-work-management/overview.md): Agentic work management is Port's platform layer for running AI agents safely across engineering. We do not provide the agents. We provide the registries, governance, and orchestration that let your teams adopt agents from Cursor, Claude Code, or any MCP-compatible tool, without losing visibility or control. ### autonomous-security-management #### compliance-as-code Port transforms compliance from a manual, reactive burden into an automated, continuous, and measurable practice. - [Compliance as code](/solutions/autonomous-security-management/compliance-as-code.md): Port transforms compliance from a manual, reactive burden into an automated, continuous, and measurable practice. #### overview Security tools are good at finding issues. They are poor at telling you which ones matter. Port enriches every finding with ownership, environment, and business context so security teams, developers, and AI agents focus remediation on what actually affects the business. - [Autonomous security management](/solutions/autonomous-security-management/overview.md): Security tools are good at finding issues. They are poor at telling you which ones matter. Port enriches every finding with ownership, environment, and business context so security teams, developers, and AI agents focus remediation on what actually affects the business. #### prioritise-vulnerabilities Port transforms vulnerability management from chaos to clarity — helping security teams focus on what truly matters to the business. - [Prioritize vulnerabilities](/solutions/autonomous-security-management/prioritise-vulnerabilities.md): Port transforms vulnerability management from chaos to clarity — helping security teams focus on what truly matters to the business. #### security-actions-automations Manual security processes don't scale. Every day, security teams face an overwhelming stream of alerts, vulnerability reports, compliance exceptions, and incident escalations. Meanwhile, developers wait for approvals, security reviews, and guidance on issues they could resolve themselves if given the right context and tools. - [Security actions & automations](/solutions/autonomous-security-management/security-actions-automations.md): Manual security processes don't scale. Every day, security teams face an overwhelming stream of alerts, vulnerability reports, compliance exceptions, and incident escalations. Meanwhile, developers wait for approvals, security reviews, and guidance on issues they could resolve themselves if given the right context and tools. #### security-champions-initiatives Port empowers organizations to scale security culture by making secure development measurable, actionable, and rewarding. - [Security champions & initiatives](/solutions/autonomous-security-management/security-champions-initiatives.md): Port empowers organizations to scale security culture by making secure development measurable, actionable, and rewarding. #### security-metrics-visualization Port transforms security metrics from vanity numbers into actionable insights, helping CISOs, security teams, and developers align on what truly matters. - [Security metrics visualization](/solutions/autonomous-security-management/security-metrics-visualization.md): Port transforms security metrics from vanity numbers into actionable insights, helping CISOs, security teams, and developers align on what truly matters. ### autonomous-ticket-resolution #### code-review The code review phase applies the same platform primitives as ticket enrichment - catalog context, scorecards as gates, and structured outputs written back to the work item entity - but at the PR stage. - [Review the results](/solutions/autonomous-ticket-resolution/code-review.md): The code review phase applies the same platform primitives as ticket enrichment - catalog context, scorecards as gates, and structured outputs written back to the work item entity - but at the PR stage. #### overview Autonomous Ticket Resolution (ATR) is Port's approach to automating the full software delivery lifecycle - from the moment a ticket is created to the moment code reaches production. - [Autonomous ticket resolution](/solutions/autonomous-ticket-resolution/overview.md): Autonomous Ticket Resolution (ATR) is Port's approach to automating the full software delivery lifecycle - from the moment a ticket is created to the moment code reaches production. #### roi-dashboard Measure the impact of Autonomous Ticket Resolution (ATR) in Port with an ROI dashboard covering tickets resolved, time saved, and cost impact. - [Measure ATR's impact](/solutions/autonomous-ticket-resolution/roi-dashboard.md): Measure the impact of Autonomous Ticket Resolution (ATR) in Port with an ROI dashboard covering tickets resolved, time saved, and cost impact. #### safe-release