Skip to content

Commit 76c0f39

Browse files
Update documentation
1 parent 4bf130a commit 76c0f39

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,44 @@ Rancher is an open source project that provides infrastructure services designed
44

55
## Why?
66

7-
Implicitly most applications take advantage of storage and networking infrastructure services in one way or another. If you are running on AWS today and you are using any functionality from EBS, VPC, etc. you are effectively tying your application to AWS. While Docker provides a portable compute unit, Rancher.io aims to complete the picture by providing portable implementations of storage and networking.
7+
Implicitly most applications take advantage of storage and networking infrastructure services in one way or another. If you are running on AWS today and you are using any functionality from EBS, VPC, etc. you are effectively limiting the portability of your application. While Docker provides a portable compute unit, Rancher.io aims to complete the picture by providing portable implementations of storage and networking services.
88

99
## Installation
1010

11-
Start the management server
11+
Rancher is deployed as a set of Docker containers. Running Rancher is a simple as launching two containers. One container as the management server and another container on a node as an agent.
12+
13+
### Requirements
14+
15+
* Docker 1.3+
16+
* Ubuntu 14.04 or CoreOS 494+
17+
* *Note: These are the only tested distributions at the moment, but most modern Linux distributions will work*
18+
19+
### Management Server
1220

1321
docker run -d -p 8080:8080 rancher/server
1422

15-
Register a node by pointing it to the created management server
23+
### Register Docker Nodes
1624

1725
docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock rancher/agent http://MANAGEMENT_IP:8080
1826

1927
The UI/API is available on the exposed port 8080.
2028

2129
### Vagrant
2230

23-
Just run `vagrant up` and then access port 8080 for the UI.
31+
If you want to use Vagrant to run this on your laptop just clone the repo and to do `vagrant up` and then access port 8080 for the UI.
2432

2533
## UI
2634

2735
The UI is available by accessing the base HTTP URL of the management server. For example, http://server:8080
2836

37+
![UI](docs/host.png)
38+
2939
## API
3040

3141
The API is available by accessing the `/v1` HTTP path of the management server. For example, http://server:8080/v1
3242

43+
Rancher has its own API for infrastructure management tasks. For Docker related operations, the intention is to support the Docker CLI. That work is currently in progress.
44+
3345
## Status
3446

3547
We've just recently kicked off this project. Currently Rancher.io is able to provide a basic implementation of overlay networking and cross server Docker links. A lot of work has been done to put in a solid orchestration platform to control all the functionality we wish to do. Now that that framework is in place expect this project to produce a high amount of features over the next six months.

docs/host.png

54.4 KB
Loading

docs/hosts.png

74.4 KB
Loading

0 commit comments

Comments
 (0)