CA Open Space. Implementation Guide. Release

Transcription

1 CA Open Space Implementation Guide Release

2 This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation ) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation is proprietary information of CA and may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. If you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice. The manufacturer of this Documentation is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (b)(3), as applicable, or their successors. Copyright 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

3 Contact CA Technologies Contact CA Support For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At you can access the following resources: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product Providing Feedback About Product Documentation If you have comments or questions about CA Technologies product documentation, you can send a message to techpubs@ca.com. To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at

4

5 Contents Chapter 1: Introduction 7 Chapter 2: Install CA Open Space 9 Verify the Prerequisites... 9 Run the Installer Chapter 3: Modify CA Open Space 15 Chapter 4: Upgrade CA Open Space 17 Chapter 5: How to Set up the Cluster Environment 19 Set up and Configure Node Install and Configure Apache Solr Configure Liferay to use Solr for Searching Set up and Configure Node Configure the Load Balancer Chapter 6: Uninstall CA Open Space 27 Contents 5

6

7 Chapter 1: Introduction CA Open Space is a community-based communication tool, which lets you connect and share knowledge with the people in your organization. Using this communication tool, you can post questions, get answers, share information, solutions, and ideas. A powerful search capability offers results from community conversations, SharePoint content, and external search engines, such as Google. CA Open Space is integrated with CA SDM 12.6, 12.7, and 12.9, and with CA Service Catalog 12.9 as a self-service front end. If the community cannot provide the answer, you can open a request. You can also monitor the progress of requests in CA Open Space. You can use shortcut keys to perform some basic navigation tasks quickly or to work without a mouse. The following table describes the available keyboard shortcuts: TO DO THIS Go to Home page Go to Communities Ask a Question Go to My Profile Reply to a Question Go to Questions Display Help PRESS CTRL+1 CTRL+2 CTRL+3 CTRL+4 CTRL+5 CTRL+6 F1 Note: To use the keyboard shortcut to reply to a question (CTRL+5), you must be viewing the entire conversation. Chapter 1: Introduction 7

8

9 Chapter 2: Install CA Open Space CA Open Space lets you create and build user communities for your users. Install CA Open Space to create and manage communities. As an administrator you can perform the following task to install CA Open Space: 1. Verify the Prerequisites (see page 9) 2. Run the Installer (see page 10). 3. To verify the installation, log in to the following URL as an administrator: The default tenant Home Page is displayed. Verify the Prerequisites Before you install CA Open Space Release 3.0, verify the following prerequisites: Ensure that the server where you want to install CA Open Space supports the hardware and the Operating System requirements as mentioned in the Release Notes. Download Liferay CE 6.1 GA edition zip file. Note: Do not install Liferay manually as the CA Open Space installer unzips the downloaded file and installs Liferay. Install MySQL from Install MySQL Workbench from and use it for the following actions: a. Create a DB Admin User (For example, OSOP). Open MySQL Workbench and navigate to Manage Security, Security, Users and Privileges, Add Account, (For example, OSOP). Verify that Limited Connectivity to Hosts Matching is set to %. Note: You can also use Root as a DB Admin User but ensure that Limited Connectivity to Hosts Matching is set to %. Chapter 2: Install CA Open Space 9

