Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Pre-reqs: Steps 1, Downloading: Step 3: add comment re. latest service pack; Pre-reqs: step 3, Enabling your single-node deployment for cluster operation, Adding new nodes to an existing single-node: clarify steps for preparing for multi-node operation

Table of Contents
outlinetrue
stylenone

...

Pre-requisites

1.  Ensure you have the syndeia-cloud-3.4_janusgraph_setup.zip downloaded to  (or latest service pack) downloaded to your home directory (or home directory's Downloads folder) from the download/license instructions sent out by our team.  

(info)  Note: the .ZIP will pre-create a separate folder for its contents when extracted so there is no need to pre-create a separate folder for it.  

2.  Ensure you satisfy Janusgraph's pre-requisites, ie: have (Open|Oracle)JDK/JRE + Apache Cassandra (& optionally Elasticsearch) installed.  Re. CPU, memory, HD space, etc. this will depend on how much data you expect to store, query, and graph.  

3.  If using a firewall, and JG will be on a separate server from SC, ensure the following port is accessible (consult your local network admin if required): TCP port 8182 (this is the port to listen to for client connections).  


...

Downloading & Extracting JanusGraph

...

3. Unzip Syndeia Cloud's JanusGraph setup package in your home directory ~/, ie:  unzip syndeia-cloud-3.4.SP1_2021-10-14_janusgraph_setup.zip -d ~/

...

- Create/update janusgraph-current symlink to specified version, default = 0.3.1
- Create a new syndeia_admin superuser in Cassandra with a password you specify
- Create a new syndeia_cloud_graph and syndeia_cloud_graph_config keyspaces
GRANT ALL PERMISSIONS ON KEYSPACE syndeia_cloud_graph TO syndeia_admin
GRANT ALL PERMISSIONS ON KEYSPACE syndeia_cloud_graph_config TO syndeia_admin
- Run a Groovy JanusGraph setup script to set storage params for your graph and build indexes
- Create a renamed copy of the file /opt/janusgraph-<release_ver>/conf/janusgraph-cql-configurationgraph.properties as janusgraph-cql-configurationgraph-syndeia.properties with: 

graph.graphname=syndeia_cloud_graph_config
Add storage.username=syndeia_admin
Add storage.password=<password_specified>
storage.hostname=<your_Cassandra_host>

- If you installed Elasticsearch on the same machine, add index.search.backend=elasticsearch and index.search.hostname=localhost to use Elasticsearch for search indexing
- Create a renamed copy of the file /opt/janusgraph-<release_ver>/conf/gremlin-server/gremlin-server-configuration.yaml as gremlin-server-configuration-syndeia.yaml and set ConfigurationManagementGraph to point to janusgraph-cql-configurationgraph-syndeia.properties.  
- Install systemd .service file for JanusGraph service
- Start JanusGraph service

(info) Note: you may be prompted for sudo authentication.  You will also be prompted for your cassandra account password (default = cassandra), to set your syndeia_admin password and the FQDN of your Cassandra host.  

(warning)  Avoid any of the following special characters: \?*[]+#&.{}$ when setting your syndeia_admin password.


...

Managing JanusGraph:

7. To check the status of Syndeia Cloud services, use systemctl status janusgraph.  You can verify that it started by verifying "Active: active (running)" shows up in the output: 

...

9. To view the logs for JanusGraph, use sudo journalctl -eu janusgraph & less /opt/janusgraph-0.3.1-hadoop2/log/gremlin-server.log.  To follow the log files, you can use sudo journalctl -feu janusgraph & tail -f /opt/janusgraph-0.3.1-hadoop2/log/gremlin-server.log.  You should see output similar to the following (abridged) text:

(info) Note, for your convenience you may wish to create a symlink to /opt/janusgraph-0.3.1-hadoop2/log/ from /var/log, ie: sudo ln -nfs /opt/janusgraph-0.3.1-hadoop2/log/ /var/log/janusgraph

...

Enabling your single-node deployment for cluster operation

11. Ensure you first enable Cassandra for If Cassandra will be on a separate server from JG, ensure you first enable Cassandra for cluster operation.   

12. Update the Janusgraph syndeia_cloud_graph configuration via by running /opt/janusgraph-current/bin/gremlin.sh and running the following Groovy code ; where cassandra.mydomain.com = the FQDN of the Casandra server that you have now exposed :  

Code Block
languagebashgroovy
themeRDark
:remote connect tinkerpop.server conf/remote.yaml session
:remote console
map = new HashMap();
map.put('storage.backend', 'cql');  // should return: ==>null
map.put('storage.hostname', 'cassandra.mydomain.com');
ConfiguredGraphFactory.updateConfiguration('syndeia_cloud_graph', map);

...

13. Deploy another instance of your Janusgraph base image (which depending on your topology could be the same as your Cassandra base image).
14. Make any appropriate changes for the MAC address (ex: in the VM settings and/or udev, if used).
15. Setup forward & reverse DNS records on your DNS server (consult your IT admin/sysadmin if required) and set the hostname and primary DNS suffix on the machine itself (sudo hostnamectl set-hostname <new_JanusGraph_node_FQDN> where FQDN = Fully Qualified Domain Name, ex: janusgraph2.mycompany.com )
16. SSH to the IP (or the FQDN of the new node if DNS has already propagated).

...

  If Janusgraph will be on a different server than SC, please also:

13A.  Update the host: localhost entry on L1 in /opt/janusgraph-current/conf/gremlin-server/gremlin-server-configuration-syndeia.yaml, ex:  

Code Block
languagecss
themeRDark
linenumberstrue
host: jg-server.domain.tld
port: 8182

[...]

where jg-server.domain.tld = the FQDN of your JG server

13B.  Ensure port 8182 is accessible on the JG server. 

...

Adding new nodes to an existing single-node

14. Deploy another instance of your Janusgraph base image (which depending on your topology could be the same as your Cassandra base image).

15. Make any appropriate changes for the MAC address (ex: in the VM settings and/or udev, if used).

16. Setup forward & reverse DNS records on your DNS server (consult your IT admin/sysadmin if required) and set the hostname and primary DNS suffix on the machine itself (sudo hostnamectl set-hostname <new_JanusGraph_node_FQDN> where FQDN = Fully Qualified Domain Name, ex: janusgraph2.mycompany.com )

17. SSH to the IP (or the FQDN of the new node if DNS has already propagated).

(info) Note: If using Fail2Ban, update the sender line in /etc/fail2ban/jail.local to root@<new_JanusGraph_node_FQDN>. Restart the fail2ban service (sudo systemctl restart fail2ban)

1718. Three things need to occur:  you will need to change the Snitch (if not already done for Cassandra), alter the keyspace Replication Factor (RF), and run nodetool repair on each node (see https://docs.datastax.com/en/archived/cassandra/3.x/cassandra/operations/opsChangeKSStrategy.html for a summary of the process).

  1. Change the Snitch:  see "Switching Snitches":  https://docs.datastax.com/en/archived/cassandra/3.x/cassandra/operations/opsChangeKSStrategy.html
  2. Alter the RF:  verify the Cassandra “datacenter” name (default = dc1) from the CLI by running nodetool status and then from Cassandra CQLSH increment the RF for your JanusGraph keyspace(s):

    Code Block
    languagesql

    from the CLI by running nodetool status and then from Cassandra CQLSH increment the RF for your JanusGraph keyspace(s):

    Code Block
    languagesql
    ALTER KEYSPACE syndeia_cloud_auth WITH REPLICATION = { 'class' : 'NetworkTopologyStrategy', '<datacenter_name>' : <total_number_of_nodes> };
    -- where <datacenter_name> = the name of the datacenter as shown via nodetool status, and <total_number_of_nodes> = total # of nodes (in the cluster)
    ALTER KEYSPACE syndeia_cloud_store WITH REPLICATION = { 'class' : 'NetworkTopologyStrategy', '<datacenter_name>' : <total_number_of_nodes> };
    -- where <datacenter_name> = the name of the datacenter as shown via nodetool status, and <total_number_of_nodes> = total # of nodes (in the cluster)
    ALTER KEYSPACE syndeia_cloud_confluence WITH REPLICATION = { 'class' : 'NetworkTopologyStrategy', '<datacenter_name>' : <total_number_of_nodes> };
    -- where <datacenter_name> = the name of the datacenter as shown via nodetool status, and <total_number_of_nodes> = total # of nodes (in the cluster)
    ALTER KEYSPACE syndeia_cloud_graph WITH REPLICATION = { 'class' : 'NetworkTopologyStrategy', '<datacenter_name>' : <total_number_of_nodes> };
    -- where <datacenter_name> = the name of the datacenter as shown via nodetool status, and <total_number_of_nodes> = total # of nodes (in the cluster)
    ALTER KEYSPACE syndeia_cloud_graph_config WITH REPLICATION = { 'class' : 'NetworkTopologyStrategy', '<datacenter_name>' : <total_number_of_nodes> };
    -- where <datacenter_name> = the name of the datacenter as shown via nodetool status, and <total_number_of_nodes> = total # of nodes (in the cluster)
    


  3. Run nodetool repair:  Run nodetool repair --full <keyspace_name> on each node (for more details see https://docs.datastax.com/en/dse/5.1/cql/cql/cql_using/cqlUpdateKeyspaceRF.html)

1819. Follow  "Things to Consider in a Multi-Node JanusGraph Cluster" https://docs.janusgraph.org/0.3.1/things-to-consider-in-a-multi-node-janusgraph-cluster.html

1920. Repeat steps 13 14 ~ 18 19 for each additional cluster node.

...

Validating JanusGraph Operation for 1-node (or multiple nodes)

1921. To validate JanusGraph operation, we start a Gremlin client and issue commands to check the edges and vertices in our graph  To do this, perform the following steps:  

1921.1.  Open a new terminal window

1921.2.  Go to the bin folder in JanusGraph installation and type the following command:  ./gremlin.sh.  You should see output similar to the below:    

Code Block
languagebash
themeRDark
$ ./gremlin.sh 

         \,,,/
         (o o)
-----oOOo-(3)-oOOo-----
SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/opt/janusgraph-0.3.1-hadoop2/lib/slf4j-log4j12-1.7.12.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/opt/janusgraph-0.3.1-hadoop2/lib/logback-classic-1.1.2.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [org.slf4j.impl.Log4jLoggerFactory]
plugin activated: janusgraph.imports
plugin activated: tinkerpop.server
plugin activated: tinkerpop.utilities
20:19:16 WARN  org.apache.hadoop.util.NativeCodeLoader  - Unable to load native-hadoop library for your platform... using builtin-java classes where applicable
plugin activated: tinkerpop.hadoop
plugin activated: tinkerpop.spark
plugin activated: tinkerpop.tinkergraph
gremlin> 

1921.3.  Type the following commands, substituting your appropriate values as required:  

Code Block
languagebash
themeRDark
:remote connect tinkerpop.server conf/remote.yaml session
:remote console
graph = ConfiguredGraphFactory.open('syndeia_cloud_graph');
// should return: ==>standardjanusgraph[cql:[cassandra.mydomain.com]]
g = graph.traversal();
g.V();
g.E();

(info) The last 2 commands above should not return any results since the graph (syndeia_cloud_graph) is empty - no vertices or edges.

1921.4.  Type :quit   


Page break macro

...