{"action":"created","comment":{"url":"https://api.github.com/repos/openebs/openebs/pulls/comments/143957142","pull_request_review_id":68542681,"id":143957142,"diff_hunk":"@@ -0,0 +1,113 @@\n+## INTRODUCTION TO OPENEBS E2E\r\n+\r\n+OpenEBS e2e is focused on workload simulation & application deployment on OpenEBS storage, predominantly in a \r\n+kubernetes environment. In its current state, it includes application workflow tests,basic compliance and resiliency tests. \r\n+The scope of the said tests is expected to evolve over time to include performance and security tests as well. \r\n+The e2e is mostly written in ansible, i.e., as ansible playbooks with docker used for test images (these include standard \r\n+application images from dockerhub as well as custom-built images stored in openebs/test-storage).Since the tests are performed \r\n+in a kubernetes environment, the test images are typically deployed as \"pods\" and \"jobs\" and therefore accompanied by the \r\n+respective specification YAML files.\r\n+\r\n+## BUILDING BLOCKS OF OPENEBS CI\r\n+\r\n+The OpenEBS Continuous Integration has two distinct parts : \r\n+\r\n+- Travis is used to run unit tests, build code and push images to dockerhub (in case of repos where the image is the build artifact)\r\n+- Jenkins pulls these images, creates the kubernetes-based test environment and executes the e2e. It is also used to run tests upon commits that change application specs OR openebs kubernetes deployment specs.\r\n+\r\n+While the OpenEBS e2e can be run as a standalone suite by users, the priority is have them run upon commits to the core openebs github\r\n+repositories such as openebs/openebs, openebs/mayaserver, openebs/jiva. This part of the continuous integration is built around a dedicated Jenkins server, which upon detecting commits via a polling mechanism, launches VMs using Vagrant and runs the ansible playbooks to setup the environment and execute e2e tests. The openebs/e2e project focuses on this part of the CI.\r\n+\r\n+The below schema illustrates the workflow\r\n+\r\n+![OpenEBS CI Overview Diagram](https://github.com/ksatchit/openebs/blob/master/documentation/source/_static/OpenEBS_CI_Workflow.png)\r\n+\r\n+## CONTRIBUTING TO E2E & OPENEBS CI \r\n+\r\n+Contributions are welcome !!  Before starting, a reading of the project documentation at [ReadTheDocs](http://openebs.readthedocs.io/en/latest/ ) is highly recommended. Please raise a github issue for any questions you may have on the project in general or e2e,CI in particular.\r\n+You can post questions on the OpenEBS slack channel too.\r\n+\r\n+You could contribute to any of the following areas : \r\n+\r\n+- Submit proposals to add new tests/test categories to the e2e\r\n+- Create new application specification YAMLs \r\n+- Create ansible playbooks to execute test workflows\r\n+- Submit changes to fix bugs/improve e2e tests \r\n+- Raise/fix issues on the CI framework \r\n+- Raise/fix issues on the e2e, CI documentation\r\n+\r\n+## GENERAL CONTRIBUTION GUIDELINES\r\n+\r\n+Here are some general contribution guidelines. \r\n+\r\n+### Adding new tests/test-categories\r\n+\r\n+To add new tests, please raise an issue describing the objective, pre-requisites, test steps, expected results & cleanup routines.\r\n+In case of proposals to add new test sections/categories, also add a generic description explaining the purpose and value addition\r","path":"contribute/e2e/CONTRIBUTING.md","position":null,"original_position":46,"commit_id":"10daa4327eb8fe0559744f87a3b415f0ce3b5e46","original_commit_id":"82f605f6db26271f8f4c6118d7ee9c465ec44454","user":{"login":"ksatchit","id":21166217,"avatar_url":"https://avatars0.githubusercontent.com/u/21166217?v=4","gravatar_id":"","url":"https://api.github.com/users/ksatchit","html_url":"https://github.com/ksatchit","followers_url":"https://api.github.com/users/ksatchit/followers","following_url":"https://api.github.com/users/ksatchit/following{/other_user}","gists_url":"https://api.github.com/users/ksatchit/gists{/gist_id}","starred_url":"https://api.github.com/users/ksatchit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ksatchit/subscriptions","organizations_url":"https://api.github.com/users/ksatchit/orgs","repos_url":"https://api.github.com/users/ksatchit/repos","events_url":"https://api.github.com/users/ksatchit/events{/privacy}","received_events_url":"https://api.github.com/users/ksatchit/received_events","type":"User","site_admin":false},"body":"Done ","created_at":"2017-10-11T09:28:55Z","updated_at":"2017-10-11T09:28:55Z","html_url":"https://github.com/openebs/openebs/pull/590#discussion_r143957142","pull_request_url":"https://api.github.com/repos/openebs/openebs/pulls/590","author_association":"OWNER","_links":{"self":{"href":"https://api.github.com/repos/openebs/openebs/pulls/comments/143957142"},"html":{"href":"https://github.com/openebs/openebs/pull/590#discussion_r143957142"},"pull_request":{"href":"https://api.github.com/repos/openebs/openebs/pulls/590"}},"in_reply_to_id":143935257},"pull_request":{"url":"https://api.github.com/repos/openebs/openebs/pulls/590","id":145855293,"html_url":"https://github.com/openebs/openebs/pull/590","diff_url":"https://github.com/openebs/openebs/pull/590.diff","patch_url":"https://github.com/openebs/openebs/pull/590.patch","issue_url":"https://api.github.com/repos/openebs/openebs/issues/590","number":590,"state":"open","locked":false,"title":"Create contribution documentation for openebs/e2e","user":{"login":"ksatchit","id":21166217,"avatar_url":"https://avatars0.githubusercontent.com/u/21166217?v=4","gravatar_id":"","url":"https://api.github.com/users/ksatchit","html_url":"https://github.com/ksatchit","followers_url":"https://api.github.com/users/ksatchit/followers","following_url":"https://api.github.com/users/ksatchit/following{/other_user}","gists_url":"https://api.github.com/users/ksatchit/gists{/gist_id}","starred_url":"https://api.github.com/users/ksatchit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ksatchit/subscriptions","organizations_url":"https://api.github.com/users/ksatchit/orgs","repos_url":"https://api.github.com/users/ksatchit/repos","events_url":"https://api.github.com/users/ksatchit/events{/privacy}","received_events_url":"https://api.github.com/users/ksatchit/received_events","type":"User","site_admin":false},"body":"<!--  Thanks for sending a pull request!  Here are some tips for you -->\r\n\r\n**What this PR does / why we need it**:\r\n\r\n- Creates contribution documentation for openebs/e2e\r\n\r\n**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #567 \r\n\r\n**Special notes for your reviewer**:\r\nCreated a single file - inspired in principle from kubernetes/e2e. Will add more sections for when applicable.","created_at":"2017-10-11T04:44:04Z","updated_at":"2017-10-11T09:28:55Z","closed_at":null,"merged_at":null,"merge_commit_sha":"437004e621f40bf1e9eba9badff447599ebc8c75","assignee":null,"assignees":[],"requested_reviewers":[{"login":"yudaykiran","id":24768611,"avatar_url":"https://avatars0.githubusercontent.com/u/24768611?v=4","gravatar_id":"","url":"https://api.github.com/users/yudaykiran","html_url":"https://github.com/yudaykiran","followers_url":"https://api.github.com/users/yudaykiran/followers","following_url":"https://api.github.com/users/yudaykiran/following{/other_user}","gists_url":"https://api.github.com/users/yudaykiran/gists{/gist_id}","starred_url":"https://api.github.com/users/yudaykiran/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/yudaykiran/subscriptions","organizations_url":"https://api.github.com/users/yudaykiran/orgs","repos_url":"https://api.github.com/users/yudaykiran/repos","events_url":"https://api.github.com/users/yudaykiran/events{/privacy}","received_events_url":"https://api.github.com/users/yudaykiran/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/openebs/openebs/pulls/590/commits","review_comments_url":"https://api.github.com/repos/openebs/openebs/pulls/590/comments","review_comment_url":"https://api.github.com/repos/openebs/openebs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/openebs/openebs/issues/590/comments","statuses_url":"https://api.github.com/repos/openebs/openebs/statuses/10daa4327eb8fe0559744f87a3b415f0ce3b5e46","head":{"label":"ksatchit:master","ref":"master","sha":"10daa4327eb8fe0559744f87a3b415f0ce3b5e46","user":{"login":"ksatchit","id":21166217,"avatar_url":"https://avatars0.githubusercontent.com/u/21166217?v=4","gravatar_id":"","url":"https://api.github.com/users/ksatchit","html_url":"https://github.com/ksatchit","followers_url":"https://api.github.com/users/ksatchit/followers","following_url":"https://api.github.com/users/ksatchit/following{/other_user}","gists_url":"https://api.github.com/users/ksatchit/gists{/gist_id}","starred_url":"https://api.github.com/users/ksatchit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ksatchit/subscriptions","organizations_url":"https://api.github.com/users/ksatchit/orgs","repos_url":"https://api.github.com/users/ksatchit/repos","events_url":"https://api.github.com/users/ksatchit/events{/privacy}","received_events_url":"https://api.github.com/users/ksatchit/received_events","type":"User","site_admin":false},"repo":{"id":91052603,"name":"openebs","full_name":"ksatchit/openebs","owner":{"login":"ksatchit","id":21166217,"avatar_url":"https://avatars0.githubusercontent.com/u/21166217?v=4","gravatar_id":"","url":"https://api.github.com/users/ksatchit","html_url":"https://github.com/ksatchit","followers_url":"https://api.github.com/users/ksatchit/followers","following_url":"https://api.github.com/users/ksatchit/following{/other_user}","gists_url":"https://api.github.com/users/ksatchit/gists{/gist_id}","starred_url":"https://api.github.com/users/ksatchit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ksatchit/subscriptions","organizations_url":"https://api.github.com/users/ksatchit/orgs","repos_url":"https://api.github.com/users/ksatchit/repos","events_url":"https://api.github.com/users/ksatchit/events{/privacy}","received_events_url":"https://api.github.com/users/ksatchit/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/ksatchit/openebs","description":"OpenEBS is containerized storage for containers integrated tightly into K8S and other environments and based on distributed block storage and containerization of storage control.  OpenEBS derives intent from K8S and other YAML or JSON such as per container QoS SLAs, tiering and replica policies, and more.  OpenEBS is EBS API compliant as well.   ","fork":true,"url":"https://api.github.com/repos/ksatchit/openebs","forks_url":"https://api.github.com/repos/ksatchit/openebs/forks","keys_url":"https://api.github.com/repos/ksatchit/openebs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ksatchit/openebs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ksatchit/openebs/teams","hooks_url":"https://api.github.com/repos/ksatchit/openebs/hooks","issue_events_url":"https://api.github.com/repos/ksatchit/openebs/issues/events{/number}","events_url":"https://api.github.com/repos/ksatchit/openebs/events","assignees_url":"https://api.github.com/repos/ksatchit/openebs/assignees{/user}","branches_url":"https://api.github.com/repos/ksatchit/openebs/branches{/branch}","tags_url":"https://api.github.com/repos/ksatchit/openebs/tags","blobs_url":"https://api.github.com/repos/ksatchit/openebs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ksatchit/openebs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ksatchit/openebs/git/refs{/sha}","trees_url":"https://api.github.com/repos/ksatchit/openebs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ksatchit/openebs/statuses/{sha}","languages_url":"https://api.github.com/repos/ksatchit/openebs/languages","stargazers_url":"https://api.github.com/repos/ksatchit/openebs/stargazers","contributors_url":"https://api.github.com/repos/ksatchit/openebs/contributors","subscribers_url":"https://api.github.com/repos/ksatchit/openebs/subscribers","subscription_url":"https://api.github.com/repos/ksatchit/openebs/subscription","commits_url":"https://api.github.com/repos/ksatchit/openebs/commits{/sha}","git_commits_url":"https://api.github.com/repos/ksatchit/openebs/git/commits{/sha}","comments_url":"https://api.github.com/repos/ksatchit/openebs/comments{/number}","issue_comment_url":"https://api.github.com/repos/ksatchit/openebs/issues/comments{/number}","contents_url":"https://api.github.com/repos/ksatchit/openebs/contents/{+path}","compare_url":"https://api.github.com/repos/ksatchit/openebs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ksatchit/openebs/merges","archive_url":"https://api.github.com/repos/ksatchit/openebs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ksatchit/openebs/downloads","issues_url":"https://api.github.com/repos/ksatchit/openebs/issues{/number}","pulls_url":"https://api.github.com/repos/ksatchit/openebs/pulls{/number}","milestones_url":"https://api.github.com/repos/ksatchit/openebs/milestones{/number}","notifications_url":"https://api.github.com/repos/ksatchit/openebs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ksatchit/openebs/labels{/name}","releases_url":"https://api.github.com/repos/ksatchit/openebs/releases{/id}","deployments_url":"https://api.github.com/repos/ksatchit/openebs/deployments","created_at":"2017-05-12T04:49:25Z","updated_at":"2017-07-29T17:39:25Z","pushed_at":"2017-10-11T09:22:02Z","git_url":"git://github.com/ksatchit/openebs.git","ssh_url":"git@github.com:ksatchit/openebs.git","clone_url":"https://github.com/ksatchit/openebs.git","svn_url":"https://github.com/ksatchit/openebs","homepage":"http://openebs.readthedocs.io/en/latest/Overview.html","size":5730,"stargazers_count":0,"watchers_count":0,"language":"Go","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"openebs:master","ref":"master","sha":"539a6969b1c3d4054d2f709166d8d6acd1539c96","user":{"login":"openebs","id":20769039,"avatar_url":"https://avatars0.githubusercontent.com/u/20769039?v=4","gravatar_id":"","url":"https://api.github.com/users/openebs","html_url":"https://github.com/openebs","followers_url":"https://api.github.com/users/openebs/followers","following_url":"https://api.github.com/users/openebs/following{/other_user}","gists_url":"https://api.github.com/users/openebs/gists{/gist_id}","starred_url":"https://api.github.com/users/openebs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/openebs/subscriptions","organizations_url":"https://api.github.com/users/openebs/orgs","repos_url":"https://api.github.com/users/openebs/repos","events_url":"https://api.github.com/users/openebs/events{/privacy}","received_events_url":"https://api.github.com/users/openebs/received_events","type":"Organization","site_admin":false},"repo":{"id":64654523,"name":"openebs","full_name":"openebs/openebs","owner":{"login":"openebs","id":20769039,"avatar_url":"https://avatars0.githubusercontent.com/u/20769039?v=4","gravatar_id":"","url":"https://api.github.com/users/openebs","html_url":"https://github.com/openebs","followers_url":"https://api.github.com/users/openebs/followers","following_url":"https://api.github.com/users/openebs/following{/other_user}","gists_url":"https://api.github.com/users/openebs/gists{/gist_id}","starred_url":"https://api.github.com/users/openebs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/openebs/subscriptions","organizations_url":"https://api.github.com/users/openebs/orgs","repos_url":"https://api.github.com/users/openebs/repos","events_url":"https://api.github.com/users/openebs/events{/privacy}","received_events_url":"https://api.github.com/users/openebs/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/openebs/openebs","description":"OpenEBS is containerized block storage written in Go for cloud native and other environments w/ per container (or pod) QoS SLAs, tiering and replica policies across AZs and environments, and predictable and scalable performance.  ","fork":false,"url":"https://api.github.com/repos/openebs/openebs","forks_url":"https://api.github.com/repos/openebs/openebs/forks","keys_url":"https://api.github.com/repos/openebs/openebs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/openebs/openebs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/openebs/openebs/teams","hooks_url":"https://api.github.com/repos/openebs/openebs/hooks","issue_events_url":"https://api.github.com/repos/openebs/openebs/issues/events{/number}","events_url":"https://api.github.com/repos/openebs/openebs/events","assignees_url":"https://api.github.com/repos/openebs/openebs/assignees{/user}","branches_url":"https://api.github.com/repos/openebs/openebs/branches{/branch}","tags_url":"https://api.github.com/repos/openebs/openebs/tags","blobs_url":"https://api.github.com/repos/openebs/openebs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/openebs/openebs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/openebs/openebs/git/refs{/sha}","trees_url":"https://api.github.com/repos/openebs/openebs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/openebs/openebs/statuses/{sha}","languages_url":"https://api.github.com/repos/openebs/openebs/languages","stargazers_url":"https://api.github.com/repos/openebs/openebs/stargazers","contributors_url":"https://api.github.com/repos/openebs/openebs/contributors","subscribers_url":"https://api.github.com/repos/openebs/openebs/subscribers","subscription_url":"https://api.github.com/repos/openebs/openebs/subscription","commits_url":"https://api.github.com/repos/openebs/openebs/commits{/sha}","git_commits_url":"https://api.github.com/repos/openebs/openebs/git/commits{/sha}","comments_url":"https://api.github.com/repos/openebs/openebs/comments{/number}","issue_comment_url":"https://api.github.com/repos/openebs/openebs/issues/comments{/number}","contents_url":"https://api.github.com/repos/openebs/openebs/contents/{+path}","compare_url":"https://api.github.com/repos/openebs/openebs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/openebs/openebs/merges","archive_url":"https://api.github.com/repos/openebs/openebs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/openebs/openebs/downloads","issues_url":"https://api.github.com/repos/openebs/openebs/issues{/number}","pulls_url":"https://api.github.com/repos/openebs/openebs/pulls{/number}","milestones_url":"https://api.github.com/repos/openebs/openebs/milestones{/number}","notifications_url":"https://api.github.com/repos/openebs/openebs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/openebs/openebs/labels{/name}","releases_url":"https://api.github.com/repos/openebs/openebs/releases{/id}","deployments_url":"https://api.github.com/repos/openebs/openebs/deployments","created_at":"2016-08-01T09:33:32Z","updated_at":"2017-10-11T07:15:49Z","pushed_at":"2017-10-11T09:22:03Z","git_url":"git://github.com/openebs/openebs.git","ssh_url":"git@github.com:openebs/openebs.git","clone_url":"https://github.com/openebs/openebs.git","svn_url":"https://github.com/openebs/openebs","homepage":"https://www.openebs.io","size":5528,"stargazers_count":2378,"watchers_count":2378,"language":"Go","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":218,"mirror_url":null,"open_issues_count":306,"forks":218,"open_issues":306,"watchers":2378,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/openebs/openebs/pulls/590"},"html":{"href":"https://github.com/openebs/openebs/pull/590"},"issue":{"href":"https://api.github.com/repos/openebs/openebs/issues/590"},"comments":{"href":"https://api.github.com/repos/openebs/openebs/issues/590/comments"},"review_comments":{"href":"https://api.github.com/repos/openebs/openebs/pulls/590/comments"},"review_comment":{"href":"https://api.github.com/repos/openebs/openebs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/openebs/openebs/pulls/590/commits"},"statuses":{"href":"https://api.github.com/repos/openebs/openebs/statuses/10daa4327eb8fe0559744f87a3b415f0ce3b5e46"}},"author_association":"OWNER"}}
{"actor":{"display_login":"ksatchit"}}