10 Run the Installer b. Provide the following roles in the Administrative Roles tab: UserAdmin, SecurityAdmin, DBManager, DBDesigner, BackupAdmin. c. Ensure that the role has all of the following privileges, and if not, manually add them: ALTER CREATE TEMPORARY TABLES EVENT INSERT SHOW DATABASES ALTER ROUTINE CREATE USER EXECUTE LOCK TABLES CREATE ROUTINE CREATE VIEW FILE REFERENCE S CREATE DELETE GRANT OPTION CREATE TABLESPACE RELOAD SHOW VIEW SHUTDOWN TRIGGER DROP INDEX SELECT UPDATE Note: The custom role is created when you select Create Table Space, Execute, File, References, and Shutdown privileges. d. Add all schema privileges for the DB Admin User (created while installing MySQL Workbench) or the root user (if Root is specified as the DB Admin User) by clicking Add Entry from the Schema Privileges tab in Mysql Workbench. Ensure that you have checked the Grant option. (Recommended) For a better search performance, set up a separate Solr search engine server with the CA Open Space server pointing to it. For more information, see the Install and Configure Apache Solr (see page 23) topic. Run the Installer Run the installer to install CA Open Space. Follow these steps: 1. Double-click Install.bat from the installation directory. The Introduction wizard is displayed. 2. Click Next. The License Agreement wizard is displayed. 3. Scroll through the agreement details and select I accept the terms of License Agreement, and click Next. The Liferay Zip File wizard is displayed. 10 Implementation Guide

11 Run the Installer 4. Click Choose, select the liferay zip file that you have downloaded, and click Next. The Path to Installation Folder wizard is displayed. 5. Click Choose and select the path to the Installation folder. 6. Click Next and enter the following details in the Tomcat Server Settings wizard. Web Host Specifies the host name of the computer where you are installing CA Open Space. Tomcat port number Defines the tomcat port number. Tomcat Shutdown port number 7. Click Next. Defines the Tomcat shutdown port number that is used to close Tomcat. The MySQL Database Setting wizard is displayed. 8. To configure the MySQL server, select one of the following options: Create Database Specifies to create a MySQL database. Overwrite Database Deletes the existing database and creates a database with the same name. Select this option when you want to modify the installation. Use Existing Database Uses the existing database. Select this option when you want to modify the installation. DB Server Host Defines the host name of the database server. DB Server Port Defines the port number of the database server. DB Name Defines the name of the database. Chapter 2: Install CA Open Space 11

12 Run the Installer DB Admin User (User to Connect/Create/Grant access to DB) Defines the name of the DB Admin User that is used to create the database and CA Open Space database user. DB Admin User Password Defines the password of the DB Admin user. Open Space Database User Name Defines the name of the CA Open Space database user. The installer creates a user with this name. This user name is used to connect the database when CA Open Space runs. Open Space Database User Password 9. Click Next. Defines the password of the CA Open Space database user. The Administrator Settings wizard is displayed. Provide the details of the administrator. The following list includes the explanation of only those fields that are not self-explanatory: Mail Domain Defines the name of your company domain. Example: forwardinc.com Admin ID (Screen Name) Defines the administrator user name. Enter Password Defines the administrator password. Re-enter Password Defines to re-enter the administrator password. 10. Click Next and provide the mail server details for sending the automatic notification s from CA Open Space in the SMTP Mail Server Settings wizard. Mail Server (mail.openspace.com) Defines the name of the mail server. Example: mail.forwardinc.com Enable Authentication Specifies whether anonymous users are allowed to send s to the mail server. Ensure that the anonymous user setting is set in the mail server too. Note: If you select the Enable Authentication option, then Mail User and Mail User s Password is required. 12 Implementation Guide

13 Run the Installer Mail User Defines the name of the mail user using which you want to send automatic notifications. Mail User's Password Defines the password of the mail user. Is Security (TLS) enabled? Specifies whether the TLS security is enabled or not for the mail server. SMTP Port Number 11. Click Next. Defines the port number of the SMTP mail server. The Pre-installation Summary wizard is displayed. 12. Click Install. The Installing Open Space page opens. After the extraction of CA Open Space the Tomcat Server wizard is displayed. 13. Click Next. The Install Complete wizard is displayed. 14. Click Done. CA Open Space is installed. Chapter 2: Install CA Open Space 13

14

