iosphere Software Installation Guide for Version 3.2.1

Transcription

1 Installation Guide iosphere Software Installation Guide for Version English

2 iosphere Software Installation Guide Version 3.2.1

3 iosphere Software Installation Guide for Version Installation Overview Download Files Management Server Firewall Settings Management Server Installation and Configuration Management Server - Linux Installation and Configuration Management Server - Windows Installation and Configuration Agent Installation and Configuration Agent Linux Installation and Configuration Agent Windows Installation and Configuration Agent Config Options Fusion Powered Support iosphere Software Installation Guide 2

4 iosphere Software Installation Guide for Version Legal Notices The information contained in this document is subject to change without notice. Copyright 2012 Fusion-io, Inc. All rights reserved. Fusion-io, the Fusion-io logo, iodrive, and directcache are registered trademarks, and VSL is a registered trademark of Fusion-io, Inc. in the United States and other countries. The names of other organizations and products referenced herein are the trademarks or service marks (as applicable) of their respective owners. Unless otherwise stated herein, no association with any other organization or product referenced herein is intended or should be inferred. Fusion-io 2855 E. Cottonwood Parkway, Suite 100 Salt Lake City, UT USA (801) Part Number D _ iosphere Software Installation Guide 3

5 Installation Overview Introduction iosphere allows you to manage iomemory devices using a convenient web interface. There are four main components that you must install to use iosphere: iomemory VSL (Driver) Agent Management Server ( fio-msrv) directcache driver (if you want to manage directcache from iosphere) iomemory VSL (Driver) The iomemory VSL is the driver that runs iomemory devices. The driver, along with all of its support packages and utilities, must be installed for iosphere to work. For more information on installing and using the driver, see the iomemory User Guide for your operating system, which you can find at Management Server The Management Server manages iomemory devices on the host (or hosts) by communicating with the Agent on each host. The Management Server offers a web-based user interface for managing your iomemory devices. For information regarding using this web interface, see the iosphere Software User Guide. Install the Management Server on a server that you will use to manage all of your host iomemory devices. For optimum iomemory device performance, we recommend running iosphere on a machine that does not host iomemory devices. iosphere Software Installation Guide 4

6 Agent The Agent communicates with the iomemory VSL and the Management Server. The Agent should be installed on a host machine after the iomemory VSL is already installed. Because iosphere allows management of multiple hosts, you will install the Agent on every host machine that you wish to control using iosphere. directcache If you wish to take advantage of the added capabilities of directcache, you will need to install directcache. Go to download the latest version of directcache software and documentation. The directcache User Guide (for Windows or Linux) contains instructions on how to install directcache software. iosphere Software Installation Guide 5

