Chapter 3. Customizing the config.yaml file
Use this procedure to customize the config.yaml
file before integrating products and external services. Customizing this file ensures that your integrations and preferences are preserved during installation.
Prerequisites
- You have access to the OpenShift Web Console.
- You plan to integrate at least one external product or service (For example, RHACS or Quay).
(Optional) Forked software catalog repository URL. RHTAP provides a catalog of software templates that help developers scaffold applications. To customize these templates, fork the repository before installation.
- In your browser, go to the RHTAP software catalog repository.
Click Fork to fork the repository.
-
Uncheck the box labeled Copy the
main
branch only.
-
Uncheck the box labeled Copy the
-
When the fork is created, copy its URL and save it in the
private.env
file. - In the forked repository, click main to open the branch/tag dropdown.
Under Tags, select the release that matches your RHTAP version.
NoteUpdate your fork periodically to include changes from the upstream repository.
Procedure
- In the OpenShift console, switch to the Administrator perspective.
- Go to Workloads > ConfigMaps.
- From the Project drop down list, select RHTAP.
-
Open the
rhtap-cli-config
ConfigMap. Select the YAML view and navigate to where
config.yaml
parameters are defined.NoteIf your cluster already includes the required subscriptions or operators, you can prevent the installer from creating new ones by setting the
manageSubscription
property tofalse
.-
manageSubscription: true
(default): The installer manages and installs all required operator subscriptions.
-
manageSubscription: false
: The installer skips installing required operator subscriptions because it assumes they already exist on the cluster.- Ensure that the pre-installed operators are compatible with RHTAP. Incompatible versions or configurations may cause the installation to fail.
Update the following fields as needed:
To use a custom software catalog, set the
catalogURL
:Copy to Clipboard Copied! Toggle word wrap Toggle overflow redhatDeveloperHub: properties: catalogURL: https://github.com/<your-org>/tssc-sample-templates/blob/releases/all.yaml
redhatDeveloperHub: properties: catalogURL: https://github.com/<your-org>/tssc-sample-templates/blob/releases/all.yaml
To disable installation of components you’ve integrated externally (for example, ACS and Quay):
Copy to Clipboard Copied! Toggle word wrap Toggle overflow redhatAdvancedClusterSecurity: enabled: &rhacsEnabled false namespace: &rhacsNamespace rhtap-rhacs redHatQuay: enabled: &quayEnabled false namespace: &quayNamespace rhtap-quay
redhatAdvancedClusterSecurity: enabled: &rhacsEnabled false namespace: &rhacsNamespace rhtap-rhacs redHatQuay: enabled: &quayEnabled false namespace: &quayNamespace rhtap-quay
NoteIf you try to integrate outside products or pre-existing instances, but do not customize
config.yaml
, Red Hat Trusted Application Pipeline still installs and uses its default products. You must customizeconfig.yaml
for yourrhtap-cli integration
commands to take effect. However, if you do not customizeconfig.yaml
for yourrhtap-cli integration
, the installer deploys the product and overrides the existing integrations.
To enable the RBAC plugin in Developer Hub, configure the
RBAC
property in theredhatDeveloperHub
section.Copy to Clipboard Copied! Toggle word wrap Toggle overflow RBAC: enabled: true # Enables the RBAC feature. adminUsers: # GitHub usernames that should have administrator access. - yourGitHubUsername - anotherGitHubAdmin orgs: # GitHub organizations whose members are imported into the Developer Hub catalog with access roles. - your-github-org
RBAC: enabled: true # Enables the RBAC feature. adminUsers: # GitHub usernames that should have administrator access. - yourGitHubUsername - anotherGitHubAdmin orgs: # GitHub organizations whose members are imported into the Developer Hub catalog with access roles. - your-github-org
NoteIf you omit
adminUsers
ororgs
, the installer defaults to the GitHub user and organization that were configured when integrating the GitHub application.
To use a custom namespace instead of the default one, configure the
namespacePrefixes
property in theredhatDeveloperHub
section of theconfig.yaml
file. By default, RHTAP creates four namespaces during installation:-
rhtap-app-ci
: For CI pipeline workloads rhtap-app-development
,rhtap-app-stage
, andrhtap-app-prod
: For development, staging, and prod deploymentsYou can customize the prefixes for these namespaces and define additional namespace sets by using the
namespacePrefixes
property. For example, you can configure custom prefixes to generate namespaces such asmy_prefix1-app-ci
,my_prefix1-app-development
,my_prefix1-app-stage
, andmy_prefix1-app-prod
.Copy to Clipboard Copied! Toggle word wrap Toggle overflow redhatDeveloperHub: namespacePrefixes: - my_prefix1 - my_prefix2
redhatDeveloperHub: namespacePrefixes: - my_prefix1 - my_prefix2
- After you complete all necessary changes, select Save.
-