Versions Compared

Old Version 7

changes.mady.by.user Brian Miller

Saved on

compared with

New Version Current

changes.mady.by.user Brian Miller

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Installing, Configuring, and Starting Syndeia Cloud: step 1: remove bug warning; mention cd-ing into bin

Table of Contents
outlinetrue
stylenone

Single Node Setup Instructions:


...

Pre-requisites:

1.  Ensure you have the syndeia-cloud-3.5.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 wish to use  If you will be using JMX monitoring (or Grafana), 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-webgatewayweb-gateway

31100

sc-aras

31112

sc-artifactory

31116

sc-bitbucket

31104

sc-collaborator31118

sc-confluence

31105

sc-doors

31115

sc-github

31106

sc-gitlab

31107

sc-jama

31114

sc-jira

31108

sc-restful31119

sc-sysmlv2

31112

sc-testrail

31113

sc-twcloud

31109

sc-volta31117

sc-wc

31110

...

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 

...

(warning)  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:

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 ${new_build_version}. this step we will run the automated SC setup script.  

Panel
borderColor#eae6ff
bgColor#eae6ff
titleColorblack
borderWidth1
borderStylesolid

  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 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

...

titleMulti-node

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

Panel
borderColor#deebff
bgColor#deebff
titleColorblack
borderWidth1
borderStylesolid

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

  1. ensure you have CQLSH installed,
  2. run the SC setup with the --multi_node or -m  switch. 

(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

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. 

...