{"action":"created","comment":{"url":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/comments/69309648","id":69309648,"diff_hunk":"@@ -1,124 +1,115 @@\n # kubesnap\n \n ## How to run\n+1. [Prerequisites](#1-prerequisites)  \n+2. [Start work with Google Cloud Platform](#2-start-work-with-google-cloud-platform)  \n+3. [Install kubesnap](#3-install-kubesnap)\n+4. [Contributing](#4-contributing)  \n+5. [License](#5-license)  \n+6. [Acknowledgements](#6-acknowledgements)  \n \n-### Prerequisites\n+### 1. Prerequisites\n \n-- **Kubernetes** cluster - tested with Kubernetes on CoreOS\n-- One minion node labeled as tribe chief:\n-```\n-kubectl label nodes 10.91.97.195 tribe-role=chief\n-```\n-- Other minion nodes labeled as tribe members:\n-```\n-kubectl label nodes 10.91.97.194 tribe-role=member\n-```\n+- **Kubernetes** cluster - tested with Kubernetes on Google Cloud Environment (GCE)\n \n-### Steps\n+### 2. Start work with Google Cloud Platform\n \n-#### Building\n+#### a) Open Google Cloud Platform Console\n+ - go to https://console.cloud.google.com/  \n+ - log in using your e-mail address\n+ - follow the instruction [how to create a Cloud Platform Console project](https://cloud.google.com/storage/docs/quickstart-console)\n \n-- Clone **Heapster**\n-```\n-git clone https://github.com/kubernetes/heapster.git\n-cd heapster\n-git reset --hard de510e4bdcdea96722b5bde19ff0b7a142939485\n-```\n \n-- Clone **kubesnap**\n-```\n-git clone https://github.com/intelsdi-x/kubesnap.git\n-```\n+#### b) Select your project  \n+- select your project from the drop-down menu in the top right corner\n+  ![Alt text](docs/images/image_01.png \"Selecting a project in Cloud Platform Console\")  \n \n-- Clone **kubesnap-plugin-publisher-heapster**\n-```\n-cd kubesnap/src/snap\n-git clone https://github.com/intelsdi-x/kubesnap-plugin-publisher-heapster.git\n-```\n+#### c) Switch to _**Compute Engine**_ screen\n \n-- Clone **kubesnap-plugin-collector-docker**\n-```\n-cd kubesnap/src/snap\n-git clone https://github.com/intelsdi-x/kubesnap-plugin-collector-docker.git\n-```\n+- select _Products & Services_ from GC Menu in the top left corner  \n \n-- Build **Heapster** container\n-```\n-cd kubesnap/src/heapster\n-docker build -t heapster-snap .\n-docker tag heapster-snap <docker_registry>/heapster-snap:1\n-docker push <docker_registry>/heapster-snap:1\n-```\n+  ![Alt text](docs/images/image_02.png \"Google Cloud Console Menu\") \n \n-- Build **Influxdb** container\n-```\n-cd heapster/influxdb\n-docker build -t influxdb-snap .\n-docker tag influxdb-snap <docker_registry>/influxdb-snap:1\n-docker push <docker_registry>/influxdb-snap:1\n-```\n+- and then select _Compute Engine_ from the drop-down list\n \n-- Build **Grafana** container\n-```\n-cd heapster/grafana\n-docker build -t grafana-snap .\n-docker tag grafana-snap <docker_registry>/grafana-snap:1\n-docker push <docker_registry>/grafana-snap:1\n-```\n+  ![Alt text](docs/images/image_03.png \"Selecting Compute Engine in Google Cloud Console Menu\")\n \n-- Build **snap** container\n-```\n-cd kubesnap/src/snap\n-docker build -t snap .\n-docker tag snap <docker_registry>/snap:1\n-docker push <docker_registry>/snap:1\n-```\n+#### d) Create an VM instance  \n+- create a new VM instance\n+  ![Alt text](docs/images/image_04.png \"Creating an VM instance\")  \n \n-- (Optional) Build **workload** container\n-```\n-cd kubesnap/src/workload\n-docker build -t workload .\n-docker tag workload <docker_registry>/workload:1\n-docker push <docker_registry>/workload:1\n-```\n+- set an unique name of a new instance\n+- choose a machine with 4 vCPUs (or more) and at least 15GB RAM\n+- select Ubuntu 16.04 with standard persistent disk with at least 100GB\n \n-- (Optional) Build **snap_stub** container\n-```\n-cd kubesnap/src/snap_stub\n-docker build -t snap_stub .\n-docker tag snap_stub 10.1.23.1:5000/snap_stub:1\n-docker push 10.1.23.1:5000/snap_stub:1\n-```\n+  ![Alt text](docs/images/image_05.png \"Setting up a new VM\")  \n \n-#### Running\n+#### e) Start GCE Virtual Machine  \n+- select your VM and choose _START_ option which is available on the top of screen\n \n-- Deploy snap (or snap_stub)\n-```\n-cd kubesnap/deploy\n-kubectl create -f snap/ OR kubectl create -f snap_stub/\n-```\n+  ![Alt text](docs/images/image_06.png \"Staring an VM instance\")  \n+\n+#### f) Open the VM terminal by click on SSH  \n+ -  click on SSH to open the VM terminal (it will open as a new window)\n+\n+  ![Alt text](docs/images/image_07.png \"Opening the terminal of Virtual Machine\") \n+\n+#### g) Authorize access to Google Cloud Platform  \n+- manage credentials for the Google Cloud SD. To do that, run the following command:\n+  ```\n+  gcloud auth login\n+  ```\n+  Answer `Y` to the question (see below) and follow the instructions:\n+  -\tcopy the link in your browser and \n+  -\tauthenticate with a service account which you use in Google Cloud Environment,\n+  - copy the verification code from browser window and enter it\n \n-- Deploy Heapster, InfluxDB and Grafana\n+  ![Alt text](docs/images/image_08.png \"Access authorization to Google Cloud Platform\")\n+\n+- check if you are on credentialed accounts:  ","path":"README.md","position":150,"original_position":150,"commit_id":"ac0b51ad68fb953c73c8970f6f4d6f5621d755d9","original_commit_id":"ac0b51ad68fb953c73c8970f6f4d6f5621d755d9","user":{"login":"marcin-krolik","id":14905131,"avatar_url":"https://avatars.githubusercontent.com/u/14905131?v=3","gravatar_id":"","url":"https://api.github.com/users/marcin-krolik","html_url":"https://github.com/marcin-krolik","followers_url":"https://api.github.com/users/marcin-krolik/followers","following_url":"https://api.github.com/users/marcin-krolik/following{/other_user}","gists_url":"https://api.github.com/users/marcin-krolik/gists{/gist_id}","starred_url":"https://api.github.com/users/marcin-krolik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/marcin-krolik/subscriptions","organizations_url":"https://api.github.com/users/marcin-krolik/orgs","repos_url":"https://api.github.com/users/marcin-krolik/repos","events_url":"https://api.github.com/users/marcin-krolik/events{/privacy}","received_events_url":"https://api.github.com/users/marcin-krolik/received_events","type":"User","site_admin":false},"body":"Maybe \"on authorization list\" instead of \"on credentialed accounts\" sounds better?","created_at":"2016-07-01T14:42:42Z","updated_at":"2016-07-01T14:42:42Z","html_url":"https://github.com/intelsdi-x/kubesnap/pull/75#discussion_r69309648","pull_request_url":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/75","_links":{"self":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/comments/69309648"},"html":{"href":"https://github.com/intelsdi-x/kubesnap/pull/75#discussion_r69309648"},"pull_request":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/75"}}},"pull_request":{"url":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/75","id":75989227,"html_url":"https://github.com/intelsdi-x/kubesnap/pull/75","diff_url":"https://github.com/intelsdi-x/kubesnap/pull/75.diff","patch_url":"https://github.com/intelsdi-x/kubesnap/pull/75.patch","issue_url":"https://api.github.com/repos/intelsdi-x/kubesnap/issues/75","number":75,"state":"open","locked":false,"title":"Updated README.md and CONTRIBUTING.md","user":{"login":"IzabellaRaulin","id":11335874,"avatar_url":"https://avatars.githubusercontent.com/u/11335874?v=3","gravatar_id":"","url":"https://api.github.com/users/IzabellaRaulin","html_url":"https://github.com/IzabellaRaulin","followers_url":"https://api.github.com/users/IzabellaRaulin/followers","following_url":"https://api.github.com/users/IzabellaRaulin/following{/other_user}","gists_url":"https://api.github.com/users/IzabellaRaulin/gists{/gist_id}","starred_url":"https://api.github.com/users/IzabellaRaulin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IzabellaRaulin/subscriptions","organizations_url":"https://api.github.com/users/IzabellaRaulin/orgs","repos_url":"https://api.github.com/users/IzabellaRaulin/repos","events_url":"https://api.github.com/users/IzabellaRaulin/events{/privacy}","received_events_url":"https://api.github.com/users/IzabellaRaulin/received_events","type":"User","site_admin":false},"body":"  \r\n-  Added section how to start work with Google Cloud Platform  \r\n-  Added kubesnap installation guidance \r\n-  Added images to README.md\r\n-  Added sections: Contributing, License and Acknowledgements\r\n- Removed outdated information  \r\n- Updated CONTRIBUTING.md (correction in tittle, fixing the link to kubesnap issues)\r\n\r\n\r\n","created_at":"2016-07-01T14:35:37Z","updated_at":"2016-07-01T14:42:42Z","closed_at":null,"merged_at":null,"merge_commit_sha":"4c24b88d71523631ea39cd95b9119558fdb2237f","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/75/commits","review_comments_url":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/75/comments","review_comment_url":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/comments{/number}","comments_url":"https://api.github.com/repos/intelsdi-x/kubesnap/issues/75/comments","statuses_url":"https://api.github.com/repos/intelsdi-x/kubesnap/statuses/ac0b51ad68fb953c73c8970f6f4d6f5621d755d9","head":{"label":"IzabellaRaulin:readme_update","ref":"readme_update","sha":"ac0b51ad68fb953c73c8970f6f4d6f5621d755d9","user":{"login":"IzabellaRaulin","id":11335874,"avatar_url":"https://avatars.githubusercontent.com/u/11335874?v=3","gravatar_id":"","url":"https://api.github.com/users/IzabellaRaulin","html_url":"https://github.com/IzabellaRaulin","followers_url":"https://api.github.com/users/IzabellaRaulin/followers","following_url":"https://api.github.com/users/IzabellaRaulin/following{/other_user}","gists_url":"https://api.github.com/users/IzabellaRaulin/gists{/gist_id}","starred_url":"https://api.github.com/users/IzabellaRaulin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IzabellaRaulin/subscriptions","organizations_url":"https://api.github.com/users/IzabellaRaulin/orgs","repos_url":"https://api.github.com/users/IzabellaRaulin/repos","events_url":"https://api.github.com/users/IzabellaRaulin/events{/privacy}","received_events_url":"https://api.github.com/users/IzabellaRaulin/received_events","type":"User","site_admin":false},"repo":{"id":62228883,"name":"kubesnap","full_name":"IzabellaRaulin/kubesnap","owner":{"login":"IzabellaRaulin","id":11335874,"avatar_url":"https://avatars.githubusercontent.com/u/11335874?v=3","gravatar_id":"","url":"https://api.github.com/users/IzabellaRaulin","html_url":"https://github.com/IzabellaRaulin","followers_url":"https://api.github.com/users/IzabellaRaulin/followers","following_url":"https://api.github.com/users/IzabellaRaulin/following{/other_user}","gists_url":"https://api.github.com/users/IzabellaRaulin/gists{/gist_id}","starred_url":"https://api.github.com/users/IzabellaRaulin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/IzabellaRaulin/subscriptions","organizations_url":"https://api.github.com/users/IzabellaRaulin/orgs","repos_url":"https://api.github.com/users/IzabellaRaulin/repos","events_url":"https://api.github.com/users/IzabellaRaulin/events{/privacy}","received_events_url":"https://api.github.com/users/IzabellaRaulin/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/IzabellaRaulin/kubesnap","description":"PoC - Kubernetes monitoring by snap","fork":true,"url":"https://api.github.com/repos/IzabellaRaulin/kubesnap","forks_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/forks","keys_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/keys{/key_id}","collaborators_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/teams","hooks_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/hooks","issue_events_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/issues/events{/number}","events_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/events","assignees_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/assignees{/user}","branches_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/branches{/branch}","tags_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/tags","blobs_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/git/refs{/sha}","trees_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/git/trees{/sha}","statuses_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/statuses/{sha}","languages_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/languages","stargazers_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/stargazers","contributors_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/contributors","subscribers_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/subscribers","subscription_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/subscription","commits_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/commits{/sha}","git_commits_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/git/commits{/sha}","comments_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/comments{/number}","issue_comment_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/issues/comments{/number}","contents_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/contents/{+path}","compare_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/compare/{base}...{head}","merges_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/merges","archive_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/downloads","issues_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/issues{/number}","pulls_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/pulls{/number}","milestones_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/milestones{/number}","notifications_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/labels{/name}","releases_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/releases{/id}","deployments_url":"https://api.github.com/repos/IzabellaRaulin/kubesnap/deployments","created_at":"2016-06-29T13:41:28Z","updated_at":"2016-06-29T13:51:39Z","pushed_at":"2016-07-01T14:25:45Z","git_url":"git://github.com/IzabellaRaulin/kubesnap.git","ssh_url":"git@github.com:IzabellaRaulin/kubesnap.git","clone_url":"https://github.com/IzabellaRaulin/kubesnap.git","svn_url":"https://github.com/IzabellaRaulin/kubesnap","homepage":"","size":16531,"stargazers_count":0,"watchers_count":0,"language":"Go","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":1,"forks":0,"open_issues":1,"watchers":0,"default_branch":"master"}},"base":{"label":"intelsdi-x:master","ref":"master","sha":"c550c496ed3517a0477eac4cb20703b52f3076ef","user":{"login":"intelsdi-x","id":8398747,"avatar_url":"https://avatars.githubusercontent.com/u/8398747?v=3","gravatar_id":"","url":"https://api.github.com/users/intelsdi-x","html_url":"https://github.com/intelsdi-x","followers_url":"https://api.github.com/users/intelsdi-x/followers","following_url":"https://api.github.com/users/intelsdi-x/following{/other_user}","gists_url":"https://api.github.com/users/intelsdi-x/gists{/gist_id}","starred_url":"https://api.github.com/users/intelsdi-x/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/intelsdi-x/subscriptions","organizations_url":"https://api.github.com/users/intelsdi-x/orgs","repos_url":"https://api.github.com/users/intelsdi-x/repos","events_url":"https://api.github.com/users/intelsdi-x/events{/privacy}","received_events_url":"https://api.github.com/users/intelsdi-x/received_events","type":"Organization","site_admin":false},"repo":{"id":56494348,"name":"kubesnap","full_name":"intelsdi-x/kubesnap","owner":{"login":"intelsdi-x","id":8398747,"avatar_url":"https://avatars.githubusercontent.com/u/8398747?v=3","gravatar_id":"","url":"https://api.github.com/users/intelsdi-x","html_url":"https://github.com/intelsdi-x","followers_url":"https://api.github.com/users/intelsdi-x/followers","following_url":"https://api.github.com/users/intelsdi-x/following{/other_user}","gists_url":"https://api.github.com/users/intelsdi-x/gists{/gist_id}","starred_url":"https://api.github.com/users/intelsdi-x/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/intelsdi-x/subscriptions","organizations_url":"https://api.github.com/users/intelsdi-x/orgs","repos_url":"https://api.github.com/users/intelsdi-x/repos","events_url":"https://api.github.com/users/intelsdi-x/events{/privacy}","received_events_url":"https://api.github.com/users/intelsdi-x/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/intelsdi-x/kubesnap","description":"PoC - Kubernetes monitoring by snap","fork":false,"url":"https://api.github.com/repos/intelsdi-x/kubesnap","forks_url":"https://api.github.com/repos/intelsdi-x/kubesnap/forks","keys_url":"https://api.github.com/repos/intelsdi-x/kubesnap/keys{/key_id}","collaborators_url":"https://api.github.com/repos/intelsdi-x/kubesnap/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/intelsdi-x/kubesnap/teams","hooks_url":"https://api.github.com/repos/intelsdi-x/kubesnap/hooks","issue_events_url":"https://api.github.com/repos/intelsdi-x/kubesnap/issues/events{/number}","events_url":"https://api.github.com/repos/intelsdi-x/kubesnap/events","assignees_url":"https://api.github.com/repos/intelsdi-x/kubesnap/assignees{/user}","branches_url":"https://api.github.com/repos/intelsdi-x/kubesnap/branches{/branch}","tags_url":"https://api.github.com/repos/intelsdi-x/kubesnap/tags","blobs_url":"https://api.github.com/repos/intelsdi-x/kubesnap/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/intelsdi-x/kubesnap/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/intelsdi-x/kubesnap/git/refs{/sha}","trees_url":"https://api.github.com/repos/intelsdi-x/kubesnap/git/trees{/sha}","statuses_url":"https://api.github.com/repos/intelsdi-x/kubesnap/statuses/{sha}","languages_url":"https://api.github.com/repos/intelsdi-x/kubesnap/languages","stargazers_url":"https://api.github.com/repos/intelsdi-x/kubesnap/stargazers","contributors_url":"https://api.github.com/repos/intelsdi-x/kubesnap/contributors","subscribers_url":"https://api.github.com/repos/intelsdi-x/kubesnap/subscribers","subscription_url":"https://api.github.com/repos/intelsdi-x/kubesnap/subscription","commits_url":"https://api.github.com/repos/intelsdi-x/kubesnap/commits{/sha}","git_commits_url":"https://api.github.com/repos/intelsdi-x/kubesnap/git/commits{/sha}","comments_url":"https://api.github.com/repos/intelsdi-x/kubesnap/comments{/number}","issue_comment_url":"https://api.github.com/repos/intelsdi-x/kubesnap/issues/comments{/number}","contents_url":"https://api.github.com/repos/intelsdi-x/kubesnap/contents/{+path}","compare_url":"https://api.github.com/repos/intelsdi-x/kubesnap/compare/{base}...{head}","merges_url":"https://api.github.com/repos/intelsdi-x/kubesnap/merges","archive_url":"https://api.github.com/repos/intelsdi-x/kubesnap/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/intelsdi-x/kubesnap/downloads","issues_url":"https://api.github.com/repos/intelsdi-x/kubesnap/issues{/number}","pulls_url":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls{/number}","milestones_url":"https://api.github.com/repos/intelsdi-x/kubesnap/milestones{/number}","notifications_url":"https://api.github.com/repos/intelsdi-x/kubesnap/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/intelsdi-x/kubesnap/labels{/name}","releases_url":"https://api.github.com/repos/intelsdi-x/kubesnap/releases{/id}","deployments_url":"https://api.github.com/repos/intelsdi-x/kubesnap/deployments","created_at":"2016-04-18T09:22:34Z","updated_at":"2016-06-30T08:34:25Z","pushed_at":"2016-07-01T14:35:37Z","git_url":"git://github.com/intelsdi-x/kubesnap.git","ssh_url":"git@github.com:intelsdi-x/kubesnap.git","clone_url":"https://github.com/intelsdi-x/kubesnap.git","svn_url":"https://github.com/intelsdi-x/kubesnap","homepage":"","size":19887,"stargazers_count":1,"watchers_count":1,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":8,"forks":2,"open_issues":8,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/75"},"html":{"href":"https://github.com/intelsdi-x/kubesnap/pull/75"},"issue":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/issues/75"},"comments":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/issues/75/comments"},"review_comments":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/75/comments"},"review_comment":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/pulls/75/commits"},"statuses":{"href":"https://api.github.com/repos/intelsdi-x/kubesnap/statuses/ac0b51ad68fb953c73c8970f6f4d6f5621d755d9"}}}}
{"actor":{"display_login":"marcin-krolik"}}