OneView Installation

Transcription

1 OneView Installation

2 1. Introduction The OneView Software Package OneView server Disk Layout OneView Software Download Hardware Recommendations Software Requirements Installation of OneView Included Files Installation Directory Java Installation Windows Service Install service Service Configuration OneView Configuration Parameters General Parameters Web Server Parameters (https) Web Server Parameters (http) Dashboard Server Parameters Backup Parameters Dashboard Sharing Proxy Server Parameters Log File Parameters Active Directory Parameters Debug Parameters Database Parameters PostgreSQL Parameters Example of Configuration File Setup of OneView Connect to OneView for the First time The OneView Demo Dashboard System Properties tab Maintenance Calendar View Options OneView Installation Page 2 of 19

3 7.1.4 External systems Dashboard calculation Users User roles Adding a new user How to Uninstall OneView Remove service Remove files OneView Installation Page 3 of 19

4 1. Introduction This document describes the installation of OneView. The OneView software consists of several autonomous components that can be installed on separate servers. This enables you to distribute your data collection across several OneView servers. One server might make CPU hungry scripted tests. A dedicated log reader server may be installed at your outsourcing partner for security reasons. The log reader server access the log files and sends response time data back to your central OneView server. Note: A valid OneView implementation will always include a single, central OneView server - and, optionally, OneView extenders. The OneView extenders may be installed on the same OS instance as the server, or, depending on server loads and network topology, the extenders may be installed on separate OS instances as stand-alone components reporting to the central OneView server. Multiple OneView extenders may be installed onto the same OS instance without conflict where server load or network topology makes this desirable. For the installation of the OneView Extenders please refer to separate documentation for each extender. 1.1 The OneView Software Package On the download page the OneView software is available as a full software package The software package is available as a zipped file The software package contains the different OneView components In order to start building a OneView system the following components are used: 1.2 OneView server Disk Layout The OneView server could have the following approved disk layout: C-drive for the operating system D-drive (200GB) for OneView The advantage of this layout is that the D-drive can be increased easily if required. It is more complicated to increase the disk containing the operating system. OneView Installation Page 4 of 19

5 1.3 OneView Software Download Contact Monsalta Support to download the latest software package. The download page also contains information on the most important content of the release, and if applicable a list of known issues related to this particular release. New software is released on a regular basis. Contact Monsalta in order to get information on the release schedule. 2. Hardware Recommendations 1 CPU quad core, 2GHz 8 GB Memory (4 GB required) 200 GB data disk space (50 GB required) 3. Software Requirements Windows XP, Vista, 7, 8, 2003, Server 2008, Server 2008 R2, Server 2012, Server 2012 R2 Java Runtime Environment version 1.7 or later. 4. Installation of OneView 4.1 Included Files All following files included in the download must be installed, especially: OneView32.exe OneView64.exe OneView.jar /html /templates /conf /icons 32-bit Service executable 64-bit Service executable The OneView application Static web content Report templates Configuration files Icon files 4.2 Installation Directory All OneView files are placed in a folder of your choice on your system. This folder is referenced as ONEVIEW_HOME. The default value for ONEVIEW_HOME is $:\OneView\ 4.3 Java Installation Download the latest Java Server JRE 64-bit software for the installation of OneView and its extenders from the official Oracle website. A supported version tested by Monsalta is available for download from Unzip Java software to ONEVIEW_HOME in a directory for Java e.g. jdk1.8.0_66. OneView Installation Page 5 of 19

6 4.4 Windows Service When OneView is installed, a Windows service by the name OneView is created and started. The service runs under the local system account and is started automatically on machine startup. The process name will be OneView32 or OneView64 respectively for 32-bit and 64 bit systems Install service 1) Unpack the installation zip-file (or copy the directory with all files and subdirectories from another computer) to a location on a local disk, e.g. ONEVIEW_HOME\OneView 2) Open a command window as administrator and change directory to ONEVIEW_HOME\OneView 3) Execute the command: ONEVIEW_HOME\jdk1.8.0_66\bin\java jar OneView.jar install 4) Start the OneView service: net start OneView 5) Exit the command window 4.5 Service Configuration The OneView service configuration can be controlled by editing the following registry key: HKEY_LOCAL_MACHINE\SOFTWARE\[Wow6432Node]\Apache Software Foundation\Procrun 2.0\ OneView\Parameters\Java. These parameters can be edited: Parameter Type Description Example Jvm String Java Virtual Machine location ONEVIEW_HOME\jdk1.8.0_66\jre\bin\server\jvm.dll Classpath String OneView application C:\OneView\OneView.jar JvmMs DWORD Minimum memory allocation (MB) JvmMx DWORD Maximum memory allocation (MB) Options Multi- String Optional JVM settings. Fx. time zone and regional settings. -Duser.country=DK -Duser.language=da -Duser.timezone=Europe/Paris OneView Installation Page 6 of 19

