KB-2254 How to use the isSuitableForUpgrade script

pauline.delacruz — Thu, 10 Aug 2023 13:37:34 GMT

Current Revision posted to Appian Knowledge Base by pauline.delacruz on 8/10/2023 1:37:34 PM

Purpose

In order to safely upgrade an Appian environment, the engines in the source environment must be shut down using the stop script. Ungraceful shutdowns can introduce data inconsistencies and can lead to a failed upgrade.

The isSuitableForUpgrade.sh script can be used to detect if engines are not shutdown gracefully before the upgrade is performed. This helps validate the state of the engine data and confirms whether the data is in a state in which it can be safely be upgraded to a higher Appian version.

This script currently only works with single node and highly available(HA) topologies where the service_manager.log is in a central location. This script currently does not work with distributed topologies where the service_manager.log can be present on multiple servers.

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh -p <your_service_manager_password>

The script will detect if the engines are suitable for upgrade and output the result to the console.

If all engines are suitable for upgrade, it is safe to proceed with the next steps of the upgrade procedure. Sample output:

Date of evaluation: * 

The below results refer to the shutdown performed at * 
If the timestamp is incorrect, please start and stop your engines then try again.

15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade

If one or more engines are unsuitable for upgrade, run the following steps. Sample output:

Date of evaluation: * 

The below results refer to the shutdown performed at * 
If the timestamp is incorrect, please start and stop your engines then try again.

12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Start all engines.
Verify that all engines are running.
Shut down all engines.
Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: August 2023

Tags: engines, linux, upgrade, infrastructure

KB-2254 How to use the isSuitableForUpgrade script

pauline.delacruz — Thu, 10 Aug 2023 13:37:21 GMT

Revision 21 posted to Appian Knowledge Base by pauline.delacruz on 8/10/2023 1:37:21 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh -p <your_service_manager_password>

The script will detect if the engines are suitable for upgrade and output the result to the console.

If all engines are suitable for upgrade, it is safe to proceed with the next steps of the upgrade procedure. Sample output:

Date of evaluation: * 

The below results refer to the shutdown performed at * 
If the timestamp is incorrect, please start and stop your engines then try again.

15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade

If one or more engines are unsuitable for upgrade, run the following steps. Sample output:

Date of evaluation: * 

The below results refer to the shutdown performed at * 
If the timestamp is incorrect, please start and stop your engines then try again.

12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Start all engines.
Verify that all engines are running.
Shut down all engines.
Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

KB-2254 How to use the isSuitableForUpgrade script

pauline.delacruz — Fri, 04 Aug 2023 17:21:48 GMT

Revision 20 posted to Appian Knowledge Base by pauline.delacruz on 8/4/2023 5:21:48 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh -p <your_service_manager_password>
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the next steps of the upgrade procedure. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

KB-2254 How to use the isSuitableForUpgrade script

pauline.delacruz — Fri, 04 Aug 2023 15:23:26 GMT

Revision 19 posted to Appian Knowledge Base by pauline.delacruz on 8/4/2023 3:23:26 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the next steps of the upgrade procedure. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-2254 How to use the isSuitableForUpgrade script

pauline.delacruz — Tue, 18 Jul 2023 13:10:19 GMT

Revision 18 posted to Appian Knowledge Base by pauline.delacruz on 7/18/2023 1:10:19 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the next steps of the upgrade procedure. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

KB-2254 How to use the isSuitableForUpgrade script

pauline.delacruz — Fri, 14 Jul 2023 17:00:24 GMT

Revision 17 posted to Appian Knowledge Base by pauline.delacruz on 7/14/2023 5:00:24 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the next steps of the upgrade procedure. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

Tejas Kargutkar — Wed, 12 Jul 2023 15:30:58 GMT

Revision 16 posted to Appian Knowledge Base by Tejas Kargutkar on 7/12/2023 3:30:58 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the next steps of the upgrade procedure. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

Tejas Kargutkar — Wed, 12 Jul 2023 15:25:31 GMT

Revision 15 posted to Appian Knowledge Base by Tejas Kargutkar on 7/12/2023 3:25:31 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the next steps of the upgrade procedure. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

Tejas Kargutkar — Wed, 12 Jul 2023 15:23:54 GMT

