Skip to content

Commit

Permalink
development: add Vagrantfile support and docs
Browse files Browse the repository at this point in the history
Signed-off-by: Patrick Stephens <[email protected]>
  • Loading branch information
patrick-stephens authored and edsiper committed Aug 11, 2022
1 parent 9fa5f02 commit 1aae936
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 12 deletions.
16 changes: 4 additions & 12 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -545,20 +545,12 @@ cmake ...
make
```

Be aware of any permissions issues with the filesystem on the VM vs the host.
You may prefer to build to an un-exposed filesystem:

```shell
vagrant up
vagrant ssh
mkdir -p /tmp/build
cd /tmp/build
cmake ... /vagrant
make
```

It also acts as a reference for the tooling required to be installed on a local PC if you want to build things.

The VM created by Vagrant uses `rsync` to synchronize the files with rather than directly mounting the local directory.
The reason is to handle any permission issues and isolate the underlying host filesystem.
Refer to the Vagrant documentation for syncing changes: <https://www.vagrantup.com/docs/cli/rsync-auto>

To enable the unit tests run:

```shell
Expand Down
43 changes: 43 additions & 0 deletions Vagrantfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# -*- mode: ruby -*-
# vi: set ft=ruby :

Vagrant.configure("2") do |config|
# config.vm.box = "ubuntu/focal64" # Ubuntu 20.04 Focal Fossa (non CO-RE)
# config.vm.box = "ubuntu/hirsute64" # Ubuntu 21.04 Hirsute Hippo (CO-RE)
# config.vm.box = "ubuntu/impish64" # Ubuntu 21.10 Impish Indri (CO-RE)
config.vm.box = "ubuntu/jammy64" # Ubuntu 22.04 Jammy Jellyfish (CO-RE)

config.ssh.extra_args = ["-t", "cd /vagrant; bash --login"]

# Use rsync rather than mounting into the VM as triggers a few issues with permissions during build
config.vm.synced_folder ".", "/vagrant", type: "rsync"

config.vm.provider "virtualbox" do |vb|
vb.gui = false
vb.memory = "2048"
end

config.vm.provision "shell", inline: <<-SHELL
VAGRANT_HOME="/home/vagrant"
apt-get update
apt-get install --yes apt-transport-https ca-certificates curl
# https://github.com/fluent/fluent-bit/tree/master/packaging/distros/ubuntu
# Main build
apt-get install --yes build-essential cmake dh-make git make openssl pkg-config tar
# Dependencies
apt-get install --yes libssl3 libssl-dev libsasl2-dev pkg-config libsystemd-dev zlib1g-dev libpq-dev postgresql-server-dev-all flex bison libyaml-dev libpq5
# Debug
apt-get install --yes gdb valgrind
# From Unit Tests:
apt-get install --yes gcc-7 g++-7 clang-6.0 gcovr
# For packaging potentially
apt-get install --yes docker.io
usermod -aG docker vagrant
SHELL
end

0 comments on commit 1aae936

Please sign in to comment.