When creating a configured API, you must select the GitHub repository that contains the API documents from which Tanzu Service Mesh will create an API specification for the API. For Tanzu Service Mesh to connect to the repository, you must create a GitHub integration to point Tanzu Service Mesh to the organization account on GitHub that owns the repository.

  • Verify that you are familiar with the concept of configured API in Tanzu Service Mesh.

  • Verify that you have created an organization account on GitHub.

  • Verify that you have created a repository within the organization to store the API documents (YAML files) that Tanzu Service Mesh will use to create an API specification for the configured API. Verify that you know the name of the repository.

  • Have your GitHub personal access token ready.

  • Access the Tanzu Service Mesh Console.

Procedure

  1. In the navigation pane on the left, click Admin > Integration.
  2. On the Integrations page, under All Integrations, find the GitHub card.

    If one or more GitHub integration accounts exist in Tanzu Service Mesh, the number of accounts is displayed in the lower-left corner of the card.

  3. Select one of the following options.

    • If you are creating the first GitHub integration account, at the bottom of the card, click Configure.

    • If one or more GitHub integration accounts exist and you are creating another account, at the bottom of the card, click Add Account.

  4. In the New GITHUB Integration dialog box, provide the following information.

    • Name. Enter a name to help identify the account in Tanzu Service Mesh.

    • Description (Optional). Enter an optional description of the account.

    • Access Token. Enter your personal access token on GitHub.

  5. Click Save.

Results

The new account is added to the GitHub integration card on the Integrations page.

Tanzu Service Mesh will connect to GitHub to retrieve a list of the repositories owned by the associated organization account. Now when you create a configured API, you need to first select the appropriate Git integration account-organization pair and then the repository. For more information about creating a configured API, see Configure an API.

What to do next

To view the details of the new GitHub integration account and of the other existing accounts on the integration accounts details page, click View Details on the GitHub card.

To edit the GitHub integration account, click Edit in the GitHub card and then make the changes you want in the Edit GITHUB Integration dialog box. If you have more than one GitHub integration accounts, in the lower-left corner of the card, click number Accounts, click the name of the account, and then click Edit .

To delete the GitHub integration account, click Delete in the GitHub card and then click Confirm. If you have more than one GitHub integration accounts, in the lower-left corner of the card, click number Accounts, click the name of the account, and then click Delete.

Note:

You can also edit or delete a GitHub integration account from the integration accounts details page. Click View Details on the GitHub card. To edit the account, next to the name of the account, click Edit Configuration. To delete the account, click More Actions and then click Delete Account.