# **[Plugin](http://docs.vagrantup.com/v2/plugins/index.html)** that adds **[Clear Linux](https://clearlinux.org)** *guest* support to **[Vagrant](http://www.vagrantup.com/)**

[![Gem Version](https://badge.fury.io/rb/vagrant-guests-clearlinux.svg)](https://badge.fury.io/rb/vagrant-guests-clearlinux)

> Once it gets feature complete and rock solid, and time and resources permit, work will start in
> order to get this plugin merged into **[upstream](https://github.com/hashicorp/vagrant)**.

Currently the plugin exposes the following *guest*
**[capabilities](https://www.vagrantup.com/docs/plugins/guest-capabilities.html)** to **Vagrant**:
- **[rsync](https://www.vagrantup.com/docs/synced-folders/rsync.html)**
- **[NFS](https://www.vagrantup.com/docs/synced-folders/nfs.html)**

Beyond adding proper **[Clear Linux](https://clearlinux.org)** *guest* support to **Vagrant** this
plugin also comes bundled two additional **[provisioners](https://www.vagrantup.com/docs/provisioning/)**:

- a simple **[provisioner](https://www.vagrantup.com/docs/provisioning/)** that
  enable basics
**[swupd](https://clearlinux.org/documentation/clear-linux/guides/maintenance/swupd-guide)**
operations straight from the `Vagrantfile`:

  - adding one or more **[bundles](https://clearlinux.org/documentation/clear-linux/reference/bundles)**

    ```ruby
    config.vm.provision :bundle_add, bundles: 'wireshark'
    # alternatively ... functionally equivalent to above
    # config.vm.provision :bundle_add do |p|
    #  p.bundles = 'wireshark'
    # end
    ```

  - removing one or more **[bundles](https://clearlinux.org/documentation/clear-linux/reference/bundles)**

    ```ruby
    # assuming it was installed already ...
    config.vm.provision :bundle_remove, bundles: [ 'wireshark', 'nmap' ]
    # alternatively ... functionally equivalent to above
    # config.vm.provision :bundle_remove do |p|
    #  p.bundles = ['wireshark', 'nmap']
    # end
    ```

- a provisioner to set the desired [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

  Given that the available ClearLinux boxes ship with a default timezone set unlikely
  to suit everyone (Author's one `Portugal` *aka* `Europe/Lisbon`) here's how to programatically your own straight from the `Vagrantfile`:

  ```ruby
  config.vm.provision :set_timezone, timezone: 'Asia/Dili'
  ```

  > `Vagrant` loading will abort if the provided timezone is invalid

## Compatible Vagrant boxes

The **Clear Linux** Vagrant **[boxes](https://app.vagrantup.com/AntonioMeireles/boxes/ClearLinux)** come
bundled with this plugin and, in most conditions, should install it automatically.

For additional information about them please visit their
[documentation](https://github.com/AntonioMeireles/ClearLinux-packer/blob/master/README.md).

### Manual Maintenance

#### Manual Installation

```shell
❯❯❯ vagrant plugin install vagrant-guests-clearlinux
```

### Manual Upgrading

```shell
❯❯❯ vagrant plugin update vagrant-guests-clearlinux
```

## Development

To build, install or modify the plugin directly from this repository:

> NOTE: commands bellow assume you have a working docker environment.

```shell
❯❯❯ make build
❯❯❯ make local-install VERSION=...
```

where `VERSION` is whatever is being set in `lib/vagrant-guests-clearlinux/version.rb`

You can run RSpec with:

```shell
❯❯❯ bundle install
❯❯❯ bundle exec rake
```

## Feedback

**[Bug Reports and Feature Suggestions](https://github.com/AntonioMeireles/vagrant-guests-clearlinux/issues)**
and **[Pull Requests](https://github.com/AntonioMeireles/vagrant-guests-clearlinux/pulls)**. You're welcome!

## Acknowledgments

This was developed,  initially, inspired in works of [Fabio Rapposelli](https://github.com/frapposelli)
on [vagrant-guests-photon](https://github.com/vmware/vagrant-guests-photon) and
[Alex Sorkin](https://github.com/alexsorkin) on
[vagrant-guests-innovitable](https://github.com/alexsorkin/vagrant-guests-innovitable).