Revision 14 posted to Appian Knowledge Base by Tejas Kargutkar on 7/12/2023 3:23:54 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with copying the data to the target location. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

Tejas Kargutkar — Wed, 12 Jul 2023 15:20:22 GMT

Revision 13 posted to Appian Knowledge Base by Tejas Kargutkar on 7/12/2023 3:20:22 PM

Purpose

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is HA, place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with copying the data to the target location. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

Tejas Kargutkar — Wed, 12 Jul 2023 15:16:15 GMT

Revision 12 posted to Appian Knowledge Base by Tejas Kargutkar on 7/12/2023 3:16:15 PM

Purpose

//Make a comment saying this script currently only works with single node and HA topologies where the service_manager.log is in a central location.

Instructions

How to execute the script:

After shutting down all Appian components, download the script to the server that hosts the Appian engines.
1. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with copying the data to the target location. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

rachel.gillespie — Tue, 11 Jul 2023 19:34:57 GMT

Revision 11 posted to Appian Knowledge Base by rachel.gillespie on 7/11/2023 7:34:57 PM

Purpose

//Make a comment saying this script currently only works with single node and HA topologies where the service_manager.log is in a central location.

Instructions

How to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian engines.
1. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh - Which location?? <AE-Home>/logs?
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

Tejas Kargutkar — Mon, 10 Jul 2023 18:58:30 GMT

Revision 10 posted to Appian Knowledge Base by Tejas Kargutkar on 7/10/2023 6:58:30 PM

Purpose

//Make a comment saying this script currently only works with single node and HA topologies where the service_manager.log is in a central location.

Instructions

How to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian engines.
1. If the environment is highly-available (HA) or distributed, place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting the engines.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh - Which location?? <AE-Home>/logs?
The script will detect if the engines are suitable for upgrade and output the result to the console - //Does it also write to a file? If so it should be indicated here. Add a screenshot of the expected behavior instead.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

Elly Meng — Fri, 07 Jul 2023 19:52:18 GMT

Revision 9 posted to Appian Knowledge Base by Elly Meng on 7/7/2023 7:52:18 PM

Purpose

In order to safely upgrade an Appian environment, the engines in the source environment must be shut down properly. Otherwise, the target (upgraded) environment will not be viable and the upgrade must be attempted again.

The isSuitableForUpgrade.sh script can be used to detects improperly shut down engines before the upgrade is performed. This helps save time by preventing time-consuming complications related to the upgrade process.

Instructions

How to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian engines.
1. If the environment is highly-available (HA) or distributed, place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting the engines.
2. If the environment is on a single server, place the script in <APPIAN_HOME>/logs.
Make the script executable by running chmod +x isSuitableForUpgrade.sh.
Run ./isSuitableForUpgrade.sh
The script will detect if the engines are suitable for upgrade and output the result to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade. Sample output:
```
15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade
```
2. If one or more engines are unsuitable for upgrade, run the following steps. Sample output:
```
12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again
```
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please create a case with Appian Support.

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

pauline.delacruz — Thu, 06 Jul 2023 20:56:05 GMT

Revision 8 posted to Appian Knowledge Base by pauline.delacruz on 7/6/2023 8:56:05 PM

Purpose

In order to safely upgrade an Appian environment, the engines in the source environment must be shut down properly. Failure to shut down the engines properly will cause the upgrade to fail. In these cases, the target (upgraded) environment is not viable, and the upgrade must be attempted again.

The isSuitableForUpgrade.sh script automatically detects improperly shut down engines before the upgrade is performed. This script helps to save time when upgrading Appian and prevents time-consuming complications related to the upgrade process.

Instructions

Run the following steps to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian Engines.
1. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting engines.
2. If the engines are hosted on a single server, place the script in <APPIAN_HOME>/logs.
Make the isSuitableForUpgrade.sh script executable.
1. chmod +x isSuitableForUpgrade.sh
Run the following command: ./isSuitableForUpgrade.sh
The script will automatically detect if engines are suitable for upgrade and output to the console.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade.
2. If one or more engines is unsuitable for upgrading, run the following steps:
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 3-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please open a ticket with Appian Support.

Sample Output

