Skip to main content

GitHub

Integrate GitHub with Cloudaware to ingest organizations, repositories, issues, pull requests, workflows, and related SDLC metadata for DevOps governance and reporting.

info
  • Audience: Cloudaware administrators, DevOps
  • Outcome: The GitHub account is connected, and GitHub objects are available in the CMDB for repository governance, workflow visibility, and application correlation

Capabilities​

The integration supports:

  • Read-only discovery of GitHub organizations, repositories, issues, pull requests, workflows, users, teams, and packages in the CMDB
  • Relationships between repositories, SDLC activity, applications, and related cloud assets
  • DevOps governance and SDLC posture reporting in Cloudaware

Prerequisites​

Before you begin, make sure you have:

  • Access to a Cloudaware account.
  • A user with access to the Admin Console and permissions to manage cloud accounts, organizations, and integrations (Cloudaware Administrator).
  • GitHub personal access token (fine-grained or classic) with the required read scopes:
    • For fine-grained access tokens:
      • Actions
      • Codespaces
      • Contents
      • Dependabot alerts
      • Environments
      • Issues
      • Pull requests
      • Secrets*
      • Webhooks
      • Workflows
    • For tokens (classic):
      • repo (full access for private repositories) or public_repo (public repositories only)
      • workflow
      • read:packages
      • read:org
      • read:repo_hook
      • admin:org_hook
      • codespace
      • read:project
note

*Cloudaware collects only metadata of secrets.

Add a GitHub Account to Cloudaware​

To connect your GitHub account to Cloudaware:

  1. In Cloudaware, go to Admin.
  2. Find GitHub Accounts, then click + ADD.
  3. Enter the following values:
    • Name: A display name for this connection.
    • Token: The GitHub personal access token.
  4. Click SAVE.
  5. Confirm that the integration status indicator is green.

View GitHub Data in CMDB​

To browse discovered GitHub resources:

  1. In Cloudaware, open CMDB Navigator.
  2. In the left pane, select GITHUB.
  3. Open an object list, e.g., GitHub Repositories or GitHub Issues, to view records.

Supported Objects​

Cloudaware ingests the following GitHub objects:

GitHub ObjectCMDB Object API Name
GitHub AccountCA10GH__CaGithubAccount__c
GitHub BranchCA10GH__CaGithubBranch__c
GitHub CodespaceCA10GH__CaGithubCodespace__c
GitHub Dependabot AlertCA10GH__CaGithubDependabotAlert__c
GitHub EnvironmentCA10GH__CaGithubEnvironment__c
GitHub IssueCA10GH__CaGithubIssue__c
GitHub OrganizationCA10GH__CaGithubOrganization__c
GitHub PackageCA10GH__CaGithubPackage__c
GitHub ProjectCA10GH__CaGithubProject__c
GitHub Pull RequestCA10GH__CaGithubPullRequest__c
GitHub RepositoryCA10GH__CaGithubRepository__c
GitHub Secret (metadata)CA10GH__CaGithubSecret__c
GitHub TeamCA10GH__CaGithubTeam__c
GitHub UserCA10GH__CaGithubUser__c
GitHub WebhookCA10GH__CaGithubWebhook__c
GitHub WorkflowCA10GH__CaGithubWorkflow__c

Troubleshooting​

note

Initial data collection may take time to complete.

Authentication Fails or Integration Shows Red Status​

  • Verify that the GitHub token is active and copied correctly.
  • Confirm that the token has read access to the organizations and repositories Cloudaware must discover.
  • Check whether the token has expired or was revoked.
  • Re-enter the token by editing the integration in Cloudaware.

Repositories or Organizations Are Missing​

  • Confirm that the token owner can access the missing organizations or repositories in GitHub.
  • Review token scopes and organization access restrictions.
  • In CMDB Navigator, verify that you are viewing the GITHUB section and related resources.

Still stuck? Contact Cloudaware Support at support@cloudaware.com with the integration name and a brief description of the issue.

Reconfigure or Remove the Integration​

warning

To rotate credentials, edit the existing integration instead of deleting and re-creating it.

Update the Integration Details​

  1. Go to Admin.
  2. Select GitHub Accounts.
  3. Select the specific integration.
  4. Open the three-dot menu (⋮), then click Edit.
  5. Update the required fields.
  6. Click Save.

Remove the Integration from Cloudaware​

  1. Go to Admin.
  2. Select GitHub Accounts.
  3. Select the specific integration.
  4. Open the three-dot menu (⋮), then click Delete.
  5. Confirm the deletion if prompted.

Security Notes​

  • Use a dedicated GitHub token for Cloudaware discovery.
  • Grant only the minimum read scopes required for the organizations, repositories, and metadata Cloudaware must discover.
  • Prefer token expiration where supported and rotate tokens according to your organization's policy.
  • Avoid using personal administrator tokens for long-running integrations.
  • Update the Cloudaware integration immediately if the token is revoked, regenerated, or expires.