Symbolic links and synced folders in Vagrant

synchronization sync vagrant rsync vagrantfile
Golo Roden picture Golo Roden · Jun 13, 2014 · Viewed 69.8k times · Source

I want to use Vagrant to provide a common development environment to my team. The hosts are completely different:

  • Some use OS X, some Linux, and some Windows.
  • Some use VMware, some use VirtualBox.

Inside of the VM we want to run Linux.

So far, everything is fine.

Now our idea was that each developer shall be able use the IDE of their choice, and hence we have introduced a synced folder that shares the source code between the host and the VM. This basically, works as well … except for symbolic links.

Inside of our source code we actually do have a few symbolic links, which is not a problem within the Linux inside the VM, but on Windows as host this causes problems. The only thing that we can not do is get rid of the symbolic links, so we need another way to deal with this.

So far, we have tried a number of options:

  • There is a workaround mentioned in an issue of Vagrant, unfortunately this is VirtualBox-only and does not help those who run VMware. So far, we haven't found a way of running code in the Vagrantfile depending on the provider used.
  • Instead of using a standard shared folder we now have tried using the rsync type. This works on Windows, but crashes on OS X with a number of errors telling us that the symlink has no referent (one error per symbolic link).
  • We thought about NFS, but that only works if you do not use Windows as host.
  • We also though about SMB, but this again only works on Windows as host.

I can not imagine that we are the only or the first persons on this planet to experience problems with multi-platform hosts and symbolic links within the shared folder.

How can you solve this issue, so that we can keep symbolic links, but still use different host operating systems?

Answer

jdunk picture jdunk · Mar 13, 2015

The accepted answer is no good. The question describes an issue with synced folders, not shared folders. The proposed solution would have no effect on an rsynced (not shared) folder. And even if the OP was using a shared folder, the accepted answer's suggestion is something that had already been integrated into vagrant as of 1.1, released 15 months before the OP posted the question (not to mention VirtualBox's shared folders are abysmally slow).

I encountered this same issue: on OS X, I got the symlink has no referent rsync error. I was personally able to solve it by adding particular rsync args to my vagrantfile: 

config.vm.synced_folder ".", "/var/www", type: "rsync", rsync__args: ["--verbose", "--archive", "--delete", "-z"]

I also opened this issue on vagrant's github to point out something that appears to be wrong with their default value for rsync__args (specifically, that one of the default args, --copy-links, seems to be breaking another, --archive, at least as far as copying broken symlinks is concerned).

Related questions

How does lock work exactly?

I see that for using objects which are not thread safe we wrap the code with a lock like this: private static readonly Object obj = new Object(); lock (obj) { // thread unsafe code } So what happens when multiple threads access the …

Read More
How to sync with a remote Git repository?

I forked a project on github, made some changes, so far so good. In the meantime, the repository I forked from changed and I would like to get those changes into my repository. How do I do that ?

Read More
Mutex example / tutorial?

I'm new to multithreading, and was trying to understand how mutexes work. Did a lot of Googling but it still left some doubts of how it works because I created my own program in which locking didn't work. One absolutely …

Read More