Table of Contents

Updates and fixes in this service pack (3.

...

5 SP1)

Syndeia Cloud 3.4 5 SP1, including the REST API and the Syndeia Cloud Web Dashboard, has several improvements which are listed here: Syndeia 3.5 SP1 - Improvements.

...

Installation Process

Syndeia Cloud 3.4 5 SP1 is a full build of Syndeia Cloud and not a patch/incremental build. It is an in-place upgrade of the Syndeia Cloud services and does NOT require any data migration. Follow the steps below to deploy Syndeia Cloud 3.4 5 SP1.

Download & extract the three .zip files to your home dir, i.e. syndeia-cloud-3.

...

5-SP1.zip, syndeia-cloud-3.

...

5-SP1_

...

janusgraph.zip, syndeia-cloud-3.

...

5-SP1_cassandra_zookeeper_kafka_setup.zip
Identify your current Syndeia Cloud version and platform (Windows, Linux).

...

The version can be identified by

...

checking the Help > About menu in Syndeia Cloud.
Follow the instructions below for the scenario and platform relevant to your environment.

...

Scenario 1: If you are deploying SC 3.

...

5 for the first time with this service pack (or starting from scratch)

Linux / Windows

...

Gather the three .zip files you downloaded for Syndeia Cloud 3.

...

5 SP1 and follow the instructions here

...

:

...

Deployment

...

Scenario 2: If you are already running SC 3.

...

5 and upgrading to this 3.

...

5 SP1 release

Linux

...

To upgrade

...

Syndeia Cloud (

...

SC)

...

to 3.

...

5 SP1: in your bash shell, run the below and follow the prompts:
Code Block
language

...

bash

...

:remote connect tinkerpop.server conf/remote.yaml session
:remote console
graph = ConfiguredGraphFactory.open('syndeia_cloud_graph')
graph.tx().rollback()
mgmt = graph.openManagement()
// below checks query.smart-limit
mgmt.get('query.smart-limit')
mgmt.set('query.smart-limit', false)
// above sets query.smart-limit to "false"
mgmt.get('query.smart-limit')
// you should get ==>false above
mgmt.commit()
:quit

export SC_snapshot_version_old=3.5
cd ~/syndeia-cloud-3.5-SP1/bin/
./syndeia-cloud-3.5_install.bash --upgrade -s -SC_v 3.5-SP1

Note, if you are running a multi-node configuration you will also need to pass in --multi_node (or -m), ie:

Code Block

language

...

bash

...

gremlin> :remote connect tinkerpop.server conf/remote.yaml session
==>Configured localhost/127.0.0.1:8182-[0f1a9b8d-8430-4dcd-a72d-05d5c5b0ffb9]
gremlin> :remote console
==>All scripts will now be sent to Gremlin Server - [localhost/127.0.0.1:8182]-[0f1a9b8d-8430-4dcd-a72d-05d5c5b0ffb9] - type ':remote console' to return to local mode
gremlin> graph = ConfiguredGraphFactory.open('syndeia_cloud_graph')
==>standardjanusgraph[cql:[localhost]]
gremlin> graph.tx().rollback()
==>null
gremlin> mgmt = graph.openManagement()
==>org.janusgraph.graphdb.database.management.ManagementSystem@aa6b750
gremlin> // below checks query.smart-limit
==>null
gremlin> mgmt.get('query.smart-limit')
==>true
gremlin> mgmt.set('query.smart-limit', false)
==>org.janusgraph.diskstorage.configuration.UserModifiableConfiguration@436ce29
gremlin> // above sets query.smart-limit to "false"
==>null
gremlin> mgmt.get('query.smart-limit')
==>false
gremlin> // you should get ==>false above
==>null
gremlin> mgmt.commit()
==>null
gremlin> :quit

export SC_snapshot_version_old=3.5
cd ~/syndeia-cloud-3.5-SP1/bin/
./syndeia-cloud-3.5_install.bash --upgrade -s --multi_node --SC_version=3.5-SP1

