Vagrant Repository

This is a Vagrant Repository for private hosting of Vagrant boxes

Find the code in the GitHub repository:

https://github.com/acntech/vagrant-repository

API

The application has an API that contains a set of REST endpoints for managing hosted Vagrant Boxes in the repository. This means read and write operations for organizations, boxes, versions and providers for the repository.

It also provides the endpoints used by Vagrant clients to retrieve information about hosted Vagrant boxes.

The API can be accessed from the /api/v1/* path of the application http://localhost:8080/api/v1/*.

OpenAPI

The application exposes OpenAPI definition:

JSON: http://localhost:8080/api/docs
UI: http://localhost:8080/api/docs.html

Management

The application exposes Spring Actuator endpoints:

http://localhost:8080/management/*

GUI

The application also has a GUI that can be used to manage hosted Vagrant boxes in the repository.

The GUI can be accessed from the root path of the application http://localhost:8080/.

Getting started

The Vagrant Repository are available as a Docker container in the Docker Hub:

https://hub.docker.com/r/acntechie/vagrant-repository

Run

Use the following docker-compose.yml file to run the Vagrant Repository:

version: "3.7"

services:
    repository:
        image: acntechie/vagrant-repository
        ports:
            - "8080:8080"
        environment:
            - SPRING_PROFILES_ACTIVE=environment
            - SPRING_DATASOURCE_URL=jdbc:postgresql://postgres:5432/vagrant_repository
            - SPRING_DATASOURCE_USERNAME=vagrant_repository
            - SPRING_DATASOURCE_PASSWORD=64nd4lf
        networks:
            - postgres
    postgres:
        image: postgres
        environment:
            - POSTGRES_DB=vagrant_repository
            - POSTGRES_USER=vagrant_repository
            - POSTGRES_PASSWORD=64nd4lf
        networks:
            - postgres

networks:
    postgres:
        name: acntech.postgres

Login

When starting a fresh instance of the Vagrant Repository it will create a default admin user. The password is generated on startup. Look in the application log to find the login information.

Database

The application needs a database in order to run. PostgreSQL is the default database used.

If you want to use another database type you need to do four things:

You need to update the application config to reflect wanted database.
You need to migrate the database schema to the SQL syntax of the database you want to use.
You need to change the JDBC driver for the database you want to use.
The application uses JOOQ as it's database framework. You need to generate the JOOQ meta model with the correct database dialect. This is changed in the JOOQ Maven plugin config.

Application config

You need to run the application or Docker container with the following environment variables:

SPRING_SQL_INIT_PLATFORM=mariadb
SPRING_DATASOURCE_DRIVER_CLASS_NAME=org.mariadb.jdbc.Driver

Database schema

E.g. if you want to use MariaDB instead of PostgreSQL then you create a new directory:

src/main/resources/db/vendor/mariadb

Then you migrate the PostgreSQL script to MariaDB SQL syntax and place it in the directory.

Here directory name must correspond to the platform name mariadb used in the previous step.

Database driver

Add the MariaDB JDBC driver to Maven:


<dependency>
    <groupId>org.mariadb.jdbc</groupId>
    <artifactId>mariadb-java-client</artifactId>
    <version>x.y.z</version>
</dependency>

JOOQ Maven plugin

Update the JOOQ Maven plugin config with the correct database dialect:

<plugin>
    <groupId>org.jooq</groupId>
    <artifactId>jooq-codegen-maven</artifactId>
    <version>x.y.z</version>
    <executions>
        <execution>
            <id>generate-meta-model</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <jdbc>
                    <driver>org.mariadb.jdbc.Driver</driver>
                    <url>jdbc:mariadb://localhost:3306/vagrant_repository</url>
                    <user>vagrant_repository</user>
                    <password>64nd4lf</password>
                </jdbc>
                <generator>
                    <database>
                        <name>org.jooq.meta.mariadb.MariaDBDatabase</name>
                        <includes>.*</includes>
                        <excludes/>
                    </database>
                </generator>
            </configuration>
        </execution>
    </executions>
</plugin>

Hosting boxes

Vagrant boxes belong to an organization. A box can exist as one or more version. A box version is published with an associated provider. The provider is the virtualization platform that the box is meant to run on. As of now VirtualBox, VMWare and Hyper-V are the only supported providers.

To use a hosted box like e.g. acntech/ubuntu in Vagrant then define a Vagrantfile similar to the example below:

# -*- mode: ruby -*-
# vi: set ft=ruby :

Vagrant.configure(2) do |config|

  # Name of Vagrant Box
  config.vm.box = "acntech/ubuntu"

  # URL to Vagrant Repository for given Vagrant Box
  config.vm.box_url = "http://repo.private.com/api/box/acntech/ubuntu"

  # Don't generate new SSH key, but use the default insecure key
  config.ssh.insert_key = false

  config.vm.provider "virtualbox" do |vb|

    # Name to display in VirtualBox
    vb.name = "AcnTech Ubuntu"

    # Display the VirtualBox GUI when booting the machine
    vb.gui = true

    # Customize the amount of memory on the VM
    vb.memory = "1024"

    # Customize CPU count
    vb.cpus = "1"
  end
end

acntech / vagrant-repository

readme