15 Chapter 3: Modify CA Open Space You can change any of the following settings: Tomcat Settings Database Settings Administrator Settings Mail Server Settings Important! Before you modify CA Open Space, ensure that you install JRE or later and set JAVA_HOME to the JRE path. Ensure to add JAVA_HOME in the Environment PATH variable. Follow these steps: 1. Depending on your operating system, do one of the following steps: (Windows) Click Start, All Programs, CA, Open Space, Change Open Space Installation for Windows. (LINUX) Navigate to the install directory, run Change Open Space Installation, select Modify Open Space Settings. The Manage Instances page opens. 2. Select Modify an Existing Instance and click OK. 3. Follow the wizard prompts to modify. For more information about the field details, see Run the Installer (see page 10). CA Open Space is modified. Chapter 3: Modify CA Open Space 15

16

17 Chapter 4: Upgrade CA Open Space Upgrade CA Open Space 2.0 or 2.0 SP1 to CA Open Space Release 3.0. Follow these steps: 1. Upgrading CA Open Space updates the existing LAR file which overwrites any existing customization. If you require these customizations, back up the existing LAR file before the upgrade. 2. Select Start, All Programs, CA, Open Space, Stop to stop the existing CA Open Space server before starting the upgrade. 3. Double-click Install.bat from the installation directory. 4. From the Manage Instances screen, select the Upgrade to CA Open Space 3.0 option, and follow the wizard prompts to upgrade. For more information about the installation, see Run the Installer (see page 10). Verify that the version.txt at the Installation path displays 3.0. For example, C:\Program Files\CA\Open Space\Version.txt. 5. If you have backed up the previous LAR file, as specified in step 1, apply the customizations in the new LAR file that has been created after the installation. 6. Open the existing onboarded tenant page, if any, to verify the successful upgrade. CA Open Space is upgraded to the Release 3.0. Chapter 4: Upgrade CA Open Space 17

18

19 Chapter 5: How to Set up the Cluster Environment For the optimal performance, set up CA Open Space on a cluster environment. In an ideal cluster environment, multiple server instances with identical configuration span across multiple nodes. All instances in a cluster work together to provide high availability, reliability, and scalability. You need the following minimum requirements for the cluster environment: 2 machines to set up the CA Open Space nodes 1 machine to set up Solr 1.4.1, Notification Server, and Shared Repository 1 machine for MySQL Database server 1 machine for Load Balancer Following software: Liferay 6.1 CE GA 1 - Standard Requirement MySQL Community Edition Server Standard Requirement EEM, if you plan to set up the ITSM environment. Chapter 5: How to Set up the Cluster Environment 19

20 Run the Installer The following diagram shows an ideal cluster environment for CA Open Space: The following diagram shows how to set up the cluster environment: 20 Implementation Guide

21 Set up and Configure Node 1 Follow these steps: 1. Set up and Configure Node 1 (see page 21) 2. Set up and Configure Node 2 (see page 24) 3. Configure the Load Balancer (see page 25) Set up and Configure Node 1 Set up CA Open Space on node 1 and configure it for the cluster environment. Follow these steps: 1. Install CA Open Space on a machine or node 1. Ensure that you give the Database Host as the machine name. 2. After the installation, add all schema privileges for the root user by clicking Add Entry from the Schema Privileges tab in Mysql Workbench. Ensure that you have checked the Grant option. 3. Onboard a tenant and configure the CA SDM data source. For more information, see the Administration Guide. 4. Shutdown CA Open Space in services.msc. 5. Open the portal-ext.properties file located in the OSOP folder of the CA Open Space installation directory. 6. Append the file with the following lines: #cluster cluster.link.enabled=true ehcache.cluster.link.replication.enabled=true lucene.replicate.write=false net.sf.ehcache.configurationresourcename=/custom-ehcache/hibernate-clustered. xml ehcache.multi.vm.config.location=/custom-ehcache/liferay-multi-vm-clustered.x ml 7. Extract the custom-ehcache.zip file from the OSOP\tools folder to the OSOP\tomcat \webapps\ROOT\WEB-INF\classes\ folder. Important! Ensure that after the extraction, the custom-ehcache folder is created in the same path as the hibernate-clustered.xml and liferay-multi-vm-clustered.xml files. Chapter 5: How to Set up the Cluster Environment 21