7 5. OneView Configuration Parameters OneView configuration parameters are set in either environment variables or by a configuration file in ONEVIEW_HOME\conf called OneView.conf. If a parameter is not found in the environment or in the configuration file, a default parameter value is applied. The file is a standard java properties text file containing one parameter and value per line: <parameter>=<value> Lines can be ignored by prefixing with a #-sign like this: #<parameter>=<value> NOTE: When setting parameters via environment variables, the parameter name must be prefixed with ov_ and all dots. in the parameter name must be replaced with an underscore _. Fx. the variable name for the parameter data.root becomes ov_data_root. 5.1 General Parameters These parameters control the Oneview administration web server that is accessible via http. Parameter Description Default Value mute Option to disable all notifications and dashboard updates. false dashboard.login data.root Controls whether only registered users can view the dashboard. true = login required, false = public access Root directory for all Oneview data sub directories (db, attachments, tasks, work, backups). Useful in environments where data is placed on a different volume than software. Defaults to the Oneview installation directory ONEVIEW_HOME. Example usage: data.root=f:\oneviewdata false ONEVIEW_HOME 5.2 Web Server Parameters (https) These parameters control the Oneview administration web server that is accessible via https. Parameter Description Default Value https.enabled TLS Admin Web server enable/disable false https.port TLS Admin Web server port number 443 https.threads TLS Admin Web server thread pool size (concurrent connections) 50 OneView Installation Page 7 of 19

8 https.localhost.only TLS Admin Web Server available locally only false https.keystore.filename TLS Admin Web Server key store filename conf/oneview.keystore https.keystore.password TLS Admin Web Server key store password Web Server Parameters (http) These parameters control the Oneview administration web server that is accessible via http. Parameter Description Default Value http.enabled Admin Web server enable/disable true http.port Admin Web server port number 1234 http.threads Admin Web server thread pool size (concurrent connections) 50 http.localhost.only Admin Web Server available locally only false 5.4 Dashboard Server Parameters These parameters control the dashboard (display only) web server used for wall dashboards. Parameter Description Default Value dashboard.http.enabled Dashboard Web server enable/disable true dashboard.http.port Dashboard Web Server Port Number 80 dashboard.http.threads Dashboard Web Server Thread Pool Size 20 dashboard.http.localhost.only Dashboard Web Server available locally only false 5.5 Backup Parameters Each day OneView will backup the entire OneView database. Backups are kept for a certain number of days. Parameter Description Default Value backup.dir Local directory used for database backup files. Defaults to a subdirectory called backups in the directory specified by the parameter data.root. Example usage: backup.dir=g:\oneviewbackups {data.root}/backups 5.6 Dashboard Sharing These optional parameters control uploading of and linking to public dashboard data. Should only in rare cases be changed. OneView Installation Page 8 of 19

9 Parameter Description Values Default dashboard.public.host Name of mobile dashboard server. (Required) <hostname>[:port] dashboard.oneview.eu dashboard.upload.host Alternative mobile dashboard server for upload. (Optional) dashboard.upload.failover If set to true, a list of alternative failover servers are used for upload. If set to false, only the server specified in parameter dashboard.public.host is used for upload. <hostname>[:port] true/false true 5.7 Proxy Server Parameters Parameters identifying proxy server to use for accessing the internet. Parameter Description Default Value proxy.host Proxy server host name or IP-address - proxy.port Proxy server port number - proxy.user Username for proxy server authentication (optional) - proxy.pass Password for proxy server authentication (optional) - proxy.domain Domain name for proxy user (optional) Log File Parameters Parameters used for setting values for deletion of log files. Parameter Description Default Value log.statistics.days Number of days before OneView statistics log files are deleted. 30 log.access.days Number of days before OneView access log files are deleted 7 log.service.days Number of days before OneView service log files are deleted Active Directory Parameters Login attempts to OneView are by default checked against the internal OneView database. If a valid user/password combination is not found here, OneView can - if enabled - authenticate username and password against an active directory server. You must enable AD integration and set the name of the domain to authenticate against in the configuration. OneView Installation Page 9 of 19

