arno/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-16 05:18:56 +00:00
Code Issues Releases Wiki Activity

Merge branch 'remote_install_changes'

Browse Source 
Changes to remote-install to make it compatible with the latest versions of ubuntu server. Also adds an option to install the welcome dialog from gns3vm
This commit is contained in:
Xatrekak 2023-02-12 18:44:12 -05:00
commit 229168367b
2 changed files with 479 additions and 408 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
scripts/remote-install.sh
View File

@ -26,6 +26,7 @@ function help {
echo "--with-openvpn: Install OpenVPN" >&2
echo "--with-iou: Install IOU" >&2
echo "--with-i386-repository: Add the i386 repositories required by IOU if they are not already available on the system. Warning: this will replace your source.list in order to use the official Ubuntu mirror" >&2
echo "--with-welcome: Install GNS3-VM welcome.py script" >&2
echo "--without-kvm: Disable KVM, required if system do not support it (limitation in some hypervisors and cloud providers). Warning: only disable KVM if strictly necessary as this will degrade performance" >&2
echo "--unstable: Use the GNS3 unstable repository"
echo "--help: This help" >&2
@ -49,7 +50,7 @@ I386_REPO=0
DISABLE_KVM=0
UNSTABLE=0
TEMP=`getopt -o h --long with-openvpn,with-iou,with-i386-repository,without-kvm,unstable,help -n 'gns3-remote-install.sh' -- "$@"`
TEMP=`getopt -o h --long with-openvpn,with-iou,with-i386-repository,with-welcome,without-kvm,unstable,help -n 'gns3-remote-install.sh' -- "$@"`
if [ $? != 0 ]
then
help
@ -72,6 +73,10 @@ while true ; do
I386_REPO=1
shift
;;
--with-welcome)
WELCOME_SETUP=1
shift
;;
--without-kvm)
DISABLE_KVM=1
shift
@ -159,7 +164,7 @@ apt-get install -y gns3-server
log "Create user GNS3 with /opt/gns3 as home directory"
if [ ! -d "/opt/gns3/" ]
then
useradd -d /opt/gns3/ -m gns3
useradd -m -d /opt/gns3/ gns3
fi
@ -296,6 +301,37 @@ fi
log "GNS3 installed with success"
if [ $WELCOME_SETUP == 1 ]
then
NEEDRESTART_MODE=a apt-get install -y net-tools
NEEDRESTART_MODE=a apt-get install -y python3-pip
NEEDRESTART_MODE=a apt-get install -y dialog
pip install --no-input --upgrade pip
pip install --no-input pythondialog
#using a direct link to the latest commit instead of the branch alias to bypass github raw caching issues.
curl https://raw.githubusercontent.com/Xatrekak/gns3-server/62c2ca9be1d73ccbdcc076508f6d1bb32353fad0/scripts/welcome.py > /usr/local/bin/welcome.py
chmod 755 /usr/local/bin/welcome.py
chown gns3:gns3 /usr/local/bin/welcome.py
mkdir /etc/systemd/system/getty@tty1.service.d
cat <<EOFI > /etc/systemd/system/getty@tty1.service.d/override.conf
[Service]
ExecStart=
ExecStart=-/sbin/agetty -a gns3 --noclear %I \$TERM
EOFI
chmod 755 /etc/systemd/system/getty@tty1.service.d/override.conf
chown root:root /etc/systemd/system/getty@tty1.service.d/override.conf
echo "python3 /usr/local/bin/welcome.py" >> /opt/gns3/.bashrc
echo "gns3:gns3" | chpasswd
usermod --shell /bin/bash gns3
usermod -aG sudo gns3
fi
if [ $USE_VPN == 1 ]
then
log "Setup VPN"
@ -417,3 +453,12 @@ service gns3 start
log "Download http://$MY_IP_ADDR:8003/$UUID/$HOSTNAME.ovpn to setup your OpenVPN client after rebooting the server"
fi
if [ $WELCOME_SETUP == 1 ]
then
NEEDRESTART_MODE=a apt-get update
NEEDRESTART_MODE=a apt-get upgrade
python3 -c 'import sys; sys.path.append("/usr/local/bin/"); import welcome; ws = welcome.Welcome_dialog(); ws.repair_remote_install()'
cd /opt/gns3
su gns3
fi

