From f8795fa181d06bde4d2fb03c5aeabe9b37864128 Mon Sep 17 00:00:00 2001 From: Olivier Lambert Date: Thu, 11 May 2017 15:29:27 +0200 Subject: [PATCH] feat(xoa script): add details for using new xoa helpers scripts --- docs/troubleshooting.md | 38 +++++++++++++------------------------- docs/xoa.md | 28 +++++++++++++++++++++++++--- 2 files changed, 38 insertions(+), 28 deletions(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 7d97baec8..d5ce89167 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -10,38 +10,26 @@ The solution is to use **HTTPS**. In this way, websockets will be encapsulated i ## XOA configuration -XOA is a virtual appliance running Debian and Xen Orchestra. If you have any problem, the first thing to do is to check the network configuration. - -The easiest step is to check if you can ping our servers: +XOA is a virtual appliance running Debian and Xen Orchestra. If you have any problem, the first thing to do is to use our check service by running the `xoa check` command in a terminal: ``` -$ ping xen-orchestra.com - -PING xen-orchestra.com (*******) 56(84) bytes of data. -64 bytes from xen-orchestra.com (*******): icmp_seq=1 ttl=53 time=11.0 ms -64 bytes from xen-orchestra.com (*******): icmp_seq=2 ttl=53 time=11.0 ms +$ xoa check +✔ Node version +✔ Disk space for /var +✔ Disk space for / +✔ XOA version +✔ xo-server config syntax +✔ Appliance registration +✔ Internet connectivity ``` -If you have something completely different than that, or error messages, lost packets etc., it means you have probably a network problem. Check the following sections on network and DNS configuration. +If you have something completely different than that, or error messages, lost packets etc., it means you have a problem. -### IP configuration +### Network issues -You can see your current network configuration with a `ifconfig eth0`. If you have a firewall, please check that you allow the XOA's IP. +You can see your current network configuration with a `ifconfig eth0`. If you have an external firewall, please check that you allow the XOA's IP. -You can modify the IP configuration in `/etc/network/interfaces`. - -[Follow the official Debian documentation about that]( https://wiki.debian.org/NetworkConfiguration#Configuring_the_interface_manually). - - -### DNS configuration - -The DNS servers are configured in `/etc/resolv.conf`. If you have problems with DNS resolution, please modify the IPs of those servers to fit your current network configuration. - -[Check the official Debian documentation to configure it](https://wiki.debian.org/NetworkConfiguration#The_resolv.conf_configuration_file). - -### Disk space - -You can run `df -h` to check if you don't have space disk issue. If you want to backup your VMs in XOA, [take a look here](https://xen-orchestra.com/docs/full_backups.html#add-a-disk-for-local-backups). +You can modify the IP configuration with `xoa network static` (for a static IP address) or ` xoa network dhcp` to be in DHCP. ### Memory diff --git a/docs/xoa.md b/docs/xoa.md index 630d85e85..ea5825d55 100644 --- a/docs/xoa.md +++ b/docs/xoa.md @@ -104,15 +104,37 @@ Administrator. It usually boils down to these three things: ### Network configuration -XOA is in **DHCP** by default, so if you need to configure the IP, you need to edit `/etc/network/interfaces` as explained in the [Debian documentation](https://wiki.debian.org/NetworkConfiguration#Configuring_the_interface_manually). You can access the VM console through XenCenter or using VNC through a SSH tunnel. +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`. -> If you are using a static IP configuration, take care of the `/etc/resolv.conf` file to fit your DNS settings. +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. However, if you want to deactivate it, you can type `chage -E 0 xoa-support`. To re-activate this account, you must use the `chage -E 1 xoa-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