Deploy and upgrade blades

We provide a variety of Platform blades in kit form that can you can purchase and deploy to your Caplin Platform using the Deployment Framework.

Contents:

Deploying blades
Upgrading blades

Deploying blades

The instructions in this section are generic. For instructions specific to the blade you are deploying, see the documentation for the blade.

For instructions specific to Liberator and Transformer, see Installing Liberator and Installing Transformer.

If you’re deploying blades as part of an upgrade from Caplin Platform 6 to Caplin Platform 7, read Caplin Platform: upgrading from 6.x to 7.x.

To deploy a blade for the first time, follow the steps below:

Stop all running Caplin Platform components:
```
$ ./dfw stop
```
Copy the blade’s installation kit to the Deployment Framework’s kits directory.

Deploy the installation kit:

Example deployment: Transformer 7.1.3

$ ./dfw deploy

  Deploying Transformer kit Transformer-7.1.3-311854-x86_64-pc-linux-EL6-gnu.tar.gz
  Kit will be saved in kits/archive.
  Kit successfully unpacked.
  Not copying license from Transformer kit. Ensure the current license
   is the same version as the kit just deployed.

  Transformer kit has deployed a new blade: PersistenceService
  Transformer kit has deployed a new blade: PersistenceServiceClient
  Transformer kit has deployed a new blade: TransformerDemoDataSource
  Transformer kit has deployed a new blade: TransformerJMX
  Transformer kit has deployed a new blade: TransformerToLiberatorConnection
  Transformer kit has deployed a new blade: TransformerToLiberatorSSLConnection

  Activating the peer connection blade.

  Activating TransformerToLiberatorConnection

  Blades ok

  The configuration has been updated. The new configuration will not be active
  until the Framework is restarted.

  1 kit(s) deployed

  Blades ok

Check the blade installed correctly by listing all installed blades and their versions:
```
$ ./dfw versions
```
If the Caplin blade is a component (Liberator, Transformer, or an integration adapter), specify the primary and secondary hosts on which the component runs:
```
$ ./dfw hosts <blade> <primary-host> <secondary-host>
```
Use the ./dfw versions command above to discover the name by which the Deployment Framework identifies the blade.
Follow any extra steps in the blade’s deployment instructions.
Restart Caplin Platform components:
```
$ ./dfw start
```

Upgrading blades

The instructions in this section are generic. For instructions specific to the blade you are upgrading, see the documentation for the blade.

For instructions specific to Liberator and Transformer, see Upgrading Liberator and Upgrading Transformer.

Before upgrading a Platform 6 component to a Platform 7 component, read Caplin Platform: upgrading from 6.x to 7.x.

Follow the steps below to upgrade a blade:

Read the release notes for the new version of the blade and all versions in between the installed version and the new version. Take note of any extra upgrade steps and new configuration.

To find the version number of the installed blade, run the ./dfw versions command.
Stop all running Caplin Platform components:
```
$ ./dfw stop
```
Copy the blade’s installation kit to the Deployment Framework’s kits directory.

Deploy the new kit:

Example upgrade: Transformer 7.1.3 to Transformer 7.1.5

$ ./dfw deploy

  Deploying Transformer kit Transformer-7.1.5-312996-x86_64-pc-linux-EL6-gnu.tar.gz
  Kit will be saved in kits/archive.
  Remove unpacked kit directory - Transformer-7.1.3-311854 (y/n) ? n (1)
  Kit successfully unpacked.
  Not copying license from Transformer kit. Ensure the current license
   is the same version as the kit just deployed.
  Not copying override file autopub.conf from kit. (2)
  Not copying override file cluster.conf from kit.
  Not copying override file java.conf from kit.
  Not copying override file jmx.conf from kit.
  Not copying override file pipeline.conf from kit.
  Not copying override file transformer.conf from kit.

  Please review the Transformer release note and merge these files if required.

  Inactive overrides exist for PersistenceService in the directory:

        global_config/inactive_overrides/PersistenceService

  Not copying kit overrides from PersistenceService blade in Transformer kit

  Please review the Transformer release note and merge the files in these
   directories if required.

  Transformer kit has deployed a new blade: TransformerSystemInfo

  1 kit(s) deployed

  Blades ok

1 The Deployment Framework prompts you to remove the previously unpacked kit directory (kits/<blade_name>/<blade_name>-<version>). Removing the unpacked kit directory does not remove the blade’s override files copied to global_config/overrides/<blade_name>.

Override files from the new version of the blade are not copied to the directory global_config/overrides/<blade_name> if they would overwrite existing files in that directory.

For all Caplin components except Liberator and Transformer, removing a previously unpacked kit directory also removes the component’s log files.

Check the blade installed correctly by listing all installed blades and their versions:
```
$ ./dfw versions
```

Check if there have been any changes introduced to the override files in the new version of the blade. Manually merge any changes to the override files under the global_config/overrides/<blade_name> directory.

To check for changes to override files between versions of a blade, download the installation kits for both versions, unpack the kits, and use the diff command to compare override directories.

$ tar xzf Transformer-7.1.3-311854-x86_64-pc-linux-EL6-gnu.tar.gz
$ tar xzf Transformer-7.1.5-312996-x86_64-pc-linux-EL6-gnu.tar.gz
$ diff -u Transformer-7.1.3-311854/etc/overrides/etc \
> Transformer-7.1.5-312996/etc/overrides/etc

If the diff output reveals that a new configuration item has been introduced, check the blade’s release notes for guidance on its use before copying the configuration item to the appropriate file under the global_config/overrides/<blade_name> directory.

Example diff output

diff -u Transformer-7.1.3-311854/etc/overrides/etc/java.conf Transformer-7.1.5-312996/etc/overrides/etc/java.conf
--- Transformer-7.1.3-311854/etc/overrides/etc/java.conf	2018-09-24 09:34:19.000000000 +0100
+++ Transformer-7.1.5-312996/etc/overrides/etc/java.conf	2019-05-14 13:46:12.000000000 +0100
@@ -4,8 +4,8 @@


 # The size of the Java heap (in megabytes)
-define JVM_XMS_HEAP_SIZE        256
-define JVM_XMX_HEAP_SIZE        256
+define TRANSFORMER_JVM_XMS_HEAP_SIZE        256
+define TRANSFORMER_JVM_XMX_HEAP_SIZE        256

 # If set to a non-zero value, then the JVM debugger will be started on the
 # configured port
@@ -20,7 +20,7 @@
 ## Java Heap size #############################################################
 #
 #
-jvm-options    -Xms${JVM_XMS_HEAP_SIZE}m -Xmx${JVM_XMX_HEAP_SIZE}m
+jvm-options    -Xms${TRANSFORMER_JVM_XMS_HEAP_SIZE}m -Xmx${TRANSFORMER_JVM_XMX_HEAP_SIZE}m


 ## Debugging options #########################################################

In the example diff output above, the JVM_XMS_HEAP_SIZE and JVM_XMX_HEAP_SIZE configuration variables have been renamed to TRANSFORMER_JVM_XMS_HEAP_SIZE and TRANSFORMER_JVM_XMX_HEAP_SIZE respectively. Merge these changes manually to the file global_config/overrides/servers/Transformer/java.conf, and update the file global_config/environment.conf if it references the old variable names.

The override files for Liberator 6 and Transformer 6 were packaged with the Deployment Framework 6. From Liberator 7 and Transformer 7, the override files are packaged in the etc/overrides/etc directories of the Liberator and Transformer deployment kits .

Restart Caplin Platform components:
```
$ ./dfw start
```

See also:

Caplin supplied blades