Sample Output 1: All engines were shut down properly and it is safe to proceed with the upgrade

15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade

Sample Output 2: One or more engine was not shut down cleanly, and it is not safe to proceed with the upgrade.

12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux.

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

pauline.delacruz — Thu, 06 Jul 2023 20:51:06 GMT

Revision 7 posted to Appian Knowledge Base by pauline.delacruz on 7/6/2023 8:51:06 PM

Purpose

Instructions

Run the following steps to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian Engines.
1. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting engines.
2. If the engines are hosted on a single server, place the script in <APPIAN_HOME>/logs.
Make the isSuitableForUpgrade.sh script executable.
1. chmod +x isSuitableForUpgrade.sh
Run the following command: ./isSuitableForUpgrade.sh
The script will automatically detect if engines are suitable for upgrade.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade.
2. If one or more engines is unsuitable for upgrading, run the following steps:
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 2-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please open a ticket with Appian Support.

Sample Output

Sample Output 1: All engines were shut down properly and it is safe to proceed with the upgrade

15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade

Sample Output 2: One or more engine was not shut down cleanly, and it is not safe to proceed with the upgrade.

12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux.

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

pauline.delacruz — Thu, 06 Jul 2023 20:29:45 GMT

Revision 6 posted to Appian Knowledge Base by pauline.delacruz on 7/6/2023 8:29:45 PM

Purpose

Instructions

Run the following steps to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian Engines.
1. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting engines.
2. If the engines are hosted on a single server, place the script in <APPIAN_HOME>/logs.
Make the isSuitableForUpgrade.sh script executable.
1. chmod +x isSuitableForUpgrade.sh
Run the following command: ./isSuitableForUpgrade.sh
The script will automatically detect if engines are suitable for upgrade.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade.
2. If one or more engines is unsuitable for upgrading, run the following steps:
  1. Start all engines.
  2. Verify that all engines are running.
  3. Shut down all engines.
  4. Repeat steps 2-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please open a ticket with Appian Support.

Sample Output

Sample Output 1: All engines were shut down properly and it is safe to proceed with the upgrade

15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade

Sample Output 2: One or more engine was not shut down cleanly, and it is not safe to proceed with the upgrade.

12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux.

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

pauline.delacruz — Thu, 06 Jul 2023 20:28:22 GMT

Revision 5 posted to Appian Knowledge Base by pauline.delacruz on 7/6/2023 8:28:22 PM

Purpose

Instructions

Run the following steps to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian Engines.
1. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting engines.
2. If the engines are hosted on a single server, place the script in <APPIAN_HOME>/logs.
Make the isSuitableForUpgrade.sh script executable.
1. chmod +x isSuitableForUpgrade.sh
Run the following command: ./isSuitableForUpgrade.sh
The script will automatically detect if engines are suitable for upgrade.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade.

If one or more engines is unsuitable for upgrading, run the following steps:

Start all engines.
Verify that all engines are running.
Shut down all engines.
Repeat steps 2-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please open a ticket with Appian Support.

Sample Output

Sample Output 1: All engines were shut down properly and it is safe to proceed with the upgrade

15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade

Sample Output 2: One or more engine was not shut down cleanly, and it is not safe to proceed with the upgrade.

12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux.

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

pauline.delacruz — Thu, 06 Jul 2023 20:26:22 GMT

Revision 4 posted to Appian Knowledge Base by pauline.delacruz on 7/6/2023 8:26:22 PM

Purpose

Instructions

Run the following steps to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian Engines.
1. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting engines.
2. If the engines are hosted on a single server, place the script in <APPIAN_HOME>/logs.
Make the isSuitableForUpgrade.sh script executable.
1. chmod +x isSuitableForUpgrade.sh
Run the following command: ./isSuitableForUpgrade.sh
The script will automatically detect if engines are suitable for upgrade.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade.

If one or more engines is unsuitable for upgrading, follow the below steps:

Start all engines.
Verify that all engines are running.
Shut down all engines.
Repeat steps 2-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please open a ticket with Appian Support.

Sample Output

Sample Output 1: All engines were shut down properly and it is safe to proceed with the upgrade

15 engines are suitable for upgrade
15 total engines detected 