220
scripts/welcome.py
View File

@ -27,13 +27,21 @@ from json import loads as convert
import urllib.request
from dialog import Dialog, PythonDialogBug
class Welcome_dialog:
def __init__(self):
try:
locale.setlocale(locale.LC_ALL, '')
except locale.Error:
# Not supported via SSH
pass
self.display = Dialog(dialog="dialog", autowidgetsize=True)
if self.gns3_version() is None:
self.display.set_background_title("GNS3")
else:
self.display.set_background_title("GNS3 {}".format(self.gns3_version()))
def get_ip():
def get_ip(self):
"""
Return the active IP
"""
@ -57,8 +65,17 @@ def get_ip():
return ip_addr
def repair_remote_install(self):
"""
This method is only called by remote-install.sh during setup to ensure it is setting the same IP as shown by Dialog
"""
ip_addr = self.get_ip()
subprocess.run(["sed", "-i", f"s/host = 0.0.0.0/host = {ip_addr}/", "/etc/gns3/gns3_server.conf"],capture_output=False)
subprocess.run(["service", "gns3", "stop"],capture_output=False)
subprocess.run(["service", "gns3", "start"],capture_output=False)
def get_config():
def get_config(self):
"""
Read the config
"""
@ -68,7 +85,7 @@ def get_config():
return config
def write_config(config):
def write_config(self, config):
"""
Write the config file
"""
@ -77,19 +94,19 @@ def write_config(config):
config.write(f)
def gns3_major_version():
def gns3_major_version(self):
"""
Returns the GNS3 major server version
"""
version = gns3_version()
version = self.gns3_version()
if version:
match = re.search(r"\d+.\d+", version)
return match.group(0)
return ""
def gns3_version():
def gns3_version(self):
"""
Return the GNS3 server version
"""
@ -99,38 +116,34 @@ def gns3_version():
return None
def gns3vm_version():
def gns3vm_version(self):
"""
Return the GNS3 VM version
"""
try:
with open('/home/gns3/.config/GNS3/gns3vm_version') as f:
return f.read().strip()
except FileNotFoundError:
return "Remote Install"
d = Dialog(dialog="dialog", autowidgetsize=True)
if gns3_version() is None:
d.set_background_title("GNS3")
else:
d.set_background_title("GNS3 {}".format(gns3_version()))
def mode():
if d.yesno("This feature is for testers only. You may break your GNS3 installation. Are you REALLY sure you want to continue?", yes_label="Exit (Safe option)", no_label="Continue") == d.OK:
def mode(self):
if self.display.yesno("This feature is for testers only. You may break your GNS3 installation. Are you REALLY sure you want to continue?", yes_label="Exit (Safe option)", no_label="Continue") == self.display.OK:
return
code, tag = d.menu("Select the GNS3 version",
code, tag = self.display.menu("Select the GNS3 version",
choices=[("2.1", "Stable release for this GNS3 VM (RECOMMENDED)"),
("2.1dev", "Development version for stable release"),
("2.2", "Latest stable release")])
d.clear()
self.display.clear()
if code == Dialog.OK:
os.makedirs(os.path.expanduser("~/.config/GNS3"), exist_ok=True)
with open(os.path.expanduser("~/.config/GNS3/gns3_release"), "w+") as f:
f.write(tag)
update(force=True)
self.update(force=True)
def get_release():
def get_release(self):
try:
with open(os.path.expanduser("~/.config/GNS3/gns3_release")) as f:
content = f.read()
@ -148,13 +161,13 @@ def get_release():
return "1.5"
def update(force=False):
def update(self, force=False):
if not force:
if d.yesno("PLEASE SNAPSHOT THE VM BEFORE RUNNING THE UPGRADE IN CASE OF FAILURE. The server will reboot at the end of the upgrade process. Continue?") != d.OK:
if self.display.yesno("PLEASE SNAPSHOT THE VM BEFORE RUNNING THE UPGRADE IN CASE OF FAILURE. The server will reboot at the end of the upgrade process. Continue?") != self.display.OK:
return
release = get_release()
release = self.get_release()
if release == "2.2":
if d.yesno("It is recommended to run GNS3 version 2.2 with lastest GNS3 VM based on Ubuntu 18.04 LTS, please download this VM from our website or continue at your own risk!") != d.OK:
if self.display.yesno("It is recommended to run GNS3 version 2.2 with lastest GNS3 VM based on Ubuntu 18.04 LTS, please download this VM from our website or continue at your own risk!") != self.display.OK:
return
if release.endswith("dev"):
ret = os.system("curl -Lk https://raw.githubusercontent.com/GNS3/gns3-vm/unstable/scripts/update_{}.sh > /tmp/update.sh && bash -x /tmp/update.sh".format(release))
@ -165,21 +178,21 @@ def update(force=False):
time.sleep(15)
def migrate():
def migrate(self):
"""
Migrate GNS3 VM data.
"""
code, option = d.menu("Select an option",
code, option = self.display.menu("Select an option",
choices=[("Setup", "Configure this VM to send data to another GNS3 VM"),
("Send", "Send images and projects to another GNS3 VM")])
d.clear()
self.display.clear()
if code == Dialog.OK:
(answer, destination) = d.inputbox("What is IP address or hostname of the other GNS3 VM?", init="172.16.1.128")
if answer != d.OK:
(answer, destination) = self.display.inputbox("What is IP address or hostname of the other GNS3 VM?", init="172.16.1.128")
if answer != self.display.OK:
return
if destination == get_ip():
d.msgbox("The destination cannot be the same as this VM IP address ({})".format(destination))
if destination == self.get_ip():
self.display.msgbox("The destination cannot be the same as this VM IP address ({})".format(destination))
return
if option == "Send":
# first make sure they are no files belonging to root
@ -189,9 +202,9 @@ def migrate():
ret = os.system('bash -c "{}"'.format(command))
time.sleep(10)
if ret != 0:
d.msgbox("Could not send data to the other GNS3 VM located at {}".format(destination))
self.display.msgbox("Could not send data to the other GNS3 VM located at {}".format(destination))
else:
d.msgbox("Images and projects have been successfully sent to the other GNS3 VM located at {}".format(destination))
self.display.msgbox("Images and projects have been successfully sent to the other GNS3 VM located at {}".format(destination))
elif option == "Setup":
script = """
if [ ! -f ~/.ssh/gns3-vm-key ]
@ -199,23 +212,23 @@ then
ssh-keygen -f ~/.ssh/gns3-vm-key -N '' -C gns3@{}
fi
ssh-copy-id -i ~/.ssh/gns3-vm-key gns3@{}
""".format(get_ip(), destination)
""".format(self.get_ip(), destination)
ret = os.system('bash -c "{}"'.format(script))
time.sleep(10)
if ret != 0:
d.msgbox("Error while setting up the migrate feature")
self.display.msgbox("Error while setting up the migrate feature")
else:
d.msgbox("Configuration successful, you can now send data to the GNS3 VM located at {} without password".format(destination))
self.display.msgbox("Configuration successful, you can now send data to the GNS3 VM located at {} without password".format(destination))
def shrink_disk():
def shrink_disk(self):
ret = os.system("lspci | grep -i vmware")
if ret != 0:
d.msgbox("Shrinking the disk is only supported when running inside VMware")
self.display.msgbox("Shrinking the disk is only supported when running inside VMware")
return
if d.yesno("Would you like to shrink the VM disk? The VM will reboot at the end of the process. Continue?") != d.OK:
if self.display.yesno("Would you like to shrink the VM disk? The VM will reboot at the end of the process. Continue?") != self.display.OK:
return
os.system("sudo service gns3 stop")
@ -223,50 +236,60 @@ def shrink_disk():
os.system("sudo vmware-toolbox-cmd disk shrink /opt")
os.system("sudo vmware-toolbox-cmd disk shrink /")
d.msgbox("The GNS3 VM will reboot")
self.display.msgbox("The GNS3 VM will reboot")
os.execvp("sudo", ['/usr/bin/sudo', "reboot"])
def vm_information():
def vm_information(self):
"""
Show IP, SSH settings....
"""
content = "Welcome to GNS3 appliance\n\n"
version = gns3_version()
version = self.gns3_version()
if version is None:
content += "GNS3 is not installed please install it with sudo pip3 install gns3-server. Or download a preinstalled VM.\n\n"
else:
content = "GNS3 version: {gns3_version}\nVM version: {gns3vm_version}\nKVM support available: {kvm}\n\n".format(
gns3vm_version=gns3vm_version(),
gns3vm_version=self.gns3vm_version(),
gns3_version=version,
kvm=kvm_support())
kvm=self.kvm_support())
ip = get_ip()
ip = self.get_ip()
if ip:
content += "IP: {ip}\n\nTo log in using SSH:\nssh gns3@{ip}\nPassword: gns3\n\nImages and projects are located in /opt/gns3""".format(ip=ip)
content += f"""
IP: {ip}
Web UI: http://{ip}:3080
To log in using SSH:
ssh gns3@{ip}
Password: gns3
Images and projects are located in /opt/gns3
""".strip()
else:
content += "eth0 is not configured. Please manually configure it via the Networking menu."
content += "\n\nRelease channel: " + get_release()
content += "\n\nRelease channel: " + self.get_release()
try:
d.msgbox(content)
self.display.msgbox(content)
# If it's an scp command or any bugs
except:
os.execvp("bash", ['/bin/bash'])
def check_internet_connectivity():
d.pause("Please wait...\n\n")
def check_internet_connectivity(self):
self.display.pause("Please wait...\n\n")
try:
response = urllib.request.urlopen('http://pypi.python.org/', timeout=5)
except urllib.request.URLError as err:
d.infobox("Can't connect to Internet (pypi.python.org): {}".format(str(err)))
self.display.infobox("Can't connect to Internet (pypi.python.org): {}".format(str(err)))
time.sleep(15)
return
d.infobox("Connection to Internet: OK")
self.display.infobox("Connection to Internet: OK")
time.sleep(2)
@ -277,27 +300,27 @@ def keyboard_configuration():
os.system("/usr/bin/sudo dpkg-reconfigure keyboard-configuration")
def set_security():
config = get_config()
if d.yesno("Enable server authentication?") == d.OK:
def set_security(self):
config = self.get_config()
if self.display.yesno("Enable server authentication?") == self.display.OK:
if not config.has_section("Server"):
config.add_section("Server")
config.set("Server", "auth", True)
(answer, text) = d.inputbox("Login?")
if answer != d.OK:
(answer, text) = self.display.inputbox("Login?")
if answer != self.display.OK:
return
config.set("Server", "user", text)
(answer, text) = d.passwordbox("Password?")
if answer != d.OK:
(answer, text) = self.display.passwordbox("Password?")
if answer != self.display.OK:
return
config.set("Server", "password", text)
else:
config.set("Server", "auth", False)
write_config(config)
self.write_config(config)
def log():
def log(self):
os.system("/usr/bin/sudo chmod 755 /var/log/upstart/gns3.log")
with open("/var/log/upstart/gns3.log") as f:
try:
@ -308,37 +331,37 @@ def log():
return
def edit_config():
def edit_config(self):
"""
Edit GNS3 configuration file
"""
major_version = gns3_major_version()
major_version = self.gns3_major_version()
if major_version == "2.2":
os.system("nano ~/.config/GNS3/{}/gns3_server.conf".format(major_version))
else:
os.system("nano ~/.config/GNS3/gns3_server.conf")
def edit_network():
def edit_network(self):
"""
Edit network configuration file
"""
if d.yesno("The server will reboot at the end of the process. Continue?") != d.OK:
if self.display.yesno("The server will reboot at the end of the process. Continue?") != self.display.OK:
return
os.system("sudo nano /etc/network/interfaces")
os.execvp("sudo", ['/usr/bin/sudo', "reboot"])
def edit_proxy():
def edit_proxy(self):
"""
Configure proxy settings
"""
res, http_proxy = d.inputbox(text="HTTP proxy string, for example http://<user>:<password>@<proxy>:<port>. Leave empty for no proxy.")
if res != d.OK:
res, http_proxy = self.display.inputbox(text="HTTP proxy string, for example http://<user>:<password>@<proxy>:<port>. Leave empty for no proxy.")
if res != self.display.OK:
return
res, https_proxy = d.inputbox(text="HTTPS proxy string, for example http://<user>:<password>@<proxy>:<port>. Leave empty for no proxy.")
if res != d.OK:
res, https_proxy = self.display.inputbox(text="HTTPS proxy string, for example http://<user>:<password>@<proxy>:<port>. Leave empty for no proxy.")
if res != self.display.OK:
return
with open('/tmp/00proxy', 'w+') as f:
@ -357,48 +380,45 @@ def edit_proxy():
os.system("sudo chmod 744 /etc/profile.d/proxy.sh")
os.system("sudo cp /etc/profile.d/proxy.sh /etc/default/docker")
d.msgbox("The GNS3 VM will reboot")
self.display.msgbox("The GNS3 VM will reboot")
os.execvp("sudo", ['/usr/bin/sudo', "reboot"])
def kvm_support():
def kvm_support(self):
"""
Returns true if KVM is available
"""
return subprocess.call("kvm-ok") == 0
def kvm_control():
def kvm_control(self):
"""
Check if KVM is correctly configured
"""
kvm_ok = kvm_support()
config = get_config()
kvm_ok = self.kvm_support()
config = self.get_config()
try:
if config.getboolean("Qemu", "enable_kvm") is True:
if kvm_ok is False:
if d.yesno("KVM is not available!\n\nQemu VM will crash!!\n\nThe reason could be unsupported hardware or another virtualization solution is already running.\n\nDisable KVM and get lower performances?") == d.OK:
if self.display.yesno("KVM is not available!\n\nQemu VM will crash!!\n\nThe reason could be unsupported hardware or another virtualization solution is already running.\n\nDisable KVM and get lower performances?") == self.display.OK:
config.set("Qemu", "enable_kvm", False)
write_config(config)
self.write_config(config)
os.execvp("sudo", ['/usr/bin/sudo', "reboot"])
else:
if kvm_ok is True:
if d.yesno("KVM is available on your computer.\n\nEnable KVM and get better performances?") == d.OK:
if self.display.yesno("KVM is available on your computer.\n\nEnable KVM and get better performances?") == self.display.OK:
config.set("Qemu", "enable_kvm", True)
write_config(config)
self.write_config(config)
os.execvp("sudo", ['/usr/bin/sudo', "reboot"])
except configparser.NoSectionError:
return
vm_information()
kvm_control()
def display_loop(self):
try:
while True:
code, tag = d.menu("GNS3 {}".format(gns3_version()),
code, tag = self.display.menu("GNS3 {}".format(self.gns3_version()),
choices=[("Information", "Display VM information"),
("Upgrade", "Upgrade GNS3"),
("Migrate", "Migrate data to another GNS3 VM"),
@ -415,12 +435,12 @@ try:
("Restore", "Restore the VM (if you have trouble for upgrade)"),
("Reboot", "Reboot the VM"),
("Shutdown", "Shutdown the VM")])
d.clear()
self.display.clear()
if code == Dialog.OK:
if tag == "Shell":
os.execvp("bash", ['/bin/bash'])
elif tag == "Version":
mode()
self.mode()
elif tag == "Restore":
os.execvp("sudo", ['/usr/bin/sudo', "/usr/local/bin/gns3restore"])
elif tag == "Reboot":
@ -428,26 +448,32 @@ try:
elif tag == "Shutdown":
os.execvp("sudo", ['/usr/bin/sudo', "poweroff"])
elif tag == "Upgrade":
update()
self.update()
elif tag == "Information":
vm_information()
self.vm_information()
elif tag == "Log":
log()
self.log()
elif tag == "Migrate":
migrate()
self.migrate()
elif tag == "Configure":
edit_config()
self.edit_config()
elif tag == "Networking":
edit_network()
self.edit_network()
elif tag == "Security":
set_security()
self.set_security()
elif tag == "Keyboard":
keyboard_configuration()
self.keyboard_configuration()
elif tag == "Test":
check_internet_connectivity()
self.check_internet_connectivity()
elif tag == "Proxy":
edit_proxy()
self.edit_proxy()
elif tag == "Shrink":
shrink_disk()
self.shrink_disk()
except KeyboardInterrupt:
sys.exit(0)
if __name__ == "__main__":
ws = Welcome_dialog()
ws.vm_information()
ws.kvm_control()
ws.display_loop()