このコンテンツは選択した言語では利用できません。
Chapter 5. 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.
-
Clear the box labeled Copy the
mainbranch only.
-
Clear 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
tssc. -
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 installation program manages and installs all required operator subscriptions. -
manageSubscription:false: The installation program skips installing required operator subscriptions. When set tofalse, Operators installed before deploying RHADS must have Update Approval set to Automatic. If it is set to Manual, the installation might fail with a timeout. - Ensure that existing operators are compatible with RHADS - SSC. Incompatible versions might cause installation failure.
-
5.1. Customizing the tssc.products section of the config.yaml file リンクのコピーリンクがクリップボードにコピーされました!
Customize the tssc.products section to adjust the default products and features. 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.
Procedure
To use a custom software catalog, set the
catalogURL:- name: Developer Hub properties: catalogURL: https://github.com/redhat-appstudio/tssc-sample-templates/blob/release-v1.7.x/all.yaml- name: Developer Hub properties: catalogURL: https://github.com/redhat-appstudio/tssc-sample-templates/blob/release-v1.7.x/all.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow To disable automatic installation of components that are already integrated externally, set
enabled: false:- name: Advanced Cluster Security enabled: false namespace: tssc-acs- name: Advanced Cluster Security enabled: false namespace: tssc-acsCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteIf external integrations are not correctly reflected in the
config.yaml, the installation program will deploy default components. Update the file to prevent unintended provisioning.To select your Identity and Access Management (IAM) provider, set
authProvider:- name: Developer Hub authProvider: <github|gitlab>- name: Developer Hub authProvider: <github|gitlab>Copy to Clipboard Copied! Toggle word wrap Toggle overflow You can specify
github(default) orgitlab.ImportantYou must integrate the authentication provider that you choose.
To enable role-based access control (RBAC) for Developer Hub, set
RBAC.enabledtotrue:Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteIf you do not define
adminUsers, the installation program defaults to the GitHub or GitLab credentials specified during integration. If you specify GitHub as your IAM provider, you can specify anorgslist, but if you specify GitLab it will ignore theorgslist and default to the organization specified in the integration configuration.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:
- name: Developer Hub 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`- name: Developer Hub 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`Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
-
After you complete all necessary changes, you can push it to the cluster using the
tssc config --create ` command. If you are updating a configuration that you have already pushed, specify the `--forceoption too. Once you push the configuration, you can run thetssc deploycommand again to implement the changes.