Single Node Setup Instructions:
Pre-requisites:
1. Ensure you have the syndeia-cloud-3.6.zip (or the 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 (green = new since SC 3.6).
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-dscr | 56131 |
| sc-dse3 | 56128 |
| sc-dt | 56132 |
| sc-genesys | 56129 |
sc-github | 31106 |
sc-gitlab | 31107 |
sc-jama | 31114 |
sc-jira | 31108 |
| sc-restful | 31119 |
sc-sysmlv2 | 31112 |
sc-testrail | 31113 |
| sc-tc | 56116 |
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.6 ; export new_build_version
3. Create a new user and group named syndeia-cloud, ie: sudo useradd --system --user-group syndeia-cloud
Note, if you've already enabled JMX, per the previous section, you may have already created this.
4. Run umask to ensure your user umask is set to 0002 and root's umask is set to 0022. If not, set it, ie: umask 0002, and then su && umask 0022
5. cd into the directory where you downloaded the Syndeia Cloud .ZIP
6. Unzip the main package, ie: unzip syndeia-cloud-${new_build_version}.zip
Note: if you don't have unzip installed, you may need to first install it via yum install unzip
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 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.6 (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 a tmpfiles.d .conf file for syndeia-cloud,
- install systemd .target and .service files for syndeia-cloud microservices
- start all Syndeia Cloud microservices,
- create the superuser account, and
- create default repository-type data.
1. In the directory you downloaded and extracted the main .zip, cd into bin and run the install script, ie: ./syndeia-cloud-3.6_install.bash -SC_v ${. new_build_version}
Note, If you are deploying SC 3.6 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
Syndeia Cloud (SC) 3.6 introduces new integrations for the following tools. These integrations require JAR files (libraries) to be collected and deployed.
If your organization is using these tools and your Syndeia license grants you access to these integrations, please follow the steps from the relevant page(s) linked above to gather and install these JAR files from the external repository server(s), otherwise proceed to the Verification section.
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: 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
2. To stop/start the Syndeia Cloud services, use sudo systemctl <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 enabled to start on boot by default. For more information see Setting up Services to Start on Boot.
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|wc
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 Post-Deployment Optional Application Configuration section.
1.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.