10 The OneView role of a successfully authenticated active directory user is determined by the user s active directory group memberships. For each user role (System, Administrator, User) in Oneview, an equivalent Active Directory group must exist. Assigning a domain user to one of these Active Directory groups automatically grants the user access to Oneview at the corresponding user role level. For this to work, you must enter the names of the active directory groups in the OneView configuration that grants a user the OneView System and Administrator roles. Please Note: The OneView configuration file must be editable by system administrators only! Parameter Description Default Value ad.enabled Active Directory integration enabled (true/false) false ad.domain Name of domain to authenticate against (e.g. monsalta.dk). (Required) If the ad.server parameter is not set, the ad.domain parameter is used for locating an Active Directory server via DNS. - ad.group.system ad.group.administrator ad.server Name of active directory group that grants the user a OneView system role. (Required) Name of active directory group that grants the user a OneView administrator role. (Required) Name of active directory server. (Optional) If the ad.server parameter is not set, the ad.domain parameter is used for locating an Active Directory server via DNS ad.referral Referrals strategy. Must be one of ignore, throw or follow. (Optional) follow ad.protocol LDAP connection security protocol. Must be plain or ssl. (Optional) Plain ad.user.search.filter Define a custom LDAP search filter to find a user entity in AD based on a login name supplied when logging in to Oneview. The variable {username} represents the login name in the filter. The default search filter looks up a user based on principal name or windows account name for backwards compatibility: (& ( (userprincipalname={username}@*)(samaccountname={username})) (objectclass=user) ) 5.10 Debug Parameters The following parameters control the amount of debugging information in the log files. Parameter Description Values Default OneView Installation Page 10 of 19

11 debug Enable general debug information. true/false false maintenance When true OneView starts in maintenance mode. In maintenance mode no data will be inserted into the database and dashboard calculation is disabled. true/false trace.ad Enable trace info for active directory integration true/false false trace.dashboard Enable trace info for dashboard calculation true/false false trace.graph Enable trace info for graph generation true/false false trace.notification Enable trace info for notification engine. true/false false trace.sql Enable trace info for SQL executions true/false false trace.spooler Enable trace of spool file handling true/false false false 5.11 Database Parameters OneView supports two types of databases. Derby is an embedded java relational database. This is the default database used by OneView. Parameter Description Values Default Value db.type Type of database derby/postgresql derby jdbc.threads Size of database connection pool If you use an existing database server other than Derby, you need to specify the connection properties with these parameters. Parameter Description Default Value jdbc.hostname Host name of database server - jdbc.port Port number of database server - jdbc.database Database name - jdbc.username Database user name - jdbc.password Database password PostgreSQL Parameters PostgreSQL is an enterprise open source database. OneView can use an existing PostgreSQL database in which case you need to specify the correct database connection parameters. In this case OneView will create the necessary tables in the existing database. OneView can also start its own instance of PostgreSQL server. In this case you need to specify some db.postgresql.* parameters. You must download a PostgreSQL server and unzip the binary files in a local folder. OneView will automatically create a database and tables for you. You may specify the location for OneView Installation Page 11 of 19

12 the database files. You need not specify any database connection parameters. Parameter Description Default Value db.postgresql.start Should OneView start the PostgreSQL server on startup? True or false. db.postgresql.root Root directory for the PostgreSQL database binaries ONEVIEW_HOME \pgsql db.postgresql.data Data directory for the PostgreSQL database files ONEVIEW_HOME \pgdata false 5.13 Example of Configuration File The following example makes use of some of the parameters explained above. Please refer to the tables above to investigate the effect these configurations have: http.port=1234 http.threads=50 backup.dir=d:\backup debug=false dashboard.http.port=8080 dashboard.http.threads=20 OneView Installation Page 12 of 19

