# Roadie Documentation Clean markdown versions of Roadie docs. ## Docs Index - [Authorization of the API](https://roadie.io/docs/api/authorization.md) - [Entity Push API Tutorial](https://roadie.io/docs/api/entity-push-api.md) - [Roadie API & MCP Servers](https://roadie.io/docs/api/overview.md) - [Roadie MCP AI Servers (Beta)](https://roadie.io/docs/api/roadie-mcp.md) - [API Docs Query Server](https://roadie.io/docs/api/roadie-mcp/api-docs-query.md) - [Backend Config Server](https://roadie.io/docs/api/roadie-mcp/backend-config.md) - [Catalog Decorators Server](https://roadie.io/docs/api/roadie-mcp/catalog-decorators.md) - [Rich Catalog Entity Server](https://roadie.io/docs/api/roadie-mcp/rich-catalog-entity.md) - [Scaffolder Server](https://roadie.io/docs/api/roadie-mcp/scaffolder.md) - [Tech Insights Facts Server](https://roadie.io/docs/api/roadie-mcp/tech-insights-facts.md) - [Use custom renderer with your API entities](https://roadie.io/docs/catalog/custom-api-docs-renderers.md) - [Custom Cards [beta]](https://roadie.io/docs/catalog/custom-cards.md) - [Customising your Catalog](https://roadie.io/docs/catalog/custom-views.md) - [Introduction](https://roadie.io/docs/catalog/decorating-components.md) - [Displaying Entity Metadata](https://roadie.io/docs/catalog/entity-metadata-card.md) - [Use the grpc-docs plugin with your API entities](https://roadie.io/docs/catalog/grpc-docs.md) - [Managing locations and autodiscovery](https://roadie.io/docs/catalog/location-management.md) - [Modeling Entities in the Catalog](https://roadie.io/docs/catalog/modeling-entities.md) - [Using OpenAPI Specs](https://roadie.io/docs/catalog/openapi-specs.md) - [Roadie Catalog](https://roadie.io/docs/catalog/overview.md) - [Ownership in Backstage Entities](https://roadie.io/docs/catalog/ownership.md) - [Testing Components and Previewing Entity Changes](https://roadie.io/docs/catalog/previewing-changes.md) - [Repositories in the Catalog](https://roadie.io/docs/catalog/repositories.md) - [Creating rich team pages](https://roadie.io/docs/catalog/rich-team-pages.md) - [Testing Page Configurations](https://roadie.io/docs/catalog/sandbox-mode.md) - [Showing Relationships Between Entities](https://roadie.io/docs/catalog/showing-dependencies.md) - [Using TechDocs in Roadie](https://roadie.io/docs/catalog/techdocs.md) - [Build and Publish TechDocs via CI](https://roadie.io/docs/catalog/techdocs/build-via-ci.md) - [Troubleshooting TechDocs](https://roadie.io/docs/catalog/techdocs/troubleshooting.md) - [Troubleshooting the Catalog](https://roadie.io/docs/catalog/troubleshooting-the-catalog.md) - [Removing or Deleting Entities](https://roadie.io/docs/catalog/unregister-components.md) - [Roadie Backstage Entity Validator](https://roadie.io/docs/catalog/validator.md) - [Available APIs when developing Roadie plugins](https://roadie.io/docs/custom-plugins/available-apis.md) - [Using the Broker with Custom Plugins](https://roadie.io/docs/custom-plugins/connectivity/broker.md) - [Configuring Proxies for Custom Plugins](https://roadie.io/docs/custom-plugins/connectivity/proxy.md) - [Deploying Custom Plugins](https://roadie.io/docs/custom-plugins/deploying.md) - [Developing Custom Plugins](https://roadie.io/docs/custom-plugins/developing.md) - [Getting started with Custom Plugins](https://roadie.io/docs/custom-plugins/getting-started.md) - [Installing Custom Plugins](https://roadie.io/docs/custom-plugins/legacy/artifactory.md) - [Configuring Custom Plugins](https://roadie.io/docs/custom-plugins/legacy/configuring.md) - [Using the MDX plugin to create Custom Plugins](https://roadie.io/docs/custom-plugins/mdx-plugin-card.md) - [Roadie Custom Plugins](https://roadie.io/docs/custom-plugins/overview.md) - [Adding Your Custom Plugins to Roadie](https://roadie.io/docs/custom-plugins/plugin-registration.md) - [Testing Custom Plugins](https://roadie.io/docs/custom-plugins/testing.md) - [AWS S3](https://roadie.io/docs/getting-started/adding-a-catalog-item/aws-s3.md) - [Azure DevOps](https://roadie.io/docs/getting-started/adding-a-catalog-item/azure-devops.md) - [Integrating with Bitbucket](https://roadie.io/docs/getting-started/adding-a-catalog-item/bitbucket.md) - [GitHub](https://roadie.io/docs/getting-started/adding-a-catalog-item/github.md) - [GitLab](https://roadie.io/docs/getting-started/adding-a-catalog-item/gitlab.md) - [Roadie API](https://roadie.io/docs/getting-started/adding-a-catalog-item/roadie-api.md) - [Roadie CLI](https://roadie.io/docs/getting-started/adding-a-catalog-item/roadie-cli.md) - [Designating admins](https://roadie.io/docs/getting-started/assigning-admins.md) - [Enabling autodiscovery](https://roadie.io/docs/getting-started/autodiscovery.md) - [Customising the Roadie UI](https://roadie.io/docs/getting-started/configure-ui.md) - [Adding plugins](https://roadie.io/docs/getting-started/configuring-backstage-plugins.md) - [Creating a scorecard](https://roadie.io/docs/getting-started/creating-a-scorecard.md) - [Model your software](https://roadie.io/docs/getting-started/model-software.md) - [Overview](https://roadie.io/docs/getting-started/overview.md) - [Creating a Scaffolder template](https://roadie.io/docs/getting-started/scaffolding-components.md) - [Modelling users & groups](https://roadie.io/docs/getting-started/teams.md) - [Adding your docs](https://roadie.io/docs/getting-started/technical-documentation.md) - [Inviting users](https://roadie.io/docs/getting-started/user-management.md) - [Accessing AWS Services](https://roadie.io/docs/integrations/accessing-aws-resources.md) - [Configuring Architecture Decision Records (ADR)](https://roadie.io/docs/integrations/adr.md) - [AI Assistant (Alpha)](https://roadie.io/docs/integrations/ai-assistant.md) - [Allowlisting Roadie Traffic](https://roadie.io/docs/integrations/allowlisting-roadie-traffic.md) - [Allure Plugin](https://roadie.io/docs/integrations/allure.md) - [Announcements Plugin](https://roadie.io/docs/integrations/announcements.md) - [Viewing Apache Airflow DAGs in Roadie](https://roadie.io/docs/integrations/apache-airflow.md) - [Argo CD Plugin](https://roadie.io/docs/integrations/argocd.md) - [Configuring AWS Accounts for Plugins](https://roadie.io/docs/integrations/aws-plugins.md) - [Configuring AWS Resources Autodiscovery](https://roadie.io/docs/integrations/aws-resources.md) - [Integrating with AWS S3](https://roadie.io/docs/integrations/aws-s3.md) - [Azure Devops](https://roadie.io/docs/integrations/azure-devops.md) - [Integrating with Azure DevOps](https://roadie.io/docs/integrations/azure-devops-provider.md) - [Accessing Public resources from the Backend](https://roadie.io/docs/integrations/backend-reading-allow-list.md) - [Integrating with Bitbucket](https://roadie.io/docs/integrations/bitbucket.md) - [Integrating to internal infrastructure with Broker](https://roadie.io/docs/integrations/broker.md) - [Bugsnag](https://roadie.io/docs/integrations/bugsnag.md) - [Buildkite Plugin](https://roadie.io/docs/integrations/buildkite.md) - [Catalog Graph](https://roadie.io/docs/integrations/catalog-graph.md) - [Viewing CircleCI Builds in Roadie](https://roadie.io/docs/integrations/circleci.md) - [Configuring Cloudsmith plugin](https://roadie.io/docs/integrations/cloudsmith.md) - [code-coverage Plugin](https://roadie.io/docs/integrations/codecoverage.md) - [Coder](https://roadie.io/docs/integrations/coder.md) - [CodeScene](https://roadie.io/docs/integrations/codescene.md) - [Confluence Search](https://roadie.io/docs/integrations/confluence.md) - [Cost Insights on Roadie](https://roadie.io/docs/integrations/cost-insights.md) - [How to Create an Authenticated Proxy](https://roadie.io/docs/integrations/create-proxy/authenticated.md) - [How to Create a Basic Proxy](https://roadie.io/docs/integrations/create-proxy/basic.md) - [Datadog](https://roadie.io/docs/integrations/datadog.md) - [DX](https://roadie.io/docs/integrations/dx.md) - [Dynatrace](https://roadie.io/docs/integrations/dynatrace.md) - [End Of Life Plugin](https://roadie.io/docs/integrations/endoflife.md) - [FireHydrant](https://roadie.io/docs/integrations/firehydrant.md) - [Flux Plugin](https://roadie.io/docs/integrations/flux.md) - [Google Calendar Plugin](https://roadie.io/docs/integrations/gcalendar.md) - [Configuring GCP Service Account for Backstage in Roadie](https://roadie.io/docs/integrations/gcp.md) - [Configuring GitHub Enterprise Server in Roadie](https://roadie.io/docs/integrations/ghe.md) - [GitHub App Permissions](https://roadie.io/docs/integrations/github-app-permissions.md) - [Github Deployments Plugin](https://roadie.io/docs/integrations/github-deployments.md) - [Configuring auto discovery for your organization](https://roadie.io/docs/integrations/github-discovery.md) - [Configuring GitHub Enterprise](https://roadie.io/docs/integrations/github-enterprise.md) - [GitHub Pull Requests Board Plugin](https://roadie.io/docs/integrations/github-pull-request-board.md) - [Loading GitHub Organization Teams](https://roadie.io/docs/integrations/github-teams.md) - [GitHub Token Permissions](https://roadie.io/docs/integrations/github-token.md) - [GitLab Plugin](https://roadie.io/docs/integrations/gitlab.md) - [Configuring GitLab OAuth in Roadie](https://roadie.io/docs/integrations/gitlab-oauth.md) - [Integrating with GitLab](https://roadie.io/docs/integrations/gitlab-provider.md) - [Configuring Glean](https://roadie.io/docs/integrations/glean.md) - [Configuring Google OAuth for Backstage in Roadie](https://roadie.io/docs/integrations/google-oauth-client.md) - [Grafana Plugin](https://roadie.io/docs/integrations/grafana.md) - [GraphiQL Plugin](https://roadie.io/docs/integrations/graphiql.md) - [Configuring Harbor](https://roadie.io/docs/integrations/harbor.md) - [Harness Plugin](https://roadie.io/docs/integrations/harness.md) - [Home Page Plugin](https://roadie.io/docs/integrations/home-page.md) - [How Roadie connects to your tools](https://roadie.io/docs/integrations/how-roadie-connects.md) - [HTTP](https://roadie.io/docs/integrations/http.md) - [Humanitec Plugin](https://roadie.io/docs/integrations/humanitec.md) - [IFrame Plugin](https://roadie.io/docs/integrations/iframe.md) - [incident.io Plugin](https://roadie.io/docs/integrations/incident.md) - [Performing a sync with your GitHub for your catalog files](https://roadie.io/docs/integrations/initial-github-discovery.md) - [Configuring Jenkins plugin](https://roadie.io/docs/integrations/jenkins.md) - [Configuring the Jira plugins](https://roadie.io/docs/integrations/jira.md) - [Kratix Plugin](https://roadie.io/docs/integrations/kratix.md) - [Adding a Kubernetes cluster](https://roadie.io/docs/integrations/kubernetes.md) - [Kubernetes Ingestor and Crossplane plugin](https://roadie.io/docs/integrations/kubernetes-ingestor.md) - [Configuring LaunchDarkly plugin](https://roadie.io/docs/integrations/launchdarkly.md) - [Lighthouse](https://roadie.io/docs/integrations/lighthouse.md) - [Markdown Card Plugin](https://roadie.io/docs/integrations/markdown-card.md) - [Mend.io Plugin](https://roadie.io/docs/integrations/mend.md) - [Integrating with Azure AD](https://roadie.io/docs/integrations/ms-graph-org-provider.md) - [Creating a New Relic token for Roadie](https://roadie.io/docs/integrations/newrelic.md) - [Configuring Okta Team / User Provider](https://roadie.io/docs/integrations/okta.md) - [Configuring Opsgenie](https://roadie.io/docs/integrations/opsgenie.md) - [Set up the PagerDuty plugin](https://roadie.io/docs/integrations/pagerduty.md) - [Plugins & Integrations](https://roadie.io/docs/integrations/plugin-overview.md) - [Configuring Prometheus integration](https://roadie.io/docs/integrations/prometheus.md) - [Proxy Sigv4 Plugin](https://roadie.io/docs/integrations/proxy-sigv4.md) - [Pulumi Plugin](https://roadie.io/docs/integrations/pulumi.md) - [Requesting plugins](https://roadie.io/docs/integrations/requesting-plugins.md) - [Required Metadata](https://roadie.io/docs/integrations/required-metadata.md) - [Using the Roadie API](https://roadie.io/docs/integrations/roadie-api.md) - [Configuring Rootly](https://roadie.io/docs/integrations/rootly.md) - [Sentry](https://roadie.io/docs/integrations/sentry.md) - [Setting secrets](https://roadie.io/docs/integrations/setting-secrets.md) - [Shortcut Plugin](https://roadie.io/docs/integrations/shortcut-plugin.md) - [Snyk](https://roadie.io/docs/integrations/snyk.md) - [Configuring SonarQube](https://roadie.io/docs/integrations/sonarqube.md) - [Configuring Spacelift](https://roadie.io/docs/integrations/spacelift.md) - [Configuring Splunk On-Call](https://roadie.io/docs/integrations/splunk-on-call.md) - [Stackoverflow Plugin](https://roadie.io/docs/integrations/stackoverflow.md) - [Configuring Tech Radar](https://roadie.io/docs/integrations/tech-radar.md) - [Terraform Plugin](https://roadie.io/docs/integrations/terraform.md) - [Configuring TODO Comments](https://roadie.io/docs/integrations/todo.md) - [Travis CI](https://roadie.io/docs/integrations/travis-ci.md) - [Wiz](https://roadie.io/docs/integrations/wiz.md) - [Using Permissions in Custom Plugins](https://roadie.io/docs/permissions/custom-plugins.md) - [Managing Policies](https://roadie.io/docs/permissions/managing-policies.md) - [Managing Roles](https://roadie.io/docs/permissions/managing-roles.md) - [Permissions](https://roadie.io/docs/permissions/overview.md) - [Organising Templates](https://roadie.io/docs/scaffolder/certified-templates.md) - [Custom Scaffolder Parameters](https://roadie.io/docs/scaffolder/custom-fields.md) - [Append content to a file](https://roadie.io/docs/scaffolder/recipes/append.md) - [Make a PR in Azure DevOps](https://roadie.io/docs/scaffolder/recipes/azure-actions.md) - [Fetch Azure resources via ARM REST API](https://roadie.io/docs/scaffolder/recipes/azure-resources.md) - [Call an external API](https://roadie.io/docs/scaffolder/recipes/call-external-api.md) - [Create RFC template](https://roadie.io/docs/scaffolder/recipes/create-rfc.md) - [Debug your nunjucks template](https://roadie.io/docs/scaffolder/recipes/debug-template.md) - [Edit the contents of a file](https://roadie.io/docs/scaffolder/recipes/edit-file.md) - [Refer to parameter values in another repo](https://roadie.io/docs/scaffolder/recipes/global-constants.md) - [Transform JSON files with JSONata](https://roadie.io/docs/scaffolder/recipes/json-jsonata-transform.md) - [Using for Loops to repeat scaffolder steps](https://roadie.io/docs/scaffolder/recipes/loops-in-steps.md) - [Using for Loops in Templates](https://roadie.io/docs/scaffolder/recipes/loops-in-templates.md) - [Manipulate a JSON file](https://roadie.io/docs/scaffolder/recipes/manipulate-json-files.md) - [Manipulate YAML file](https://roadie.io/docs/scaffolder/recipes/manipulate-yaml-files.md) - [Refer to steps defined in another repo](https://roadie.io/docs/scaffolder/recipes/placeholders.md) - [Automatically filling out scaffolder form with URL params](https://roadie.io/docs/scaffolder/recipes/predefined-values-via-url-params.md) - [Using the split function to process comma-separated strings](https://roadie.io/docs/scaffolder/recipes/split-string.md) - [Validate catalog entities](https://roadie.io/docs/scaffolder/recipes/validate-entity.md) - [Assigning Scaffolder Variables](https://roadie.io/docs/scaffolder/recipes/variables-in-scaffolder.md) - [Transform YAML files with JSONata](https://roadie.io/docs/scaffolder/recipes/yaml-jsonata-transform.md) - [Backstage Scaffolder Parameters](https://roadie.io/docs/scaffolder/scaffolder-parameters.md) - [Guide to Create Your Own Custom Actions - Roadie Agent Library](https://roadie.io/docs/scaffolder/self-hosted-scaffolder-actions.md) - [Template Extensions](https://roadie.io/docs/scaffolder/template-extensions.md) - [Testing and Troubleshooting Scaffolder Templates](https://roadie.io/docs/scaffolder/troubleshooting.md) - [Scaffolder templates](https://roadie.io/docs/scaffolder/writing-templates.md) - [Adding a new check](https://roadie.io/docs/tech-insights/add-check.md) - [Adding a Scorecard](https://roadie.io/docs/tech-insights/add-scorecard.md) - [Add a scorecard to catalog](https://roadie.io/docs/tech-insights/add-scorecard-to-catalog.md) - [Using Built-in Data Sources](https://roadie.io/docs/tech-insights/builtin-data-sources.md) - [Introduction to Checks](https://roadie.io/docs/tech-insights/checks.md) - [Overview of the Data Source results and details](https://roadie.io/docs/tech-insights/data-source-details.md) - [Introduction to Data Sources](https://roadie.io/docs/tech-insights/data-sources.md) - [Define custom Data Sources](https://roadie.io/docs/tech-insights/define-custom-data-sources.md) - [Displaying Fact Data](https://roadie.io/docs/tech-insights/displaying-fact-data.md) - [Enforce branch protection](https://roadie.io/docs/tech-insights/enforce-branch-protection.md) - [Tech Insights](https://roadie.io/docs/tech-insights/introduction.md) - [Introduction to Scorecards](https://roadie.io/docs/tech-insights/scorecards.md) - [Track Codecov coverage results](https://roadie.io/docs/tech-insights/track-codecov-coverage-results.md) - [Track CODEOWNERS adoption](https://roadie.io/docs/tech-insights/track-codeowners-usage.md) - [Track Datadog SLOs](https://roadie.io/docs/tech-insights/track-datadog-slos.md) - [Tracking Dependency versions](https://roadie.io/docs/tech-insights/track-dependency-versions.md) - [Tracking GitHub Actions Annotations](https://roadie.io/docs/tech-insights/track-deprecated-actions.md) - [Tracking a Docker base image migration](https://roadie.io/docs/tech-insights/track-docker-base-image-migration.md) - [Track Fragments on catalog entities](https://roadie.io/docs/tech-insights/track-fragments.md) - [Track Sonarcloud Project Issues/Hotspots](https://roadie.io/docs/tech-insights/track-sonarcloud.md) - [Track On-prem SonarQube metrics](https://roadie.io/docs/tech-insights/track-sonarqube.md) - [Check labels are being used correctly](https://roadie.io/docs/tech-insights/tracking-catalog-correctness/correct-labels.md) - [Check the GitHub annotation is set](https://roadie.io/docs/tech-insights/tracking-catalog-correctness/github-annotation.md) - [Check mandatory Backstage metadata is set](https://roadie.io/docs/tech-insights/tracking-catalog-correctness/mandatory-metadata.md) - [Check Component lifecycle is valid](https://roadie.io/docs/tech-insights/tracking-catalog-correctness/valid-lifecycle.md) - [Check Component type is valid](https://roadie.io/docs/tech-insights/tracking-catalog-correctness/valid-type.md)