Single Node Setup Instructions:

Pre-requisites:

1.  Ensure you have the syndeia-cloud-3.5.zip (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.  

  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. Review Syndeia Cloud's recommendations, ie: (Open|Oracle)JDK/JRE, memory, FS selection, params, etc. in Deployment.  

  Note:  Syndeia Cloud can be deployed on a different machine VS Cassandra but these steps will focus on a single-node deployment.  

3. Decide if you wish to configure Java JRE/JDK for JMX monitoring or not (for example, if you wish to monitor via Grafana). 

4. If using a firewall, ensure the following port(s) are accessible from client machines (consult your local network admin if required): TCP port 9000 (HTTP), 9443 (HTTPS). 

 If you will be using JMX monitoring, the following additional ports will also need to be accessible (NOT necessarily externally) from where you will run monitoring.  

Downloading & Extracting Syndeia Cloud:

1. Launch a Cygwin Terminal, it should start in your home dir. 

 CAUTION:  To avoid any issues on Windows, it is recommended you do NOT use a path that contains any spaces in any of the directory (or file) names.  

2. Make a download directory for the build & cd into it, ex:  new_build_version=3.5 ; export new_build_version

  Note:  If your version you have is older than the one shown above, please reach out to us to obtain the latest Service Pack.  

3. In the download dir, unzip the main package, ie:  unzip syndeia-cloud-3.5.zip ;  You should see additional .ZIPs for each microservice

  IMPORTANT:  once Java JRE/JDK is installed, please ensure you have enabled JMX monitoring per Appendix C3.5 (if for whatever reason you do not wish to use JMX, you can disable it pre or post SC setup via the steps in Appendix C3.6).

Installing, Configuring, and Starting Syndeia Cloud:

In this step we will run the automated SC setup script.  

1. In the directory you downloaded and extracted the main .ZIP, cd into the bin directory and run the install script, ie:  ./syndeia-cloud-3.5_install_windows.bash -SC_v ${new_build_version}. 

  Note: you may be prompted for sudo authentication when installing to /opt/... you will also be prompted for your syndeia_admin password set previously

2. Validate correct operation and create/update an archive image to use as a new base image if the node needs to be rebuilt or if you wish to create a cluster. 

  Before making the image you may wish to first stop and optionally disable Syndeia Cloud's services temporarily to prevent auto-start on boot, ie:  sc.exe '\\localhost' config <service_name> start=disabled ; where <service_name> = one of sc-auth|sc-store|sc-graph|sc-web-gateway|sc-aras|sc-artifactory|sc-bitbucket|sc-collaborator|sc-confluence|sc-doors|sc-github|sc-gitlab|sc-jama|sc-jira|sc-restful|sc-sysmlv2|sc-testrail|sc-twcloud|sc-volta|sc-wc
.  

Managing Syndeia Cloud:

1. To check the status of Syndeia Cloud services, from a CMD.exe prompt run sc.exe '\\localhost' queryex <service_name>; where <service_name> = one of sc-auth|sc-store|sc-graph|sc-web-gateway|sc-aras|sc-artifactory|sc-bitbucket|sc-collaborator|sc-confluence|sc-doors|sc-github|sc-gitlab|sc-jama|sc-jira|sc-restful|sc-sysmlv2|sc-testrail|sc-twcloud|sc-volta|sc-wc


2. To stop/start the Syndeia Cloud services, run sc.exe '\\localhost' <action> <service_name>; where <action> = one of start|stop, and <service_name> = one of sc-auth|sc-store|sc-graph|sc-web-gateway|sc-aras|sc-artifactory|sc-bitbucket|sc-collaborator|sc-confluence|sc-doors|sc-github|sc-gitlab|sc-jama|sc-jira|sc-restful|sc-sysmlv2|sc-testrail|sc-twcloud|sc-volta|sc-wc


  Note: services are configured to run on boot.  For more information on controlling services run sc.exe /? 

  Windows has a limited degree of control over service start ordering but in general you will want to ensure that all your service start in the order of:  Cassandra, Janusgraph, Zookeeper, Kafka, SC (sc-store, sc-auth, sc-graph, sc-web-gateway, sc-<all_others>).  

3. To view the logs for any Syndeia Cloud service, see the appropriate service's log folder, ex:  c:\cygwin64\opt\icx\syndeia-cloud-current\<service_name>-3.5\logs where <service_name> = one of auth-impl|store-impl|graph-impl|web-gateway|aras-impl|artifactory-impl|bitbucket-impl|collaborator-impl|confluence-impl|doors-impl|github-impl|gitlab-impl|jama-impl|jira-impl|restful-impl|sysmlv2-impl|testrail-impl|teamworkcloud-impl|volta-impl|windchill-impl

  Note:  there are 5 types of log files/streams generated:  access logs, Apache Commons daemon log, stdout (standard output), stderr (standard error), and the log from SC itself.  In a troubleshooting scenario you may wish to examine one or more of these.   

Validating Syndeia Cloud Installation & Configuration:

1. On the server and/or your local machine, launch a web browser & check the following to validate that the application is correctly running:  

1.1.  http://<syndeia_server_FQDN>:9000 should give you:  

 To login as the default administrator and create users, see the User Management section. 

2.2  Once logged in, please verify you see a bar graph get rendered (and not a never-ending spinner followed by an error message) on the Dashboard home page and the version is shown correctly under Help > About in the sidebar..