VMmanager 6: Administrator guide

Installation

ISPSystem

To install VMmanager, you need license information. If you purchased VMmanager from ISPsystem, you can view this information in your personal account at eu.ispsystem.com in the "Platforms" section. To install, you need a value from the Token field.

Note

SELinux will be disabled during the installation as it prevents the platform from working correctly.

Installation steps


  1. Connect to the server via SSH with the superuser permissions (root per default). 
  2. Download the installation script: 

    curl -O https://download.ispsystem.com/6/installer/vm/vm
  3. Make it executable:

    chmod +x vm
  4. Run the installation process using the activation key (license token):

    ./vm install -l="<token>"

    Where:

    • <token> —  the value of the Token parameter of your license. You can find it in the Client area eu.ispsystem.com on the license information page.

      Optional command parameters:

      • -s — platform release version. The default value is stable. Possible values:
        • stable — stable software version;
        • regular — regular software version that includes all functionality updates;

          Example command
          ./vm install -l="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -s=regular

          Note

          The stable version can only be upgraded to the latest stable version; the regular version can only be upgraded to the latest regular version.

      • -n — domain name of the server. Will be used in the platform URL; 

        Example command
        ./vm install -l="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -n="vmmanager.example.com"
      • --registry-port — TCP port for downloading docker container images. Use this option if the server denies incoming connections on ports 5000/tcp and 443/tcp; 

        Example command
        ./vm install -l="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" --registry-port=5001
      • -f — installation on a server with specifications below the required ones;

      • --ssl-crt-file, --ssl-key-file  — path to the files with the public and private key of the SSL certificate. The data will be added to the web server settings; 

        Example command
        ./vm install -l="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" --ssl-crt-file="/root/example.crt" --ssl-key-file="/root/example.key"
      • --proxy — HTTP proxy settings in the format http://<user>:<password>@<address>:<port>:
        • <user> — username for authorization. Optional parameter ;
        • <password> — password for authorization. Optional parameter ;
        • <address> — HTTP proxy IP address;
        • <port> — HTTP proxy port.

          Example command for a proxy with authorization
          ./vm install -l="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" --proxy="http://admin:pass123@192.168.57.1:3128"
          Example command for a proxy without authorization
          ./vm install -l="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" --proxy="http://192.168.57.1:3128"
  5. The installer will check the server against the minimum system requirements. If the server does not meet the requirements, a warning of the form will appear in the terminal window:  

    Example of the warning
    Checking available resources of the machine ... fail
    Resources of the machine don't match with minimal requirements
    
      RESOURCE  | MACHINE  | REQUIRED  
    ------------+----------+-----------
      CPU Speed | 3.60 GHz |  2 GHz    
      CPU Cores |    1     |    2      
      RAM       | 0.47 Gb  |   2 Gb    
      Storage   | 6.94 Gb  |  40 Gb

    To install the platform on a server with specifications below the required ones, add the -f parameter to the installation command:

    Example command
    ./vm install -l="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -f
  6. After the platform is installed successfully, in the terminal you will see the access link to VMmanager: 

    The panel has been successfully installed
    Link to administrator registration page: https://1.2.3.4/auth/setup?token=C50A0BFA55DEDE3343AABE713022A15F

    Note

    When you open a link, your browser will display a warning about a possible security threat. This happens if the server uses a self-signed SSL certificate. You can connect a valid SSL certificate to the platform by following the instructions.

  7. Go to the VMmanager interface using the received link and create the first user:
    1. Enter the User email.
    2. Create a Password or click generate to automatically generate a password.
    3. Click Done.
  8. Perform the initial setup of the platform.
  9. If you have a resource package certificate, activate it:
    1. Go to System information Activate package .
    2. Enter the code from your resource package certificate.

    3. Press Activate.

      For more information about resource packs, see the Licensing article.

After installation, VMmanager platform will be available by the IP address or domain name of your server. The installer will be started as the systemd service.

Note

To increase the fault tolerance of the platform, you can move it to the HA cluster. For more information, see the article Migrating a server with VMmanager to a VM in an HA cluster

Reinstalling the platform


  1. Create a new Token value for your license. You can do it in your client area at eu.ispsystem.com or contact technical support.
  2. Stop the platform:

    vm down
  3. Delete the directory /opt/ispsystem/vm :

    rm /opt/ispsystem/vm -rf
  4. Restart the vm service:

    systemctl restart vm
  5. Install the platform:

    vm install -l="<new_token>"

    Comments to the command:

    • <new_token> — new value of the Token parameter for your license.


When VMmanager is installed on the server, but the first user is not created, you can get the unique link to the web-interface: 

  1. Connect through SSH to the server with VMmanager. 
  2. Execute the installation command through the systemd service vm: 

    vm install -l="<token>"

    Where:

    • <token> —  the value of the Token parameter of your license. You can find it in the Client area eu.ispsystem.com on the license information page.
  3. Log in to the interface using the link and specify the credentials of the first user.

Logs


The VMmanager installation log is kept in the file /opt/ispsystem/vm/install.log.

Thank you for your feedback!
Was the article useful?
Tell us why not:

it does not match the title

it was hard to understand

I didn't find the answer

recommendations from the article did not help

other

Tell us what you didn't like in the article: