Merge pull request #13 from BigBitBusInc/documentation/vagrant-cmds

Documentation/vagrant cmds

Author: bigbitbus

README.md

@@ -1,8 +1,10 @@
-<center>
-<img src="documentation/images/kubernetes-application.svg"  alt="BigBitBus KAT components" width="400"/>
-</center>
+<div align="center">
+    <h1> BigBitBus KAT Components</h1>
+    <img src="documentation/images/kubernetes-application.svg"  alt="BigBitBus KAT components" width="400"/>
 
-**Components of the BigBitBus KAT application code. Click on the diagram to enlarge, or follow [this link](documentation/) for detailed documentation**
+<!-- **Components of the BigBitBus KAT application code. Click on the diagram to enlarge, or follow [this link](documentation/) for detailed documentation** -->
+**Click on the diagram to enlarge, or follow [this link](documentation/) for detailed documentation** 
+</div>
 
 # Introduction
 
@@ -16,7 +18,6 @@ Most components of the Kubernetes cloud native ecosystem are extremely well docu
 
 From here, we recommend you start with a [review of some Kubernetes and related concepts](./documentation/) we have put together. Or, if you want to directly go to the code and examples you can navigate the folders in the repository, the table below will launch you right in.
 
-
 # What is where?
 
 | Category | File or Directory  | Description |
@@ -28,6 +29,12 @@ From here, we recommend you start with a [review of some Kubernetes and related
 | Monitoring | [code/k8s-common-code/monitoring](code/k8s-common-code/monitoring) |Installing and configuring monitoring with Prometheus and Grafana into the Kubernetes cluster using standard Helm charts created by the Prometheus community |
 | Kubernetes Dashboard | [code/k8s-common-code/k8sdashboard](code/k8s-common-code/k8sdashboard) | Deploying the Kubernetes dashboard, a browser-based GUI view of the Kubernetes cluster |
 
+# Deploy KAT Project
+| Deployment | File or Directory | Description |
+|---|---|---|
+| Cloud Native | [documentation/cloudvm.md](./documentation/cloudvm.md) | Deploy KAT on a Cloud |
+| Local System | [documentation/quickstart-vagrant.md](./documentation/quickstart-vagrant.md) | Deploy KAT on your Local System|
+
 # License
 
 All code and configuration in the BigBitBus KAT repository (code files contained in this directory and all subdirectories) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).

documentation/cloudvm.md

@@ -35,11 +35,11 @@ For example (Mac, Linux)
 ssh -i private_key_file theuser@publicip -L 8080:localhost:80 -N
 ```
 
-For Windows, see [this file](windows-setup.md) on how to setup Putty for port forwarding.
+For Windows, see [this file](putty-setup.md) on how to setup Putty for port forwarding.
 
  You can now open a web-browser and reach these end-points
   - Todo application Vuejs Frontend [http://localhost:8080/frontend/](http://localhost:8080/frontend/) [Learn more](../code/app-code/frontend/todo-vuejs/)
-  - Todo application browsable API [http://localhost:8080/djangoapi/api/v1/](http://localhost:8080/djangoapi/api/v1) [Learn more](../code/app-code/api/todo-python-django/)
+  - Todo application browsable API [http://localhost:8080/djangoapi/apis/v1/](http://localhost:8080/djangoapi/apis/v1) [Learn more](../code/app-code/api/todo-python-django/)
   - Kubernetes Dashboard [http://localhost:8080/dashboard/](http://localhost:8080/dashboard/) [Learn more](../code/k8s-common-code/k8sdashboard/) (Access token is printed in the Vagrant output as mentioned above).
   - Grafana Monitoring [http://localhost:8080/monitoring-grafana/](http://localhost:8080/monitoring-grafana/) [Learn more](../code/k8s-common-code/monitoring/) (default credentials: admin/promoperator)
 

documentation/windows-setup.md renamed to documentation/putty-setup.md

@@ -1,4 +1,4 @@
-### This README goes over the steps needed to connect to the cloud VM and display the KAT example on your local Windows machine. You don't need this if you used Vagrant on your local machine.
+### Connect to Cloud VM from your Local Windows Machine using Port Forwarding Technique.
 
 Requirements:
 - Putty

documentation/quickstart-vagrant.md

@@ -4,8 +4,7 @@ Follow these steps to quickly deploy the KAT example. You will need a PC with at
 
 1. Clone this repository: `git clone https://github.com/BigBitBusInc/kubernetes-automation-toolkit.git`
 
