Skip to content

Commit

Permalink
#2935: README.md, replace 'vagrant' with 'rancher'
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff1evesque committed Feb 20, 2018
1 parent 185aa93 commit a107dd6
Showing 1 changed file with 65 additions and 22 deletions.
87 changes: 65 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,39 +39,82 @@ Fork this project, and remember to [generate](https://github.com/jeff1evesque/ma

## Installation

In order to proceed with the installation for this project, two dependencies
need to be installed:
In order to proceed with the installation for this project, docker must be installed:

- [Vagrant](https://www.vagrantup.com/)
- [Virtualbox](https://www.virtualbox.org/) (with extension pack)
### Legacy: Windows
- [docker toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/): allows Docker use on systems
that do not meet [Docker for Windows](https://docs.docker.com/docker-for-windows/) minimal system requirements.

### Community Edition
- [windows](https://docs.docker.com/docker-for-windows/install/#download-docker-for-windows)
- [ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
- [centos](https://docs.docker.com/install/linux/docker-ce/centos/)
- [mac](https://docs.docker.com/docker-for-mac/install/)

**Note:** if the host machine is windows, then [cygwin](https://www.cygwin.com/) will need to
be installed, in order for the `make build` command to succeed installing `rancher-compose`.

Once the necessary dependencies have been installed, execute the following
command to build the virtual environment:
within the docker quickstart terminal, to install [rancher](https://rancher.com/):

```bash
cd /path/to/machine-learning/
vagrant up
```

Depending on the network speed, the build can take between 10-15 minutes. So,
grab a cup of coffee, and perhaps enjoy a danish while the virtual machine
builds. Remember, the application is intended to run on localhost, where the
[`Vagrantfile`](https://github.com/jeff1evesque/machine-learning/blob/master/Vagrantfile)
defines the exact port-forward on the host machine.

**Note:** a more complete refresher on virtualization, can be found within the
vagrant [wiki page](https://github.com/jeff1evesque/machine-learning/wiki/Vagrant).

The following lines, indicate the application is accessible via `localhost:8080`,
on the host machine:
## .
## ## ## ==
## ## ## ## ## ===
/"""""""""""""""""\___/ ===
~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~
\______ o __/
\ \ __/
\____\_______/
docker is configured to use the default machine with IP 192.168.99.100
For help getting started, check out the docs at https://docs.docker.com
Start interactive shell
jeff1evesque@XXXXXXX YYYYYZZ ~
$ cd /path/to/machine-learning
jeff1evesque@XXXXXXX YYYYYZZ /path/to/machine-learning (feature-2935)
$ ./install_rancher
Unable to find image 'rancher/server:latest' locally
latest: Pulling from rancher/server
bae382666908: Pull complete
29ede3c02ff2: Pull complete
da4e69f33106: Pull complete
8d43e5f5d27f: Pull complete
b0de1abb17d6: Pull complete
422f47db4517: Pull complete
79d37de643ce: Pull complete
69d13e08a4fe: Pull complete
2ddfd3c6a2b7: Pull complete
bc433fed3823: Pull complete
b82e188df556: Pull complete
dae2802428a4: Pull complete
a6247572ea3c: Pull complete
884c916ebae4: Pull complete
85517c9c5365: Pull complete
02dded9fe690: Pull complete
fd9f433c3bc6: Pull complete
44d91b3fea45: Pull complete
0d463387dfeb: Pull complete
60753c4d26f0: Pull complete
a003892966fe: Pull complete
Digest: sha256:42441f0128fae4d72d51f92de2049392427d462356282a46f28434332967c7e4
Status: Downloaded newer image for rancher/server:latest
57e7f8577c7a80d8ea10d1b0855de619c4ec9ad0318172b1f52e70006b99afa6
```
The following lines, from our `docker-compose.development.yml` indicate corresponding port forwards:
```bash
...
## Create a forwarded port mapping which allows access to a specific port
## within the machine from a port on the host machine. In the example below,
## accessing "localhost:8080" will access port 80 on the guest machine.
main.vm.network 'forwarded_port', guest: 5000, host: 8080
main.vm.network 'forwarded_port', guest: 6000, host: 9090
ports:
- "5000:8080"
- "6000:9090"
...
```
Expand Down

0 comments on commit a107dd6

Please sign in to comment.