Syndeia Cloud Installation Instructions for Windows (2012-R2 x64)
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.
SC service | JMX port # |
|---|---|
sc-auth | 31101 |
sc-store | 31102 |
sc-graph | 31103 |
sc-web-gateway | 31100 |
sc-aras | 31112 |
sc-artifactory | 31116 |
sc-bitbucket | 31104 |
sc-collaborator | 31118 |
sc-confluence | 31105 |
sc-doors | 31115 |
sc-github | 31106 |
sc-gitlab | 31107 |
sc-jama | 31114 |
sc-jira | 31108 |
sc-restful | 31119 |
sc-sysmlv2 | 31112 |
sc-testrail | 31113 |
sc-twcloud | 31109 |
sc-volta | 31117 |
sc-wc | 31110 |
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.
This will:
- install Syndeia Cloud 3.5 (or latest service pack) to /opt/icx/syndeia-cloud-${new_build_version} ,
- make syndeia-cloud:syndeia-cloud the owner,
- configure the application.conf files if necessary,
- generate a concatenated schema file,
- stop any existing Syndeia Cloud 3.X processes,
- update/create a "current" symlink to the installed version,
- stop the Kafka service (on single-node deployments only),
- archive any old Kafka logs (on single-node deployments only),
- drop any old keyspaces & generate the new schema in the DB (Cassandra),
- start Kafka service (on single-node deployments only),
- start Janusgraph service, if needed (on single-node deployments only),
- initialize the Janusgraph configuration (on single-node deployments only),
- install NT SCM services files for syndeia-cloud microservices using Apache Commons wrapper daemon
- start all Syndeia Cloud microservices,
- create the superuser account, and
- create some sample test data.
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, If you are deploying SC 3.5 on a multi-node configuration where SC is not on the same machine as Cassandra or JG, please:
ensure you have CQLSH installed,
run the SC setup with the
--multi_nodeor-mswitch.
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
.