-2. Install Vagrant for your OS (Vagrant supports Windows, Linux and MacOS); you may also need to install the hypervisor software and a vagrant plugin for this hypervisor on your platform; you should also find this information on the Vagrant installation page for your OS. [This link](https://gist.github.com/wpscholar/a49594e2e2b918f4d0c4) lists some useful Vagrant commands.
-
+2. Install `Vagrant` for your OS (Vagrant supports Windows, Linux and MacOS); you may also need to install the hypervisor software and a vagrant plugin for this hypervisor on your platform; We have [guidelines](../documentation/vagrant-setup.md) on how to setup Vagrant on your PC. 
 3. Navigate to the root directory of the KAT repository and enter this command in a terminal
 ```bash
 cd kubernetes-automation-toolkit
@@ -16,7 +15,7 @@ Please be patient, even on a fast Internet connection remember we are downloadin
 
 3.   You can now open a web-browser and reach these end-points
   - Todo application Vuejs Frontend [http://localhost:8080/frontend/](http://localhost:8080/frontend/) [Learn more](../code/app-code/frontend/todo-vuejs/)
-  - Todo application browsable API [http://localhost:8080/djangoapi/api/v1/](http://localhost:8080/djangoapi/api/v1) [Learn more](../code/app-code/api/todo-python-django/)
+  - Todo application browsable API [http://localhost:8080/djangoapi/apis/v1/](http://localhost:8080/djangoapi/apis/v1) [Learn more](../code/app-code/api/todo-python-django/)
   - Kubernetes Dashboard [http://localhost:8080/dashboard/](http://localhost:8080/dashboard/) [Learn more](../code/k8s-common-code/k8sdashboard/) (Access token is printed in the Vagrant output as mentioned above).
   - Grafana Monitoring [http://localhost:8080/monitoring-grafana/](http://localhost:8080/monitoring-grafana/) [Learn more](../code/k8s-common-code/monitoring/) (default credentials: admin/promoperator)
 
@@ -51,7 +50,7 @@ Confirm that you can now log into the Vagrant VM by simply typing `vagrant ssh`
    ssh vagrant-vm-name-in-ssh-config -L 8080:localhost:80 -N
    ```
 
-   For Windows you can look at some of the screenshots in [this file](windows-setup.md) to get an idea of how to set ssh port-forwarding  with [Putty](https://www.putty.org/).
+   For Windows you can look at some of the screenshots in [this file](putty-setup.md) to get an idea of how to set ssh port-forwarding  with [Putty](https://www.putty.org/).
 
 
 Here are links to some useful documentation of different tools that are used in the KAT example.
@@ -75,3 +74,15 @@ To destroy the Vagrant VM, open a terminal and go to the kubernetes-automation-t
 ```
 vagrant destroy
 ```
+## Useful Vagrant Commands
+| Vagrant | Cmd |
+| ---- | ---------- |
+| Start Vagrant Environment | `vagrant up` |
+| Connect to Vagrant via SSH | `vagrant ssh` |
+| Stop Vagrant Machine | `vagrant halt` |
+| Resume Vagrant Machine | `vagrant resume` |
+| Suspend Virtual Machine | `vagrant suspend` |
+| List Installed Boxes | `vagrant box list`|
+| Delete Vagrant Machine | `vagrant destroy` |
+
+[This link](https://gist.github.com/wpscholar/a49594e2e2b918f4d0c4) lists some useful Vagrant commands.

documentation/vagrant-setup.md

@@ -0,0 +1,24 @@
+## Setup Vagrant on Windows
+
+1. Install `VirtualBox`. Vagrant requires VirtualBox to create Virtual Machine. Navigate to https://www.virtualbox.org/wiki/Downloads to Download Virtual Box.
+
+2. Install `Vagrant`. Navigate to https://www.vagrantup.com/downloads to download latest version of Vagrant.
+
+3. Install `Putty`. Navigate to https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html to download latest version of putty.
+
+
+## Setup Vagrant on Mac
+
+1. Install `Virtual box` using [direct download](https://www.virtualbox.org/wiki/Downloads) or use homebrew for installing it.<br/> `brew cask install virtualbox`
+
+2. Install `Vagrant` using [direct download](https://www.vagrantup.com/downloads.html) or use homebrew for installing it.<br/> `brew cask install vagrant`
+
+
+## Setup Vagrant on Linux
+1. Install `Virtual box` by running: <br> `sudo apt update` <br> `sudo apt install virtualbox`
+
+2. Download `Vagrant` Package with wget: <br> `curl -O https://releases.hashicorp.com/vagrant/2.2.14/vagrant_2.2.14_x86_64.deb`
+
+3. Install Downloaded File by typing: <br> `sudo apt install ./vagrant_2.2.14_x86_64.deb`
+
+4. Verify installation using: <br> `vagrant --version`