Features of the Teamscale Dogus
Core features
Automated provisioning
During the initial installation of the Teamscale dogus, a complete provisioning process takes place. At best, a directly executable Teamscale instance is available after installation. Automated provisioning has its limitations in the use of a separately purchased Teamscale license key. A valid license key in the Dogu config key 'teamscale_license' is the prerequisite here.
Important: Without a valid Teamscale license key, the Teamscale-Dogu can be installed. However, important features in Teamscale are missing. In particular, some Teamscale API calls do not work without a valid license. This concerns, among other things, the synchronization of users/groups and the creation of a backup. For this reason, a valid license is also absolutely necessary to upgrade the Teamscale-Dogu, as this creates and restores a backup.
TIP: "cat teamscale.license | etcdctl set /config/teamscale/teamscale_license " The key file is expected by teamscale in the folder /opt/teamscale/config/ before the start. After that, the Dogu must be manually restarted once.
Other core features common to Dogu
- Single sign-on and single log-out via CAS
- Support for CES backup/restore
- Support for renaming relevant user groups
- Support for change of CES instance FQDN
Automatic import of analysis profiles
On each start the Dogu checks the mounted docker volume /var/lib/ces/teamscale/volumes/analysis_profiles for Teamscale analysis profiles.
The provided analysis profiles need to have the file extension .tsanalysis-profile and were exported directly from Teamscale at best.
After the successful import the analysis profiles will be deleted from the volume.
Errors which occur during the import will be logged to the console but the start process will still continue.
Provide declaration of accessibility
A custom declaration of accessibility can be provided via the docker volume /var/lib/ces/teamscale/volumes/custom_config.
The file containing the declaration have to be named declaration_of_accessibility.md.
If no such file exists inside this volume the declaration will be removed from the Dogu on the next Dogu start.
Provide custom styles
Custom css styles can be provided via the docker volume /var/lib/ces/teamscale/volumes/custom_config.
The file containing the styles have to be named custom.css.
If no such file exists inside this volume any custom styles will be removed from the Dogu on the next Dogu start.
Provide custom finding descriptions
Custom finding descriptions can be provided via the docker volume /var/lib/ces/teamscale/volumes/custom_config.
All files and subfolders inside finding-descriptions will be loaded on Dogu start.
If no descriptions were provided the existing custom descriptions will be removed on the next Dogu start.
Providing default data via importing teamscale backup archives.
Archives can be imported via the Docker volume /var/lib/ces/teamscale/volumes/default_data_archives.
To import the archives, they must be placed there. Afterward the Dogu must be restarted.
After importing the archives, they are automatically deleted from the volume.
The volume is not taken into account by the backup.
Feature control via Dogu configuration key
The following values can be configured via cesapp edit-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
Via the key wait_for_scm_manager you can define if the upgrade process should wait for the SCM Manager Dogu to get healthy
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