Skip to content

Commit 344e32a

Browse files
author
nik mohamad aizuddin bin nik azmi
authored
docs(README): Add deployment diagram and getting started instructions
1 parent b74097a commit 344e32a

File tree

4 files changed

+46
-0
lines changed

4 files changed

+46
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,29 @@
33
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Build Status](https://travis-ci.com/extra2000/vagrant-basic.svg?branch=master)](https://travis-ci.com/extra2000/vagrant-basic)
44

55
Simple example on how to use Vagrant to create Centos 7 virtual machine.
6+
7+
![localhost](docs/resources/localhost.svg)
8+
9+
10+
## Prerequisites
11+
12+
You need to install [Vagrant](https://www.vagrantup.com/downloads). You may need to install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) if you want to use it as the provider for Vagrant. Otherwise, you can use [Libvirt](https://libvirt.org/downloads.html) on Linux or HyperV on Windows platforms.
13+
14+
15+
## Getting Started
16+
17+
Clone this repository:
18+
```
19+
$ git clone https://github.com/extra2000/vagrant-basic.git
20+
```
21+
22+
Then create Vagrant box named `centos-box` (you can change `--provider=virtualbox` to either `--provider=libvirt` or `--provider=hyperv`):
23+
```
24+
$ cd vagrant-basic
25+
$ vagrant up --provider=virtualbox
26+
```
27+
28+
29+
## More References
30+
31+
* [Example Usage](docs/example-usage.md)

docs/example-usage.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Example Usage
2+
3+
You can `ssh` into the `centos-box` using the following command:
4+
```
5+
$ vagrant ssh centos-box
6+
```
7+
8+
To shutdown `centos-box`:
9+
```
10+
$ vagrant halt centos-box
11+
```
12+
13+
To destroy `centos-box`:
14+
```
15+
$ vagrant destroy centos-box
16+
```

docs/resources/localhost.drawio

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

docs/resources/localhost.svg

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)