From 6d8a415b4d7a396b57b6013eb2c09df4397e03f4 Mon Sep 17 00:00:00 2001
From: Kevin Jing Qiu <kevin@idempotent.ca>
Date: Fri, 2 Jun 2017 20:09:37 -0400
Subject: [PATCH] Update doc on Vagrant local override file
---
docs/vagrant.md | 26 +++++++++++++++++++++++---
1 file changed, 23 insertions(+), 3 deletions(-)
diff --git a/docs/vagrant.md b/docs/vagrant.md
index ea08536d4..1b0073799 100644
--- a/docs/vagrant.md
+++ b/docs/vagrant.md
@@ -40,10 +40,30 @@ k8s-02 Ready 45s
k8s-03 Ready 45s
```
+Customize Vagrant
+=================
+
+You can override the default settings in the `Vagrantfile` either by directly modifying the `Vagrantfile`
+or through an override file.
+
+In the same directory as the `Vagrantfile`, create a folder called `vagrant` and create `config.rb` file in it.
+
+You're able to override the variables defined in `Vagrantfile` by providing the value in the `vagrant/config.rb` file,
+e.g.:
+
+ echo '$forwarded_ports = {8001 => 8001}' >> vagrant/config.rb
+
+and after `vagrant up` or `vagrant reload`, your host will have port forwarding setup with the guest on port 8001.
+
Use alternative OS for Vagrant
==============================
By default, Vagrant uses Ubuntu 16.04 box to provision a local cluster. You may use an alternative supported
-operating system for your local cluster. Change `$os` variable in `Vagrantfile` to another operating system to change
-the vagrant base box. The supported operating systems for vagrant are defined in the `SUPPORTED_OS` constant in
-the `Vagrantfile`.
+operating system for your local cluster.
+
+Customize `$os` variable in `Vagrantfile` or as override, e.g.,:
+
+ echo '$os = "coreos-stable"' >> vagrant/config.rb
+
+
+The supported operating systems for vagrant are defined in the `SUPPORTED_OS` constant in the `Vagrantfile`.
--
GitLab