7 Download Files To install the Management Server and Agent applications, go to download and install the following files: Linux fio-common*.rpm or fio-common*.deb (if not already installed) fio-msrv*.rpm or fio-msrv*.deb (iosphere's Management Server) Windows fio-agent*.rpm or fio-agent*.deb Fusion-io_Management_Server_Setup_*_x64.exe (Server and Agent) Fusion-io_Agent_Setup_*_x64.exe (Agent only) Installation and configuration procedures for Linux and Windows are described on the following pages. iosphere Software Installation Guide 6

8 Management Server Firewall Settings If you need to adjust your firewall settings to allow Agents to communicate via SSL to the Management Server, use the following: Port: 9051 TCP (TLS/SSL) Direction: Outbound (Agent), Inbound (Server) Domain: [Management Server Domain/IP] Port 9051 TCP is the port that has been assigned to Fusion-io by the Internet Assigned Numbers Authority (IANA). You can choose to modify the port in the Management Server settings (in the web user interface), but you may need to re-export the Agent access key if you do not use auto-discovery. iosphere Software Installation Guide 7

9 Management Server Installation and Configuration Follow the instructions based on your platform. Management Server - Linux Installation and Configuration Installation Install fio-common (if not already installed) All commands require administrator privileges. Log in as "root" or use sudo to run the install. fio-common is a support package that is available with the iomemory VSL (driver) installation. To see if fio-common is installed, run: rpm -qa grep -i fio-common Debian equivalent command: dpkg -l grep -i fio-common 1. To install fio-common, run the following command: sudo rpm -i fio-common*.rpm a. For Ubuntu/Debian, run this command: sudo dpkg -i fio-common*.deb If you are upgrading from fio-msrv version 1.x to 3.x, uninstall the old version before proceeding to the following steps. iosphere Software Installation Guide 8

10 Install Management Server ( fio-msrv) 1. Run the following command: sudo rpm -i fio-msrv*.rpm a. For Ubuntu/Debian, run this command: sudo dpkg -i fio-msrv*.deb 2. When installation is complete, start the server with the following command: sudo /etc/init.d/fio-msrv start fio-msrv is already configured to auto-start on boot. If you have upgraded and installed the new fio-msrv, iosphere maintains most of your data, but does not restore your saved searches or custom alerts. As a part of the upgrade process, iosphere puts the contents of those two files on disk in two different text files. If you want to keep your alerts and search rules created in a previous version, you will have to read them and re-enter them in the new GUI after the installation is complete and upon first run. These are the names of the two backed-up files: alert_rules.txt saved_searches.txt and this is the directory where you will find them: /var/lib/fio/data/data_legacy. You may use the data in the two text files to recreate your saved alert rules and saved searches in the iosphere 3.x server. If you are updating to 3.x, then you will need to associate the same Labels to the iomemory that they were previously associated with in the previous version. iosphere Software Installation Guide 9

11 Uninstalling Management Server 1. To uninstall the Management Server, run the following command: sudo rpm -e <pkg-name> a. For Ubuntu/Debian, run this command: sudo dpkg -r <pkg-name> First Time Setup Local Browser 1. On the machine where you you installed fio-msrv, open your local browser and go to 2. Set the admin password. Click Next. 3. Enter the iomemory Push Frequency (optional). Default is 15 seconds. Increasing this number will make updates less frequent (and history/report information less detailed). Decreasing this number makes updates more frequent, but could affect performance if you are using many clients (more than 20 or 30, for example). Increasing this number above 600 displays this message: "A high push frequency will potentially result in data being out of date in iosphere." 4. Enable Remote Access (optional). Unchecked by default. Check this box to allow the Agent to remotely access this server. 5. Advertise Using Zeroconf (optional). This allows Agents to automatically discover and connect to iosphere (requires Avahi on Linux or Bonjour on Windows). 6. Host Name (optional). Select or Enter the remote host name or Host IP here. 7. Port. This is set to 9051 by default; Fusion-io owns this port. You have the option of entering a different port here. 8. Use pre-configured Fusion-io certificate (optional). iosphere Software Installation Guide 10

12 iosphere includes a pre-configured SSL certificate, but it is recommended that you create and use a custom certificate. No Local Web Browser in Linux If you run fio-msrv from a command line without a local browser, you must configure these settings manually: 1. Set admin password: sudo fio-msrv -w 2. Enable remote access: sudo fio-msrv -R 3. Set the port number <num> that the service is listening to: sudo fio-msrv -P<num> 4. Enable automatic Agent authorization This will decrease security. sudo fio-msrv -A 5. To view the remote URL path run: sudo fio-msrv -u 6. Open your web browser and enter the URL You will be prompted to configure the remaining settings, as described above. Server Firewall Settings If you need to adjust your firewall settings to allow Agents to communicate via SSL to the Server, use the following: Port: 9051 TCP (TLS/SSL) Direction: Outbound (Agent), Inbound (Server) Domain: iosphere Server Domain/IP iosphere Software Installation Guide 11

13 Management Server - Windows Installation and Configuration Warning To prevent loss of data during the Windows installation, be sure to do the following BEFORE uninstalling iosphere 1.x and BEFORE installing iosphere 3.x: Before uninstalling iosphere 1.x: Backup the data folder found in C:\Windows\System32\config\systemprofile\AppData\Roaming\fio. Before installing iosphere 3.x: Return the data folder back to its original location in C:\Windows\System32\config\systemprofile\AppData\Roaming\fio. Installation Run Fusion-io_Management_Server_Setup_*_x64.exe and follow the installation wizard's on-screen instructions. If you have upgraded and installed the new fio.msrv, iosphere maintains most of your data, but does not restore your saved searches or custom alerts. As a part of the upgrade process, iosphere puts the contents of those two files on disk in two different text files. If you want to keep your alerts and search rules created in a previous version, you will have to re-enter them in the new GUI after the installation is complete and upon first run. These are the names of the two backed-up files: alert_rules.txt saved_searches.txt and this is the directory where you will find them: C:\Windows\System32\config\systemprofile\AppData\Roaming\fio\data\data_legacy. You may use the data in the two text files to recreate your saved alert rules and saved searches in the iosphere 3.x server. If you are updating to 3.x, then you will need to associate the same Labels to the iomemory that is was previously associated with in 1.x. iosphere Software Installation Guide 12

14 First Time Setup 1. Open your browser on the machine where the management server was installed and go to 2. Set the admin password. Click Next. 3. Optionally, enter the iomemory Push Frequency. Default is 15 seconds. Increasing this number will make updates less frequent (and history/report information less detailed). Decreasing this number makes updates more frequent, but could affect performance if you are using many clients (more than 20 or 30, for example). Increasing this number above 600 displays this message: "A high push frequency will potentially result in data being out of date in iosphere." 4. Enable Remote Access (optional). Allows remote access to the Management Server from Agent processes not located on the same machine as the Management Server. 5. Advertise Using Zeroconf (optional). Causes the Management Server to advertise its service using the Zeroconf service discovery protocol. This allows remote Agent services to automatically discover and communicate with the Management Server. The Zeroconf protocol requires that Avahi be installed on Linux operating systems and Bonjour be installed on Windows operating systems. 6. Host Name. Enter an IP address that will not change in an uncontrolled way (such as a DHCP lease that expires). This address is used by Agent services to communicate to the Management Server. 7. Port. By default, the port is set to 9051, which is reserved for iosphere worldwide and should not conflict with any other applications. You may opt to change the port (to 443, for example) depending on your requirements. 8. Use the pre-configured Fusion-io certificate (optional). Fusion-io provides a pre-configured certificate, but will result in "untrusted certificate" messages. It is less secure than using a certificate signed by a trusted CA that is made specifically for your server. 9. Click Save. iosphere includes a pre-configured SSL certificate, but it is recommended that you create and use a custom certificate. iosphere Software Installation Guide 13

15 Agent Installation and Configuration Follow the instructions based on your platform. Agent Linux Installation and Configuration The Agent requires the iomemory VSL (iomemory driver) to run. Make sure you have installed version or later of the driver and the libfio package before installing the Agent. All commands require administrator privileges. Log in as "root" or use sudo to run the install and start the server. Install fio-common (if not already installed) All commands require administrator privileges. Log in as "root" or use sudo to run the install. fio-common is a support package that is available with the iomemory VSL (driver) installation. To see if fio-common is installed, run: rpm -qa grep -i fio-common Debian equivalent command: dpkg -l grep -i fio-common 1. To install fio-common, run the following command: sudo rpm -i fio-common*.rpm a. For Ubuntu/Debian, run this command: sudo dpkg -i fio-common*.deb iosphere Software Installation Guide 14

16 If you are upgrading from fio-msrv version 1.x to 3.x, uninstall the old version before proceeding to the following steps. Install fio-agent 1. Run the following command: sudo rpm -i fio-agent*.rpm a. For Ubuntu/Debian, run this command: sudo dpkg -i fio-agent*.deb 2. When installation is complete, start the Agent with the following command: sudo /etc/init.d/fio-agent start The Agent is already configured to auto-start on boot. Uninstalling fio-agent 1. To uninstall the Agent, run the following command: sudo rpm -e <pkg-name> a. For Ubuntu/Debian, run this command: sudo dpkg -r <pkg-name> Configuration The Agent is configured to automatically find and connect to a Management Server (iosphere requires Avahi on Linux). To connect the agent to the server manually: 1. Using iosphere, navigate to Settings/Remote Access Key. iosphere Software Installation Guide 15

17 2. On the host machine where the Agent is running, click Download Remote Access Key and save the copy to: /var/lib/fio/agent_keys/ Once copied, the Agent should connect within 15 seconds. To disconnect the Agent from the server manually, delete the Access Key ([hostname].key) from the following location on the machine where the Agent is running: /var/lib/fio/agent_keys/[hostname].key Proxy (iosphere only) The Agent uses the Linux http_proxy and https_proxy environment variables for proxy connections. If you want the Agent to use a proxy server, consult your OS documentation on how to modify these environment variables. Agent Run Options Option Description -f, --foreground Run in foreground rather than service/daemon. --verbose --brief (default) Enable verbose (debug) logging. Disable verbose (debug) logging. -r, --runonce FMS -"Run Once" mode. Collect device data once and push to Fusion-io, then exit. -o, --outfile <path> Same as --runonce but dump to specified path instead of automatically sending to Fusion-io. -c, --cfg-path <path> Path to config file. -t, --runtime-datafiles-path <path> Path to runtime data files (if not specified, default location is used.) Help Option Description -h, --help Print the help menu then exit. -v, --version Print the program name and version then exit. iosphere Software Installation Guide 16

18 Agent Windows Installation and Configuration Installation Run Fusion-io_Agent_Setup_*_x64.exe and follow the on-screen instructions. During the installation, you will be asked if you are willing to agree to send anonymous information to Fusion-io, which is the FMS (Fusion-io Monitoring System). This option sends data to Fusion-io at a specified time each day. You can specify when the data is sent; see Agent Config Options for more information. Configuration The Agent is configured to automatically find and connect to an iosphere server (requires Bonjour on Windows). To connect the Agent to the server manually: 1. Using iosphere, navigate to go to the Settings page and click the Remote Access Key link. 2. On the host machine running the agent, click Download Remote Access Key and copy the key to: C:\Windows\System32\config\systemprofile\AppData\Roaming\fio\agent_keys Once copied, the Agent should connect within 15 seconds. To disconnect the Agent from the server manually, delete the Access Key ( hostname.key) from the following location: C:\Windows\System32\config\systemprofile\AppData\Roaming\fio\agent_keys\[hostn Proxy (iosphere only) The Agent uses the Windows http_proxy and https_proxy environment variables for proxy connections. If you want the Agent to use a proxy server, consult your OS documentation on how to modify these environment variables. Agent Config Options The following settings can be modified in Linux: /var/lib/fio/ fio-agent-cfg.xml, located at: iosphere Software Installation Guide 17

19 Windows: C:\Windows\System32\config\systemprofile\AppData\Roaming\fio\fio-agent-cfg.xml Auto-Discover Management Server <iomanager-discovery-enabled> Enabling this causes an Agent to locate a management server and to automatically connect with it. True=Enable(Default) False=Disabled Why would you disable? Multiple Management Servers - An Agent does not try to connect with any server beyond the first one it finds. You will have to manually connect an agent to multiple services. Security You must delete the XML "comment" tags (" <!-" and "->") in order for this parameter to take effect. iosphere Software Installation Guide 18

20 Fusion Powered Support We offer iodrive Customer Support by phone, and on the Web. Please use the contact form at: For the Japanese market, please use the following URL: Telephone Support For customer support phone numbers, please refer to the Fujitsu Technology Solutions service desk at For the Japanese market, please use the following URL: Web It is recommended to use the latest firmware / driver / BIOS versions on servers and components. Software packages are available for download at : > Server > Drivers & Downloads For the Japanese market, please use the following URL: Corresponding user documentation for servers and optional components can be found online at > Industry Standard Servers > Expansion Cards > PCIe SSD Cards or on the ServerView Suite Documentation DVD. For the Japanese market, please use the following URL: iosphere Software Installation Guide