Permalink
Fetching contributors…
Cannot retrieve contributors at this time
107 lines (77 sloc) 4.36 KB

Upgrading {project_name} server

It is important that you upgrade {project_name} server before upgrading the adapters.

To upgrade {project_name} server, complete the following steps:

  1. Prior to applying the upgrade, handle any open transactions and delete the data/tx-object-store/ transaction directory.

  2. Download the new server archive

  3. Move the downloaded archive to the desired location.

  4. Extract the archive. This step installs a clean instance of the latest {project_name} release.

  5. For standalone installations, copy the {project_dirref}/standalone/ directory from the previous installation over the directory in the new installation.

    For domain installations, copy the {project_dirref}/domain/ directory from the previous installation over the directory in the new installation.

    For domain installations, create the empty directory {project_dirref}/domain/deployments.

    NOTE: Files in the bin directory should not be overwritten by the files from previous versions. Changes should be made manually.

  6. Copy any custom modules that have been added to the modules directory.

  7. Run the applicable upgrade script below.

Running the Standalone Mode Upgrade Script

To run the upgrade script for standalone mode, complete the following steps:

  1. If you are using a different configuration file than the default one, edit the migration script to specify the new file name.

  2. Stop the server.

  3. Run the upgrade script:

    bin/jboss-cli.sh --file=bin/migrate-standalone.cli

Running the Standalone-High Availability Mode Upgrade Script

For standalone-high availability (HA) mode, all instances must be upgraded at the same time.

To run the upgrade script for standalone-HA mode, complete the following steps:

  1. If you are using a different configuration file than the default one, edit the migration script to specify the new file name.

  2. Stop the server.

  3. Run the upgrade script:

    bin/jboss-cli.sh --file=bin/migrate-standalone-ha.cli

Running the Domain Mode Upgrade Script

For domain mode, all instances must be upgraded at the same time.

To run the upgrade script for domain mode, complete the following steps:

  1. If you have changed the profile name, you must edit the upgrade script to change a variable near the beginning of the script.

  2. Edit the domain script to include the location of the keycloak-server.json file.

  3. Stop the server.

  4. Run the upgrade script on the domain controller only:

    bin/jboss-cli.sh --file=bin/migrate-domain.cli

Running the Domain-clustered Mode Upgrade Script

For domain-clustered mode, all instances must be upgraded at the same time.

To run the upgrade script for domain-clustered mode, complete the following steps:

  1. If you have changed the profile name, you must edit the upgrade script to change a variable near the beginning of the script.

  2. Edit the domain-clustered script to include the location of the keycloak-server.json file.

  3. Stop the server.

  4. Run the upgrade script on the domain controller only:

    bin/jboss-cli.sh --file=bin/migrate-domain-clustered.cli