All engines are suitable for upgrade
It is safe to proceed with the upgrade

Sample Output 2: One or more engine was not shut down cleanly, and it is not safe to proceed with the upgrade.

12 engines are suitable for upgrade
15 total engines detected

One or more engines is unsuitable for upgrade
Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Affected Versions

This article applies to self-managed versions of Appian 19.4 and later hosted on Linux.

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

[DRAFT SP-8832] KB-XXXX How to use the isSuitableForUpgrade script

pauline.delacruz — Thu, 06 Jul 2023 20:18:51 GMT

Revision 3 posted to Appian Knowledge Base by pauline.delacruz on 7/6/2023 8:18:51 PM

Purpose

Instructions

Run the following steps to execute the script:

After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts the Appian Engines.
1. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting engines.
2. If the engines are hosted on a single server, place the script in <APPIAN_HOME>/logs.
Make the isSuitableForUpgrade.sh script executable.
1. chmod +x isSuitableForUpgrade.sh
Run the following command: ./isSuitableForUpgrade.sh
The script will automatically detect if engines are suitable for upgrade.
1. If all engines are suitable for upgrade, it is safe to proceed with the upgrade.

If one or more engine is unsuitable for upgrade, follow the below steps:

Start all engines.
Verify that all engines are running.
Shut down all engines.
Repeat steps 2-4 until all engines are suitable for upgrade.

Note: If you are consistently unable to show that all engines are suitable for upgrade, please open a ticket with Appian Support.

Sample Output

Sample Output 1: All engines were shut down properly and it is safe to proceed with the upgrade

15 engines are suitable for upgrade
15 total engines detected 



All engines are suitable for upgrade
It is safe to proceed with the upgrade

15 engines are suitable for upgrade

15 total engines detected 



All engines are suitable for upgrade

It is safe to proceed with the upgrade

Sample Output 2: One or more engine was not shut down cleanly, and it is not safe to proceed with the upgrade.

12 engines are suitable for upgrade

15 total engines detected



One or more engines is unsuitable for upgrade

Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Affected Versions

This article applies to Appian 19.4 and later hosted on Linux.

Last Reviewed: July 2023

Tags: engines, linux, upgrade, infrastructure

How to use the isSuitableForUpgrade script

rachel.gillespie — Thu, 06 Jul 2023 17:23:35 GMT

Revision 2 posted to Appian Knowledge Base by rachel.gillespie on 7/6/2023 5:23:35 PM

Purpose

The isSuitableForUpgrade script automatically detects improperly shut down engines before the upgrade is performed. This script helps to save time when upgrading Appian and prevents time-consuming complications related to the upgrade process.

Instructions

1. After shutting down all Appian components, but before beginning the upgrade process, download the script to the server that hosts Appian Engines

a. If the environment is highly-available (HA), place the script in <APPIAN_HOME>/shared-logs on one of the servers hosting engines

b. If the engines are hosted on a single server, place the script in <APPIAN_HOME>/logs

2. Make the isSuitableForUpgrade.sh script executable

a. chmod +x isSuitableForUpgrade.sh

3. Run the following command: ./isSuitableForUpgrade.sh

4. The script will automatically detect if engines are suitable for upgrade

a. If all engines are suitable for upgrade, it is safe to proceed with the upgrade

b. If one or more engine is unsuitable for upgrade, follow the below steps:

1. Start all engines

2. Verify that all engines are running

3. Shut down all engines

4. Repeat steps 2-4 until all engines are suitable for upgrade.

5. If you are consistently unable to show that all engines are suitable for upgrade, please open a ticket with Appian Support

Sample Output

Sample Output 1: All engines were shut down properly and it is safe to proceed with the upgrade

15 engines are suitable for upgrade

15 total engines detected 



All engines are suitable for upgrade

It is safe to proceed with the upgrade

Sample Output 2: One or more engine was not shut down cleanly, and it is not safe to proceed with the upgrade.

12 engines are suitable for upgrade

15 total engines detected



One or more engines is unsuitable for upgrade

Please perform a full start-up of all engines, gracefully shut down all engines, then try again

Affected Versions

This article applies to Appian 19.4 and later hosted on Linux

Tags: engines, linux, upgrade, infrastructure