48 docs tagged with "system administration"

Release stores completed releases in a database that is separate from the repository: the archived database. Besides the completed releases, metadata for reporting is stored in this database.

It is a best practice to create regular backups of your Release server. This topic describes how to create a backup and how to restore from that backup.

This topic describes how to install Release in a standard installation - either a simple setup with the default configuration, or a manual setup in which you can choose specific options. If you are installing Release in a production-ready environment that includes options like a separate database server, load balancing for your Release servers, an active/active cluster configuration for your Release servers, and other security, monitoring, and performance considerations, see Production environment install.

You can automate the cleanup of old releases by setting up a template with a cleanup script that will be periodically triggered by criteria that you provide. You can use this procedure in cases where many releases are in a failed state that are older than a specified period of time.

This topic describes how to install and upgrade Release as a cluster. Running Release in a cluster mode lets you have a Highly Available (HA) Release setup. Release supports the following HA mode.

Release has a role-based security system with two types of users:

This topic describes how to configure Keycloak to authenticate Release users and REST API calls (using the Bearer Token Authorization).

What are roles?

What are Tasks?

Release timeout

To configure connections between Release and Deploy servers, click Connections under Configuration from the navigation pane, and go to the Deploy Server section.

Release export hooks are a powerful mechanism you can use to define Jython scripts that export information about completed and aborted releases before they are archived.

You can use the export hook feature to configure Release to run a Jython script for every release that is about to be archived.

The Feature Settings page allows you to toggle or configure the optional features in Digital.ai Release. To configure the feature settings, from the navigation bar, click Settings > System Settings, and then click Feature flags tab. The Feature flags page is only available to users who have the Admin global permission.

In Release you can configure the file upload properties. File upload properties are used to set a limit for the size of uploaded files and to restrict content accepted by Release.

To configure Release, select Settings > General from the top menu. The General settings page is only available to users who have the Admin global permission.

What are permissions?

You can use variables to manage information that you don't know in advance or that may change. Global variables can be used in all templates and releases to manage shared information (unlike release variables, which are limited to a single release or template).

All completed and aborted releases are archived, which means that they are removed from the Digital.ai Release repository and stored in a different internal database, which is called the archive database. This improves performance and allows you to create custom hooks that export release information to external databases or reporting tools.

Cross site request forgery or CSRF is a class of attack that forces an end user to execute unwanted actions on an application when the user is authenticated. You can configure CSRF protection in Release.

You can configure GZIP compression in Release. GZIP compression is used to decrease the size of server responses and save bandwidth usage. There is a small overhead of server CPU usage to compress content. It is enabled by default, but you may want to adjust the settings depending on your use case.

* For better security, Digital.ai Release 22.1 and later support the sameSite attribute of the Set-Cookie HTTP response header allowing session cookies to be restricted to a first-party or same-site context.

This page covers the minimum hardware and software requirements to install and run Digital.ai Release. Also, you will get information about the supported operating systems, databases, web browsers, kubernetes platforms, JDKs, message brokers, upgrade versions, and so on. Ensure that your setup is better than the stated minimum requirements, depending on your site's size and usage pattern. For more assistance, contact Digital.ai support.

This topic describes how support Single Sign-On (SSO) by configuring Release to use Integrated Windows Authentication to authenticate users and retrieve role (group) membership without prompting the users for a user name and password. In Release, Active Directory users and groups become principals that you can assign to roles.

Digital.ai Release has a role-based security system with two types of users:

In Digital.ai Release there are two main types of licenses: a 30 day Trial Edition license, and a new bundle license(v4) Essentials, Pro, and Premium Edition. If you have opted for a new bundle license(v4) Essentials, Pro, and Premium Edition license of Digital.ai Release, you can download your license file from the Deploy/Release Software Distribution site. This site requires any one of the Essentials, Pro, and Premium customer logins. If you have a Trial Edition of Digital.ai Release, you will receive a license key by email when you register to download a trial.

By default, the Digital.ai Release server writes information, such as: warnings, errors, and log messages to your terminal output and to XLRELEASESERVER_HOME/log/xl-release.log.

Change the encryption key password

Release provides a mechanism to automatically encrypt passwords and enables you to refer to them, so you do not need to store third-party passwords in plain text in configuration files. To declare a new third-party password:

Personal Access Tokens (PAT) are used as an alternative to passwords for authenticating with Digital.ai Release. You can use PATs with public APIs and webhook endpoints.

Digital.ai Release runs on the Java Virtual Machine (JVM) and has two classloaders: one for the server itself, and one for the plugins and extensions. A plugin can have a .jar extension. The JAR format is a ZIP archive that bundles a plugin with all of its dependencies.

You can manage your Digital.ai Release plugins directly from the Digital.ai Release user interface. The plugin manager displays the list of installed plugins and their current version. With the plugin manager you can upload a new plugin or a new version of an installed plugin directly from the user interface.

A production setup in Release consists of an external clustered database to store operational and archived data from Release.

To edit your Release user profile, select User management > User profile from the top menu.

You can clean up the archived releases in the archive database by purging the archived releases.

Release features a modular architecture that allows you to change and extend components while maintaining a consistent system. This is a high-level overview of the system architecture:

Set the global risk threshold

In Release, you can store template versions inside a folder in a Source Control Management (SCM) tool. This provides easier management of all the artifacts, and provides the possibility to store them together with Releasefiles and Jenkinsfiles, and to configure and to use them from a release pipeline. You can define an SCM connection on a folder level or on a global level in Release.

* This topic describes how to configure Release authentication using the OpenID Connect (OIDC) protocol. OpenID Connect (OIDC) is an identity layer built on top of the OAuth 2.0 protocol and supported by various OAuth 2.0 providers.

Before shutting down Release ensure that no critical processes or tasks are active. When Release restarts, it will place active tasks in a failed state.

In Release, you can configure an SMTP server to send notifications to users via email. This can be for events that occur during the execution of the release. To set up the SMTP server, you will need information such as the server's hostname, port, and login details. Once it's set up, Release can use the SMTP server to send emails to users as notifications.

To start the Release server, open a command prompt or terminal, point to the XLRELEASESERVER_HOME/bin directory, and execute the appropriate command:

This topic describes how to install a trial version of Release.

This topic describes how to troubleshoot the Release service.

If you configured your Deploy server to use a self-signed certificate and then added the server to Release, you will notice that testing the connection fails with the following error:

The Release Setup Wizard can generate a self-signed digital certificate for secure communications. This can cause issues in situations where Release needs to be accessed via a URL other than https5516, because the common name in the certificate is localhost. For more information, see Install Release using a manual setup.

This topic describes the prerequisites, process and considerations for upgrading to the latest version of Release.

Who are users?