22 Set up and Configure Node 1 8. Open the server.xml file from the OSOP\tomcat \conf\ folder. 9. Replace <Engine name="catalina" defaulthost="localhost"> with <Engine name="catalina" defaulthost="localhost" jvmroute="node1">. 10. Restart CA Open Space services. 11. Install and Configure Apache Solr (see page 23) and Configure Liferay to use Sorl for Searching (see page 24). 12. Configure the common repository for attachments on the CA Open Space common server. For more information, see the Liferay documentation. 13. Copy the OSOP\jetty v folder to the CA Open Space common server to configure the notification server on the common CA Open Space server. 14. Configure the notification server on the CA Open Space node: a. Open portal-ext.properties file and search for cometd. b. Replace localhost with the hostname or IP address of CA Open Space common server and port with the port number on which Jetty is running. For example, #cometd configurations begin cometd.enable=true cometd.contextpath=/notification-server #internal properties are used by java client cometd.internal.host=localhost cometd.internal.port=18686 cometd.internal.protocol=http #external properties are used by jquery clients cometd.external.host=localhost cometd.external.port=18686 cometd.external.protocol=http #cometd configurations end c. Stop CA Open Space Jetty server from service.msc. CA Open Space node 1 is configured. 22 Implementation Guide

23 Set up and Configure Node 1 Install and Configure Apache Solr Install Apache Solr on the CA Open Space common server. Follow these steps: 1. Download Solr on the CA Open Space common server. For more information, see any Solr website, example, 2. From the Solr distribution, copy example folder so that CA Open Space is also at the same level. 3. Define the environment variable as the location for Solr to store the search index. Example: $SOLR_HOME=/openspace/solr Note: This environment variable can be defined on the start up sequence of the operating system, in the environment for the user who is logged in, or in the start-up script for your application server. If you are using Tomcat to host Solr, modify setenv.sh or setenv.bat and add the environment variable there. 4. Use this environment variable as a parameter for JVM during the start up configuration of the application server. Note: If you are using Tomcat, edit catalina.sh or catalina.bat and add the -Dsolr.solr.home=$SOLR_HOME to the $JAVA_OPTS variable. 5. Install Solr on the CA Open Space common server. For more information, see Note: Install the Solr search engine on a separate machine from Liferay. To integrate Solr search engine with Liferay, restart the application server. 6. Shut down Solr. 7. From the Solr distribution, copy solr.war to the webapps directory of your servlet container. 8. Start Solr on the Jetty server: a. Go to $SOLR_HOME on the command prompt. b. Run java -Dsolr.solr.home=/openspace/solr -jar start.jar to set the java system property solr.solr.home. Chapter 5: How to Set up the Cluster Environment 23

24 Set up and Configure Node 2 Configure Liferay to use Solr for Searching Do not run Liferay and Solr search engine on the same machine. Follow these steps: 1. Install the Solr Liferay plugin on CA Open Space node Copy solr-web.war file from OSOP\tools to the OSOP\deploy folder of the CA Open Space installation directory. 3. Open solr-spring.xml from the WEB-INF/classes/META-INF folder. 4. Modify the following value to point to the server where Solr is up and running: <constructor-arg type="java.lang.string" value=" /> 5. Save the solr-spring.xml file and place it back in the plugin archive. 6. Copy the schema.xml file from the extracted solr-web folder (docroot/web-inf/conf) to $SOLR_HOME/conf folder of the CA Open Space common server. 7. Restart Solr on the CA Open Space common server. Liferay server search is now upgraded to use Solr. 8. Select Control Panel, Server, Server Administration. 9. Click Execute button next to reindex all search indexes at the bottom of the page. Liferay will begin sending indexing requests to Solr for execution. Once Solr has indexed the data, a search server runs independently of all the CA Open Space nodes.the CA Open Space search now uses the Solr as the search index. This is ideal for a clustered environment, as it allows all the CA Open Space nodes to share one search server and one search index, and this search server operates independently of all the nodes. Set up and Configure Node 2 Set up and configure CA Open Space on node 2 for the cluster environment. Follow these steps: 1. Stop the CA Open Space services on node Create backup of node 1: (Windows) Run TakeBackup.bat from the bin folder of the CA Open Space installation directory. (Linux) Run TakeBackup.sh Backup is created in CA Open Space_installation\CAOpenSpaceBackup.car file of the CA Open Space installation directory. 24 Implementation Guide

