Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Control Desk update job parameters

...

Info
titleVersion numbers in directory names

Note that the directory naming does not necessarily follow the exact version of your Identity Server software. The number used in the directory names refers to the earliest version when the configuration structure was taken into use. The same structure may be used for several subsequent product versions.

Control Desk update job parameters

Custom configuration is applied by running the update job for your Identity Cloud service instance on the Identity Cloud Control Desk.

  • Select the correct job and start the Build with Parameters.


PlaybookDescriptionTags
SSO custom configuration update
  1. Copies the Ubilogin custom files to SSO servers.
  2. If other SSO configuration files or templates have been configured, copies them as well.
  3. Sets the file permissions.
  4. Runs the Ubilogin SSO Tomcat update shell script.
  5. Restarts the Ubilogin servers.

This playbook operates on one SSO server at a time to minimize the likelihood of a service break. In a high availability configuration, the other SSO server should be serving normally while the other is being updated.

A single server failing to restart does not have to cause a service break. Current sessions may be affected by failover.

It is possible to make breaking changes which allow the servers to restart, but still cause a service break until the breaking changes have been corrected.

Selective control tags are usually not needed with this playbook.

The tags 'custom', 'tomcat', or 'restart' can be used to perform only that part of the update.

CustomerID custom configuration update
  1. Copies the CustomerID application custom files to CustomerID servers.
  2. Sets the file permissions.
  3. Restarts the CustomerID application servers. CustomerID management console and API will have a service break for the duration of the restart.

If the user has made breaking changes in the custom configuration, CustomerID may fail to restart until the breaking changes have been corrected.

Does not affect the SSO servers.

Selective control tags are usually not needed with this playbook.

The tag 'custom' or 'restart' can be used to perform only that part of the update.

CustomerID data import
  1. Copies the CustomerID import files to the CustomerID master server in a temporary import directory.
  2. Runs the CustomerID import shell script for each file in alphabetical order.

May affect the Ubilogin directory via the imported data only.

Selective control tags are not used with this playbook.
CustomerID LDIF import
  1. Copies the CustomerID LDIF files to the CustomerID master server in a temporary LDIF directory.
  2. Runs the LDAP modify command for each file in alphabetical order.

May affect the Ubilogin directory via the imported data only.

Selective control tags are not used with this playbook.

The Identity Cloud runs the same Identity Server software that you would run on-premises. For more information, please refer to the Identity Server product documentation.

Custom configuration branches

...