Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dcermak/obs-to-vagrantcloud
Script to upload vagrant boxes from the Open Build Service to Vagrant Cloud
https://github.com/dcermak/obs-to-vagrantcloud
open-build-service vagrant vagrant-cloud
Last synced: about 1 hour ago
JSON representation
Script to upload vagrant boxes from the Open Build Service to Vagrant Cloud
- Host: GitHub
- URL: https://github.com/dcermak/obs-to-vagrantcloud
- Owner: dcermak
- License: gpl-3.0
- Created: 2020-11-17T13:49:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T14:59:27.000Z (almost 2 years ago)
- Last Synced: 2024-12-14T05:27:33.833Z (about 2 months ago)
- Topics: open-build-service, vagrant, vagrant-cloud
- Language: Ruby
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# obs-to-vagrantcloud
[](https://github.com/dcermak/obs-to-vagrantcloud/actions/workflows/rubocop.yml)
This is a very simple script that either uploads or links a Vagrant box that has
been build and published in the [Open Build
Service](https://openbuildservice.org/) to [Vagrant
Cloud](https://app.vagrantup.com/).
## Prerequisites
You need a Vagrant box that is being build in the Open Build Service and
published with the repository type `vagrant` set in the project configuration.
This script itself requires ruby and the gems listed in the `gemspec`, install
these preferably via bundler:
```ShellSession
$ bundle install --path vendor
```
## Usage
First, you'll have to get the link to the json file that is produced by the Open
Build Service when publishing your Vagrant box. To obtain it, navigate to the
published repository and into the `boxes` subdirectory. It will contain at least
one `*.json` file. Find the correct one and save its URL.
Furthermore, you have to obtain an API Key for Vagrant Cloud from
https://app.vagrantup.com/settings/security and export it as the environment
variable `ATLAS_TOKEN`.
There are two possible modes of operation:
1. Linking - the box is published on Vagrant Cloud, but not uploaded there.
Instead, vagrant will be redirected to your Open Build Service instance.
To use this mode, add the flag `--link`
2. Upload - the box will be published and uploaded to Vagrant Cloud.
Usage:
```ShellSession
$ export ATLAS_TOKEN='YOUR_API_KEY'
$ bundle exec ./obs-to-vagrantcloud.rb --url INSERT_URL_TO_BOX_JSON --organization NAME_OF_YOUR_ORGANIZATION
```
Additional options:
- `--name NEW_BOX_NAME` Override the name of the Vagrant box.
This can be used to specify better box names as OBS can sometimes create pretty long ones.
- `--link`: The box will only be linked to Vagrant Cloud and not uploaded there.
- `--provider PROVIDER` Only upload the specified provider and not others that
are present in the boxes' json file.
**NOTE** This option is not available when linking boxes! It does not really
make sense to link individual providers, as OBS only keeps exactly those
builds around that are mentioned in the json.
## Linking or Uploading?
The general recommendation is to upload your boxes to Vagrant Cloud if your
local Internet connection allows that. The disadvantage of linking is, that the
Open Build Service only keeps the last version rebuild of each image around. So
you must continuously run this script to ensure that Vagrant Cloud has the
latest version available, otherwise users of your box will get a 404 from time
to time.