HPE ALM Octane Synchronizer Installation Guide

28 Pages·2017·0.65 MB·English

ALM Octane
Software Version: 16.1.100
Synchronizer Installation Guide
GotoHELP CENTER ONLINE
https://admhelp.microfocus.com/octane/
DocumentReleaseDate:November06,2022|SoftwareReleaseDate:November
SynchronizerInstallationGuide
ALMOctane
2022
ALMOctane(16.1.100) Page2of36
Legal Notices
©Copyright2016-2022MicroFocusoroneofitsaffiliates.
Warranty
TheonlywarrantiesforproductsandservicesofMicroFocusanditsaffiliatesand
licensors(“MicroFocus”)aresetforthintheexpresswarrantystatements
accompanyingsuchproductsandservices.Nothinghereinshouldbeconstruedas
constitutinganadditionalwarranty.MicroFocusshallnotbeliablefortechnicalor
editorialerrorsoromissionscontainedherein.Theinformationcontainedhereinis
subjecttochangewithoutnotice.
RestrictedRightsLegend
ContainsConfidentialInformation.Exceptasspecificallyindicatedotherwise,a
validlicenseisrequiredforpossession,useorcopying.ConsistentwithFAR12.211
and12.212,CommercialComputerSoftware,ComputerSoftwareDocumentation,
andTechnicalDataforCommercialItemsarelicensedtotheU.S.Government
undervendor'sstandardcommerciallicense.
Disclaimer
Certainversionsofsoftwareand/ordocuments(“Material”)accessibleheremay
containbrandingfromHewlett-PackardCompany(nowHPInc.)andHewlett
PackardEnterpriseCompany.AsofSeptember1,2017,theMaterialisnowoffered
byMicroFocus,aseparatelyownedandoperatedcompany.Anyreferencetothe
HPandHewlettPackardEnterprise/HPEmarksishistoricalinnature,andtheHP
andHewlettPackardEnterprise/HPEmarksarethepropertyoftheirrespective
owners.
ALMOctane(16.1.100) Page3of36
SynchronizerInstallationGuide
Contents
Prerequisites 6
Hardwarerequirements 6
Databaserequirements 6
Softwarerequirements 6
Permissions 7
Firewallrequirements 7
InstalltheSynchronizer 9
DownloadSynchronizerandprepareALMOctane 10
DownloadtheSynchronizer 10
PrepareALMOctanetoenabletheintegration 10
InstallSynchronizerusingtheConfiguratorinterface 13
InstallandstarttheSynchronizer 13
ConfigureSynchronizerparametersintheConfiguratorinterface 13
InstallSynchronizerusingthesync.ymlfile 15
Automaticallypopulatevaluesinsimpleenvironments 15
Manuallydefinevaluesincomplexproductionenvironments 15
InstallandstarttheSynchronizer 16
UsingSynchronizerwithSSO 16
DefineadditionalpropertiesandenabletheSynchronizerservice 18
Defineadditionalproperties 18
EnabletheSynchronizerserviceinALMOctane 19
Synchronizerparameterreference 20
Synchronizermanagement 26
Configuretrustwithasecuredatabase 26
Configuretrust 27
ConfigureasecureconnectiontotheSynchronizerservice 27
RunningtheSynchronizerserviceonOpenJRE 27
UninstalltheSynchronizer 28
UpgradetheSynchronizer(on-premises) 29
UpgradefromCP10orlater 29
UpgradefromCP9orearlier 29
UpgradeSynchronizerlinksanduninstalltheIntegrationBridge 31
UpgradeSynchronizerlinks 31
UninstalltheIntegrationBridgecomponents 32
ALMOctane(16.1.100) Page4of36
SynchronizerInstallationGuide
TroubleshootSynchronizerinstallation 33
Logs 33
ErrorwhenenablingtheSynchronizerservice 33
SendUsFeedback 35
ALMOctane(16.1.100) Page5of36
SynchronizerInstallationGuide
Prerequisites
Prerequisites
ThefollowingsectionliststheSynchronizerprerequisites.
Hardware requirements
Foreachnode(server/VM)wheretheSynchronizerwillberunning,thefollowing
arehardwarerequirements:
CPU QuadCoreAMD64processororequivalentx86-compatible
processor
Memory(RAM) 16GBminimum
FreeDisk 80GBminimum
Space
Operating RedHatEnterpriseLinux(RHEL)6.5orhigher
System
CentOS6.5orhigher
Database requirements
ThefollowingaretheSynchronizerdatabaserequirements:
Oracle19c,12c-StandardorEnterpriseedition,charactersetAL32UTF8
l
MSSQLServer2019,2017,2016
l
Software requirements
ThefollowingaretheSynchronizersoftwarerequirements:
OpenJDK1.8update65orhigher,orcompliantwiththisversionofOpenJDK.
l
ToinstallJava,useOpenJDKbyrunning:
yum install -y java-1.8.0-openjdk-devel
IfyoucanonlyuseOpenJRE,see"RunningtheSynchronizerserviceon
OpenJRE"onpage 27.
InALMOctaneonWindowsenvironmentsyouneedtoinstallthecURLutilityon
l
yourWindowsmachine,placingcurl.exeintheoctane\installfolder.
Thisenablesyoutorunthegenerateadminapikey.batcommandwhich
generatesanAPIclientIDandsecrettocommunicatewithALMOctane.
ALMOctane(16.1.100) Page6of36
SynchronizerInstallationGuide
Prerequisites
Permissions
ThefollowingaretheSynchronizerpermissionrequirements:
File system
Regularuserforinstallationprocess,orroot
l
RootforinstallingOSservice
l
Writepermissionstothelogfolderspecifiedinthepropertygeneral/logFolder,
l
inthe.ymlconfigurationfiledescribedin"InstalltheSynchronizer"onpage 9
Writepermissionstotherepositoryfolderspecifiedintheproperty
l
repository/rootFolder,inthe.ymlconfigurationfiledescribedin"Installthe
Synchronizer"onpage 9
Oracle
CREATEUSER
l
CREATESESSIONWITHADMINOPTION
l
CREATETABLEWITHADMINOPTION
l
DROPUSER
l
CREATESEQUENCEWITHADMINOPTION
l
SELECTonSYS.DBA_USERS
l
MSSQL
dbcreator
l
securityadmin
l
Firewall requirements
OntheSynchronizerserver,youmusthaveanopeninboundport.Bydefault,the
Synchronizerusesport8080forHTTPorport8443forHTTPS(SSL).
Theserviceusesthefollowing:
Port Config property name in
Purpose (default) sync.yml
Inboundcommunicationtothe 8080 sync/general/port
Synchronizer
SSL:8443
ALMOctane(16.1.100) Page7of36
SynchronizerInstallationGuide
Prerequisites
Outboundcommunicationto Oracle: sync/database/connectionString
thedatabase 1521
MSSQL:
1433
Outboundcommunicationto 8080 serviceLocations/octane
ALMOctane
Communicationbetween 5701 sync/distributedCache/port
nodesinclusterconfiguration
Outboundcommunicationto 8080 sync/general/port
Synchronizer
ALMOctane(16.1.100) Page8of36
SynchronizerInstallationGuide
InstalltheSynchronizer
Install the Synchronizer
ThefollowingsectiondescribeshowtoinstallandconfiguretheSynchronizerfor
initialuse.
1. "DownloadSynchronizerandprepareALMOctane"onthenextpage. 
FirstyoudownloadtheSynchronizerpackage.YouthenneedtoprepareALM
OctanetoenabletheintegrationwithSynchronizer.
2. Next,youinstallandconfigureSynchronizer.Therearethreewaystoinitially
configureSynchronizer,dependingonyourenvironment:
a. Inasimpleenvironmentsuchasfortestingpurposes,youcanrunascript
whichautomaticallypopulatesdefaultSynchronizerparametersinthe
/opt/sync/conf/sync.ymlfile.Youcantheneditthefilemanuallytomatch
yourenvironment.
b. Inacomplexproductionenvironmentwithclusters,youmustmanually
definetheSynchronizerparametersinthe/opt/sync/conf/sync.ymlfile.
Theabovetwoscenariosaredescribedin"InstallSynchronizerusingthe
sync.ymlfile"onpage 15.
c. Inabasicproductionenvironment(withoutclusters),youcanusethe
Configuratorinterfacetoenteryourparameterseasily.See"Install
SynchronizerusingtheConfiguratorinterface"onpage 13.
3. "DefineadditionalpropertiesandenabletheSynchronizerservice"onpage 18.
ALMOctane(16.1.100) Page9of36
SynchronizerInstallationGuide
InstalltheSynchronizer
Download Synchronizer and prepare ALM
Octane
Tobegin,youdownloadtheSynchronizerpackage.YouthenneedtoprepareALM
OctanetoenablecommunicationbetweenALMOctaneandtheSynchronizer.
Download the Synchronizer
1. DownloadtheSynchronizerinstallationpackagefromMicroFocus
Marketplace.
2. Under/opt/extractthetarfile:
tar -xzvf <installation file name>
Thefilestructureshouldnowbe/opt/sync/.
Prepare ALM Octane to enable the integration
ToenablecommunicationbetweenALMOctaneandtheSynchronizer,performthe
followingstepswithinyourALMOctaneenvironment.(Inaclusterconfiguration,
thismustbedoneseparatelyforeachALMOctanenode.)
Note:
IfyouupgradeALMOctanethefollowingconfigurationchangesare
l
overwritten.Backupthefilesdescribedbelowbeforeupgrading,and
restorethemafterupgrading.
ThisdocumentprovidespathsforALMOctaneonLinux.Ifyouareusing
l
ALMOctaneonWindows,thepathsaresimilarbutuseWindowsformat.
1. Within/opt/octane/webapps,copytheservice.locator.properties.example
filetoservice.locator.properties:
cp service.locator.properties.example service.locator.properties
2. Withintheservice.locator.propertiesfile,enterthecorrectinternalURLofthe
Synchronizer.NotethattheURLscannotstartorendwithspaces.
3. Openthe/opt/octane/wrapper/wrapper.conffile.Inthesectionheaded#on-
prem configuration,uncommentthefollowinglines(removethe#character
fromthebeginningofeachline):
ALMOctane(16.1.100) Page10of36