Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: SC 3.6-SP1: Update versions

Table of Contents
outlinetrue
stylenone

Single Node Setup Instructions:


...

Pre-requisites:

1.  Ensure you have the syndeia-cloud-3.6-SP1.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.  

(info)  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.  

(info)  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). 

(info) 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.5!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-collaborator31118

sc-confluence

31105

sc-doors

31115

sc-dscr56131
sc-dse3

56128

sc-dt56132
sc-genesys56129

sc-github

31106

sc-gitlab

31107

sc-jama

31114

sc-jira

31108

sc-restful31119

sc-sysmlv2

31112

sc-testrail

31113

sc-tc56116

sc-twcloud

31109

sc-volta31117

sc-wc

31110

...

2. Set an environment var for the build version, ex:  new_build_version=3.6-SP1 ; export new_build_version

3. Create a new user and group named syndeia-cloud, ie:  sudo useradd --system --user-group syndeia-cloud 

...

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:  

Code Block
languagebash
themeRDark
linenumberstrue
umask 0002

...


sudo su # you will be prompted for a password
umask # IF this *isn't* "0022", THEN set it in /root/.profile (at least for the duration of the SC deployment)
echo "umask 0022" > /root/.profile

5. cd into the directory where you downloaded the Syndeia Cloud .ZIP

...

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

Panel
borderColor#eae6ff
bgColor#eae6ff
titleColorblack
borderWidth1
borderStylesolid

  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.  

...

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

...

Panel
borderColor#deebff
bgColor#deebff
titleColorblack
borderWidth1
borderStylesolid

(info) Syndeia Cloud (SC) 3.6 introduces new integrations for the following tools. These integrations require JAR files (libraries) to be collected and deployed.

  1. Siemens Teamcenter

  2. Zuken DS-CR

  3. Zuken DS-E3

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.

...

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-dscr|sc-dse3|sc-dt|sc-github|sc-gitlab|sc-jama|sc-jira|sc-restful|sc-sysmlv2|sc-tc|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-dscr|sc-dse3|sc-dt|sc-github|sc-gitlab|sc-jama|sc-jira|sc-restful|sc-sysmlv2|sc-tc|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_impl>.log; where <service_name> = one of auth|store|graph|web-gateway|aras|artifactory|bitbucket|collaborator|confluence|doors|dscr|dse3|dt|github|gitlab|jama|jira|restful|sysmlv2|testrail|twcloud|volta|wc

where <service_name_impl> = one of auth-impl|store-impl|graph-impl|web-gateway|aras-impl|artifactory-impl|bitbucket-impl|collaborator-impl|confluence-impl|doors-impl|dscr-impl|dse3-impl|digital-thread-impl|github-impl|gitlab-impl|jama-impl|jira-impl|restful-impl|sysmlv2-impl|teamcenter-impl|testrail-impl|teamworkcloud-impl|volta-impl|windchill-impl 

...

Validating Syndeia Cloud Installation & Configuration:

...