Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arnaud-dezandee/vagrant-box-gcs
Vagrant plugin to download boxes from Google GCS.
https://github.com/arnaud-dezandee/vagrant-box-gcs
gcs google-cloud-storage vagrant vagrant-plugin
Last synced: about 1 month ago
JSON representation
Vagrant plugin to download boxes from Google GCS.
- Host: GitHub
- URL: https://github.com/arnaud-dezandee/vagrant-box-gcs
- Owner: arnaud-dezandee
- License: mit
- Created: 2020-05-25T12:52:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T10:55:56.000Z (about 2 years ago)
- Last Synced: 2024-11-05T03:05:08.187Z (3 months ago)
- Topics: gcs, google-cloud-storage, vagrant, vagrant-plugin
- Language: Ruby
- Size: 208 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vagrant Box Google Cloud Storage (GCS)
[](https://badge.fury.io/rb/vagrant-box-gcs)
This is a [Vagrant](http://www.vagrantup.com) 2.2.0+ plugin that adds the ability to download boxes from
[Google Compute Storage](http://cloud.google.com/storage/) (GCS).
## Installation
```bash
$ vagrant plugin install vagrant-box-gcs
```
## Usage
Only the `gs://` protocol shorthand is supported
The plugin supports fetching compatible manifest file of versioned boxes repository. See [packer-vagrant-box-gcs](https://github.com/arnaud-dezandee/packer-vagrant-box-gcs) to create one.
#### From versioned box:
```bash
$ vagrant box add gs://my-bucket/my-org/my-box-manifest.json
```
The `box update` command line is available when using manifest
```bash
$ vagrant box update --box my-org/my-box
```
```ruby
# Vagrantfile
Vagrant.configure('2') do |config|
config.vm.box = 'my-org/my-box'
config.vm.box_url = 'gs://my-bucket/my-org/my-box-manifest.json'
end
```
#### From simple box:
```bash
$ vagrant box add gs://my-bucket/my-org/my-box/virtualbox.box
```
```ruby
# Vagrantfile
Vagrant.configure('2') do |config|
config.vm.box_url = 'gs://my-bucket/my-org/my-box/virtualbox.box'
end
```
## Authentication
Authenticating with Google Cloud services requires at most one JSON file.
Vagrant will look for credentials in the following places, preferring the first location found:
1. A JSON file (Service Account) whose path is specified by the
`GOOGLE_APPLICATION_CREDENTIALS` environment variable.
2. A JSON file in a location known to the `gcloud` command-line tool.
(`gcloud auth application-default login` creates it)
On Windows, this is:
%APPDATA%/gcloud/application_default_credentials.json
On other systems:
$HOME/.config/gcloud/application_default_credentials.json
3. On Google Compute Engine and Google App Engine Managed VMs, it fetches
credentials from the metadata server. (Needs a correct VM authentication
scope configuration)
## Auto-install
Auto-install with some shell in your `Vagrantfile`:
```ruby
# Vagrantfile
unless Vagrant.has_plugin?('vagrant-box-gcs')
system('vagrant plugin install vagrant-box-gcs') || exit!
exit system('vagrant', *ARGV)
end
Vagrant.configure('2') do |config|
config.vm.box_url = 'gs://my-bucket/my-org/my-box/virtualbox.box'
# ...
end
```
## Related
- [packer-vagrant-box-gcs](https://github.com/arnaud-dezandee/packer-vagrant-box-gcs) - Packer plugin to upload Vagrant boxes to Google GCS.