generalized the cloud init YAML files while allowing for local modifications

Author: rsdoiel

README.md

@@ -20,16 +20,14 @@ start-invenio-server-vm.bash, invenio-server-init.yaml
 
 The next set provide the ability to run as a full GUI environment on macOS or Windows using the Microsoft Remote Desktop viewer or Remmina on Linux. The are based on the previous terminal oriented VMs but add the "ubuntu-desktop" and "xrdp" package to handle the remote displays.  For you to use the GUI versions your VM accounts need to have a password associated with them. You can use the `multipass shell` command to get a shell and then use `sudo passwd USERNAME` to set the password for "USERNAME" (e.g. ubuntu, rsdoiel).
 
-On a M1 Mac running under Monterey you can then use a web browser from the remote displayed VM to test services inside the VM without exposing it to your host machine.
-
+If you would like to have a Ubuntu Desktop available for use in your multipass VM Ihave provided several examples.
 start-dev-gui-vm.bash, dev-gui-init.yaml
 : A development GUI environment for Golang 1.18, uses 4 cores and 8G of RAM
 
 start-invenio-gui-vm.bash, invenio-gui-init.yaml
 : A development GUI environment for Invenio-RDM, uses 4 cores and 8G of RAM
 
 
-
 Multipass
 ---------
 
@@ -133,6 +131,28 @@ Like previous example access with the `multipass` shell command.
 
 A more complete exploration of running InvenioRDM is found in the [InvenioRDM-Setup](InvenioRDM-Setup.html)
 
+General purpose Bash scripts
+----------------------------
+
+I have provided three Bash scripts for starting/launching, getting info and stopping your multipass VM.
+
+1. start-vm.bash - starts an existing or launches a new virtual machine based on a related cloud init YAML file
+2. stats-vm.bash - will return information about the machine (i.e. it runs `multipass info $MACHINE`)
+3. stop-vm-.bash - will stop the machine
+
+If you've devined a primary name for the machine the Bash scripts can be used without any additoinal parameters. If
+you provide a machine name as a parameter then the scripts will work with that machine name.
+
+For creating new machines (aka multipass launch) the start-vm.bash script looks for a cloud init YAML file that
+defines the new machine. By default it first looks for the name `$MACHINE-local.yaml` and if that is not available
+it looks for `$MACHINE-init.yaml`.   The `*-init.yaml` files provided in this repository are a good starting point but
+the cloud init support in multipass goes much further.  The YAML file called `dev-server-local.yaml` is provided as an
+example of including full login setup for the developers in the DLD group of Caltech Library. This includes setting them
+up with sudo access, assigning them to additoinal groups and enabling login via SSH keys hosted on GitHub.  By using the
+filename convension of `*-init.yaml` I can provide a general purpose machine definition while allowing for local modification
+via a version of the same file matching `*-local.yaml`.
+
+
 Trouble shooting
 ----------------
 

codemeta.json

@@ -6,7 +6,7 @@
     "dateCreated": "2022-04-25",
     "issueTracker": "https://github.com/caltechlibrary/cloud-init-examples/issues",
     "name": "cloud-init-examples",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "description": "This is a collection of Bash scripts and cloud-init YAML files to be used with multipass for generating virtual machines useful for software development in libraries and archives.",
     "developmentStatus": "concept",
     "programmingLanguage": [

dev-server-local.yaml

@@ -0,0 +1,76 @@
+package_update: true
+package_upgrade: true
+fqdn: dev.local
+packages:
+  - build-essential
+  - git
+  - snapcraft
+  - autoconf
+  - automake
+  - curl 
+  - wget
+  - tmux
+  - tree
+  - htop
+  - lynx
+  - python3-dev
+  - python3-pip
+  - rsync
+  - libexpat1
+  - apache2
+  - apache2-utils
+  - ssl-cert
+  - libapache2-mod-wsgi 
+groups:
+  - docker
+  - staff
+  - www-data
+users:
+  - default
+  - name: rsdoiel
+    shell: /bin/bash
+    gecos: R. S. Doiel
+    primary_group: staff
+    groups: [ users, staff, adm, sudo, www-data ]
+    ssh_import_id:
+      - gh:rsdoiel
+    sudo: ALL=(ALL) NOPASSWD:ALL
+  - name: tmorrell
+    shell: /bin/bash
+    gecos: Tom Morrell
+    primary_group: staff
+    groups: [ users, staff, adm, sudo, www-data ]
+    ssh_import_id:
+      - gh:tmorrell
+  - name: mhucka
+    shell: /bin/bash
+    gecos: Mike Hucka
+    primary_group: staff
+    groups: [ users, staff, adm, sudo, www-data ]
+    ssh_import_id:
+      - gh:mhucka
+    sudo: ALL=(ALL) NOPASSWD:ALL
+  - name: tkeswick
+    shell: /bin/bash
+    gecos: Tommy Keswick
+    primary_group: staff
+    groups: [ users, staff, adm, sudo, www-data ]
+    ssh_import_id:
+      - gh:t4k
+    sudo: ALL=(ALL) NOPASSWD:ALL
+timezone: US/Pacific
+snap:
+  commands:
+  - [ install, docker ]
+  - [ install, --classic, go ]
+  - [ install, pandoc ]
+  - [ install, datatools ]
+  - [ install, mkpage ]
+  - [ install, eprinttools ]
+  - [ install, dataset ]
+runcmd:
+  - adduser ubuntu docker
+  - adduser rsdoiel docker
+  - adduser tmorrell docker
+  - adduser mhucka docker
+  - adduser tkeswick docker