This documentation is for a release that is no longer maintained
See documentation for the latest supported version.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 Copy linkLink copied to clipboard!
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
In your CLI, create a new directory.
mkdir tmp
$ mkdir tmpCopy to Clipboard Copied! Toggle word wrap Toggle overflow Extract the install charts to your new directory. Replace $CONFIG with the path of the
config.yamlfile.NoteYou don’t need to add the
--configparameter if you run therhtap-cli installercommand from a local clone of the rhtap-cli repo and you’re in the corresponding branch. In this case, RHTAP locatesconfig.yamlautomatically.rhtap-cli installer --extract=tmp --config="$CONFIG"
$ rhtap-cli installer --extract=tmp --config="$CONFIG"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a copy of the
config.yamlthat now exists in that directory.cp tmp/config.yaml tmp/my-config.yaml
$ cp tmp/config.yaml tmp/my-config.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Using your preferred text editor, change the contents of the file as appropriate for the optional procedures you completed:
If you forked the software catalog, then change the
catalogURLto 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.yamlredHatDeveloperHub: enabled: &rhdhEnabled true namespace: *installerNamespace properties: catalogURL: https://github.com/<your username>/tssc-sample-templates/blob/release/all.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow If you integrated ACS or Quay, then change the values for the relevant
enabledfields tofalse. The example below shows the change you need to make for ACS.redHatAdvancedClusterSecurity: enabled: false namespace: rhtap-acsredHatAdvancedClusterSecurity: enabled: false namespace: rhtap-acsCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteIf 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 customizeconfig.yamlfor yourrhtap-cli integrationcommands to take effect.
-
Once you have made the appropriate changes, save the new
my-config.yamlfile.
4.2. Installing RHTAP with the rhtap-cli deploy command Copy linkLink copied to clipboard!
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
In your CLI, run the installation command. If you did not make any changes to
config.yaml, you can simply runrhtap-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.NoteInstallation takes about fifteen minutes to complete.
rhtap-cli deploy --config=$CONFIG
$ rhtap-cli deploy --config=$CONFIGCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
Once installation is complete, be sure to save the output of the
rhtap-cli deploycommand in your~/install_values.txtfile. This output enables you to access your instances of the new products that are now installed. Now, you can access your instance of RHTAP!
- 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.
-
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….