13 6. Setup of OneView Once installed and configured you should continue to setup your OneView system. 6.1 Connect to OneView for the First time After installation and start of the OneView services, it is time to connect to OneView for the first time. To do that you must enter the following URL: servername-or-ip-add-of-your OneView server >:< Port number (default value is 1234 > Example: You have now connected to OneView for the first time. To continue you must fill-in some basic information about the OneView instance and System Administrator account. You are presented with the following setup box: Company name: Enter the name of your company. Full Name: Enter the full name of the System Administrator, e.g. Sysadm. Enter the System Administrator address account to where OneView should send s to. Login: Enter the login name for the System Administrator e.g. Sysadm. Password: Enter the password for the System Administrator account. Password Again: Repeat the password for the System Administrator account. When you have filled in the information, click Done. If the input is accepted, you will receive the following message: Click Go and you will now presented to the OneView Demo dashboard. OneView Installation Page 13 of 19

14 6.2 The OneView Demo Dashboard The demo dashboard in OneView is put there as a source of inspiration. It is an example made to inspire you to design your own dashboard. Your own dashboard should show you if the users are able to work efficiently with your IT systems. Login with you newly created System administrator account. With the System Administrator account, you have full access to all functions in OneView, and it is time to start using the OneView system. OneView Installation Page 14 of 19

15 7. System If you are logged in with system administrator user credentials you are allowed to access the System menu where the users are managed and the system related properties are set. 7.1 Properties tab Set up information on setup of the system and dashboard from the properties tab. Change values by clicking the small icon next the field: Maintenance The maintenance section contains information on backup and number of days to keep information on transactions and backup. Application Url: Used if the Oneview server does not know where to get the dashboard URL from. Default phone number country prefix: Add the country prefix used for sending SMS s from OneView. Hour of day when database backup will be executed (0-23): State the time for the database backup. Use a digit between 0 and 23 where 0 is equal to midnight and 23 is equal to 11 p.m. Default value is 1. Number of days before database backups are deleted: State the number of days to save the backups. Default value is 3 there is no upper limit for this value. Number of days to keep attachment files from measurements: State the number of days to save attachments, e.g. pic files from robots. Default value is 3 there is no upper limit for this value. (ATT. Disk space consuming) Number of days to keep data for transactions IN a domain: State the number of days that transactions in domains are kept in the database. The default value is 365 there is no upper limit for this value. Number of days to keep data from transactions NOT IN a domain: State the number of days that transactions not in domains are kept in the database. The default value is 14 there is no upper limit for this value. OneView Installation Page 15 of 19

16 7.1.2 Calendar The calendar function is used for SLA reporting only. For setting up time filters please use the Time Filters in the Administration tab. Working Days: State working days used for filtering on the dashboard and in the SLA reports. 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday and 6=Saturday). Default value is set to 1, 2, 3, 4 and 5. Working Hours (0-23): State working hours used for filtering in the SLA reports. Use digits between 0 and 23 where 0 is equal to midnight and 23 is equal to 11 p.m. Default value is 8, 9, 10, 11, 12, 13, 14, 15 and 16 i.e. from 8 a.m. to 4.59 p.m View Options The view options section contains information on the basic setup of the dashboard. Application Title: State the name used for this particular application. The value is shown when accessing the application remotely. Availability Graph Default On: Setting the availability graph seen from the dashboard to on or off. The default value is on. Dashboard Page Refresh Interval: Setting the interval for refreshing the dashboard default value is 20 seconds. Default Report Locale: Default language for the report. Default value is en (English). Expand all Shelves on Dashboard: Option to set shelves on the dashboard to appear as folded or unfolded. Severe incident definition: Number of minutes before error (Red box) is marked as an incident (Status used in reports). Show Compliance Level Percentages on Dashboard: Show the percentages in the dashboard select field. OneView Installation Page 16 of 19

17 7.1.4 External systems The external systems options is used for providing the system with information on how to externally access the system. External URL for Transaction Info: Link used for e.g. local Wiki. Link is shown in information field in Transaction info Dashboard calculation The dashboard calculation section contains information on how data is presented on the dashboard. It helps you setting up the strategy on dashboard calculation and how the dashboard reacts to changes in domains. Dashboard delay in minutes: Number in minutes before a faulty measurement is shown on the dashboard. Default value is 5. Dashboard period in minutes: Number in minutes that dashboard base it s calculated status (History). Default value is 15. Dashboard upload period in minutes: Numbers in minutes between data upload to mobile dashboard. Default value is 1. Default domain calculation strategy: Strategy used to calculate the domain. Default value is Worst. Default maximum number of data records: Max numbers of data records within the dashboards period. Default value is 3. Default transaction calculation strategy: Strategy used to calculate the transaction. Default value is Period Average. OneView Installation Page 17 of 19

18 8. Users The Users tab are used to add new users and to view the users already in the system. Per default only the new system administrator exist. New users can be added directly in the system or using the AD (Active Directory) 8.1 User roles Users can have one of 3 different roles: Role name System Admin User Description Has full access Cannot access the System menu Cannot access the System or Administration menus 8.2 Adding a new user Fill in the basic information on the user and pick the role required (User, Admin or System). Tick off and/or SMS if the user should receive information on system changes. Setting up notifications are set up in the Notifications tab. To enable the user to login requires Login Enabled to be ticked off. Click Add to create the user with the information provided. OneView Installation Page 18 of 19

19 9. How to Uninstall OneView 9.1 Remove service 1) Stop the OneView service: net stop OneView 2) Remove the OneView service: java -jar OneView.jar uninstall 9.2 Remove files 1) Remove the files in directory: ONEVIEW_HOME\OneView 2) Delete the directory: ONEVIEW_HOME\OneView OneView Installation Page 19 of 19