TIBCO Nimbus. Installation Planning Guide. Software Release July 2017

Transcription

1 TIBCO Nimbus Installation Planning Guide Software Release July 2017

2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, Two-Second Advantage and TIBCO Nimbus are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE RELEASE NOTE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 Table of Contents Introduction... 4 Target Audience... 4 About the Installation Planning Guide... 4 About TIBCO Nimbus... 4 General Recommendations... 5 Installation... Components 5 Operating Platforms... 5 Author Client... 5 Windows Server 2008/R2 and 2012/R Data Storage... 6 Installation Scenarios... 7 Scenarios... 7 Small Deployment on a Single Application Server Host... 7 Medium Sized 'Split' Installation Large Complex Installation TIBCO Nimbus Support Contact Details Appendix Windows... Server 2008/R2 and 2012/R2 Considerations 17 Performance Implications SMB2/SMB3 and Opportunistic Locking (OpLocks)... 17

4 Introduction Target Audience The intended audience for this Installation Planning Guide includes: The Technical Architect responsible for the overall technical solution The Technical Architect responsible for planning and managing the TIBCO Nimbus installation About the Installation Planning Guide The purpose of this guide is to provide the Technical Architect an overview of TIBCO Nimbus, and how the architecture can be scaled to support multi-national corporations. It also describes the hardware requirements for deploying and hosting TIBCO Nimbus. The figures given are purely indicative and each organization will have their own characteristics that determine their requirements. In addition, the requirements for a particular organization will change over time, driven by a changing usage profile. This means that there will be an ongoing capacity planning activity required to ensure that TIBCO Nimbus performs to the requirements of an organization. About TIBCO Nimbus TIBCO Nimbus is a process management mapping application that allows corporate information to be presented graphically and hierarchically in the form of maps and diagrams. It provides a simple userinterface that enables any employee within an organization to access information that is relevant and essential to fulfil their role. Maps are a collection of diagrams created by process authors. A map is initially created as a draft version until it is promoted to a master. Maps may also comprise a number of scenarios. Access rights can be assigned to individual users and groups, allowing or preventing access to an entire map or parts of a map. Continuous improvement to processes is achieved through a number of collaboration features. Acknowledgement requests ensure users are aware of process content that affects their roles. Reviews ensure that content is kept up-to-date. Feedback and change requests allow users to suggest improvements. Users can also be notified when content changes through the use of subscriptions. Statement sets are a hierarchical set of regulatory and auditable statements that ensure compliance to specific business and legal requirements, such as ISO 9000/12001/17799, CMMi, internal company policies, etc. Statements can be linked to activities that are related to compliance and governance. Page 4

5 General Recommendations Installation Components The basic deployment is made up of the following components: Author Client Web Server Action Server LDAP Office Integration Locking Service Batch Server BI server It is possible to deploy these components on a single server for a simple low volume installation, or to separate them to facilitate higher loadings and user throughputs. This will be shown in the sample scenarios. Operating Platforms Operating platform choice will be site specific. The release notes detail specific operating systems and browser support for the version of choice, and can be found on the TIBCO documentation web site docs.tibco.com. Author Client Author access through the Author Client should be deployed on an appropriate terminal services (TS) platform. Microsoft RDS or Citrix Xenapp are examples of supported platforms. The TS platform should be placed on the same physical network as the application host server to minimise network delays between components. The TIBCO Nimbus Author Client is classed as a High volume terminal services application and the host platform and any load balancing will need to be sized to accommodate this. Windows Server 2008/R2 and 2012/R2 Opportunistic locking should be disabled. SMB2 should be disabled. Further details on this can be found in the appendix. Page 5

6 General Recommendations These can be disabled by the addition/import of two registry keys to the server. Included in the installation media are the reg files that detail these steps. To prepare a server for use with TIBCO Nimbus, an administrator should import DisableFileServerOplocks.reg and ForceSMB1.reg. These can be backed out using the corresponding reg files as shown above. Data Storage It is highly recommended when installing the product that the data is placed on a drive that's separate from the system volume, both physically and virtually as far as is practicable. I/O competition will be exacerbated by sharing the same data space. Page 6

