Table of Contents | ||||
---|---|---|---|---|
|
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. 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 wish to use JMX monitoring (or Grafana), the following additional ports will also need to be accessible from where you will run monitoring:
SC service | JMX port # |
---|---|
sc-auth | 31101 |
sc-store | 31102 |
sc-graph | 31103 |
sc-webgateway | 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. SSH to your designated Syndeia Cloud server
2. Set an environment var for the build version, ex: new_build_version=3.5 ; export new_build_version
3. Create a new user and group named syndeia-cloud
, ie: sudo useradd --system --user-group syndeia-cloud
...
IMPORTANT: 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 post SC setup via the steps in Appendix C3.6).
...
Installing, Configuring, and Starting Syndeia Cloud:
1. In the directory you downloaded and extracted the main .zip
, run the install script, ie: ./bin/syndeia-cloud-3.5_install.bash -SC_v ${
. This will: new_build_version}
...
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: sudo systemctl disable sc.target
...
Managing Syndeia Cloud:
1. To check the status of Syndeia Cloud services, use systemctl status
<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
...
3. To tail or view the logs for any Syndeia Cloud service, use either sudo journalctl -feu sc-
<service_name> or less /opt/icx/syndeia-cloud-${new_build_version}/logs/
<service_name>.log
; where <service_name> = one of auth|store|graph|web-gateway|aras|artifactory|bitbucket|collaborator|confluence|doors|github|gitlab|jama|jira|restful|sysmlv2|testrail|twcloud|volta|w
c
...
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:
...