Chapter 3. Customizing the config.yaml file
Customize the config.yaml file before integrating external products and services to preserve your integration settings 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. RHADS - SSC 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 RHADS - SSC software catalog repository.
Click Fork to fork the repository.
-
Uncheck the box labeled Copy the
mainbranch only.
-
Uncheck the box labeled Copy the
-
When the fork is created, copy its URL and save it in the
private.envfile. - In the forked repository, click main to open the branch/tag dropdown.
Under Tags, select the release that matches your RHADS - SSC 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 RHADS - SSC.
-
Open the
tssc-configConfigMap. Select the YAML view and navigate to where
config.yamlparameters are defined.NoteTo avoid reinstalling operator subscriptions already present on your cluster, set
manageSubscription:false.-
manageSubscription:true(default): The installer manages and installs all required operator subscriptions. -
manageSubscription:false: The installer skips installing required operator subscriptions. - Ensure that existing operators are compatible with RHADS - SSC. Incompatible versions may cause installation failure.
-
Structure of the config.yaml file
The config.yaml file is structured under the main tssc object with these key attributes:
-
namespace: Defines the default installation namespace (typicallytssc), serving as the primary operational area. -
settings: Controls global deployment settings and properties. -
products: Lists products and features for deployment, each identified by a unique name with associated properties. -
dependencies: Specifies dependencies that the installer deploys in the order defined in the configuration file.
Customizing the tssc.products section
To use a custom software catalog, set the
catalogURL:developerHub: properties: catalogURL: https://github.com/<your-org>/tssc-sample-templates/blob/release-v1.6.x/all.yamlTo disable automatic installation of components that are already integrated externally:
advancedClusterSecurity: enabled: &rhacsEnabled false namespace: &rhacsNamespace tssc-acs quay: enabled: &quayEnabled false namespace: &quayNamespace tssc-quayNoteIf external integrations are not correctly reflected in the
config.yaml, the installer will deploy default components. Update the file to prevent unintended provisioning.To enable role-based access control (RBAC) for Developer Hub:
developerHub: RBAC: enabled: true adminUsers: - yourGitHubUsername - anotherGitHubAdmin orgs: - your-github-orgNoteIf you do not define
adminUsersororgs, the installer defaults to the GitHub credentials specified during integration.To use custom namespace prefixes instead of the default ones, configure the
namespacePrefixesproperty. By default, RHADS - SSC creates the following namespaces during installation:-
tssc-app-ci: For continuous integration pipeline workloads tssc-app-development,tssc-app-stage, andtssc-app-prod: For development, staging, and production deploymentsYou can customize the prefixes for these namespaces and define additional sets. For example:
developerHub: namespacePrefixes: - my_prefix1 # This generates the following namespaces: `my_prefix1-app-ci`, `my_prefix1-app-development`, `my_prefix1-app-stage`, `my_prefix1-app-prod` - my_prefix2 # This generates the following namespaces: `my_prefix2-app-ci`, `my_prefix2-app-development`, `my_prefix2-app-stage`, `my_prefix2-app-prod`-
- After you complete all necessary changes, select Save.