7 Installation Scenarios Scenarios There are three basic scenarios demonstrated that can be extended to fit specific requirements: 1. Small deployment on a single server host 2. Medium sized split installation 3. Large sized complex installation Note: It is recommended that you review the entire scenario before attempting installation. Small Deployment on a Single Application Server Host The following example provides a reference deployment to support 10 to 1000 users. The diagram shows the component layouts. Page 7

8 Installation Scenarios The component blocks above should be installed in two different locations on the server. Placement of the data store is critical. This should be installed on a data drive that is physically separated from the system drive. In a physical system this means it should not share physical space with the system drive. In a virtual system this should operate on its own Virtual Hard Drive. Normal operations factors will apply. Recommended performance: CPU Minimum 1 Ghz performance Memory 4GB allocated to installation minimum Disk Space and Type required will depend upon usage profiles and documentation storage. As an absolute minimum the drive should have 40GB of uncontested disk space. It is your responsibility to carry out Capacity Management and to ensure that there is enough disk space for the Nimbus Data at all times. You should also ensure that when using the Nimbus Backup Utility, the target location of the backup is on a separate drive to the Nimbus Data. Failure to observe either of these recommendations could result in irrecoverable data or capacity management issues. Procedure The steps for installation are documented in the TIBCO Nimbus Administration Guide but the procedure is as follows: 1. Deploy pre-requisites IIS Excel (optional if using Office integration) Recommended Anti-Virus exclusions Domain service account 2. Install the Author Client software 3. Install the Web Server software 4. Install the Action Server services 5. Install the Batch Server 6. Install the BI server (optional) 7. Launch the Author Client and create initial user 8. Configure shares and permissions 9. Configure the Web Server and DCOM permissions 10. Deploy the Author Client on terminal services platform 11. Configure LDAP (optional) Page 8

9 Installation Scenarios When installing the Client software in step 2, it is recommended that the installation folder and data folders are created separately before commencing. In the figure below you will see that separate folders have been created. Also, the installation has been placed away from the system drive. Further to this, a Process Repository was created with a shortened path PR. The folder can have any name, however it should be noted that several folders will be created in this location following the first launch of the Author Client and subsequent advanced configuration actions: Document storage Scorecard repository storage Secure credentials Each of these will need to be accessible to some degree by the Author Client. Separation into a separate data folder minimizes the changes required for security and reduces complexity. The TIBCONimbusData folder will need to be shared to allow remote access. Change permissions on the share should be set for all Administrators and Authors, along with any required domain service accounts. The File system folders will need to be set with modify permissions for these accounts. Page 9

10 Installation Scenarios Medium Sized 'Split' Installation The following example provides a reference deployment to support 1000 to 5000 users. The diagram shows the component layouts. In this scenario the application components are separated to allow greater performance levels from the Web Server platform. LDAP is highly recommended to support the number of users in this scenario. Recommended Performance: CPU Minimum dual 2.5 GHz performance Memory 8GB allocated to installation minimum Disk Space and Type required will depend upon usage profiles and documentation storage. As an absolute minimum the drive should have 40GB of uncontested disk space. It is your responsibility to carry out Capacity Management and to ensure that there is enough disk space for the Nimbus Data at all times. You should also ensure that when using the Page 10

