NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
39f9911e67d3705da8a80c937b8fa9960c8e5e24
xen-orchestra/docs/xoa.md
Olivier Lambert 39f9911e67 fix(xo): fix typo
2017-05-24 16:18:45 +02:00

7.6 KiB
Raw Blame History

XOA

The fastest way to install Xen Orchestra is to use our Appliance. You can deploy it by connecting into your XenServer and execute this:

bash -c "$(curl -s http://xoa.io/deploy)"

This won't write or modify anything into your XenServer system: it will just import XOA VM in your default storage repository.

XOA is a Debian VM with:

  • Xen Orchestra already installed (nothing to do!)
  • Tested with all bundled dependencies (QA)
  • The web updater (update in one click)
  • Support (+SSH support, tooling…)
  • Secured system (sudo, firewall)

Specifications

By default, this VM is configured with:

  • 2 vCPUs
  • 2GB of RAM
  • 15GB of disk (10GB for / and 5GB for /var)

For usage on huge infrastructure (more than 500+ VMs), feel free to raise the RAM.

Deployment

The quickest way

SSH on your XenServer, and execute this:

bash -c "$(curl -s http://xoa.io/deploy)"

And follow instructions:

  • Your IP configuration will be requested: it's in DHCP by default, otherwise you can enter a fixed IP address (eg 192.168.0.10)
  • If DHCP is selected, the script will continue automatically. Otherwise, a netmask, gateway and DNS should be provided.
  • XOA will be deployed on your default storage repository. You can move it elsewhere anytime after.

The alternative

Download XOA on xen-orchestra.com. Once you've got the XVA file, you can import it with xe vm-import filename=xoa_unified.xva or via XenCenter.

After the VM is imported, you just need to start it with a xe vm-start vm="XOA Unified" or with XenCenter.

Registration

The first thing you need to do with your XOA, is to register. Read the documentation page dedicated to the updater/register inferface.

First console connection

If you connect in SSH or via console, the default credentials are:

  • user: xoa
  • password: xoa

During your first connection, the system will ask to:

  • enter again the current password (xoa)
  • enter your new password
  • retype your new password

When it's done, you'll be disconnected, so reconnect again with your new password.

Here is an example when you connect in SSH for the first time:

$ ssh xoa@192.168.100.146
Warning: Permanently added '192.168.100.146' (ECDSA) to the list of known hosts.
xoa@192.168.100.146's password:
You are required to change your password immediately (root enforced)
 __   __             ____           _               _
 \ \ / /            / __ \         | |             | |
  \ V / ___ _ __   | |  | |_ __ ___| |__   ___  ___| |_ _ __ __ _
   > < / _ \ '_ \  | |  | | '__/ __| '_ \ / _ \/ __| __| '__/ _` |
  / . \  __/ | | | | |__| | | | (__| | | |  __/\__ \ |_| | | (_| |
 /_/ \_\___|_| |_|  \____/|_|  \___|_| |_|\___||___/\__|_|  \__,_|

Welcome to XOA Unified Edition, with Pro Support.

* Restart XO: sudo systemctl restart xo-server.service
* Display logs: sudo systemctl status xo-server.service
* Register your XOA: sudo xoa-updater --register
* Update your XOA: sudo xoa-updater --upgrade

OFFICIAL XOA DOCUMENTATION HERE: https://xen-orchestra.com/docs/xoa.html

Support available at https://xen-orchestra.com/#!/member/support

Build number: 16.10.24

Based on Debian GNU/Linux 8 (Stable) 64bits in PVHVM mode

WARNING: Your password has expired.
You must change your password now and login again!
Changing password for xoa.
(current) UNIX password:
Enter new UNIX password:
Retype new UNIX password:
passwd: password updated successfully
Connection to 192.168.100.146 closed.
$

Using sudo

To avoid typing sudo for any admin command, you can have a root shell with sudo -s:

[05:24 27] xoa@xoa:~$ sudo -s

We trust you have received the usual lecture from the local System
Administrator. It usually boils down to these three things:

    #1) Respect the privacy of others.
    #2) Think before you type.
    #3) With great power comes great responsibility.

[sudo] password for xoa:
[05:24 27] xoa:xoa$

Network configuration

XOA is in DHCP by default, so if you need to configure the IP, please run the command xoa network static. It will ask you network details:

$ xoa network static
? Static IP for this machine 192.168.100.120
? Network mask (eg 255.255.255.0) 255.255.255.0
? Gateway 192.168.100.254
? IP of the DNS server 192.168.100.254

Xen Orchestra is now accessible in your browser on https://your-vm-ip.

You can access the VM console through XenCenter or using VNC through a SSH tunnel.

If you want to go back in DHCP, just use xoa network dhcp

SSH Pro Support

By default, if you need support, there is a dedicated user named xoa-support. We are the only one with the private key. If you want our assistance on your XOA, you can open a private tunnel:

$ xoa support tunnel
The support tunnel has been created.

Do not stop this command before the intervention is over!
Give this id to the support: 40713

Give us this number, we'll be able to access your XOA in a secure manner. Then, close the tunnel with Ctrl+C after the support fixed your issue.

If you want to deactivate this bundled user, you can type chage -E 0 xoa-support. To re-activate this account, you must use the chage -E 1 xoa-support.

Firewall

By default, XOA is firewalled, with only ports 22, 80 and 443 opened. You can see the current status of the firewall using sudo ufw status verbose command:

Status: active
Logging: on (low)
Default: deny (incoming), allow (outgoing)
New profiles: skip

To                         Action      From
--                         ------      ----
22                         ALLOW IN    Anywhere
80                         ALLOW IN    Anywhere
443                        ALLOW IN    Anywhere
22/tcp                     LIMIT IN    Anywhere
22                         ALLOW IN    Anywhere (v6)
80                         ALLOW IN    Anywhere (v6)
443                        ALLOW IN    Anywhere (v6)
22/tcp                     LIMIT IN    Anywhere (v6)

If you want to open or close ports, please check the documentation of UFW.

Default XO admin account

Default user is admin@admin.net with admin as a password.

SECURITY NOTICE: create a new admin account and remove this one.

In any case, if you lose your password, you can reset the database and get the default credentials back.

Timezone

You can verify if your time is correctly set with the date command. To set XOA to your current timezone, use sudo dpkg-reconfigure tzdata.

Restart the service

You can restart Xen Orchestra by going in XOA on SSH (or console) and type systemctl restart xo-server.service.

To check the status of xo-server, use systemctl status xo-server.service, it should display something like that:

xo-server.service - XO Server
   Loaded: loaded (/etc/systemd/system/xo-server.service; enabled)
   Active: active (running) since Thu 2014-08-14 10:59:46 BST; 21min ago
 Main PID: 394 (node)
   CGroup: /system.slice/xo-server.service
           └─394 node /usr/local/bin/xo-server

Aug 14 10:59:46 xoa systemd[1]: Starting XO Server...
Aug 14 10:59:46 xoa systemd[1]: Started XO Server.
Aug 14 10:59:48 xoa xo-server[394]: WebServer listening on http://0.0.0.0:80

Migrate from an older XOA

If you still use the first XOA (which is not the "unified" version), you could migrate easily all your settings (ACLs, users, server, etc.) to the new one painlessly.

To do that, go into "Settings/Config" of your old XOA. Export the configuration: you'll download a config.json file.

Now, go to your new unified XOA, "Settings/Config" and import the config.json file you downloaded previously, by doing a drag and drop:

That's it!