Chapter 2. Configuring GitHub for RHTAP

Procedure:

1. Go to your Developer Settings page in GitHub.
2. In the left panel, under Personal access tokens, select Tokens (classic).
3. From the Generate new token drop down menu under the page banner, select Generate new token (classic). You may need to authenticate to continue.
4. Enter a name, select an expiration date, and under Select scopes, select repo (which should automatically include all scopes from repo: status to security_events).

5. Select Generate token. GitHub redirects you to a new page, where your token is visible. Make sure to label and save this token somewhere in your files.

   Note

   If you plan to complete any of the optional procedures, we recommend creating a file (for example, ~/install_values.txt) where you can store all the values that those procedures generate, along with this access token.

Procedure

1. In the web UI or your CLI, login to the OpenShift cluster where you plan to install RHTAP.

2. In your CLI, run the following command to start creating a GitHub application. Replace $TOKEN with the token you created in the previous procedure. Replace $ORG_NAME with the name of the GitHub organization you are using for RHTAP. Replace $APP_NAME with a name you would like to use for your application.

   Replace $CONFIG with the path of the config.yaml file that lists the Helm charts needed to install the required RHTAP components. By default, this file is located in the rhtap-cli/installer directory.

   Note

   You don’t need to add the --config parameter if you run the rhtap-cli integration command from a local clone of the rhtap-cli repo and you’re in the corresponding branch. In this case, RHTAP locates config.yaml automatically.

   $ rhtap-cli integration github-app --create --token="$TOKEN" --org="$ORG_NAME" $APP_NAME --config="$CONFIG"

   Copy to Clipboard Toggle word wrap
3. A web browser window should open. In that window, click Create your GitHub App.
4. The button redirects you to GitHub. If necessary, authenticate in GitHub to confirm access. Then click Create GitHub App for <your organization’s name>.
5. A new message displays, telling you that the app was successfully created. Click on the hyperlinked text to install the new application in your GitHub organization.
6. The link redirects you to GitHub. Click the green Install button.
7. Select the organization that you are using for RHTAP.

8. When prompted, select All repositories, so RHTAP can create new repositories in your organization. Click the green Install button.

   Note

   You may want to keep this GitHub page open, even though you can close it without interrupting installation. In the page banner, there is a link that you can use after installation to access RHTAP (beginning with https://backstage-developer-hub-rhtap…​).

Procedure:

1. In your web browser, navigate to the RHTAP software catalog repository.

2. Beneath the banner of the page, select Fork and fork the repository.

   1. Uncheck the box that says "Copy the main branch only".
3. Once the fork is ready, copy its address. Label and save it in ~/install_values.txt.

4. In your new fork, beneath the banner, click main to open a dropdown menu. Under Tags, select the release that corresponds to the version of RHTAP that you are using.

   Note

   Be sure to update your fork from time to time, so updates from the upstream repository can benefit your instance of RHTAP.