Windows

Stop all existing SC services via services.msc (SCM)
To upgrade Syndeia Cloud (SC) to 3.

...

5 SP1: in

...

a Cygwin/WSL terminal, run

...

the below and follow the prompts:

Code Block

language	bash

export SC_snapshot_version_old=3.5
cd ~/syndeia-cloud-3.

...

5-SP1/bin/ ./syndeia-cloud-3.

...

5_install_windows.bash --upgrade -s -SC_v 3.

...

5-SP1
Note, if you are running a multi-node configuration you will also need to pass in --multi_node (or -m), ie:
Code Block
language bash
export SC_snapshot_version_old=3.5 cd ~/syndeia-cloud-3.

...

5-SP1/bin/ ./syndeia-cloud-3.

...

5_install_windows.bash --upgrade -s --multi_node --SC_version=3.5-SP1

...

Scenario 3: If you are already running SC 3.4 SP3 and upgrading to this 3.

...

Windows

4. Stop all existing SC services via services.msc (SCM)
5. To upgrade the Janusgraph (JG) SC DB to 3.4 SP1: In a Cygwin/WSL terminal, run /opt/janusgraph-current/bin/gremlin.bat and the following Groovy code below ( this will check & set query.smart-limit to false):

Code Block

language	groovy

:remote connect tinkerpop.server conf/remote.yaml session
:remote console
graph = ConfiguredGraphFactory.open('syndeia_cloud_graph')
graph.tx().rollback()
mgmt = graph.openManagement()
// below checks query.smart-limit
mgmt.get('query.smart-limit')
mgmt.set('query.smart-limit', false)
// above sets query.smart-limit to "false"
mgmt.get('query.smart-limit')
// you should get ==>false above
mgmt.commit()
:quit

The output as you execute each line should look similar to this:

Code Block

language	groovy

gremlin> :remote connect tinkerpop.server conf/remote.yaml session
==>Configured localhost/127.0.0.1:8182-[0f1a9b8d-8430-4dcd-a72d-05d5c5b0ffb9]
gremlin> :remote console
==>All scripts will now be sent to Gremlin Server - [localhost/127.0.0.1:8182]-[0f1a9b8d-8430-4dcd-a72d-05d5c5b0ffb9] - type ':remote console' to return to local mode
gremlin> graph = ConfiguredGraphFactory.open('syndeia_cloud_graph')
==>standardjanusgraph[cql:[localhost]]
gremlin> graph.tx().rollback()
==>null
gremlin> mgmt = graph.openManagement()
==>org.janusgraph.graphdb.database.management.ManagementSystem@aa6b750
gremlin> // below checks query.smart-limit
==>null
gremlin> mgmt.get('query.smart-limit')
==>true
gremlin> mgmt.set('query.smart-limit', false)
==>org.janusgraph.diskstorage.configuration.UserModifiableConfiguration@436ce29
gremlin> // above sets query.smart-limit to "false"
==>null
gremlin> mgmt.get('query.smart-limit')
==>false
gremlin> // you should get ==>false above
==>null
gremlin> mgmt.commit()
==>null
gremlin> :quit

6. To upgrade Syndeia Cloud (SC) to 3.4 SP1: in a Cygwin/WSL terminal, run: ~/syndeia-cloud-3.4.SP1_2021-10-14/bin/syndeia-cloud-3.4_install_windows.bash --upgrade --SC_v 3.4.SP1_2021-10-14 and follow the prompts ( Note, If you are running a multi-node configuration you will also need to pass in --multi_node (or -m), ie: ~/syndeia-cloud-3.4.SP1_2021-10-14/bin/syndeia-cloud-3.4_install.bash --upgrade --multi_node --SC_version=3.4.SP1_2021-10-14).

Scenario 3: If you are already running SC 3.3 SP1 and upgrading to this 3.4 SP1 release

Linux / Windows

