> Software > Protect > SaaS > DevOps Solutions > GitHub

Configure a GitHub Instance

Create a GitHub instance that will contain the projects and repositories you want to manage and back up. Each GitHub instance is scoped to a single organization or account. If you need to back up multiple organizations, you must create a separate GitHub instance for each organization.

Before You Begin

  • If you are an MSP and you want your tenant administrators to create the DevOps app, see Infra Admin.

  • If you are an MSP and want to enable Express Configuration for your tenants using Custom Configuration, see Create GitHub App and Add Credentials.

  1. From the Command Center navigation pane, go to Explore > Service catalog.

Choose GitHub

  1. On the DevOps tile, click Configure.

  2. Select GitHub.

    The Configure GitHub App wizard appears.

Connection Settings

  1. On the Connection Settings page, in the App name box, enter a descriptive name for the GitHub application.

  2. From the Account type list, select the account type—personal or business/institution—and then select the account or organization.

  3. From the Hosting type list, select the hosting type:

    • GitHub Cloud: For cloud-hosted GitHub repositories.

    • GitHub Enterprise Server: For on-premises GitHub enterprise server.

  4. If you selected GitHub Enterprise Server, in the Host URL box, enter the URL for the GitHub enterprise server.

Authentication Configuration

Account Type Authentication Method
Business/Institution GitHub App (Express or Custom Configuration)
Personal Personal Access Token (PAT)

Note

After configuring your GitHub instance, you can switch between authentication methods. For more information, see Switch GitHub Authentication Method.

Select one of the following authentication methods:

Express Configuration

Use the GitHub App provided by Commvault. This is the recommended method for quick setup.

  1. Click Express Configuration.

  2. Log in to your GitHub account.

  3. Select the organization or account where you want to install the app.

  4. On the Install & Authorize page, review the GitHub App details:

  5. The app name and the organization where it will be installed are displayed.

  6. Review the permissions that will be granted.

  7. Under for these repositories, select the repository scope:

  8. All repositories: The app applies to all current and future repositories owned by the organization. Also includes public repositories (read-only).

  9. Only select repositories: Select specific repositories for the app to access. Also includes public repositories (read-only).

  10. Click Install & Authorize to complete the authentication.

    Note

    If you are reauthorizing an organization that has already been added, GitHub may not automatically redirect after clicking Install & Authorize. In this case, switch to the other repository scope option (for example, from All repositories to Only select repositories or vice versa), then switch back to your preferred option, and click Save to complete the redirect.

  11. Click Next.

Note

If you configure your GitHub instance using Express Configuration during onboarding, you can add multiple Express apps provided by Commvault up to the number of apps set by your MSP. Using multiple GitHub apps can help reduce API rate limit errors and improve backup performance.

Custom Configuration

Create and configure your own GitHub App for authentication.

  1. Click Custom Configuration.

  2. Create a GitHub App.

  3. In the Commvault wizard, click the plus button (+) to add credentials to the Credential Manager, and then specify the following in the Add Credential dialog box:

    a. From the Authentication Type list, select GitHub App.

    b. In the Credential name box, enter the name of the credential.

    c. In the Client ID box, paste the Client ID from GitHub.

    d. In the Client secret box, paste the Client Secret from GitHub.

    e. In the Private key box, click Upload and select the .pem file you downloaded, or paste the contents of the .pem file.

    f. In Description, enter a description of the credentials.

    g. Click Save.

  4. Click Next.

Note

If you configured your GitHub instance using Custom Configuration, you must provide your own GitHub Apps when adding additional instances on the Connection Settings page of the wizard.

Account Type Authentication Method
Business/Institution GitHub App OR PAT
Personal Personal Access Token (PAT)

Note

After configuring your GitHub instance, you can switch between authentication methods. For more information, see Switch GitHub Authentication Method.

Custom Configuration

Create and configure your own GitHub App for authentication.

  1. Click Custom Configuration.

  2. Create a GitHub App.

  3. In the Commvault wizard, click the plus button (+) to add credentials to the Credential Manager, and then specify the following in the Add Credential dialog box:

    a. From the Authentication Type list, select GitHub App.

    b. In the Credential name box, enter the name of the credential.

    c. In the Client ID box, paste the Client ID from GitHub.

    d. In the Client secret box, paste the Client Secret from GitHub.

    e. In the Private key box, click Upload and select the .pem file you downloaded, or paste the contents of the .pem file.

    f. In Description, enter a description of the credentials.

    g. Click Save.

  4. Click Next.

Note

If you configured your GitHub instance using Custom Configuration, you must provide your own GitHub Apps when adding additional instances on the Connection Settings page of the wizard.

Personal Access Token (PAT) Authentication

Use a Personal Access Token for authentication. This method is required for personal accounts and GitHub Enterprise Server.

  1. From the Account type list, select the account type—personal or business/institution—and then select the account or organization.

  2. From the Credential list, select existing credentials or create new credentials.

    To add credentials to the Credential Manager, click the plus button (+), and then specify the following in the Add Credential dialog box:

    a. In the Credential name box, enter the name of the credential.

    b. In Access token, enter the PAT.

    c. In Description, enter a description of the credentials.

    d. Click Save.

    For more information about creating an access token, go to the GitHub docs site.

    For information about the required access token permissions and user roles, see Personal Access Token Permissions and User Roles.

  3. Click Next.

The Access Nodes page appears.

Access Node Selection

  1. Choose one of the following options for access nodes:

    • Use hosted infrastructure: Select this option to use the hosted infrastructure provided by Commvault for backups.

      1. Select the region where the GitHub data is hosted, and then click Next.

    • Use your access nodes for backups: Select this option if you want to use your own configured access nodes for performing backups.

      Note

      If the MSP has configured a workload resource pool in a single region and no access node is configured by the tenant, this step will not appear. Access nodes configured in the workload resource pool are selected automatically.

Plan Creation

  1. Select a backup plan:

    Select an existing bundled storage plan or create a new bundled storage plan to associate with the GitHub instance.

    Note

    • When creating a new plan, if storage resources are configured in the selected region, the region is automatically populated.

    • If storage resources are not configured in the selected region, select the region manually. In this case, the MediaAgent you provide will be used as the storage MediaAgent.

    Select an existing backup plan or create a new backup plan to associate with the GitHub instance.

Choose Backup Content

  1. Select the backup content you want to protect.

Submit

  1. Review your selections, and then click Submit to complete the configuration.
×

Loading...