{"action":"created","comment":{"url":"https://api.github.com/repos/axsh/openvnet/pulls/comments/30218028","id":30218028,"diff_hunk":"@@ -1,424 +1,358 @@\n-# OpenVNet #\n \n-# Preliminary Operations and Installation #\n+# OpenVNet Installation Guide\n \n-> **Note:**\n-This document explains the installation of OpenVNet.  However, it was\n-written for an older version of OpenVNet and does not apply\n-to the current version.  We plan to update this guide soon.  Until\n-then, we are leaving this guide here and hope it will be useful for those\n-who wish to learn more about the components that make up OpenVNet.\n+## Overview\n \n \n-Installation Requirements\n--------------------------\n+Welcome to the world of OpenVNet! With this installation guide we help you\n+create a very simple yet innovative virtual network environment.\n \n-### System Requirements\n+![vnet_minimum](https://www.dropbox.com/s/dezarv561fg7sdj/vnet_minimum.png?dl=1)\n+\n+On a given server (here named as server1) there is one virtual network whose network address is 10.100.0.0/24 and 2 virtual machines joining it.\n+The orange circles describe OpenVNet's ruby processes; vna, vnmgr and webapi.\n+See architecture for more detail of how the OpenVNet works.\n+\n+\n+## Requirements\n \n-+ RHEL 6.4\n-+ Kernel 2.6.32-358.6.2.el6.x86_64\n \n ### Network Requirements\n \n + Local Area Network (LAN)\n + Internet connection\n \n-Pre-setup\n----------\n+## Installation\n \n-Download the openvnet.repo file and put it to your /etc/yum.repos.d/ directory.\n+### Install OpenVNet Packages\n+\n+Download the openvnet.repo file and put it to your `/etc/yum.repos.d/` directory.\n \n     # curl -o /etc/yum.repos.d/openvnet.repo -R https://raw.githubusercontent.com/axsh/openvnet/master/openvnet.repo\n \n-Download the openvnet-third-party.repo file and put it in your /etc/yum.repos.d/ directory.\n+Download the openvnet-third-party.repo file and put it in your `/etc/yum.repos.d/` directory.\n \n     # curl -o /etc/yum.repos.d/openvnet-third-party.repo -R https://raw.githubusercontent.com/axsh/openvnet/master/openvnet-third-party.repo\n \n-Install epel-release.\n+Each repo has the following packages:\n \n-    # rpm -Uvh http://dlc.wakame.axsh.jp.s3-website-us-east-1.amazonaws.com/epel-release\n+* openvnet.repo\n+  * openvnet (metapackage)\n+  * openvnet-common\n+  * openvnet-vna\n+  * openvnet-vnmgr\n+  * openvnet-webapi\n \n+* openvnet-third-party.repo\n+  * openvnet-ruby\n+  * openvswitch\n \n-OpenVNet installation\n-------------------------\n+Install epel-release.\n+\n+    # yum install -y epel-release\n \n-Install OpenVNet.\n+\n+Install OpenVNet packages.\n \n     # yum install -y openvnet\n \n-Initial Configuration\n----------------------\n+`openvnet` is a metapackage. It is equivalent to installing `openvnet-common`,\n+`openvnet-vna`, `openvnet-vnmgr` and `openvnet-webapi` at once.\n \n-### Setup vnmgr\n+### Edit Configuration Files\n \n-Modify the following section in /etc/openvnet/vnmgr.conf on the vnmgr node.\n+Edit the file `/etc/openvnet/vnmgr.conf`\n \n     node {\n       id \"vnmgr\"\n       addr {\n         protocol \"tcp\"\n-        host \"192.168.100.2\"\n+        host \"127.0.0.1\"\n+        public \"\"\n         port 9102\n       }\n     }\n \n-- **host** : The IP address or host name of the ZeroMQ node.\n-- **port** : The port number for connecting with ZeroMQ. If the vnmgr process is run on the same node as vna or webapi, specify a different value from vna and webapi.\n+Modify the parameters `host` and `public` according to your environment. In order for\n+the sample environment in the overview section we leave those parameters as is. The detail of each parameter is following.\n \n+- **id** : OpenVNet uses the [0mq](http://zeromq.org) protocol for communication between its processes. This id is used by 0mq to identify each process. Any string here is fine as long as there's no two processes using the same one. It's recommended to just use the default values.","path":"docs/InstallGuide.md","position":108,"original_position":108,"commit_id":"ec05c18fffb8f8a8403b7c50eddafe598c814d7a","original_commit_id":"ec05c18fffb8f8a8403b7c50eddafe598c814d7a","user":{"login":"Metallion","id":629110,"avatar_url":"https://avatars.githubusercontent.com/u/629110?v=3","gravatar_id":"","url":"https://api.github.com/users/Metallion","html_url":"https://github.com/Metallion","followers_url":"https://api.github.com/users/Metallion/followers","following_url":"https://api.github.com/users/Metallion/following{/other_user}","gists_url":"https://api.github.com/users/Metallion/gists{/gist_id}","starred_url":"https://api.github.com/users/Metallion/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metallion/subscriptions","organizations_url":"https://api.github.com/users/Metallion/orgs","repos_url":"https://api.github.com/users/Metallion/repos","events_url":"https://api.github.com/users/Metallion/events{/privacy}","received_events_url":"https://api.github.com/users/Metallion/received_events","type":"User","site_admin":false},"body":"I know I'm the one who suggested to use the word processes but reading it again, I feel like it might not be clear to a general reader. Perhaps a good idea to add a line above the parameter list saying \"Below we will be using the word *processes* to refer collectively to vnmgr, vna and webapi.\"","created_at":"2015-05-13T10:14:22Z","updated_at":"2015-05-13T10:14:22Z","html_url":"https://github.com/axsh/openvnet/pull/287#discussion_r30218028","pull_request_url":"https://api.github.com/repos/axsh/openvnet/pulls/287","_links":{"self":{"href":"https://api.github.com/repos/axsh/openvnet/pulls/comments/30218028"},"html":{"href":"https://github.com/axsh/openvnet/pull/287#discussion_r30218028"},"pull_request":{"href":"https://api.github.com/repos/axsh/openvnet/pulls/287"}}},"pull_request":{"url":"https://api.github.com/repos/axsh/openvnet/pulls/287","id":32193195,"html_url":"https://github.com/axsh/openvnet/pull/287","diff_url":"https://github.com/axsh/openvnet/pull/287.diff","patch_url":"https://github.com/axsh/openvnet/pull/287.patch","issue_url":"https://api.github.com/repos/axsh/openvnet/issues/287","number":287,"state":"open","locked":false,"title":"Doc update","user":{"login":"akry","id":860424,"avatar_url":"https://avatars.githubusercontent.com/u/860424?v=3","gravatar_id":"","url":"https://api.github.com/users/akry","html_url":"https://github.com/akry","followers_url":"https://api.github.com/users/akry/followers","following_url":"https://api.github.com/users/akry/following{/other_user}","gists_url":"https://api.github.com/users/akry/gists{/gist_id}","starred_url":"https://api.github.com/users/akry/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/akry/subscriptions","organizations_url":"https://api.github.com/users/akry/orgs","repos_url":"https://api.github.com/users/akry/repos","events_url":"https://api.github.com/users/akry/events{/privacy}","received_events_url":"https://api.github.com/users/akry/received_events","type":"User","site_admin":false},"body":"","created_at":"2015-03-30T01:46:21Z","updated_at":"2015-05-13T10:14:22Z","closed_at":null,"merged_at":null,"merge_commit_sha":"b7b96adc0e158f671ed68ade929a8c9647406283","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/axsh/openvnet/pulls/287/commits","review_comments_url":"https://api.github.com/repos/axsh/openvnet/pulls/287/comments","review_comment_url":"https://api.github.com/repos/axsh/openvnet/pulls/comments{/number}","comments_url":"https://api.github.com/repos/axsh/openvnet/issues/287/comments","statuses_url":"https://api.github.com/repos/axsh/openvnet/statuses/ec05c18fffb8f8a8403b7c50eddafe598c814d7a","head":{"label":"axsh:doc-update","ref":"doc-update","sha":"ec05c18fffb8f8a8403b7c50eddafe598c814d7a","user":{"login":"axsh","id":95230,"avatar_url":"https://avatars.githubusercontent.com/u/95230?v=3","gravatar_id":"","url":"https://api.github.com/users/axsh","html_url":"https://github.com/axsh","followers_url":"https://api.github.com/users/axsh/followers","following_url":"https://api.github.com/users/axsh/following{/other_user}","gists_url":"https://api.github.com/users/axsh/gists{/gist_id}","starred_url":"https://api.github.com/users/axsh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/axsh/subscriptions","organizations_url":"https://api.github.com/users/axsh/orgs","repos_url":"https://api.github.com/users/axsh/repos","events_url":"https://api.github.com/users/axsh/events{/privacy}","received_events_url":"https://api.github.com/users/axsh/received_events","type":"Organization","site_admin":false},"repo":{"id":9443209,"name":"openvnet","full_name":"axsh/openvnet","owner":{"login":"axsh","id":95230,"avatar_url":"https://avatars.githubusercontent.com/u/95230?v=3","gravatar_id":"","url":"https://api.github.com/users/axsh","html_url":"https://github.com/axsh","followers_url":"https://api.github.com/users/axsh/followers","following_url":"https://api.github.com/users/axsh/following{/other_user}","gists_url":"https://api.github.com/users/axsh/gists{/gist_id}","starred_url":"https://api.github.com/users/axsh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/axsh/subscriptions","organizations_url":"https://api.github.com/users/axsh/orgs","repos_url":"https://api.github.com/users/axsh/repos","events_url":"https://api.github.com/users/axsh/events{/privacy}","received_events_url":"https://api.github.com/users/axsh/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/axsh/openvnet","description":"Data Center Level Virtual Network Toolkit based on Edge Overlaid Network using OpenFlow 1.3.","fork":false,"url":"https://api.github.com/repos/axsh/openvnet","forks_url":"https://api.github.com/repos/axsh/openvnet/forks","keys_url":"https://api.github.com/repos/axsh/openvnet/keys{/key_id}","collaborators_url":"https://api.github.com/repos/axsh/openvnet/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/axsh/openvnet/teams","hooks_url":"https://api.github.com/repos/axsh/openvnet/hooks","issue_events_url":"https://api.github.com/repos/axsh/openvnet/issues/events{/number}","events_url":"https://api.github.com/repos/axsh/openvnet/events","assignees_url":"https://api.github.com/repos/axsh/openvnet/assignees{/user}","branches_url":"https://api.github.com/repos/axsh/openvnet/branches{/branch}","tags_url":"https://api.github.com/repos/axsh/openvnet/tags","blobs_url":"https://api.github.com/repos/axsh/openvnet/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/axsh/openvnet/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/axsh/openvnet/git/refs{/sha}","trees_url":"https://api.github.com/repos/axsh/openvnet/git/trees{/sha}","statuses_url":"https://api.github.com/repos/axsh/openvnet/statuses/{sha}","languages_url":"https://api.github.com/repos/axsh/openvnet/languages","stargazers_url":"https://api.github.com/repos/axsh/openvnet/stargazers","contributors_url":"https://api.github.com/repos/axsh/openvnet/contributors","subscribers_url":"https://api.github.com/repos/axsh/openvnet/subscribers","subscription_url":"https://api.github.com/repos/axsh/openvnet/subscription","commits_url":"https://api.github.com/repos/axsh/openvnet/commits{/sha}","git_commits_url":"https://api.github.com/repos/axsh/openvnet/git/commits{/sha}","comments_url":"https://api.github.com/repos/axsh/openvnet/comments{/number}","issue_comment_url":"https://api.github.com/repos/axsh/openvnet/issues/comments{/number}","contents_url":"https://api.github.com/repos/axsh/openvnet/contents/{+path}","compare_url":"https://api.github.com/repos/axsh/openvnet/compare/{base}...{head}","merges_url":"https://api.github.com/repos/axsh/openvnet/merges","archive_url":"https://api.github.com/repos/axsh/openvnet/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/axsh/openvnet/downloads","issues_url":"https://api.github.com/repos/axsh/openvnet/issues{/number}","pulls_url":"https://api.github.com/repos/axsh/openvnet/pulls{/number}","milestones_url":"https://api.github.com/repos/axsh/openvnet/milestones{/number}","notifications_url":"https://api.github.com/repos/axsh/openvnet/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/axsh/openvnet/labels{/name}","releases_url":"https://api.github.com/repos/axsh/openvnet/releases{/id}","created_at":"2013-04-15T07:36:18Z","updated_at":"2015-04-03T09:07:55Z","pushed_at":"2015-05-12T08:07:09Z","git_url":"git://github.com/axsh/openvnet.git","ssh_url":"git@github.com:axsh/openvnet.git","clone_url":"https://github.com/axsh/openvnet.git","svn_url":"https://github.com/axsh/openvnet","homepage":"http://openvnet.org","size":8936,"stargazers_count":39,"watchers_count":39,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":4,"mirror_url":null,"open_issues_count":33,"forks":4,"open_issues":33,"watchers":39,"default_branch":"develop"}},"base":{"label":"axsh:master","ref":"master","sha":"8234ab5b8d1d77e457b49d5a2bdb6bcdc0b1c983","user":{"login":"axsh","id":95230,"avatar_url":"https://avatars.githubusercontent.com/u/95230?v=3","gravatar_id":"","url":"https://api.github.com/users/axsh","html_url":"https://github.com/axsh","followers_url":"https://api.github.com/users/axsh/followers","following_url":"https://api.github.com/users/axsh/following{/other_user}","gists_url":"https://api.github.com/users/axsh/gists{/gist_id}","starred_url":"https://api.github.com/users/axsh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/axsh/subscriptions","organizations_url":"https://api.github.com/users/axsh/orgs","repos_url":"https://api.github.com/users/axsh/repos","events_url":"https://api.github.com/users/axsh/events{/privacy}","received_events_url":"https://api.github.com/users/axsh/received_events","type":"Organization","site_admin":false},"repo":{"id":9443209,"name":"openvnet","full_name":"axsh/openvnet","owner":{"login":"axsh","id":95230,"avatar_url":"https://avatars.githubusercontent.com/u/95230?v=3","gravatar_id":"","url":"https://api.github.com/users/axsh","html_url":"https://github.com/axsh","followers_url":"https://api.github.com/users/axsh/followers","following_url":"https://api.github.com/users/axsh/following{/other_user}","gists_url":"https://api.github.com/users/axsh/gists{/gist_id}","starred_url":"https://api.github.com/users/axsh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/axsh/subscriptions","organizations_url":"https://api.github.com/users/axsh/orgs","repos_url":"https://api.github.com/users/axsh/repos","events_url":"https://api.github.com/users/axsh/events{/privacy}","received_events_url":"https://api.github.com/users/axsh/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/axsh/openvnet","description":"Data Center Level Virtual Network Toolkit based on Edge Overlaid Network using OpenFlow 1.3.","fork":false,"url":"https://api.github.com/repos/axsh/openvnet","forks_url":"https://api.github.com/repos/axsh/openvnet/forks","keys_url":"https://api.github.com/repos/axsh/openvnet/keys{/key_id}","collaborators_url":"https://api.github.com/repos/axsh/openvnet/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/axsh/openvnet/teams","hooks_url":"https://api.github.com/repos/axsh/openvnet/hooks","issue_events_url":"https://api.github.com/repos/axsh/openvnet/issues/events{/number}","events_url":"https://api.github.com/repos/axsh/openvnet/events","assignees_url":"https://api.github.com/repos/axsh/openvnet/assignees{/user}","branches_url":"https://api.github.com/repos/axsh/openvnet/branches{/branch}","tags_url":"https://api.github.com/repos/axsh/openvnet/tags","blobs_url":"https://api.github.com/repos/axsh/openvnet/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/axsh/openvnet/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/axsh/openvnet/git/refs{/sha}","trees_url":"https://api.github.com/repos/axsh/openvnet/git/trees{/sha}","statuses_url":"https://api.github.com/repos/axsh/openvnet/statuses/{sha}","languages_url":"https://api.github.com/repos/axsh/openvnet/languages","stargazers_url":"https://api.github.com/repos/axsh/openvnet/stargazers","contributors_url":"https://api.github.com/repos/axsh/openvnet/contributors","subscribers_url":"https://api.github.com/repos/axsh/openvnet/subscribers","subscription_url":"https://api.github.com/repos/axsh/openvnet/subscription","commits_url":"https://api.github.com/repos/axsh/openvnet/commits{/sha}","git_commits_url":"https://api.github.com/repos/axsh/openvnet/git/commits{/sha}","comments_url":"https://api.github.com/repos/axsh/openvnet/comments{/number}","issue_comment_url":"https://api.github.com/repos/axsh/openvnet/issues/comments{/number}","contents_url":"https://api.github.com/repos/axsh/openvnet/contents/{+path}","compare_url":"https://api.github.com/repos/axsh/openvnet/compare/{base}...{head}","merges_url":"https://api.github.com/repos/axsh/openvnet/merges","archive_url":"https://api.github.com/repos/axsh/openvnet/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/axsh/openvnet/downloads","issues_url":"https://api.github.com/repos/axsh/openvnet/issues{/number}","pulls_url":"https://api.github.com/repos/axsh/openvnet/pulls{/number}","milestones_url":"https://api.github.com/repos/axsh/openvnet/milestones{/number}","notifications_url":"https://api.github.com/repos/axsh/openvnet/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/axsh/openvnet/labels{/name}","releases_url":"https://api.github.com/repos/axsh/openvnet/releases{/id}","created_at":"2013-04-15T07:36:18Z","updated_at":"2015-04-03T09:07:55Z","pushed_at":"2015-05-12T08:07:09Z","git_url":"git://github.com/axsh/openvnet.git","ssh_url":"git@github.com:axsh/openvnet.git","clone_url":"https://github.com/axsh/openvnet.git","svn_url":"https://github.com/axsh/openvnet","homepage":"http://openvnet.org","size":8936,"stargazers_count":39,"watchers_count":39,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":4,"mirror_url":null,"open_issues_count":33,"forks":4,"open_issues":33,"watchers":39,"default_branch":"develop"}},"_links":{"self":{"href":"https://api.github.com/repos/axsh/openvnet/pulls/287"},"html":{"href":"https://github.com/axsh/openvnet/pull/287"},"issue":{"href":"https://api.github.com/repos/axsh/openvnet/issues/287"},"comments":{"href":"https://api.github.com/repos/axsh/openvnet/issues/287/comments"},"review_comments":{"href":"https://api.github.com/repos/axsh/openvnet/pulls/287/comments"},"review_comment":{"href":"https://api.github.com/repos/axsh/openvnet/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/axsh/openvnet/pulls/287/commits"},"statuses":{"href":"https://api.github.com/repos/axsh/openvnet/statuses/ec05c18fffb8f8a8403b7c50eddafe598c814d7a"}}}}