25 Configure the Load Balancer 3. On node 2, install the similar configuration CA Open Space as set up in node 1: a. Select Use existing database option. b. Ensure that you use the same database host name as used during the CA Open Space node1 setup. c. Select node1 backup CAOpenSpaceBackup.car. Note: Ensure user has all the privileges according to the basic installation. d. Ensure that you extracted the custom-ehcache.zip file in the OSOP\tomcat \webapps\ROOT\WEB-INF\classes\ folder of the CA Open Space installation directory. Important! Ensure that after the extraction, the custom-ehcache folder is created in the same path as the hibernate-clustered.xml and liferay-multi-vm-clustered.xml files. e. Open the server.xml file from the OSOP\tomcat \conf\ folder and replace <Engine name="catalina" defaulthost="localhost"> with <Engine name="catalina" defaulthost="localhost" jvmroute="node2">. After the successful configuration, two CA Open Space nodes run with the same database in a cluster. Configure the Load Balancer Configure the load balancer to increase scalability and to maintain performance. Follow these steps: 1. Download and install Apache HTTP server Download mod_jk.so and copy it to APACHE_HOME\modules\ directory. 3. Modify the APACHE_HOME\conf\httpd.conf file: Append the file with the following lines: JkWorkersFile conf/workers.properties JkLogFile logs/mod_jk.log JkLogLevel info JkLogStampFormat "[%a %b %d %H:%M:%S %Y]" JkMount /* loadbalancer Add the following entry in the httpd.conf file (if not added ): # Load the mod_jk connector LoadModule jk_module modules/mod_jk.so Chapter 5: How to Set up the Cluster Environment 25

26 Configure the Load Balancer 4. Define the IP addresses of node1 and node 2 in the APACHE_HOME\conf\workers.properties file: worker.node1.host = <IP ADDRESS OF NODE1> worker.node2.host = <IP ADDRESS OF NODE2> 5. Start load balancer. 6. On the client machine (from where you are accessing CA Open Space) modify C:\Windows\System32\drivers\etc\host file to point to the IP address of the Load Balancer. For example, if you on boarded a tenant with virtual host as test.openspace.com and the IP address of the Apache server is , then you have to add test.openspace.com line in the host file. This allows access to the virtual host from the client machine. Load balancer is configured. 7. Stop the CA Open Space services on node 1 and verify that requests are getting mapped to node 2 even if node 1 is down. 26 Implementation Guide

27 Chapter 6: Uninstall CA Open Space Uninstall CA Open Space, if you no longer need it. Before uninstalling, ensure that you install JRE or later and set JAVA_HOME to the JRE path. Make sure to add JAVA_HOME in the Environment PATH variable. Follow these steps: (Windows) Click Start, All Programs, CA, Open Space, Change Open Space Installation, and select Uninstall Product. You get the prompt to take the backup. Click OK. A CAOpenSpaceBackup.car backup file is created under the path C:\CA_Open_Space_Backup. (Linux) Navigate to the install directory, run Change Open Space Installation, and select Uninstall Product. You get the prompt to take the backup. Click OK. A CAOpenSpaceBackup.car backup file is created under the path \CA_Open_Space_Backup. The installed directories and files are deleted from the system but the database is not deleted. Chapter 6: Uninstall CA Open Space 27