Create a GitHub App in CommvaultSaaS organization and add the credentials to Commvault Credential Manager to enable Express Configuration for tenants.
Prerequisites
- GitHub account with owner or administrator access to the CommvaultSaaS organization
- Access to Commvault with permissions to add credentials
Create a GitHub App
-
Log in to GitHub as an owner or administrator to the CommvaultSaaS organization.
-
Navigate to the GitHub App creation page: Organization Settings > Developer settings > GitHub Apps > New GitHub App.
-
Configure the app:
-
GitHub App name: Enter a descriptive name (cannot start with "GitHub")
-
Homepage URL: Enter your organization's URL or
https://localhost -
Callback URL: Enter the callback URL: https://console.commvault.com/commandcenter/msOAuthRedirect.jsp
-
Enable Redirect on update
-
-
Select scope:
- Any account (for public apps)
-
Set permissions:
Repository Permissions
-
Administration: Read & Write
-
Commit Statuses: Read & Write
-
Contents: Read & Write
-
Custom Properties: Read & Write
-
Metadata: Read Only
-
Pull Requests: Read & Write
-
Webhooks: Read & Write
-
Workflow: Read & Write
Organization/Account Permissions
-
Members: Read Only
-
Plan: Read Only
-
-
Click Create GitHub App.
-
Obtain credentials:
a. Copy the Client ID
b. Click Generate a new client secret and copy it immediately
Important
The client secret is shown only once.
c. Under Private keys, click Generate a private key and download the
.pemfile
Add Credentials to Commvault
-
From the navigation pane, go to Manage > Security.
The Security page appears.
-
Click the Credential vault tile.
The Manage credentials page appears.
-
Click the Vault configuration tab, and then click Add from the upper-right corner of the page.
The Add credential vault dialog box appears.
-
In the Add Credential dialog box, configure the following:
a. Account type: Select Cloud Account
b. Vendor type: Select GitHub
c. Authentication Type: Select GitHub App
d. Credential Vault: Select Built-In
e. Credential name: Enter a descriptive name
f. Client ID: Paste the Client ID from GitHub
g. Client secret: Paste the Client Secret from GitHub
h. Private key: Click Upload and select the
.pemfilei. Description: Enter a description (include organization and date)
j. Click Save
-
Note the credential ID assigned by the system for the next step.
After adding credentials, configure the GitHub_App_OnboardingAppCredentialID CommCell setting with this credential ID. For details, see Configuring DevOps Additional Settings.