Chapter 4. Installing RHTAP in your cluster


Once you have configured GitHub, you are ready to install RHTAP in your cluster. The actual installation process is quite simple.

However, if you forked the software catalog, or if you integrated ACS or Quay, you must first customize a file called config.yaml. This is also not difficult.

The following procedures explain how to complete both of these processes.

4.1. (Optional) Customizing config.yaml

If you forked the software catalog, or if you integrated ACS or Quay, you should customize the config.yaml. Customizing this file ensures that the RHTAP installer reacts correctly to the work you did for those procedures.

Procedure

  1. In your CLI, create a new directory.

    $ mkdir tmp
    Copy to Clipboard Toggle word wrap
  2. Extract the install charts to your new directory. Replace $CONFIG with the path of the config.yaml file.

    Note

    You don’t need to add the --config parameter if you run the rhtap-cli installer 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 installer --extract=tmp --config="$CONFIG"
    Copy to Clipboard Toggle word wrap
  3. Create a copy of the config.yaml that now exists in that directory.

    $ cp tmp/config.yaml tmp/my-config.yaml
    Copy to Clipboard Toggle word wrap
  4. Using your preferred text editor, change the contents of the file as appropriate for the optional procedures you completed:

    1. If you forked the software catalog, then change the catalogURL to the URL for your fork, as shown in the example below.

      redHatDeveloperHub:
            enabled: &rhdhEnabled true
            namespace: *installerNamespace
            properties:
              catalogURL: https://github.com/<your username>/tssc-sample-templates/blob/release/all.yaml
      Copy to Clipboard Toggle word wrap
    2. If you integrated ACS or Quay, then change the values for the relevant enabled fields to false. The example below shows the change you need to make for ACS.

      redHatAdvancedClusterSecurity:
            enabled: false
            namespace: rhtap-acs
      Copy to Clipboard Toggle word wrap
      Note

      If you try to integrate ACS or Quay but do not customize config.yaml, RHTAP still installs and uses new instances of those products. You must customize config.yaml for your rhtap-cli integration commands to take effect.

  5. Once you have made the appropriate changes, save the new my-config.yaml file.

If you have configured GitHub and, if necessary, customized config.yaml, then you are ready to install RHTAP.

Prerequisites

  • You must have logged in to your OCP cluster as ClusterAdmin.
  • You must ensure that none of the following operators are already installed in your cluster:

    • AMQ Streams
    • Crunch-Data PostgreSQL
    • OpenShift GitOps
    • Keycloak
    • OpenShift Pipelines
    • Trusted Artifact Signer
    • Quay
    • Advanced Cluster Security
    • Developer Hub

Procedure

  1. In your CLI, run the installation command. If you did not make any changes to config.yaml, you can simply run rhtap-cli deploy. But if you did customize that file, run the following command, and replace the $CONFIG variable with the path of your customized file.

    Note

    Installation takes about fifteen minutes to complete.

    $ rhtap-cli deploy --config=$CONFIG
    Copy to Clipboard Toggle word wrap
  2. Once installation is complete, be sure to save the output of the rhtap-cli deploy command in your ~/install_values.txt file. This output enables you to access your instances of the new products that are now installed.
  3. Now, you can access your instance of RHTAP!

    1. After creating a GitHub app, you may have left the page for your new GitHub app open, as our note suggested. In that case, you can use the link in the banner of that page to access RHTAP.
    2. Otherwise, navigate to your the Authorized GitHub Apps tab on your Applications page. Click on the name of the app you created for RHTAP. Again, in the banner of this page, you can find the link you need to access RHTAP, which begins with https://backstage-developer-hub-rhtap…​.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat