Skip to main content

Ingesting Entities into your Catalog from GitHub

In order to set up GitHub discovery, you will first need to ensure you have configured a GitHub integration using either a GitHub App or Personal Access Token. You will also need admin access to your Portal instance. Once you have confirmed both of these things, you can follow these steps to configure the provider.

  1. In the sidebar, click Config Manager

    The Catalog page with the Config Manager menu item at the bottom of the sidebar highlighted

  2. Underneath Catalog in the Plugins section, click Manage plugin

    The Config Manager page with the Manage plugin option highlighted for the Catalog plugin

  3. Expand providers and then github

    The Config Manager page showing all of the available options for the Catalog plugin, with the github section highlighted

  4. Fill out at least the following required fields

    • organization: The name of your GitHub organization
    • schedule
      • frequency: How often the provider should run. If you're not sure what to set this to, a default value of 3 hours is suggested
      • timeout: The maximum amount of time the operation should take before timing out. If you're not sure what to set this to, a default value of 1 hour is suggested
  5. Scroll down to the bottom of the page and press Save changes and wait until the page has reloaded before navigating away

    The bottom of the Config Manager page with the Save changes button highlighted