Multipass README.md update (#722) (#800)

* Multipass README.md update (#722)

* remove names of the multipass VM's

Author: BeckerFrank

org.eclipse.mylyn.releng/multipass/README.md

@@ -1,14 +1,20 @@
 # Multipass
 
-Here we describe how to setup an VM with local Mylyn Test Instances
+Here we describe how to set up a VM with local Mylyn test instances.
 
-This setup use Ansible and inside the VM we use Docker Swarm
+This setup uses Ansible, and within the VM we use Docker or Docker Swarm.
 
-Actual we only support the setup in Docker Swarm with 3 VM's but in the
-future I will continue to support a setup with only 1 VM
+The Docker Swarm mode with 3 VMs is no longer used (but not removed); instead, we now work in container mode.
 
-This setup is only tested on am MacBook Pro M1.
+In this mode, we have 2 VMs
+1. Management VM for admin, createCertificates
+2. Work VM Docker host with all services
+After setup, you can stop the management VM.
 
+
+This setup has only been tested on a MacBook Pro M1 and a MacMini M4.
+
+Here are the following steps.
 1. Download Multipass
    please install https://multipass.run/install for your platform
 2. Add certificate so you can run a runtime Workspace
@@ -17,81 +23,65 @@ This setup is only tested on am MacBook Pro M1.
    $JAVA_HOME was not set on my environment so I have to use th Path '/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home' instead
 
    1. cp /Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/lib/security/cacerts to the root folder of your installation ../certs/cacerts
-3. Create the Multipass VM's (3 VM's)
+3. Create the Multipass VM's
   - switch to this folder
      ```
      cd ./org.eclipse.mylyn.all/org.eclipse.mylyn/org.eclipse.mylyn.releng/multipass/
      ```
-  - create the 3 VM's
+  - create the VM's
+     ```
+     ansible-playbook -i inventory.yml create_vm.yml --ask-become-pass --extra-vars="local_prefix=mylyn"
      ```
-     ansible-playbook create_vm.yml --ask-become-pass --extra-vars="docker_run_mode=container"
-     or
-     ansible-playbook create_vm.yml --ask-become-pass --extra-vars="docker_run_mode=swarm"
-     or
-     ansible-playbook create_vm.yml --ask-become-pass --extra-vars="docker_run_mode=single"
+     this is the same as
      ```
-     This creates the 3 VM's and make sure that /etc/hosts contains the correct entries
-     and also update the inventory.yml with the new IP addresses of the VM's.
-     During the first time run we create a sshkey for all instances in folder first_setup
+     ansible-playbook -i inventory.yml create_vm.yml --ask-become-pass --extra-vars="local_prefix=mylyn" --extra-vars="docker_run_mode=container      
+	 ```  
+	 This does the following steps
+	   1. creates the VM's
+	   2. sure that /etc/hosts contains the correct entries
+	   3. create the rootca and certificate 
+	   4. During the first time run we create a sshkey for all instances in folder first_setup
+	 This creates the VM's and make sure that /etc/hosts contains the correct entries and also update the inventory.yml with the new IP addresses of the VM's.
+	 During the first time run we create a sshkey for all instances in folder first_setup
+	 
+
 4. First time Setup the VM's
    ```
-   ansible-playbook mylyn_setup.yml --extra-vars="docker_run_mode=container"
-   or
-   ansible-playbook mylyn_setup.yml --extra-vars="docker_run_mode=swarm"
-   or
-   ansible-playbook mylyn_setup.yml --extra-vars="docker_run_mode=single"
+   ansible-playbook -i inventory.yml mylyn_setup.yml --extra-vars="local_prefix=mylyn"
    ```
 5. restart the services the VM's 
    ```
-   ansible-playbook mylyn_setup.yml --skip-tags base_software --extra-vars="docker_run_mode=container"
-   or
-   ansible-playbook mylyn_setup.yml --skip-tags base_software --extra-vars="docker_run_mode=swarm"
-   or
-   ansible-playbook mylyn_setup.yml --skip-tags base_software --extra-vars="docker_run_mode=single"
-   ```
-   or with recreate the Docker swarm 
-   ```
-   ansible-playbook mylyn_setup.yml --skip-tags base_software --extra-vars="swarm_recreate=true" --extra-vars="docker_run_mode=swarm"
+   ansible-playbook mylyn_setup.yml -i inventory.yml --skip-tags base_software --extra-vars="local_prefix=mylyn"
    ```
 
 6. delete VM's and recreate VM's 
    1. delete the running VM's
    ```
-   multipass delete mylynadm01 
-   multipass delete mylynmstr01
-   multipass delete mylynwrk01
+   multipass delete <nmae VM1> 
+   multipass delete <nmae VM2> 
+   multipass delete <nmae VM3> 
    multipass purge
    ```
    2. on macOS we need to delete the on no longer needed IP Address 
     ```
    sudo vi /var/db/dhcpd_leases (delete the 7 lines per instance)
    vi ~/.ssh/known_hosts (remove the old ip adress entries)
    ```
-   3. recreate the VM's and start the Services with
-   ```
-   ansible-playbook create_vm.yml --ask-become-pass --extra-vars="docker_run_mode=container"
-   ansible-playbook mylyn_setup.yml --extra-vars="docker_run_mode=container"
-   because container is Default you can also use 
-   ansible-playbook create_vm.yml --ask-become-pass
-   ansible-playbook mylyn_setup.yml
-   or
-   ansible-playbook create_vm.yml --ask-become-pass --extra-vars="docker_run_mode=swarm"
-   ansible-playbook mylyn_setup.yml --extra-vars="docker_run_mode=swarm"
-   or
-   ansible-playbook create_vm.yml --ask-become-pass --extra-vars="docker_run_mode=single"
-   ansible-playbook mylyn_setup.yml --extra-vars="docker_run_mode=single"
-   ```
+  
+Now you can use the following URLs
+  - https://mylyn.local/traefikdashboard
+  - https://mylyn.local/mylyn_idx/
+  - https://mylyn.local/grafana/
 
-Now you can use the URLs https://traefik.mylyn.local and https://mylyn.local/mylyn_idx/ for verification on the installation host computer.
+ for verification on the installation host computer.
 You will get certification warnings and must trust the self signed certificate.
 
 If you want to access the URLs from an other computer in your local environment you must add a line to your /etc/hosts file.
-Look into /etc/hosts of your installation host computer and you see the following line
-```
-192.168.64.3 mylynmstr01 mylyn.local traefik.mylyn.local jenkins.mylyn.local artifactory.mylyn.local gitlab.mylyn.local
-```
-copy this line and replace the IP adress with the local network IP address assinged to the mylynmstr01 vm
-```
-192.168.2.120 mylynmstr01 mylyn.local traefik.mylyn.local jenkins.mylyn.local artifactory.mylyn.local gitlab.mylyn.local
-```
-Now you shold be able to assess the URLs from the other computer
+
+You can add the following additional variables for the Ansible playbook. Use the extra-vars when executing create_vm.yml. For mylyn_setup.yml, use only local_prefix; all others will be loaded from create_vm.yml.
+
+| varname | Decription |
+| --- | --- |
+| local_prefix | There are groups in the inventory, and you can select which groups to use.<br>This is used to support an inventory that can be used for different VM setups.<br>The default setting is “mylyn,” assuming we have the following groups: mylyn_admin, mylyn_swarm_master, mylyn_swarm_worker.  |
+| local_domain | The name of the domain. The default setting is “mylyn.local.” |
+| docker_run_mode | Setting mode. Allowed values: swarm, container, single.<br>The default setting is “container”, and the other modes may result in configuration errors. |

org.eclipse.mylyn.releng/multipass/roles/multipass_create_vm/tasks/main.yml

@@ -37,24 +37,24 @@
 - name: debug new list
   debug: var=inst_list verbosity=3
 
-- name: build name ip map
-  ansible.builtin.set_fact:
-    ip_2_change: "{{ ip_2_change | default([]) + [ { 'aname': item.name, 'aip': item.ip4, 'mip': (inst_list | selectattr(\"inst_name\", \"equalto\", item.name) | map(attribute='ip_adr4'))[0] } ] }}"
-  when: >
-    item.name in inst_list | map(attribute='inst_name') and
-    (inst_list | selectattr("inst_name", "equalto", item.name))| map(attribute='ip_adr4') != [item.ip4 ]
-  with_items: "{{ mylyn_vm_hosts }}"
-- name: debug ip_2_change
-  debug: var=ip_2_change verbosity=3
-  when: ip_2_change is defined
-
-- name: "Replace line in file inventory.yml"
-  replace: 
-    path: inventory.yml
-    regexp: "(^\\s*ansible_host:\\s*)(\"{{ item.aip | regex_escape() }}\")(.*)$"
-    replace: "\\1\"{{item.mip}}\""
-  with_items: "{{ ip_2_change }}"
-  when: ip_2_change is defined
+# - name: build name ip map
+#   ansible.builtin.set_fact:
+#     ip_2_change: "{{ ip_2_change | default([]) + [ { 'aname': item.name, 'aip': item.ip4, 'mip': (inst_list | selectattr(\"inst_name\", \"equalto\", item.name) | map(attribute='ip_adr4'))[0] } ] }}"
+#   when: >
+#     item.name in inst_list | map(attribute='inst_name') and
+#     (inst_list | selectattr("inst_name", "equalto", item.name))| map(attribute='ip_adr4') != [item.ip4 ]
+#   with_items: "{{ mylyn_vm_hosts }}"
+# - name: debug ip_2_change
+#   debug: var=ip_2_change verbosity=3
+#   when: ip_2_change is defined
+# 
+# - name: "Replace line in file inventory.yml"
+#   replace: 
+#     path: inventory.yml
+#     regexp: "(^\\s*ansible_host:\\s*)(\"{{ item.aip | regex_escape() }}\")(.*)$"
+#     replace: "\\1\"{{item.mip}}\""
+#   with_items: "{{ ip_2_change }}"
+#   when: ip_2_change is defined
 
 - name: remove mylyn vm from etc hosts
   become: true