11 Installation Scenarios Nimbus Backup Utility, the target location of the backup is on a separate drive to the Nimbus Data. Failure to observe either of these recommendations could result in irrecoverable data or capacity management issues. Note: The disk space requirements can grow over time. The figure quoted is not an absolute value. Procedure The steps for installation are documented in the TIBCO Nimbus administration Guide but the procedure is as follows. As this is split across two servers the steps are graded as S1 and S2 to denote the relevant hosts: 1. Deploy pre-requisites Server 1 (S1) IIS Recommended Anti-Virus exclusions Domain service account 2. Deploy pre-requisites Server 2 (S2) Excel (optional if using Office integration) 3. Install the Author Client software (S1) 4. Install the Web Server software (S1) 5. Install the Action Server services (S2) 6. Install the Batch Server (S2) 7. Install the BI server (optional) (S2) 8. Launch the Author Client and create initial user (S1) 9. Configure shares and permissions (S1) 10. Configure the Web Server and DCOM permissions (S1) 11. Deploy Author Client on terminal services platform 12. Configure LDAP (optional) (S1/S2) 13. Configure Windows Integrated Authentication (S1) When installing the Author Client software in step 3, it is recommended that the Installation folder and data folders are created separately before commencing. In the figure below you will see that separate folders have been created. Page 11

12 Installation Scenarios Also, the installation has been placed away from the system drive. Further to this, a Process Repository was created with a shortened path PR. The folder can have any name, however it should be noted that several folders will be created in this location following the first launch of the Author Client and subsequent advanced configuration actions: Document storage Scorecard repository storage Secure credentials Each of these will need to be accessible to some degree by the Author Client users. Separation into a separate data folder minimizes the changes required for security and reduces complexity. The TIBCONimbusData folder will need to be shared to allow remote access. Change permissions on the share should be set for all Administrators and Authors along with any required domain service accounts. Page 12

13 Installation Scenarios Large Complex Installation The following example provides a reference deployment to support users in varying increments. The diagram shows the component layouts. In this scenario the application components are separated to allow greater performance levels from the Web Server platform. LDAP is highly recommended to support the number of users in this scenario. Recommended Performance: CPU Minimum dual 2.5 GHz performance Memory 8GB allocated to installation minimum Disk Space and Type required will depend upon usage profiles and documentation storage. As an absolute minimum the drive should have 40GB of uncontested disk space. It is your responsibility to carry out Capacity Management and to ensure that there is enough disk space for the Nimbus Data at all times. You should also ensure that when using the Nimbus Backup Utility, the target location of the backup is on a separate drive to the Nimbus Data. Failure to observe either of these recommendations could result in irrecoverable data or capacity management issues. These requirement numbers are provided per host server. Page 13

