{"id":30612642,"url":"https://github.com/evolvedbinary/xml-developer-vm-setup","last_synced_at":"2025-10-31T10:11:55.154Z","repository":{"id":219834105,"uuid":"750052455","full_name":"evolvedbinary/xml-developer-vm-setup","owner":"evolvedbinary","description":"VM Setup for XML Developer","archived":false,"fork":false,"pushed_at":"2024-02-26T01:24:56.000Z","size":34,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-24T12:23:48.365Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Puppet","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/evolvedbinary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-01-29T22:24:34.000Z","updated_at":"2024-04-24T12:23:48.365Z","dependencies_parsed_at":"2024-02-25T23:25:21.483Z","dependency_job_id":null,"html_url":"https://github.com/evolvedbinary/xml-developer-vm-setup","commit_stats":null,"previous_names":["evolvedbinary/xml-developer-vm-setup"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/evolvedbinary/xml-developer-vm-setup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evolvedbinary%2Fxml-developer-vm-setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evolvedbinary%2Fxml-developer-vm-setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evolvedbinary%2Fxml-developer-vm-setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evolvedbinary%2Fxml-developer-vm-setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evolvedbinary","download_url":"https://codeload.github.com/evolvedbinary/xml-developer-vm-setup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evolvedbinary%2Fxml-developer-vm-setup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272808936,"owners_count":24996603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-30T05:34:46.447Z","updated_at":"2025-10-31T10:11:55.131Z","avatar_url":"https://github.com/evolvedbinary.png","language":"Puppet","funding_links":[],"categories":[],"sub_categories":[],"readme":"# The Complete XML Developer - Virtual Machine\n\nThe following instructions will enable you to setup two things:\n\n1. An [Apache Guacamole](https://guacamole.apache.org/) server that will provide a website for accessing remote machines through a Web Browser.\n\n2. One or More Virtual Machines configured with all of the software required for the purpose of teaching \"The Complete XML Developer\" training course.\n\n\n## Obtaining Servers\n\nThis can be setup either in [AWS EC2](https://aws.amazon.com/ec2/), or another Virtual Environment such as KVM running on a Linux Server.\nThe environment (which provided 1x Guacamole Server, and 8x \"The Complete XML Developer\"  Virtual Machines) and that was used for teaching \"The Complete XML Developer\" in London in February 2024 was Ubuntu 24.04 running on a bare-metal server leased by Evolved Binary from [Hetzner](https://www.hetzner.com/) in Germany, with the following configuration:\n* Xeon E5-1650 v3 @ 3.50GHz (6 Cores / 12 Threads)\n* 128 GB RAM\n* 2x 480GB SSD in RAID 1\n\nBelow we detail two options for setting up Virtual Machines: 1. Hetzner bare-metal server, and 2. AWS EC2.\n\n### 1. Setting up a new Linux KVM VM (optional)\n\nIf you have leased a server from someone like Hetzner with Ubuntu 24.04 installed and wish to set this all up using KVM to host your VMs, then on the server (KVM host) you should run the following commands (assuming an Evolved Binary Server in Hetzner):\n\n```shell\ngit clone --single-branch --branch hetzner https://github.com/adamretter/soyoustart hetzner\ncd ~/hetzner\n\nsudo uvt-simplestreams-libvirt sync --source=http://cloud-images.ubuntu.com/minimal/releases arch=amd64 release=noble\n\nexport HN=xmldev-01 IP4=188.40.179.161 IP6=2a01:4f8:140:91f0::161\n./create-uvt-kvm.sh --hostname $HN --release noble --memory 16384 --disk 30 --cpu 4 --bridge virbr1 --ip $IP4 --ip6 $IP6 --gateway 6.4.100.114 --gateway6 2a01:4f8:140:91f0::2 --dns 185.12.64.1 --dns 185.12.64.2 --dns-search evolvedbinary.com --autostart\n```\n\n**NOTE**: There is an issue at the moment with the 2nd private interface not being activated until the VM is shutdown and re-launched. So before you login to the VM fo rthe first time, please wait a few minutes so the VM finishes starting up, and then run:\n\n```shell\nvirsh shutdown xmldev-01\n```\n\nYou should then check the status of the VM until it is shutdown. You can do that by running: `virsh domstate xmldev-01`. When the state is `shut off`, you can then restart the VM by running:\n\n```shell\nvirsh xmldev-01\n```\n\n**NOTE**: The VM specific settings are:\n* `--hostname` `xmldev-01`\n* `--ip` `188.40.179.161`\n* `--ip6` `2a01:4f8:140:91f0::161`\n\n**NOTE**: The network settings specific to the host are:\n* `--bridge` `virbr1`\n* `--gateway` `6.4.100.114`\n* `--gateway6` `2a01:4f8:140:91f0::2`\n\n**NOTE**: The network settings specific to the hosting provider are:\n* `--dns 185.12.64.1`, `--dns 185.12.64.2`\n\n\n### 2. Setting up a new AWS EC2 Instance (optional)\n\nIf you wish to set this up in AWS EC2, then for each Virtual Machine you need should setup a new EC2 instance with the following properties:\n\n1. Name the instance 'xmldev-01'. (change the `01` as needed for more machines).\n\n2. Select the `Ubuntu Server 24.04 LTS (HVM), SSD Volume Type` AMI image, and the Architecture `arm64`.\n\n3. Select `m6g.xlarge` instance type. (i.e.: 4vCPU, 16GB Memory, 1x237 NVMe SSD, $0.1776 / hour).\n\n4. Select the `xmldev` keypair.\n\n5. Select the `xmldev vm` Security Group.\n\n6. Set the default Root Volume as an `EBS` `30 GiB` volume on `GP3` at `3000 IOPS` and `125 MiB throughput`.\n\n\n## Install Guacamole Server\n\nApache Guacamole provides a web interface for accessing any virtual machine remotely. This is used so that students only need a web-browser. The student accesses Guacamole, and then Guacamole connects them to the remote virtual machine.\n\nGuacamole should be run in its own virtual machine. To install Guacamole and configure it for 'The Complete XML Developer' run the following commands on a new VM:\n\n\n```shell\ngit clone https://github.com/evolvedbinary/xml-developer-vm-setup.git\ncd xml-developer-vm-setup\nsudo ./install-puppet-agent.sh\n\ncd guacamole\n\nsudo FACTER_default_user_password=mypassword2 \\\n     /opt/puppetlabs/bin/puppet apply 01-base.pp\n```\n\n**NOTE:** you should set your own passwords appropriately above! The `default_user_password` is used for the Linux user that can access the machine, the username is `ubuntu`.\n\nWe have to restart the system after the above as it may install a new Kernel and make changes to settings that require a system reboot. So run:\n\n```shell\nsudo shutdown -r now\n```\n\nAfter the system restarts and you have logged in, you need to resume from the `xml-developer-vm-setup/guacamole` repo checkout:\n\n```shell\ncd xml-developer-vm-setup/guacamole\n\nsudo FACTER_default_user_password=mypassword2 \\\n     FACTER_xmldev_default_user_password=mypassword \\\n     /opt/puppetlabs/bin/puppet apply .\n```\n\n**NOTE:** you should set your own passwords appropriately above!\n\n* `default_user_password` this is the password to set for the default linux user on this machine (typically the user is named `ubuntu` on Ubuntu Cloud images).\n* `xmlss_default_user_password` should be set to the password of the default user on the remote (cityEHR workstation) virtual machines that you are trying to access.\n\nAfter installation Guacamole's Web Server should be accessible from: [http://localhost:8080](http://localhost:8080), but should be accessible (via an nginx reverse proxy) from: [https://localhost](https://localhost)\n\n\n## Installing a Complete XML Developer Workstation\n\nYou can install one or more Complete XML Developer workstations, each should be configured within its own virtual (or physical) machine. We expect to start from a clean Ubuntu Server, or Ubuntu Cloud Image install. This has been tested with Ubuntu version 24.04 LTS (arm64).\n\n### Complete XML Developer Software Environment\n\nThe following software will be configured:\n\n* Desktop Environment\n\t* X.org\n\t* LXQt\n\t* Chromium\n\t* Firefox\n\t* Okular\n\n* Java Development Environment\n\t* JDK 17 and 21 (default: 17)\n\t\t* JavaFX 12 and 21\n\t* Apache Maven 3\n\t* IntelliJ IDEA CE\n\t* Eclipse IDE\n\n* XML Environment\n\t* Elemental 7.4.0-SNAPSHOT (build from source)\n\t* oXygen XML Editor 21.1\n\t\t* Oxygen XSpec Helper View\n\t* Saxon HE 12.8\n\t* Morgana XProc III EE 1.7\n\t* XML Calabash 3.0.16\n\t* XSpec 3.3.1\n\n* Database Environment\n\t* IBM DB2 Community Edition 12.1.2\n\t\t* DB2 JDBC (level 4) Driver\n\t* IBM Data Studio 4.1.4.0\n\t* PostgreSQL\n\t\t* pgAdmin\n\t\t* PostgreSQL JDBC (level 4) Driver\n\n* Visual Studio Code\n\n* Miscellaneous Tools\n\t* Nullmailer\n\t* Zsh and OhMyZsh\n\t* Git\n\t* cURL\n\t* wget\n\t* Screen\n\t* tar, gzip, bzip2, zstd, zip (and unzip)\n\t* Python 3 and Pip 3\n\n\n### Installing a Complete XML Developer Workstation\n\nEach Complete XML Developer Workstation should be run in its own virtual machine. To install a workstation run the following commands on a new VM:\n\n```shell\ngit clone https://github.com/evolvedbinary/xml-developer-vm-setup.git\ncd xml-developer-vm-setup\nsudo ./install-puppet-agent.sh\n\ncd workstation\n\nsudo /opt/puppetlabs/bin/puppet apply 00-locale.pp\n\nsudo FACTER_default_user_password=mypassword \\\n     /opt/puppetlabs/bin/puppet apply --modulepath=/etc/puppetlabs/code/environments/production/modules:$(pwd)/modules \\\n\t 01-base.pp\n```\n\n**NOTE:** you should set your own passwords appropriately above!\n\n* `default_user_password` this is the password to set for the default linux user on this machine (typically the user is named `ubuntu` on Ubuntu Cloud images).\n\nWe have to restart the system after the above as it may install a new Kernel and make changes to settings that require a system reboot. So:\n\n```shell\nsudo shutdown -r now\n```\n\nAfter the system restarts and you have logged in, you need to resume from the `xml-developer-vm-setup/workstation` repo checkout:\n\n```shell\ncd xml-developer-vm-setup/workstation\nsudo FACTER_default_user_password=mypassword \\\n     FACTER_elemental_db_admin_password=xmldev \\\n     FACTER_elemental_version=7.4.0-SNAPSHOT \\\n     FACTER_postgresql_db_postgres_password=postgres \\\n     /opt/puppetlabs/bin/puppet apply --modulepath=/etc/puppetlabs/code/environments/production/modules:$(pwd)/modules \\\n  .\n```\n\n**NOTE:** you should set your own passwords appropriately above!\n\n* `default_user_password` this is the password to set for the default linux user (typically the user is named `ubuntu` on Ubuntu Cloud images). It needs to be the same as the password you used for this above.\n* `elemental_db_admin_password` this is the password to set for the Elemental `admin` user.\n* `postgresql_db_postgres_password` - This is the password to set for the `postgres` database user in postgres.\n\nWe have to restart the system after the above as it installs a new desktop login manager.\n\n```shell\nsudo shutdown -r now\n```\n\nAfter installation you should be able to access this instance using either one of two mechanisms:\n\n1. Directly, by using an RDP (Remote Desktop Protocol) client, e.g. Microsoft Remote Desktop. This approach usually gives the most responsive performance for the user.\n\t* Clients:\n\t\t* **Windows** - run `mstsc.exe`\n\t\t* **Mac** - Install and run [Microsoft Remote Desktop](https://apps.apple.com/us/app/microsoft-remote-desktop/id1295203466?mt=12) from the Apple Store.\n\t\t* **Linux** - run `rdesktop` (Ubuntu install: `apt-get install -y rdesktop \u0026\u0026 rdesktop`)\n\t* Connection Settings:\n\t\t* **Host**: The IP address or FQDN of the remote machine (e.g. `xmldev-01.evolvedbinary.com`)\n\t\t* **Username**: `ubuntu`\n\t\t* **Password**: *the password you set above for `default_user_password`*\n\n\n2. Indirectly via the Guacamole website by visiting the website (e.g. [https://melon.evolvedbinary.com](https://melon.evolvedbinary.com)) in your web browser.\n\t* Login details:\n\t\t* **Username**: `xmldev-01` (replace `01` with the number of the instance)\n\t\t* **Password**: *the password you set above for `xmldev_default_user_password`*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevolvedbinary%2Fxml-developer-vm-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevolvedbinary%2Fxml-developer-vm-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevolvedbinary%2Fxml-developer-vm-setup/lists"}