Features of the Teamscale Dogu
Core features
Automated provisioning
During the initial installation of the Teamscale Dogu, a complete provisioning process takes place. At best, a directly usable Teamscale instance is available after the installation. Automated provisioning has its limitations when using a separately purchased Teamscale license key. A valid license key in the Dogu config key teamscale_license is required.
Important: The Teamscale Dogu can be installed without a valid Teamscale license key. However, important features in Teamscale will be missing. In particular, some Teamscale API calls do not work without a valid license. This affects, among other things, user/group synchronization and creating backups. For this reason, a valid license is also absolutely required to upgrade the Teamscale Dogu, since a backup is created and restored during the upgrade.
kubectl edit configmap -n ecosystem teamscale-config
data:
config.yaml: |
teamscale_license: "<license>"The license file is expected by Teamscale in the folder /opt/teamscale/config/ before startup.
After that, the Dogu must be restarted manually once.
Other core features common to Dogus
- Single sign-on and single log-out via CAS
- Support for CES backup/restore
- Support for renaming relevant user groups
- Support for changing the CES instance FQDN
Automatic import of analysis profiles
Whenever the Teamscale Dogu starts, it checks the volume /tmp/analysis_profiles for Teamscale analysis profiles.
The provided profiles must end with .tsanalysisprofile and should ideally be exported directly from Teamscale.
After a successful import, the profile exports are deleted from the directory.
Errors during the import are logged, but the overall startup process is not aborted.
Providing a declaration of accessibility
A custom declaration of accessibility can be provided via the volume /tmp/custom_config.
The file must be named exactly declaration_of_accessibility.md.
If no such file exists in the volume, an already existing file will be removed from the Dogu on the next startup.
Providing custom styles
Custom styles for adapting Teamscale can be provided via the volume /tmp/custom_config.
The file must be named exactly custom.css.
If no such file exists in the volume, an already existing file will be removed from the Dogu on the next startup.
Providing custom finding descriptions
Custom finding descriptions can be stored in the Dogu via the volume /tmp/custom_config.
All files and subdirectories inside a directory named finding-descriptions are read on Dogu startup and made available to the application.
If no descriptions are provided, already deployed descriptions are removed again on the next startup.
Providing default data via importing Teamscale backup archives
Archives can be imported via the volume /opt/teamscale/default_data_archives.
To import archives, place them there and then restart the Dogu.
After the archives have been imported, they are automatically deleted from the volume.
The volume is not included in backups.
Feature control via Dogu configuration keys
The following values can be configured via kubectl edit configmap -n ecosystem teamscale-config:
License key
teamscale_license
Gravatar
The key disable_gravatar can be used to disable Gravatar.
Valid values: TRUE | FALSE
Default value: TRUE
If the key is not explicitly set to FALSE, Gravatar is always disabled.
SCM Manager
The key wait_for_scm_manager defines whether the upgrade should wait until the SCM Manager Dogu is reachable.
Valid values: TRUE | FALSE
Default value: TRUE
Container resources
Configure container memory limit
container_config/memory_limit
Configure swap file
container_config/swap_limit
Configure Java max RAM value
container_config/java_max_ram