4. Please follow the instructions on the Migration page but use SC 3.4 SP1 everywhere where it references SC 3.4.

...

5 SP1 release

Linux / Windows

Please follow the instructions on the Migration page but use SC 3.5 SP1 everywhere where it references SC 3.5.

...

Verification

Scenario 2 ONLY: Confirm batch_size_warn_threshold_in_kb and batch_size_fail_threshold_in_kb in /etc/cassandra/default.conf/cassandra.yaml have been bumped up from their defaults, ex:
Code Block
batch_size_warn_threshold_in_kb: 250 batch_size_fail_threshold_in_kb: 300
If you make changes to the above, restart the Cassandra service:
Code Block
sudo systemctl restart cassandra
If you frequently deal with large artifact sizes you may want to configure your monitoring to watch for the “batch size” warn messages and bump up as needed.

Scenario 2 ONLY: Make sure sc-store service’s application.conf at /opt/icx/syndeia-cloud-current/store-impl-3.5-SP1/conf/application.conf contains the following performance tuning enhancements on ~L95:

Code Block

cassandra-query-journal {
  refresh-interval = 25ms
  
  # added events-by-tag nesting during lagom upgrade to 1.6.5 (to cater to akka persistence cassandra migration to 0.80)
  # https://doc.akka.io/docs/akka-persistence-cassandra/0.101/migrations.html
  events-by-tag {
    # Turn off the eventual consistency delay
    eventual-consistency-delay = 50ms

    # Turn on event by persistence id tracking, this timeout is the maximum amount of time that akka-persistence-cassandra will hold off publishing an event when missed events are detected
    # changed name from delayed-event-timeout to gap-timeout during lagom upgrade to 1.6.5 (to cater to akka persistence cassandra migration to 0.80)
    # https://doc.akka.io/docs/akka-persistence-cassandra/0.101/migrations.html
    gap-timeout = 30s 
    flush-interval = 25ms
    first-time-bucket = "20221101T00:00"
  }
}

If not, add them and restart the sc-store service.

Code Block
sudo systemctl restart sc-store

Follow the steps in the section Validating Syndeia Cloud Installation & Configuration on the following page to verify your installation:
- Linux: https://intercax.atlassian.net/wiki/spaces/

...

- SYN35/pages/

...

- 2922178619/Syndeia+Cloud+Installation+Instructions+for+RHEL

...

- +CentOS+Alma+Linux+7-8#SyndeiaCloudInstallationInstructionsforRHEL%2FCentOS%2FAlmaLinux7-8-ValidatingSyndeiaCloudInstallation%26Configuration%3A
- Windows

...

- :

...

- Syndeia

...

- Cloud

...

- Installation

...

- Instructions

...

- for

...

- Windows

...

- (2012-R2

...

- x64)

Versions Compared

Old Version 1

New Version Current

Key

Updates and fixes in this service pack (3.

5 SP1)

Installation Process

Scenario 1: If you are deploying SC 3.

5 for the first time with this service pack (or starting from scratch)

Linux / Windows

Scenario 2: If you are already running SC 3.

5 and upgrading to this 3.

5 SP1 release

Linux

Windows

Scenario 3: If you are already running SC 3.4 SP3 and upgrading to this 3.

Windows

Scenario 3: If you are already running SC 3.3 SP1 and upgrading to this 3.4 SP1 release

Linux / Windows

5 SP1 release

Linux / Windows

Verification

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Updates and fixes in this service pack (3.

5 SP1)

Installation Process

Scenario 1: If you are deploying SC 3.

5 for the first time with this service pack (or starting from scratch)

Linux / Windows

Scenario 2: If you are already running SC 3.

5 and upgrading to this 3.

5 SP1 release

Linux

Windows

Scenario 3: If you are already running SC 3.4 SP3 and upgrading to this 3.

Windows

Scenario 3: If you are already running SC 3.3 SP1 and upgrading to this 3.4 SP1 release

Linux / Windows

5 SP1 release

Linux / Windows

Verification