Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Launch a Cygwin Terminal with bash (ensure you are in your home directory)
    (info) for Windows Cygwin, this means ~/ NOT C:\Users\...

  2. Unzip all SC packages:

    Code Block
    languagebash
    unzip syndeia-cloud-3.5*.zip

Deploy Apache Cassandra

  1. cd to the cassandra_zookeeper_kafka_setup package’s bin directory:

    Code Block
    languagebash
    cd ~/syndeia-cloud-3.5_cassandra_zookeeper_kafka_setup/bin
  2. Run the Apache Cassandra pre-setup script:

    Code Block
    languagebash
    ./syndeia-cloud-3.5_cassandra_pre-setup.bash

...

  1. Verify Cassandra is up and functioning by running nodetool status:

    Code Block
    languagebash
    cd /opt/apache-cassandra-current/bin/
    ./nodetool.bat status


    You should get output similar to the following:

    Code Block
    languagebash
    Datacenter: dc1
    =======================
    Status=Up/Down
    |/ State=Normal/Leaving/Joining/Moving
    --  Address       Load       Tokens       Owns (effective)  Host ID                               Rack
    UN  192.168.1.3   644.57 KiB 256          100.0%            141c21db-4f79-476b-b818-ee6d2da16d7d  rack1

Deploy Apache Zookeeper (ZK)

  1. Run the Apache Zookeeper (ZK) pre-setup script:

    Code Block
    languagebash
    ./syndeia-cloud-3.5_zookeeper_pre-setup.bash

...

  1. Verify Zookeeper is up and functioning by running zkCli.sh:

    Code Block
    languagebash
    sudo -u zookeeper /opt/zookeeper-current/bin/zkCli.sh -server localhost:2181

    You should get output similar to the following:

    Code Block
    languagebash
    Connecting to localhost:2181
    Welcome to ZooKeeper!
    JLine support is enabled
    
    WATCHER::
    
    WatchedEvent state:SyncConnected type:None path:null
    [zk: localhost:2181(CONNECTED) 0]

Deploy Apache Kafka

  1. Run the Apache Kafka pre-setup script:

...

  1. Verify Kafka is up and functioning by creating a test topic, producer with test events and a consumer that replays them:

    Code Block
    /opt/kafka-current/bin/kafka-topics.sh --create --topic quickstart-events --bootstrap-server localhost:9092

    … producer:

    Code Block
    /opt/kafka-current/bin/kafka-console-producer.sh --topic quickstart-events --bootstrap-server localhost:9092
    Code Block
    Test event1
    Test event2

    … consumer:

    Code Block
    /opt/kafka-current/bin/kafka-console-consumer.sh --topic quickstart-events --from-beginning --bootstrap-server localhost:9092

    You should see:

    Code Block
    Test event1
    Test event2

Deploy JanusGraph (JG)

  1. cd to the janusgaph_setup package’s bin directory:

    Code Block
    languagebash
    cd ~/syndeia-cloud-3.5_janusgraph_setup/bin
  2. Run the JanusGraph (JG) pre-setup script:

    Code Block
    languagebash
    ./syndeia-cloud-3.5_janusgraph_pre-setup.bash
  3. Run the (main) JanusGraph (JG) setup script, ie:

    Code Block
    languagebash
    ./syndeia-cloud-3.5_janusgraph_setup_windows.bash

...

  1. Verify JG is up and functioning by running the Gremlin client, ie:

    Code Block
    languagebash
    /opt/janusgraph-current/bin/gremlin.bat

    Then execute the following commands after it starts up:

    Code Block
    :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();
    // The last 2 commands above should not return any results since the graph (syndeia_cloud_graph) is empty - no vertices or edges.

Deploy Syndeia Cloud (SC)

  1. cd to the syndeia-cloud package’s bin directory:

    Code Block
    languagebash
    cd ~/syndeia-cloud-3.5-SP2/bin
  2. Run the Syndeia Cloud (SC) pre-setup script:

    Code Block
    languagebash
    ./syndeia-cloud-3.5_install_pre-setup.bash

    (info) During execution, you will be prompted to set credentials for JMX monitoring. By default Syndeia Cloud has been configured with JMX enabled & the script will prompt to set a reader & read-write credentials. If you do not wish to use JMX, you can do so pre or post-SC setup via the steps in Appendix C3.6).

  3. Run the (main) Syndeia Cloud (SC) setup script, ie:

    Code Block
    languagebash
    ./syndeia-cloud-3.5_install_windows.bash

...

How to Manage Services & Check Logs

Services

Windows

Services are all managed using Windows NT Service Control Manager (SCM) services.msc Control Panel applet OR in a shell (CMD.EXE or Cygwin Terminal) via the sc.exe command with a verb, ie: query[ex], start, stop, followed the service name, ie: cassandra, janusgraph, zookeeper, kafka, sc-SC-short-service-name(s) (or sc-* to reference all SC services).

...

Example usage for Cassandra, Zookeeper, Kafka, JanusGraph, and Syndeia Cloud follows:

Apache Cassandra

  • To check the summary status:

    Code Block
    sc.exe queryex cassandra
  • To start the service:

    Code Block
    sc.exe start cassandra
  • To stop the service:

    Code Block
    sc.exe stop cassandra

Apache Zookeeper

  • To check the summary status:

    Code Block
    sc.exe queryex zookeeper
  • To start the service:

    Code Block
    sc.exe start zookeeper
  • To stop the service:

    Code Block
    sc.exe stop zookeeper

Apache Kafka

  • To check the summary status:

    Code Block
    sc.exe queryex kafka
  • To start the service:

    Code Block
    sc.exe start kafka
  • To stop the service:

    Code Block
    sc.exe stop kafka

JanusGraph

  • To check the summary status:

    Code Block
    sc.exe queryex janusgraph
  • To start the service:

    Code Block
    sc.exe start janusgraph
  • To stop the service:

    Code Block
    sc.exe stop janusgraph

Syndeia Cloud

Syndeia Cloud 3.5 is defined by two sets of services:

...

  • To check the summary status for a specific service, ex: web-gateway:

    Code Block
    sc.exe queryex sc-web-gateway
  • To start a specific service, ex: web-gateway:

    Code Block
    sc.exe start sc-web-gateway
  • To stop a service, ex: web-gateway:

    Code Block
    sc.exe stop sc-web-gateway

...

Logs & Monitoring

...

Logs on Windows rely on raw log files (there is no journal system).

...

(info) Note, on Windows, the base Cygwin Unix file paths below are all mapped to the Windows filesystem directory C:\cygwin64

Apache Cassandra

Apache Cassandra will create an application/component log file called system.log in its logs folder

Code Block
/opt/apache-cassanrdra-current/logs/

Apache Zookeeper

Zookeeper creates a log file of the form zookeeper-accountName -server-serverFQDN .log

...

Code Block
/opt/zookeeper-current/logs/

Apache Kafka

Apache Kafka will create many application/component log files with the extension .log in its logs folder

...

Code Block
/opt/kafka-current/logs/

JanusGraph

JanusGraph will create an application/component log file called gremlin-server.log in its logs folder

Code Block
/opt/janusgraph-current/logs/

Syndeia Cloud

For single-node deployments, one can use the common logs directory with symlinks to every service’s logs folder (this is useful is say one wishes to quickly archive all logs to submit for troubleshooting)

...