Merge 53a0132680 into 47bd62ec0a

URL update to current documentation

README.md

@@ -1,39 +1,51 @@
 # Xen-Orchestra (Community Edition) Installer
 
-Xen-Orchestra (Community Edition) allows you to administer Citrix XenServer and XCP-ng as well as backup any VM's running on these systems. 
+Xen-Orchestra (Community Edition) allows you to administer Citrix Hypervisor (aka XenServer) and XCP-ng as well as backup any VM's running on these systems. The single line installation script allows you to go from a bare-minimal installation of [Ubuntu](https://ubuntu.com/download/server) or [Debian (Server)](https://www.debian.org/distrib/netinst) to fully operational XOCE server.
 
-The single line installation script allows you to go from a bare-minimal installation of [Ubuntu](https://ubuntu.com/download/server) or [Debian (Server)](https://www.debian.org/distrib/netinst) to fully operational XOCE server. Run the following steps from a root shell.
+## System Minimum Requirements for installation
 
-    curl https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xo_install.sh | sudo bash
+* 1 vCPU
-    <password>
+* 3 GiB RAM
+* 10 GiB disk space
+
+## System recommendations for operation
+
+* 2 vCPU recommended 
+* 3 GiB of RAM (for environments containing 500+ VMs increase the amount RAM)
+* 20 GiB disk space (for system updates)
+
+## Assumptions
+
+* We assume you have a Virtual or physical server running a currently supported Ubuntu or Debian server installation with internet connectivity
+* You've read this community and understand what installation entails and does on your soon to be XOCE server
+
+## Installation
+ 
+Run the following steps from a root shell on your **Ubuntu or Debian** host.
+
+	sudo bash
+	bash -c "$(curl https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xo_install.sh)"
     
 The default username and password are applied, admin@admin.net and admin for the password
-    
+
 If you don't want NFS capabilities run ```sudo apt-get remove nfs-common```.
 
 * Do not use LAMP
 * SSH Access is optional, but highly recommended
 
-# Declaration
+## Updates
 
-This script automates the manual process which can be [found here](https://xen-orchestra.com/docs/from_the_sources.html) as well as removes a few feature restrictions that otherwise would need to be changed manually if following the manual installation process. This script is not officially supported by the Vates team, but is supported by this community. 
+To maintain your installation from Source or from this repo. (either prepackaged or scripted installation) we recommend using the update script which this community maintains. This can be [found here](https://github.com/Jarli01/xenorchestra_updater) and doesn't require you to download or install a separate package to your XOCE installation. Simply run it via shell session of your XOCE host.
 
-# Prepacked Installation option
+# Declarations
 
-To download and deploy a prepacked Ubuntu 20.04 installation of Xen Orchestra (CE) run the below from an SSH session on your XCP-NG/Citrix Hypervisor (XenServer) host(s)
+This script automates the manual process which can be [found here](https://docs.xen-orchestra.com/installation) as well as removes a few feature restrictions that otherwise would need to be changed manually if following the manual installation process. This script is not officially supported by the Vates team, but is supported by this community. 
-
-    bash -c "$(curl -s https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xoce)"
-
-SHA256 Checksum "0ae7e283518f9b12b9a3756c58fbf357aea852df062be842adbb45eb1e42dcec"
-
-For verification of SHA256 checksum the XVA file can be downloaded directly and verified/imported. 
-XVA Direct Download https://srv-file19.gofile.io/download/Kt6nJu/20200722T183158Z%20-%20XOCE.xva
 
 # Self-signed SSL 
 
-If you are running this internally and need SSL (recommended) follow the below steps to create a self-signed SSL key and certificate; while browsers will still say the connection is unsecured, this is because the certificate isn't from a public authority and is on your LAN. Alternatively a reverse proxy can be used for public facing installations.  
+If you are running this internally and need SSL (recommended) follow the below steps to create a self-signed SSL key and certificate; while browsers will still say the connection is unsecured, this is because the certificate isn't from a public authority and is on your LAN. You can add this cert to your systems root authority if it want to to remove the warning. Alternatively a reverse proxy can be used for public facing installations.  
 
-## Generate your key and cert
+## Generate your key and cert from your XOCE installation
 
     sudo openssl req -x509 -nodes -days 3650 -newkey rsa:4096 -keyout /etc/ssl/private/key.pem -out /etc/ssl/certs/certificate.pem
     

ansible/xoa-role/defaults/main.yml

@@ -0,0 +1,15 @@
+# defaults file
+# The default username and password are applied,  and admin for the password
+xoa_install_url: https://raw.githubusercontent.com/Jarli01/xenorchestra_installer/master/xo_install.sh
+xoa_install_script: xo_install.sh
+xoa_update_url: https://raw.githubusercontent.com/Jarli01/xenorchestra_updater/master/xo-update.sh
+xoa_update_script: xo_update.sh
+git_email: ""
+git_user: ""
+xoa_default_user: "admin@admin.net"
+xoa_default_password: "admin"
+xoa_user: xoa
+xoa_password: xoa
+xcpng_servers: [{"label": "localhost", "ip": "127.0.1"}]
+xcpng_user: root
+xcpng_password: xcpng

ansible/xoa-role/handlers/main.yml

@@ -0,0 +1,22 @@
+- name: reload_systemd
+  shell: systemctl daemon-reload
+  args:
+    warn: no
+
+- name: cleaning_packages_metadata
+  shell: yum clean all && rm -rf /var/cache/yum
+  when: ansible_distribution == 'Red Hat Enterprise Linux' or ansible_distribution == 'XCP-ng'
+  args:
+    warn: no
+
+- name: cleaning_packages_metadata
+  shell: zypper clean && rm -rf /var/cache/zypp
+  when: ansible_distribution == 'openSUSE Leap'
+  args:
+    warn: no
+
+- name: cleaning_packages_metadata
+  shell: apt clean
+  when: ansible_distribution == 'Debian'
+  args:
+    warn: no

ansible/xoa-role/meta/main.yml

@@ -0,0 +1,57 @@
+galaxy_info:
+  author: your name
+  description: your description
+  company: your company (optional)
+
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: http://example.com/issue/tracker
+
+  # Some suggested licenses:
+  # - BSD (default)
+  # - MIT
+  # - GPLv2
+  # - GPLv3
+  # - Apache
+  # - CC-BY
+  license: license (GPLv2, CC-BY, etc)
+
+  min_ansible_version: 1.2
+
+  # If this a Container Enabled role, provide the minimum Ansible Container version.
+  # min_ansible_container_version:
+
+  # Optionally specify the branch Galaxy will use when accessing the GitHub
+  # repo for this role. During role install, if no tags are available,
+  # Galaxy will use this branch. During import Galaxy will access files on
+  # this branch. If Travis integration is configured, only notifications for this
+  # branch will be accepted. Otherwise, in all cases, the repo's default branch
+  # (usually master) will be used.
+  #github_branch:
+
+  #
+  # platforms is a list of platforms, and each platform has a name and a list of versions.
+  #
+  # platforms:
+  # - name: Fedora
+  #   versions:
+  #   - all
+  #   - 25
+  # - name: SomePlatform
+  #   versions:
+  #   - all
+  #   - 1.0
+  #   - 7
+  #   - 99.99
+
+  galaxy_tags: []
+    # List tags for your role here, one per line. A tag is a keyword that describes
+    # and categorizes the role. Users find roles by searching for tags. Be sure to
+    # remove the '[]' above, if you add tags to this list.
+    #
+    # NOTE: A tag is limited to a single word comprised of alphanumeric characters.
+    #       Maximum 20 tags per role.
+
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.

ansible/xoa-role/tasks/main.yml

@@ -0,0 +1,250 @@
+- name: Updating packages
+  shell: apt-get update -y && apt-get upgrade -y
+  when: ansible_distribution == 'Debian'
+  ignore_errors: True
+  args:
+    warn: no
+  notify: cleaning_packages_metadata
+  tags:
+  - install
+  - update
+
+- name: Installing packages
+  package: name={{item}} state=present
+  when: ansible_distribution == 'Debian'
+  with_items:
+  - curl
+  - git
+  notify: cleaning_packages_metadata
+  tags:
+  - install
+  - update
+
+- name: Check if xoa is already installed
+  stat:
+    path: /opt/xen-orchestra
+  register: xen_orchestra_directory
+  tags:
+  - install
+  - update
+
+- name: Ensure group xoa exists
+  ansible.builtin.group:
+    name: xoa
+    state: present
+  tags:
+  - install
+  - update
+
+- name: Check if xoa is already registered in sudoers.d
+  stat:
+    path: /etc/sudoers.d/xoa
+  register: xoa_sudoers_file
+  tags:
+  - install
+  - update
+
+- name: Add the xoa user
+  ansible.builtin.user:
+    name: xoa
+    shell: /bin/bash
+    home: /home/xoa
+    comment: xen-orchestra user
+    uid: 1040
+    groups: xoa,users
+    append: yes
+  when: not xoa_sudoers_file.stat.exists
+  tags:
+  - install
+  - update
+
+- name: Register xoa in sudoers.d
+  ansible.builtin.file:
+    path: /etc/sudoers.d/xoa
+    owner: root
+    group: root
+    mode: '0640'
+  when: not xoa_sudoers_file.stat.exists
+  tags:
+  - install
+  - update
+
+- name: Allow xoa to have passwordless sudo
+  lineinfile:
+    dest: /etc/sudoers.d/xoa
+    state: present
+    regexp: '^%xoa'
+    line: '%xoa ALL=(ALL) NOPASSWD: ALL'
+  tags:
+  - install
+  - update
+
+- name: Setting git user email
+  git_config:
+    name: user.email
+    scope: global
+    value: "{{git_email}}"
+  tags:
+  - install
+  - update
+
+- name: Setting git user
+  git_config:
+    name: user.name
+    scope: global
+    value: "{{git_user}}"
+  tags:
+  - install
+  - update
+
+- name: Download installation script
+  ansible.builtin.get_url:
+    url: "{{xoa_install_url}}"
+    dest: "/tmp/{{xoa_install_script}}"
+    mode: '0770'
+  when: not xen_orchestra_directory.stat.exists
+  tags:
+  - install
+  - update
+
+- name: Download update script
+  ansible.builtin.get_url:
+    url: "{{xoa_update_url}}"
+    dest: "/home/xoa/{{xoa_update_script}}"
+    mode: '0770'
+  tags:
+  - install
+  - update
+
+- name: Create symbolic link to
+  file:
+    src: "/home/xoa/{{xoa_update_script}}"
+    dest: "/etc/cron.weekly/{{xoa_update_script}}"
+    state: link
+  tags:
+  - install
+  - update
+
+- name: Removing existing data structures
+  shell: "rm -R /var/lib/xo-server"
+  ignore_errors: False
+  args:
+    warn: no
+  when: not xen_orchestra_directory.stat.exists
+  tags:
+  - install
+
+- name: Removing existing data structures
+  shell: "rm -R /var/lib/xo-updater"
+  ignore_errors: False
+  args:
+    warn: no
+  when: not xen_orchestra_directory.stat.exists
+  tags:
+  - install
+
+- name: Removing existing redis data
+  shell: "redis-cli -n 0 FLUSHALL"
+  ignore_errors: False
+  args:
+    warn: no
+  when: not xen_orchestra_directory.stat.exists
+  tags:
+  - install
+
+- name: Installing
+  shell: "/tmp/{{xoa_install_script}}"
+  ignore_errors: False
+  args:
+    warn: no
+  when: not xen_orchestra_directory.stat.exists
+  tags:
+  - install
+  - update
+
+- name: Updating
+  shell: "/home/xoa/{{xoa_update_script}} -n stable"
+  ignore_errors: False
+  args:
+    warn: no
+  when: xen_orchestra_directory.stat.exists
+  tags:
+  - install
+  - update
+
+- name: Installing xo-cli
+  shell: "npm install -g xo-cli"
+  ignore_errors: False
+  args:
+    warn: no
+  tags:
+  - add-servers
+  - install
+  - update
+
+- name: Closing existing session using xo-cli
+  shell: "xo-cli --unregister"
+  ignore_errors: True
+  args:
+    warn: no
+  tags:
+  - add-servers
+  - install
+  - update
+
+- name: Opening session using xo-cli
+  shell: "xo-cli --register --au http://127.0.0.1 {{xoa_default_user}} {{xoa_default_password}}"
+  ignore_errors: False
+  args:
+    warn: no
+  tags:
+  - install
+
+- name: Adding user session using xo-cli
+  shell: "xo-cli user.create email='{{xoa_user}}' password='{{xoa_password}}' permission='admin'"
+  ignore_errors: False
+  args:
+    warn: no
+  tags:
+  - install
+
+- name: Closing existing session using xo-cli
+  shell: "xo-cli --unregister"
+  ignore_errors: True
+  args:
+    warn: no
+  tags:
+  - add-servers
+  - install
+  - update
+
+- name: Opening session using xo-cli
+  shell: "xo-cli --register --au http://127.0.0.1 {{xoa_user}} {{xoa_password}}"
+  ignore_errors: False
+  args:
+    warn: no
+  tags:
+  - add-servers
+  - install
+  - update
+
+- name: Adding xcp-ng servers using xo-cli
+  shell: "xo-cli server.add label='{{item.label}}' host='{{item.ip}}' username={{xcpng_user}} password='{{xcpng_password}}' autoConnect=true allowUnauthorized=true"
+  ignore_errors: False
+  with_items: "{{xcpng_servers}}"
+  args:
+    warn: no
+  tags:
+  - add-servers
+  - install
+  - update
+
+- name: Closing session using xo-cli
+  shell: "xo-cli --unregister"
+  ignore_errors: False
+  args:
+    warn: no
+  tags:
+  - add-servers
+  - install
+  - update

ansible/xoa-role/tests/inventory

@@ -0,0 +1,2 @@
+localhost
+

ansible/xoa-role/tests/test.yml

@@ -0,0 +1,4 @@
+- hosts: localhost
+  remote_user: root
+  roles:
+  - xoa

ansible/xoa-role/vars/main.yml

@@ -0,0 +1,2 @@
+---
+# vars file

xo_install.sh

@@ -5,7 +5,7 @@
 
 # Check for required memory
 totalk=$(awk '/^MemTotal:/{print $2}' /proc/meminfo)
-if [ "$totalk" -lt "3000000" ]; then echo "XOCE Requires at least 3GB Memory!"; exit 1; fi 
+if [ "$totalk" -lt "2000000" ]; then echo "XOCE Requires at least 2GB Memory!"; exit 1; fi 
 
 distro=$(/usr/bin/lsb_release -is)
 if [ "$distro" = "Ubuntu" ]; then /usr/bin/add-apt-repository multiverse; fi
@@ -13,7 +13,7 @@ if [ "$distro" = "Ubuntu" ]; then /usr/bin/add-apt-repository multiverse; fi
 xo_branch="master"
 xo_server="https://github.com/vatesfr/xen-orchestra"
 n_repo="https://raw.githubusercontent.com/tj/n/master/bin/n"
-yarn_repo="deb https://dl.yarnpkg.com/debian/ stable main"
+yarn_repo="deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main"
 yarn_gpg="https://dl.yarnpkg.com/debian/pubkey.gpg"
 n_location="/usr/local/bin/n"
 xo_server_dir="/opt/xen-orchestra"
@@ -27,7 +27,7 @@ xo_service="xo-server.service"
 #Install yarn
 cd /opt
 
-/usr/bin/curl -sS $yarn_gpg | apt-key add -
+/usr/bin/curl -sSL $yarn_gpg | gpg --dearmor | tee /usr/share/keyrings/yarnkey.gpg >/dev/null
 echo "$yarn_repo" | tee /etc/apt/sources.list.d/yarn.list
 /usr/bin/apt-get update
 /usr/bin/apt-get install --yes yarn
@@ -43,7 +43,7 @@ n lts
 ln -s /usr/bin/node /usr/local/bin/node
 
 # Install XO dependencies
-/usr/bin/apt-get install --yes build-essential redis-server libpng-dev git python2-minimal libvhdi-utils nfs-common lvm2 cifs-utils
+/usr/bin/apt-get install --yes build-essential redis-server libpng-dev git python3-minimal libvhdi-utils nfs-common lvm2 cifs-utils
 
 /usr/bin/git clone -b $xo_branch $xo_server
 
@@ -71,7 +71,9 @@ for source in $(ls -d /opt/xen-orchestra/packages/xo-server-*); do
     fi
 done
 
-if [[ ! -e $systemd_service_dir/$xo_service ]] ; then
+if [[ -e $systemd_service_dir/$xo_service ]] ; then
+  rm $systemd_service_dir/$xo_service
+fi
 
 /bin/cat << EOF >> $systemd_service_dir/$xo_service
 # Systemd service for XO-Server.
@@ -82,14 +84,15 @@ After=network-online.target
 
 [Service]
 WorkingDirectory=/opt/xen-orchestra/packages/xo-server/
-ExecStart=/usr/local/bin/node ./bin/xo-server
+ExecStart=/usr/local/bin/node ./dist/cli.mjs
+
 Restart=always
 SyslogIdentifier=xo-server
 
 [Install]
 WantedBy=multi-user.target
 EOF
-fi
+
 
 /bin/systemctl daemon-reload
 /bin/systemctl enable $xo_service

xoce-import.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-XOCE_URL=https://srv-file19.gofile.io/download/Kt6nJu/20200722T183158Z%20-%20XOCE.xva
+XOCE_URL=https://nc.nl.tab.digital/s/WQmCwmH4e9EdTTA/download
 
 # Welcome message
 printf "\n\033[1mWelcome to the XOCE auto-deploy script!\033[0m\n\n"
@@ -10,7 +10,7 @@ then
   echo
   echo 'Sorry, the xe command is required for this auto-deploy.'
   echo
-  echo 'Please, make sure you are on a XenServer host.'
+  echo 'Please, make sure you are on a XCP-ng/XenServer host.'
   echo
   exit 1
 fi
@@ -18,8 +18,8 @@ fi
 # Basic check: are we on a XS host?
 if grep -Fxq "XenServer" /etc/issue
 then
-  printf "\nSorry, it seems you are not on a XenServer (XCP-ng) host.\n\n"
+  printf "\nSorry, it seems you are not on a XCP-ng/XenServer host.\n\n"
-  printf "\n\033[1mThis script is meant to be deployed on XenServer (or XCP-ng) only.\033[0m\n\n"
+  printf "\n\033[1mThis script is meant to be deployed on XCP-ng or XenServer only.\033[0m\n\n"
   exit 1
 fi
 
@@ -36,7 +36,7 @@ then
   read -p "dns? [8.8.8.8] " dns
   dns=${dns:-8.8.8.8}
 else
-  printf "\nYour XOCE will be started using DHCP\n\n"
+  printf "\nYour XOCE installation will be started using DHCP\n\n"
 fi
 
 # Downloading and importing the VM
@@ -56,7 +56,7 @@ fi
 import=$?
 if [ $import -ne 0 ]
 then
-  printf "\n\nAuto deploy failed. Please contact us on xen-orchestra.com live chat for assistance.\nError:\n\n %s\n\n" "$uuid"
+  printf "\n\nAuto deploy failed. Please contact us on https://github.com/Jarli01/xenorchestra_installer/issues for assistance.\nError:\n\n %s\n\n" "$uuid"
   exit 0
 fi
 
@@ -75,7 +75,7 @@ sleep 2
 
 # Waiting for the VM IP from Xen tools for 60 secs
 
-printf "Waiting for your XOCE to be ready…\n"
+printf "Waiting for XOCE to be ready…\n"
 url=$(xe vm-param-get uuid=$uuid param-name=networks param-key=0/ip 2> /dev/null)
 wait=0
 limit=60
@@ -95,7 +95,7 @@ done
 
 if [ "$ip" != 'dhcp' ]
 then
-  printf "\n\033[1mYour XOCE is ready on https://%s/\033[0m\n" "$ip"
+  printf "\n\033[1mYour XOCE is ready at https://%s/\033[0m\n" "$ip"
   # clean the xenstore data
   xe vm-param-remove param-name=xenstore-data param-key=vm-data/dns param-key=vm-data/ip param-key=vm-data/netmask param-key=vm-data/gateway uuid=$uuid
 
@@ -105,7 +105,7 @@ elif [ -z "$url" ]
 then
   printf "\n\033[1mYour XOCE booted but we couldn't fetch its IP address\033[0m\n"
 else
-  printf "\n\033[1mYour XOCE is ready on https://%s/\033[0m\n" "$url"
+  printf "\n\033[1mYour XOCE is ready at https://%s/\033[0m\n" "$url"
 fi
 printf "\nDefault UI credentials: admin@admin.net/admin\nDefault console credentials: xoce/xoce\n"
 printf "\nVM UUID: %s\n\n" "$uuid"