Installation
      Back to home
      1. Support Portal
      2. Getting Started
      3. Installation

      Cruz Operations Center OVA Install Guide

      Installation and Initialization of the Virtual Appliance

      View the full pdf guide here: Cruz Operations Center OVA Installation Guide

      Video -How to install the Cruz Virtual Appliance (OVA) 

      VMware Linux OVA installation 

      • Quick Start Step for Installation and Initialization of the Virtual Appliance  
      1. Import the .OVA file into your ESX environment.  Make sure you allocate these minimum resources indicated below and power on the new VM.  Refer to Prerequisites
        for resource allocation beyond  the base trial deployment
        • 12Gb ram (16GB Best)
        • 6 core CPU  (8 Core best)
        • 200GB disc space
      2. Login into the VM CLI with: 

        o    username= synergy

        o    password= synergyP@$$ 

      3. Run the ./setup command.

      4. Select Option #1 for initial VM configuration and follow the prompts.  This configures the VM's static IP address and installs the 30 day trial license. 

      5. Restart the VM and wait about 15-20 minutes.

      6. Login back in and go to the ./setup menu.

      7. Run the "Check server status option” from the ./setup menu. This allows you to confirm server startup. (Servers may take ~15 first time).  3 servers will show "ready" when they are up.

      8. When ready, enter the following URL from your browser:  http://yourIP:8080 or  https://yourIP:8443

      9. A login page will appear and your VM environment should be up and running.

      10.  Sign in with the default credentials:  

        • username=admin
        • password=admin 
      • IMPORTANT: Complete the tasks on the Home page -> Getting started task.
      • If you encounter issues during VM installation or need more detailed steps, see the following sections: 

        Detail Steps to Start Virtual Appliance  

        Upgrading the VM 

        Troubleshooting VM Installation  

        Detail Steps for Installation and Initialization of the Virtual Appliance  

        This section provides detailed steps for importing/configuring and starting the Virtual Appliance. The Quick Start section 1.1 shows you how to get the appliance up and running quickly with no issues. Section 1.2 is intended for users that are experiencing issues during the quick start or if more information is needed regarding the process.  

        To configure the software application as a virtual appliance, follows these step:  

        • Understanding Prerequisites  
        • Deploying the OVA Template  
        • Starting the Virtual Machine  
        • Completing the Initial VM Host Configuration  
        • Starting the Application  
        • Getting Started Tasks (this is a post-installation setup task)  
           

        Before putting the CRUZOC Virtual Appliance into a production environment, make sure that you change the MySQL password. See Securing MySQL Passwords for detailed instructions.  

        Understanding Prerequisites  and Sizing 

        The OVA Appliance  is intended and sized to support trial/evaluation of the software for up about 100 devices. Other deployments may be supported and may require additional VM configuration. Many factors affect the VM performance. The underlying hardware resources must be able to support the desired deployment configuration. Reconfiguration may require more RAM, hard drives, faster hard drives, CPU/cores, or storage allocated to the VM. Refer to the software User Guide for sizing details. 

        If the OVA Appliance is extended to production usage there are application setting in addition to VM changes that  may be required to get the desired performance. When re-sizing the application, you may use this table as a guide when considering updates to the software parameters or the VM.  

        NOTE: If the Virtual Appliance requires reconfiguration, you may be  limited to these maximum resource settings: 

        • 64 GB memory limit  
        • 8 processor limit  
        • 10 network adapter limit  
        • 2 TB disk size limit  

        If you need resources in excess of these constraints, you will need to create your own VM by performing a package installation on your new VM. If you need to expand an existing system beyond these limits, you need to follow the database migration procedures to backup the mysql database, re-install the same software version on your target VM, and then restore the database files to the target VM.  

        Make sure that you have the following:  

        • A downloaded .ova file, the IPv4 address, network mask and gateway identified for the VM appliance  
        • The VM host has a connectivity to the target managed devices 
        • Neither Firewalls nor other restrictions block communication for ICMP, SNMP, FTP, TFTP, SCP, SSH, Telnet, HTTP, etc.  
        • SMTP and internet access are required for notification from CRUZOC by e-mail as well as for license/subscription renewal  
        • The following system requirements:  

         

        Requirement  

        Description  

        Virtual Machine  

        VM is configured with 1 processor and 6 cores. 6-8 cores are recommended for  

        Production/Non-trial environments with 500-1000 devices.  

         

        Adjust the number of cores needed based on the application performance by 

        right-clicking the imported VM and selecting a settings option for adjusting a VM’s resources.  

        CPU  

        Speed exceeds 3.0 Ghz.  

        Memory  

        Minimum 12 GB RAM allocated to the VM.  

        Disk Space  

        Minimum 105 GB allocated to the VM.  

        The software’s VM is pre-set to installation defaults and dynamically grows up to 85 GB.  

        If the VM is used beyond a trial evaluation, you may need more space depending on  

        your specific usage and needs. For example, higher data retention policies for  

        performance, TFA, audit logs, and events increase the database space needs.  

        Allocate more space by increasing the:  

        • Space allocated to the VM from the hypervisor (Hypervisor > select the VM > settings)  

        • Mysql database size 
        Refer to the software User Guide for detailed steps on how to extend the Mysql database size. Consult your VM and/or Linux administrator before adjusting the VM size.  

        The database should consist of 1 or more 10-15K RPM disk, or the equivalent solid state disk 

         for better performance.  

        • Make sure that the VMware virtual disk runs on adequately performing physical disk infrastructure.  
        • Heavy performance monitoring and TFA requires disk IO speeds that support this configuration.  
        • If you plan to use the VM beyond the initial trial configuration, consider some configuration changes to ensure proper system sizing. Refer to the software User Guide for sizing recommendations before converting the trial VM to a production usage. You may need to: 
        • Expand the storage capacity to accommodate the workload data and retention preferences. 
        • Allocate additional memory to support a production environment  

        Virtual Appliance Software  

        The software runs as a virtual appliance. It requires the following Hypervisors: 

        • VMware Workstation v8 or higher  

        • vSphere® Hypervisor (ESXi) 5.0 and higher (must meet virtual appliance, port access, and listening port requirements)  

        Ports Use  

        All necessary ports and firewall settings are pre-configured on this VM. Refer to the software User Guide for ports details.  

        Browser  

        This version supports the latest browser versions: • Chrome(V59 and above)• Safari (V10 and above)• Firefox (V54 and above)  

        • Internet Explorer (V11 and above)  

         

        Requirement  

        Description  

        Adobe  

        VM does not come with graphics capabilities to view PDF or run Flash. Remote access is required using a Web browser and therefor you will need: 

        • FlashPlayer (32-bit or 64-bit)  

        • Reader  

        Java  

        • 1.6 or later  

        Screen  

        • Screen resolution must equal or exceed 1280x1024 pixels.  Your screen must be at least 1250 pixels wide.  

        Deploying the OVA Template: 

        You can deploy the Open Virtualization Format (OVA) template with VMware workstation, VMware Player, or ESX. High Availability Deployment options are available for the software that you can deploy with or without VMs. Contact your sales representative if you are interested in these options. The trial version is not intended to support conversion to a HA platform.  

        NOTE:  If you see an error message about in-compatibility or OVF specifications, make sure that you have sufficient disk space and are using a local drive (not a share).  

        Deploy the OVA template as follows: 

        1. Deploy the OVA template from the VMware Workstation.
        2. Select File > Open menu. 
        3. Select the Ova File. 
        4. Power on the VM. 

        2  Deploy the OVA Template from the VMware Player.  

        1. Select File > Open Virtual Machine. 
        2. Right-click and then select Play Virtual machine. 

        3  Deploy the OVA Template from the vSphere/ESX server.  

        1. Start the VMware vSphere client.  The vSphere client is displayed. 
        2. Select File > Deploy OVA Template. 
        3. Select the Deploy from file option and then browse to where you copied the software OVA file.
        4. Select the  .ova file and then click the Next button. 
           

        Starting the Virtual Machine  

        After you have completed the above steps, you can start the application in the VM console.  

        NOTE:  Before you start the VM console, make sure that you make any needed VM setting modifications by right-clicking the image to get the menu of options.  

        1. Start the VM by clicking on its name and then selecting Power > Power On. 
        2. Open the VM Console.
        3. Log in with the default credentials (synergy user). 

        Username: synergy Password: synergyP@$$ 

        NOTE: The synergy user has sudo privileges. 

        Completing the Initial VM Host Configuration  

        A user setup menu script simplifies VM initialization. Complete the initial VM host configuration from the command line as follows: 

        1. Log in as the synergy user (synergy/synergyP@$$).
        2. Enter the following command:./setup
        3. Select 1) VM Configuration Menu and follow the prompts.
        4. If the setup is not successful, resolve any issues and then repeat step 3.  

        NOTE: The VM initialization is designed to detect all available ethernet interfaces. Typically this is eth0 or ens32. Make sure eth<zero> is entered when asked. ethO (oh) is not a valid Linux interface and interface configuration will not be successful. If no interfaces are listed, do not proceed and do not make up an interface name. Contact your VMware administrator.  If a customized VM configuration is required to support alternate interfaces, DNS, or other environments, contact your Linux and network administrator.  

        5.  Reboot the VM

         

        Starting the Application  

        NOTE: By default the software servers are configured to automatically start. After restarting the VM, all of the servers should come up and the application is ready soon after startup.  You can use the menu option or the corresponding status command to check.  

        1. After VM reboot, login as the synergy user
        2.  Enter ./setup and then select the Check Server Status option. 

        This continuously checks the server status until the servers start successfully. If startup is successful, the following message is displayed.  

        Application server status:---- appserver: ready 

        Web server Status:------------ synergy is running Synergy is ready  

        Database server status:------- owaredb is running  

        ===================================================  

        1.  Once the application server and web server are ready, open a browser and enter the following URL:http://hostIPAddress:8080or https: //hostIPAddress:8443 
        2.  Sign in to the application using the default credentials:   Username: admin Password: admin
        3. Set a password reminder and then click Save. The software Home page is displayed. Continue with Getting Started post-installation setup tasks. 

        The Application is Ready to Use - What’s Next? 

        The Home page contains the "Getting Started" portlet. Walkthrough each step to configure the primary features for managing and monitoring your network. 

        Application Setup Tasks  

        Once the Web portal is up you must perform some initial setup and validation tasks. 

        File server information. 

        For device backup/restore/deploy firmware capabilities, the VM comes with two pre-installed file servers. You can set your own external file server parameters for any existing server you may already have in your environment.  

        Two file servers are already configured on the Linux OS. The settings below apply the two pre-configured file servers on the Virtual Appliance. The VM_FTP_TFTP file server is dynamically used for devices that support FTP AND TFTP. The VM_FS_SCP file server supports devices that require a more secure protocol like SCP. These file servers are automatically created during the VM initialization (./setup - option 1) process when you set the IP address for the VM. The following list defines the built-in files server attributes. The file server settings are found in the application in the File Servers Portlet in the Configuration Management menu.  

        Address Leave blank. This is only required if the managed devices are using a different IP address to reference this same File server.  

        Attribute 

        Value  

        Name 

        VM_FS_FTP_TFTP or VM_FS_SCP 

        Enabled 

        Checked 

        Select File Server Type 

        FTP with optional TFTP or SCP only 

        IP address 

        Same IP set for the VM 

        Login 

        ftpuser 

        Password 

        ftpuserPaSS 

        External IP 

        Leave blank. This is only required if the managed devices are using a different IP address to reference this same File server. 

        Net Mask 

        The mask used to determine which file server to use 

        To create an entry for a new File server in Cruz Operations Center, follow these steps: 

        • Go to Setting -> Common Setup task under setting and edit the "File servers" task. 
        • Click New File Server  
        • Fill in  required data with your file server type, IP, login, password 
        • Click Test Button on the lower right to confirm the server is working 
        • Click Save, once everything works  

        This completes the file server setup for your system 

        Upgrading the VM  

        Upgrade the software (CruzOC) Virtual Appliance/VM similar to a standard Linux upgrade. Upgrade the CruzOC Virtual Appliance/VM installation from the command line as follows.  

        1. Transfer the unzipped CruzOC installation package to the VM using FTP or mount a share on the VM with access to the CruzOC install files. 
        2.  Log in as a non-root user, such as synergy. 
        3. Modify installer CruzOC_SingleInstall_Linux_9.0.x.x.bin permission to allow its execution

        For example:  

        chmod +x CruzOC_SingleInstall_Linux_9.0.0.92.bin  

        1.  Start the installer:./CruzOC_SingleInstall_Linux_9.0.0.92.bin 
        2. Accept the license agreement to start the upgrade process. A message is displayed indicating that an existing installation was detected and this will be an upgrade. Also noted are the installed features. Click Enter to continue. Otherwise, enter quit to cancel the upgrade. 
        3. Answer each prompt appropriately.
        •  If you did not backup your database before starting the update, you are given a chance to do so.  The database backup is stored in the <installPath>/backup.sql file by default.  
        • If you elect not to rebuild the database, the update still re-seeds the system settings. 
        • If you encounter port conflicts, resolve them before continuing. 
        • If you are running either MySQL or Oracle as your database on a separate server, you must also run dbpostinstall on the (primary) Application server before starting your system.  

        If your upgrade fails, see the install.log, db_setup.log or app_setup.log file in the destination directory for messages that may help fix the failure.  

         Troubleshooting VM Installation  

        In addition to the troubleshooting section in your application’s guides, you may want to try the following if the application server does not start:  

        1. Check the server status (option 5) to see if there is a license expired error. 
        2. Verify that your system has the minimum hardware requirements. If there ia not enough RAM or CPU or Disk, the servers cannot start.  The ESX host must be set to allow the VM to utilize the resource it was built with.  
        3. Contact support if your server still fails to start.  Upon reboot or system restart, by default, the Application, Web, and Database servers are configured to automatically start (autostart). If you need to stop or start a server without rebooting the VM, use the following commands: 
          1. Application server: sudo service  sudo service oware stop | start
          2. Stop or start the Synergy server (web server service):  sudo service synergy stop | start 
          3. Stop or start the database: sudo service owaredb stop | start 
        4. A slow or sluggish UI may be due to insufficient resources. Adjusting the application server RAM can help. Use the ./setup menu options to reset the web or application server memory. Follow the steps on the screen exactly as stated. Use this table as a guide to making these changes for your size deployment.
          You should NOT make these changes until you know the total resource allocation provided to the VM. For example, if the VM has 12GB allocated, you cannot set web server memory to 5GB and application server memory to 10GB. Generally, you should have 2-3GB more RAM allocated to the VM above the sum of individual server allocation.   Servers need to be stopped and restarted for memory setting to take effect

        NOTE:  The startup process takes a few minutes, and depends on the host speed. The application server needs to be fully up before the Web server can provide full client access. The Web server should be fully functional within five minutes of the Application server being up.