14 Installation Scenarios Procedure The steps for installation are documented in the TIBCO Nimbus administration guide but the procedure is as follows. As this is split across a potential of 5 servers plus a load balancer and terminal services stack, the steps are graded as S1 to S5 to denote the relevant hosts. S1 to S3 are Web Servers, S4 is the Action Server Host and S5 is the data store. 1. Deploy pre-requisites Server 1 (S1-S3) IIS Recommended Anti-Virus exclusions Domain service account 2. Deploy pre-requisites Server 2 (S4) Excel (optional if using Office integration 3. Install the Author Client software (S5) 4. Configure shares and permissions (S5) 5. Install the Web Server software (S1-S3) 6. Install the Action Server services (S4) 7. Install the Batch Server (S4) 8. Install the BI server (optional) (S4) 9. Launch the Author Client and create initial user (S5) 10. Configure the Web Server and DCOM permissions (S1-S3) 11. Deploy Author Client on terminal services platform stack 12. Configure LDAP (optional) (S5) 13. Configure Windows Integrated Authentication (S1-S3) When installing the Author Client software in step 3 it is recommended that the installation folder and data folders are created separately before commencing. In the figure below you will see that separate folders have been created. Also, the installation has been placed away from the system drive. Further to this, a Process Repository was created with a shortened path PR. Page 14

15 Installation Scenarios The folder can have any name, however it should be noted that several folders will be created in this location following the first launch of the Author Client and subsequent advanced configuration actions. Document storage Scorecard repository storage Secure credentials Each of these will need to be accessible to some degree by the Author Client users. Separation into a separate data folder minimizes the changes required for security and reduces complexity. The TIBCONimbusData folder will need to be shared to allow remote access. Change permissions on the share should be set for all Administrators and Authors along with any required domain service accounts Load balancers will need to be set with session affinity to ensure that a user session remains with its original server during that connection session. An appropriate sticky bit must be set at the Load balancer with reference to the internal network architecture. It is possible to use SSL offloading at the load balancer, however it is still recommended that back end Web Servers are supported at least by self-signed certificates, in this case with appropriate validation options set at the load balancer. Refer to your LB documentation for relevant configuration guidelines. Advanced Features Advanced product features include the secure process repository, the VSSBackup utility and the ability to extract the application data to a SQL database for data mining. Descriptions of these features can be found in the TIBCO Nimbus Administration Guide, downloadable from the TIBCO Documentation site at docs.tibco.com. Page 15

16 TIBCO Nimbus Support Contact Details Our specialized team are on hand to provide assistance with the TIBCO Nimbus product. TIBCO Support is an online resource where you can log cases directly, 24 hours a day, 7 days a week. You can also view updates on current cases and search the TIBCO Nimbus Knowledge Base. Use the links below to access the relevant service. Requirement Contact Details To register for a TIBCO Support account. Request an account for TIBCO Support To log in to TIBCO Support. support.tibco.com If your support issue is urgent and you have support@tibco.com not yet registered for an account please . For phone numbers and further information on service level agreements. TIBCO Support Services Access the TIBCO Community site. TIBCO Community Page 16

17 Appendix Windows Server 2008/R2 and 2012/R2 Considerations Performance Implications Disabling SMB2/3 will only have a very minor impact on performance and hence this will not usually be noticeable. Opportunistic locking can provide significant performance improvements but only when a single PC or server accesses remote files. However, once a process on the file server or on another PC/server starts accessing the same file, this gain is lost. As the Process Repository will either be accessed either entirely from the local server or more usually several servers, opportunistic locking is not in use and therefore disabling it should not have any significant impact on performance. SMB2/SMB3 and Opportunistic Locking (OpLocks) A potential data corruption issue has been identified when the Process Repository is placed on a; Microsoft Windows Server 2008/R2, Windows Server 2012/R2, or on a Microsoft Windows Vista/ Windows 7 workstation and then accessed by another Windows Server 2008/R2, 2012/R2 or a Vista/ Windows 7 workstation that is SMB2 enabled. To avoid any possible corruption to the data in this deployment set-up, Nimbus highly recommends disabling both the Server Message Block (SMB2/3) file sharing protocol and Opportunistic Locking on the file server. Note: Opportunistic locking can only be disabled when SMB2/3 has been disabled. After disabling SMB2/3, SMB1 will be used, even when clients that are SMB2/3 capable open files on the file server. To disable SMB2/3 and Opportunistic Locking: The CD image contains registry import files that will disable SMB2/3 and Opportunistic Locking on a server (found in System Updates and Utils/Oplocks and SMB2). Force SMB1.reg will disable SMB2/3 and use SMB1. DisableFileServerOplocks.reg will disable opportunistic locking. Alternatively, the Windows Server System Registry can be manually edited: To disable SMB2/3, change or add the following REG_DWORD value: HKEY_LOCAL_MACHINE\SYSTEM\ CurrentControlSet\Services\LanmanServer\Parameters\SMB2 Set the value to 0. To disable Opportunistic Locking, change or add the following REG_DWORD value: HKEY_LOCAL_MACHINE\SYSTEM\ CurrentControlSet\Services\LanmanServer\Parameters \EnableOplocks Set the value to 0. Note: You must restart the computer for the above registry changes to take effect. Page 17

18 Appendix To enable SMB2/3 and Opportunistic Locking: AllowSMB2.reg will enable SMB2/3. EnableFileServerOplocks.reg will enable opportunistic locking. Alternatively, you can manually set the registry values above to 1. Page 18