diff --git a/debian-generic/README.md b/debian-generic/README.md index 7afe86d..3a0d116 100644 --- a/debian-generic/README.md +++ b/debian-generic/README.md @@ -1,24 +1,24 @@ # Generic Debian 8.0 ("Jessie") VM -These files were created to allow users to use Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)) to quickly and easily spin up a generic Debian 8.0 ("Jessie") 64-bit VM. The configuration was tested using Vagrant 1.7.2, VMware Fusion 6.0.5, and the Vagrant VMware plugin. +These files were created to allow users to use Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)) to quickly and easily spin up a generic Debian 8.0 ("Jessie") 64-bit VM. The configuration was tested using Vagrant 1.8.1 and 1.8.5, VMware Fusion 8.1.0 (with the Vagrant VMware plugin), and VirtualBox 5.1. **NOTE:** There's really nothing special here; I created these files because I often had a need to quickly and easily spin up a generic Debian VM for some purpose (building a package or testing a command). I'm including them here just for the sake of completeness. ## Contents -* **README.md**: This file you're currently reading. +* **machines.yml**: This YAML file contains a list of VM definitions and associated configuration data. It is referenced by `Vagrantfile` when Vagrant instantiates the VMs. -* **servers.yml**: This YAML file contains a list of VM definitions and associated configuration data. It is referenced by `Vagrantfile` when Vagrant instantiates the VMs. +* **README.md**: This file you're currently reading. * **Vagrantfile**: This file is used by Vagrant to spin up the virtual machines. This file is fairly extensively commented to help explain what's happening. You should be able to use this file unchanged; all the VM configuration options are stored outside this file. ## Instructions -These instructions assume you've already installed VMware Fusion, Vagrant, and the Vagrant VMware plugin. Please refer to the documentation for those products for more information on installation or configuration. +These instructions assume you've already installed your virtualization provider (VMware Fusion/Workstation or VirtualBox), Vagrant, and any necessary plugins (such as the Vagrant VMware plugin). Please refer to the documentation for those products for more information on installation or configuration. -1. Use `vagrant box add` to add a 64-bit Debian 8.0 ("Jessie") base box to be used by this `Vagrantfile`. You'll need to specify a box that provides support for the `vmware_desktop` provider (it should work with either VMware Workstation or VMware Fusion). +1. Use `vagrant box add` to add a 64-bit Debian 8.0 ("Jessie") base box to be used by this `Vagrantfile`. You'll need to specify a box that provides support for the virtualization provider you're planning to use. -2. Edit the `servers.yml` file to ensure the box you downloaded in step 1 is specified on the "box:" line of this file. +2. Edit the `machines.yml` file to ensure the box you downloaded in step 1 is specified on the "box:" line of this file. 3. Run `vagrant up`, and when the VM is up use `vagrant ssh` to access the generic Debian VM. diff --git a/photon-cloudinit/README.md b/photon-cloudinit/README.md index 2f83c5d..b3ade51 100644 --- a/photon-cloudinit/README.md +++ b/photon-cloudinit/README.md @@ -1,37 +1,37 @@ # Customizing Photon with cloud-init -These files provide an example of how to customize VMware Photon ([https://github.com/vmware/photon](https://github.com/vmware/photon)) using cloud-init ([https://launchpad.net/cloud-init](https://launchpad.net/cloud-init)) and the NoCloud datasource when used in conjunction with Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)). This configuration was tested using Vagrant 1.7.2, VMware Fusion 6.0.5, and the Vagrant VMware plugin. +These files provide an example of how to customize VMware Photon ([https://github.com/vmware/photon](https://github.com/vmware/photon)) using cloud-init ([https://launchpad.net/cloud-init](https://launchpad.net/cloud-init)) and the NoCloud datasource when used in conjunction with Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)). This configuration was tested using Vagrant 1.8.1 and 1.8.5, VMware Fusion 8.1.0 (with the Vagrant VMware plugin), and VirtualBox 5.1. ## Contents +* **machines.yml**: This YAML file contains configuration data for Vagrant to use to instantiate VMs. It is referenced by `Vagrantfile` when the user runs `vagrant up`. If you use a Vagrant box _other_ than "vmware/photon", or if you want more memory, more vCPUs, or more than 1 Photon VM created, then you'll need to edit this file. Otherwise, you should be able to use this file unchanged. + * **meta-data**: This file is used by `cloud-init` and should not be modified. Vagrant will put this file in the correct place in the Photon VM(s) via the setup script that is called by `Vagrantfile`. * **README.md**: This file you're reading right now. -* **servers.yml**: This YAML file contains configuration data for Vagrant to use to instantiate VMs. It is referenced by `Vagrantfile` when the user runs `vagrant up`. If you use a Vagrant box _other_ than "vmware/photon", or if you want more memory, more vCPUs, or more than 1 Photon VM created, then you'll need to edit this file. Otherwise, you should be able to use this file unchanged. - * **setup.sh**: This bash shell script prepares the Photon VM(s) to use the NoCloud datasource with `cloud-init`. The script is designed to be as idempotent as possible, but isn't guaranteed to be completely idempotent. You should not need to edit this file. * **user-data**: This file is used by `cloud-init` to perform the desired customization to the Photon VM(s). You should not need to edit this file unless you wish to change the customization that is occurring. Otherwise, you can use this file unchanged. -* **Vagrantfile**: This file is used by Vagrant to spin up the VMs. This file is fairly extensively commented to help explain what's happening. You should be able to use this file unchanged; all the VM configuration options are stored outside this file in `servers.yml`. +* **Vagrantfile**: This file is used by Vagrant to spin up the VMs. This file is fairly extensively commented to help explain what's happening. You should be able to use this file unchanged; all the VM configuration options are stored outside this file in `machines.yml`. ## Instructions -These instructions assume that you've already installed VMware Fusion, Vagrant, and the Vagrant VMware plugin, and that they are all working properly. Please refer to the documentation for those products for more information on installation, configuration, or troubleshooting. +These instructions assume that you've already installed your virtualization provider (VMware Fusion/Workstation or VirtualBox), Vagrant, any necessary plugins (such as the Vagrant VMware plugin), and that they are all working properly. Please refer to the documentation for those products for more information on installation, configuration, or troubleshooting. -1. If you haven't already downloaded the VMware Photon Vagrant box, use `vagrant box add vmware/photon` to download the VMware Photon Vagrant box. You can verify that the box is downloaded and ready for use with the command `vagrant box list`. +1. If you haven't already downloaded the VMware Photon Vagrant box, use `vagrant box add vmware/photon` to download the VMware Photon Vagrant box. You can verify that the box is downloaded and ready for use with the command `vagrant box list`. The same Vagrant box is available for multiple virtualization providers. -2. If you decided to use a different Vagrant box (something different than "vmware/photon"), you'll need to edit `servers.yml` and specify the correct box. +2. If you decided to use a different Vagrant box (something different than "vmware/photon"), you'll need to edit `machines.yml` and specify the correct box. 3. Put the files from the `photon-cloudinit` directory of this GitHub repository into a directory on your local system. You can clone the entire "learning-tools" repository via `git clone`, or just download the specific files from the `photon-cloudinit` folder. -4. From a terminal window, change into the directory where you placed the files from step 3 and run `vagrant up`. Vagrant will instantiate one or more Photon VMs according to the information in `servers.yml`. +4. From a terminal window, change into the directory where you placed the files from step 3 and run `vagrant up`. Vagrant will instantiate one or more Photon VMs according to the information in `machines.yml`. -5. Currently, Photon VMs created by Vagrant won't perform the `cloud-init` customizations until they are rebooted after first being brought up by Vagrant. Use `vagrant ssh` to log into the Photon VM (if you created more than one by adding entries to `servers.yml`, you'll need to add the VM name to the `vagrant ssh` command). Reboot the VM using `sudo reboot -h now`. +5. Currently, Photon VMs created by Vagrant won't perform the `cloud-init` customizations until they are rebooted after first being brought up by Vagrant. Use `vagrant ssh` to log into the Photon VM (if you created more than one by adding entries to `machines.yml`, you'll need to add the VM name to the `vagrant ssh` command). Reboot the VM using `sudo reboot -h now`. -6. When the Photon VM comes back up, the Docker daemon should be listening on the official Docker TCP port (2375). If you have a Docker client installed, you can run `docker -H tcp://W.X.Y.Z:2375 ps`, where "W.X.Y.Z" is the IP address assigned to the Photon VM. The command will return a list of running containers (which is most likely empty). +6. When the Photon VM comes back up, the Docker daemon should be listening on the official Docker TCP port (2375). If you are running VMware Fusion/Workstation and have a Docker client installed on the host system, you can run `docker -H tcp://W.X.Y.Z:2375 ps`, where "W.X.Y.Z" is the IP address assigned to the Photon VM. The command will return a list of running containers (which is most likely empty). Note that this will _not_ work with VirtualBox. At this point, you can use the Docker client (either inside the Photon VM or from a system with connectivity to the Photon VM) to pull down images, launch images, etc. -Enjoy! \ No newline at end of file +Enjoy! diff --git a/photon/README.md b/photon/README.md index 878d91c..3817bf0 100644 --- a/photon/README.md +++ b/photon/README.md @@ -1,29 +1,29 @@ # Simple VMware Photon Environment -These files were created to allow users to use Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)) to quickly and relatively easily spin up an instance of VMware Photon (container-optimized Linux distribution). The configuration was tested using Vagrant 1.7.2, VMware Fusion 6.0.5, and the Vagrant VMware plugin. +These files were created to allow users to use Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)) to quickly and relatively easily spin up an instance of VMware Photon (container-optimized Linux distribution). The configuration was tested using Vagrant 1.8.1 and 1.8.5, VMware Fusion 8.1.0 (with the Vagrant VMware plugin), and VirtualBox 5.1. ## Contents -* **README.md**: This file you're currently reading. +* **machines.yml**: This YAML file contains a list of VM definitions and associated configuration data. It is referenced by `Vagrantfile` when Vagrant instantiates the VMs. -* **servers.yml**: This YAML file contains a list of VM definitions and associated configuration data. It is referenced by `Vagrantfile` when Vagrant instantiates the VMs. +* **README.md**: This file you're currently reading. * **Vagrantfile**: This file is used by Vagrant to spin up the virtual machines. This file is fairly extensively commented to help explain what's happening. You should be able to use this file unchanged; all the VM configuration options are stored outside this file. ## Instructions -These instructions assume you've already installed VMware Fusion, Vagrant, and the Vagrant VMware plugin. Please refer to the documentation for those products for more information on installation or configuration. +These instructions assume you've already installed your virtualization provider (VMware Fusion/Workstation or VirtualBox), Vagrant, and any necessary plugins (such as the Vagrant VMware plugin). Please refer to the documentation for those products for more information on installation or configuration. 1. At the time of writing, Vagrant's guest OS support did not work as expected with Photon. To fix this issue, install a Photon-specific Vagrant plugin using this command: vagrant plugin install vagrant-guests-photon -2. Optionally, go ahead and download the Photon box for Vagrant using the command `vagrant box add vmware/photon`. You can skip this step, if you'd like; Vagrant will then automatically download the box the first time you run `vagrant up`. +2. Optionally, go ahead and download the Photon box for Vagrant using the command `vagrant box add vmware/photon`. You can skip this step, if you'd like; Vagrant will then automatically download the box the first time you run `vagrant up`. The same Vagrant box is formatted for multiple virtualization providers. 3. Place the files from the `photon` directory of this GitHub repository into a directory on your local system. You can clone the entire "learning-tools" repository (using `git clone`), download a ZIP file of the entire "learning-tools" repository, or just download the specific files from the the `photon` folder. 4. From a terminal window, change into the directory where you stored the files from step 3 and run `vagrant up`. -5. Once Vagrant has finished bringing up the VM, simply use `vagrant ssh` to log into the system. Both `rkt` (version 0.5.1) and `docker` (version 1.5.0) are pre-installed and ready for use. +5. Once Vagrant has finished bringing up the VM, simply use `vagrant ssh` to log into the system. Enjoy! diff --git a/ubuntu-generic/README.md b/ubuntu-generic/README.md index f01003b..93c4747 100644 --- a/ubuntu-generic/README.md +++ b/ubuntu-generic/README.md @@ -1,24 +1,24 @@ # Generic Ubuntu 14.04 VM -These files were created to allow users to use Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)) to quickly and easily spin up a generic Ubuntu 14.04 64-bit VM. The configuration was tested using Vagrant 1.7.2, VMware Fusion 6.0.5, and the Vagrant VMware plugin. +These files were created to allow users to use Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)) to quickly and easily spin up a generic Ubuntu 14.04 64-bit VM. The configuration was tested using Vagrant 1.8.1 and 1.8.5, VMware Fusion 8.1.0 (with the Vagrant VMware plugin), and VirtualBox 5.1. **NOTE:** There's really nothing special here; I created these files because I often had a need to quickly and easily spin up a generic Ubuntu VM for some purpose (building a package or testing a command). I'm including them here just for the sake of completeness. ## Contents -* **README.md**: This file you're currently reading. +* **machines.yml**: This YAML file contains a list of VM definitions and associated configuration data. It is referenced by `Vagrantfile` when Vagrant instantiates the VMs. -* **servers.yml**: This YAML file contains a list of VM definitions and associated configuration data. It is referenced by `Vagrantfile` when Vagrant instantiates the VMs. +* **README.md**: This file you're currently reading. * **Vagrantfile**: This file is used by Vagrant to spin up the virtual machines. This file is fairly extensively commented to help explain what's happening. You should be able to use this file unchanged; all the VM configuration options are stored outside this file. ## Instructions -These instructions assume you've already installed VMware Fusion, Vagrant, and the Vagrant VMware plugin. Please refer to the documentation for those products for more information on installation or configuration. +These instructions assume you've already installed your virtualization provider (VMware Fusion/Workstation or VirtualBox), Vagrant, and any necessary plugins (such as the Vagrant VMware plugin). Please refer to the documentation for those products for more information on installation or configuration. -1. Use `vagrant box add` to add an Ubuntu 14.04 base box to be used by this `Vagrantfile`. You can use my base box (`slowe/ubuntu-trusty-x64`), which provides support for the `vmware_desktop` provider (it should work with either VMware Workstation or VMware Fusion). +1. Use `vagrant box add` to add an Ubuntu 14.04 base box to be used by this `Vagrantfile`. If you are using a VMware virtualization provider, you can use my base box ("slowe/ubuntu-trusty-x64"; it should work with either VMware Workstation or VMware Fusion but has only been tested on Fusion). -2. If you are using a box other than my Ubuntu 14.04 base box, or if you want to change the default amount of RAM or number of vCPUs assigned to the VM, edit the `servers.yml` file and make the desired changes. +2. If you are using a box other than my Ubuntu 14.04 base box, or if you want to change the default amount of RAM or number of vCPUs assigned to the VM, edit the `machines.yml` file and make the desired changes. 3. Run `vagrant up`, and when the VM is up use `vagrant ssh` to access the generic Ubuntu 14.04 installation.