Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextrevision/rancher-vagrant
Extensible and automated local Rancher environments using Vagrant
https://github.com/nextrevision/rancher-vagrant
Last synced: about 1 month ago
JSON representation
Extensible and automated local Rancher environments using Vagrant
- Host: GitHub
- URL: https://github.com/nextrevision/rancher-vagrant
- Owner: nextrevision
- License: apache-2.0
- Created: 2016-05-25T01:43:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-05-28T13:43:31.000Z (over 8 years ago)
- Last Synced: 2024-11-01T15:44:01.920Z (about 1 month ago)
- Language: Ruby
- Size: 19.5 KB
- Stars: 18
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rancher - Rancher Vagrant - Extensible and automated local Rancher environments using Vagrant (Rancher 1.0 / Community projects 1.0)
README
# rancher-vagrant
Extensible and automated local Rancher environments using Vagrant
## Usage
```
git clone https://github.com/nextrevision/rancher-vagrant
cd rancher-vagrant
vagrant up
```
Assuming the defaults, browse to [http://192.168.33.11:8080](http://192.168.33.11:8080) to access your Rancher server.
## Configuration
You can configure the environment by setting up a custom `config.rb` file in the root of the repository. The available configuration options to you are displayed below:
| Item | Type | Required | Default | Description |
|------------------------|----------|----------|---------------------|--------------------------------------------------------------------------|
| `$box` | *string* | false | rancherio/rancheros | Vagrant box to use for the environment |
| `$box_url` | *string* | false | `nil` | URL to download the box |
| `$box_version` | *string* | false | `nil` | Version of the box to download |
| `$disable_folder_sync` | *bool* | false | `true` | Disable syncing the current working directory to "/vagrant" on the guest |
| `$ip_prefix` | *string* | false | 192.168.33 | Prefix for all IPs assigned to the guests |
| `$rancher_version` | *string* | false | latest | Version of Rancher to deploy |
| `$boxes` | *array* | true | `[]` | List of boxes (see [Boxes](#boxes) table below) |
### Boxes
| Item | Type | Required | Default | Description |
|-----------------|----------|----------|------------------------------------------------|---------------------------------------------------------------------------------------|
| `name` | *string* | true | | Base name of the box |
| `count` | *string* | false | 1 | Number of guests to create with this config |
| `role` | *string* | false | agent | Role of the box (either "server" or "agent", at least one "server" must be specified) |
| `memory` | *string* | false | 512 | Amount of memory to dedicate to the box (for RancherOS, at least 512 is recommended) |
| `ip` | *string* | false | | IP address to assign to the box (typically best to leave this alone) |
| `install_agent` | *bool* | false | `true` if role==agent, `false` if role==server | Whether or not to run the Rancher agent on the guest |
| `project` | *string* | false | `nil` | Name of the Rancher project or environment to place the box in |
| `project_type` | *string* | false | cattle | Type of project to for the Rancher environment (cattle, swarm, kubernetes) |
| `server` | *string* | false | | Hostname or IP address of the Rancher server to join |
## Example
See [config_sample.rb](config_sample.rb)