{"action":"created","comment":{"url":"https://api.github.com/repos/kata-containers/documentation/pulls/comments/175641500","pull_request_review_id":105203153,"id":175641500,"diff_hunk":"@@ -0,0 +1,112 @@\n+# Kata API Design\n+To fulfill the [kata design requirements](kata-design-requirements.md), and based on the disscusion on [Virtcontainers API extentions](https://docs.google.com/presentation/d/1dbGrD1h9cpuqAPooiEgtiwWDGCYhVPdatq7owsKHDEQ), the kata runtime library features following APIs:\n+-  Sandbox based top API\n+-  Storage and network hotplug API\n+-  Plugin frameworks for external proprietary Kata runtime extensions\n+-  Built-in shim and proxy types and capabilities\n+\n+## Sandbox Based API\n+### Sandbox Management API\n+|Name|Description|\n+|---|---|\n+|CreateSandbox(SandboxConfig)| Create, start a sandbox and return the sandbox structure.|\n+|FetchSandbox(ID)| Connect to an existing sandbox and return the sandbox structure.|\n+|ListSandbox()| List all existing standboxes with status. |\n+\n+### Sandbox Operation API\n+|Name|Description|\n+|---|---|\n+|sandbox.Pause()| Pause the sandbox.|\n+|sandbox.Resume()| Resume the paused sandbox.|\n+|sandbox.Delete()| Destroy the sandbox and remove all persistent metadata.|","path":"design/kata-api-design.md","position":21,"original_position":21,"commit_id":"54842cc22648469dd16116dfcf482328d8204fa4","original_commit_id":"54842cc22648469dd16116dfcf482328d8204fa4","user":{"login":"bergwolf","id":88972,"avatar_url":"https://avatars0.githubusercontent.com/u/88972?v=4","gravatar_id":"","url":"https://api.github.com/users/bergwolf","html_url":"https://github.com/bergwolf","followers_url":"https://api.github.com/users/bergwolf/followers","following_url":"https://api.github.com/users/bergwolf/following{/other_user}","gists_url":"https://api.github.com/users/bergwolf/gists{/gist_id}","starred_url":"https://api.github.com/users/bergwolf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bergwolf/subscriptions","organizations_url":"https://api.github.com/users/bergwolf/orgs","repos_url":"https://api.github.com/users/bergwolf/repos","events_url":"https://api.github.com/users/bergwolf/events{/privacy}","received_events_url":"https://api.github.com/users/bergwolf/received_events","type":"User","site_admin":false},"body":"`Delete()` is to destroy the sandbox. `Release()` is to release the outstanding agent connection and let the VM fly on its own. They are different functionalities.","created_at":"2018-03-20T02:40:27Z","updated_at":"2018-03-20T02:40:27Z","html_url":"https://github.com/kata-containers/documentation/pull/27#discussion_r175641500","pull_request_url":"https://api.github.com/repos/kata-containers/documentation/pulls/27","author_association":"NONE","_links":{"self":{"href":"https://api.github.com/repos/kata-containers/documentation/pulls/comments/175641500"},"html":{"href":"https://github.com/kata-containers/documentation/pull/27#discussion_r175641500"},"pull_request":{"href":"https://api.github.com/repos/kata-containers/documentation/pulls/27"}},"in_reply_to_id":175527668},"pull_request":{"url":"https://api.github.com/repos/kata-containers/documentation/pulls/27","id":174846777,"html_url":"https://github.com/kata-containers/documentation/pull/27","diff_url":"https://github.com/kata-containers/documentation/pull/27.diff","patch_url":"https://github.com/kata-containers/documentation/pull/27.patch","issue_url":"https://api.github.com/repos/kata-containers/documentation/issues/27","number":27,"state":"open","locked":false,"title":"design: add api design doc","user":{"login":"bergwolf","id":88972,"avatar_url":"https://avatars0.githubusercontent.com/u/88972?v=4","gravatar_id":"","url":"https://api.github.com/users/bergwolf","html_url":"https://github.com/bergwolf","followers_url":"https://api.github.com/users/bergwolf/followers","following_url":"https://api.github.com/users/bergwolf/following{/other_user}","gists_url":"https://api.github.com/users/bergwolf/gists{/gist_id}","starred_url":"https://api.github.com/users/bergwolf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bergwolf/subscriptions","organizations_url":"https://api.github.com/users/bergwolf/orgs","repos_url":"https://api.github.com/users/bergwolf/repos","events_url":"https://api.github.com/users/bergwolf/events{/privacy}","received_events_url":"https://api.github.com/users/bergwolf/received_events","type":"User","site_admin":false},"body":"To fulfill the [kata design requirements](kata-design-requirements.md), and based on the disscusion on [Virtcontainers API extentions](https://docs.google.com/presentation/d/1dbGrD1h9cpuqAPooiEgtiwWDGCYhVPdatq7owsKHDEQ), [runtime API early sketch](https://github.com/kata-containers/runtime/pull/32) and [runtime API comparison](https://github.com/kata-containers/runtime/issues/46), the PR added the high level design of the kata runtime library API.\r\n\r\nFixes: #26","created_at":"2018-03-14T03:40:40Z","updated_at":"2018-03-20T02:40:27Z","closed_at":null,"merged_at":null,"merge_commit_sha":"392488eec7df348c5496d22b652bd05f67b897a9","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":848809286,"url":"https://api.github.com/repos/kata-containers/documentation/labels/review","name":"review","color":"ededed","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/kata-containers/documentation/pulls/27/commits","review_comments_url":"https://api.github.com/repos/kata-containers/documentation/pulls/27/comments","review_comment_url":"https://api.github.com/repos/kata-containers/documentation/pulls/comments{/number}","comments_url":"https://api.github.com/repos/kata-containers/documentation/issues/27/comments","statuses_url":"https://api.github.com/repos/kata-containers/documentation/statuses/54842cc22648469dd16116dfcf482328d8204fa4","head":{"label":"bergwolf:api-design","ref":"api-design","sha":"54842cc22648469dd16116dfcf482328d8204fa4","user":{"login":"bergwolf","id":88972,"avatar_url":"https://avatars0.githubusercontent.com/u/88972?v=4","gravatar_id":"","url":"https://api.github.com/users/bergwolf","html_url":"https://github.com/bergwolf","followers_url":"https://api.github.com/users/bergwolf/followers","following_url":"https://api.github.com/users/bergwolf/following{/other_user}","gists_url":"https://api.github.com/users/bergwolf/gists{/gist_id}","starred_url":"https://api.github.com/users/bergwolf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bergwolf/subscriptions","organizations_url":"https://api.github.com/users/bergwolf/orgs","repos_url":"https://api.github.com/users/bergwolf/repos","events_url":"https://api.github.com/users/bergwolf/events{/privacy}","received_events_url":"https://api.github.com/users/bergwolf/received_events","type":"User","site_admin":false},"repo":{"id":125015426,"name":"documentation","full_name":"bergwolf/documentation","owner":{"login":"bergwolf","id":88972,"avatar_url":"https://avatars0.githubusercontent.com/u/88972?v=4","gravatar_id":"","url":"https://api.github.com/users/bergwolf","html_url":"https://github.com/bergwolf","followers_url":"https://api.github.com/users/bergwolf/followers","following_url":"https://api.github.com/users/bergwolf/following{/other_user}","gists_url":"https://api.github.com/users/bergwolf/gists{/gist_id}","starred_url":"https://api.github.com/users/bergwolf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bergwolf/subscriptions","organizations_url":"https://api.github.com/users/bergwolf/orgs","repos_url":"https://api.github.com/users/bergwolf/repos","events_url":"https://api.github.com/users/bergwolf/events{/privacy}","received_events_url":"https://api.github.com/users/bergwolf/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/bergwolf/documentation","description":"Kata Containers documentation","fork":true,"url":"https://api.github.com/repos/bergwolf/documentation","forks_url":"https://api.github.com/repos/bergwolf/documentation/forks","keys_url":"https://api.github.com/repos/bergwolf/documentation/keys{/key_id}","collaborators_url":"https://api.github.com/repos/bergwolf/documentation/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/bergwolf/documentation/teams","hooks_url":"https://api.github.com/repos/bergwolf/documentation/hooks","issue_events_url":"https://api.github.com/repos/bergwolf/documentation/issues/events{/number}","events_url":"https://api.github.com/repos/bergwolf/documentation/events","assignees_url":"https://api.github.com/repos/bergwolf/documentation/assignees{/user}","branches_url":"https://api.github.com/repos/bergwolf/documentation/branches{/branch}","tags_url":"https://api.github.com/repos/bergwolf/documentation/tags","blobs_url":"https://api.github.com/repos/bergwolf/documentation/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/bergwolf/documentation/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/bergwolf/documentation/git/refs{/sha}","trees_url":"https://api.github.com/repos/bergwolf/documentation/git/trees{/sha}","statuses_url":"https://api.github.com/repos/bergwolf/documentation/statuses/{sha}","languages_url":"https://api.github.com/repos/bergwolf/documentation/languages","stargazers_url":"https://api.github.com/repos/bergwolf/documentation/stargazers","contributors_url":"https://api.github.com/repos/bergwolf/documentation/contributors","subscribers_url":"https://api.github.com/repos/bergwolf/documentation/subscribers","subscription_url":"https://api.github.com/repos/bergwolf/documentation/subscription","commits_url":"https://api.github.com/repos/bergwolf/documentation/commits{/sha}","git_commits_url":"https://api.github.com/repos/bergwolf/documentation/git/commits{/sha}","comments_url":"https://api.github.com/repos/bergwolf/documentation/comments{/number}","issue_comment_url":"https://api.github.com/repos/bergwolf/documentation/issues/comments{/number}","contents_url":"https://api.github.com/repos/bergwolf/documentation/contents/{+path}","compare_url":"https://api.github.com/repos/bergwolf/documentation/compare/{base}...{head}","merges_url":"https://api.github.com/repos/bergwolf/documentation/merges","archive_url":"https://api.github.com/repos/bergwolf/documentation/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/bergwolf/documentation/downloads","issues_url":"https://api.github.com/repos/bergwolf/documentation/issues{/number}","pulls_url":"https://api.github.com/repos/bergwolf/documentation/pulls{/number}","milestones_url":"https://api.github.com/repos/bergwolf/documentation/milestones{/number}","notifications_url":"https://api.github.com/repos/bergwolf/documentation/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/bergwolf/documentation/labels{/name}","releases_url":"https://api.github.com/repos/bergwolf/documentation/releases{/id}","deployments_url":"https://api.github.com/repos/bergwolf/documentation/deployments","created_at":"2018-03-13T08:13:41Z","updated_at":"2018-03-06T06:40:09Z","pushed_at":"2018-03-19T08:57:58Z","git_url":"git://github.com/bergwolf/documentation.git","ssh_url":"git@github.com:bergwolf/documentation.git","clone_url":"https://github.com/bergwolf/documentation.git","svn_url":"https://github.com/bergwolf/documentation","homepage":null,"size":15,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"kata-containers:master","ref":"master","sha":"f43d4f665c9ff6e0f8d5485440b8d199e8093ed2","user":{"login":"kata-containers","id":33289952,"avatar_url":"https://avatars3.githubusercontent.com/u/33289952?v=4","gravatar_id":"","url":"https://api.github.com/users/kata-containers","html_url":"https://github.com/kata-containers","followers_url":"https://api.github.com/users/kata-containers/followers","following_url":"https://api.github.com/users/kata-containers/following{/other_user}","gists_url":"https://api.github.com/users/kata-containers/gists{/gist_id}","starred_url":"https://api.github.com/users/kata-containers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kata-containers/subscriptions","organizations_url":"https://api.github.com/users/kata-containers/orgs","repos_url":"https://api.github.com/users/kata-containers/repos","events_url":"https://api.github.com/users/kata-containers/events{/privacy}","received_events_url":"https://api.github.com/users/kata-containers/received_events","type":"Organization","site_admin":false},"repo":{"id":115009978,"name":"documentation","full_name":"kata-containers/documentation","owner":{"login":"kata-containers","id":33289952,"avatar_url":"https://avatars3.githubusercontent.com/u/33289952?v=4","gravatar_id":"","url":"https://api.github.com/users/kata-containers","html_url":"https://github.com/kata-containers","followers_url":"https://api.github.com/users/kata-containers/followers","following_url":"https://api.github.com/users/kata-containers/following{/other_user}","gists_url":"https://api.github.com/users/kata-containers/gists{/gist_id}","starred_url":"https://api.github.com/users/kata-containers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kata-containers/subscriptions","organizations_url":"https://api.github.com/users/kata-containers/orgs","repos_url":"https://api.github.com/users/kata-containers/repos","events_url":"https://api.github.com/users/kata-containers/events{/privacy}","received_events_url":"https://api.github.com/users/kata-containers/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/kata-containers/documentation","description":"Kata Containers documentation","fork":false,"url":"https://api.github.com/repos/kata-containers/documentation","forks_url":"https://api.github.com/repos/kata-containers/documentation/forks","keys_url":"https://api.github.com/repos/kata-containers/documentation/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kata-containers/documentation/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kata-containers/documentation/teams","hooks_url":"https://api.github.com/repos/kata-containers/documentation/hooks","issue_events_url":"https://api.github.com/repos/kata-containers/documentation/issues/events{/number}","events_url":"https://api.github.com/repos/kata-containers/documentation/events","assignees_url":"https://api.github.com/repos/kata-containers/documentation/assignees{/user}","branches_url":"https://api.github.com/repos/kata-containers/documentation/branches{/branch}","tags_url":"https://api.github.com/repos/kata-containers/documentation/tags","blobs_url":"https://api.github.com/repos/kata-containers/documentation/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kata-containers/documentation/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kata-containers/documentation/git/refs{/sha}","trees_url":"https://api.github.com/repos/kata-containers/documentation/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kata-containers/documentation/statuses/{sha}","languages_url":"https://api.github.com/repos/kata-containers/documentation/languages","stargazers_url":"https://api.github.com/repos/kata-containers/documentation/stargazers","contributors_url":"https://api.github.com/repos/kata-containers/documentation/contributors","subscribers_url":"https://api.github.com/repos/kata-containers/documentation/subscribers","subscription_url":"https://api.github.com/repos/kata-containers/documentation/subscription","commits_url":"https://api.github.com/repos/kata-containers/documentation/commits{/sha}","git_commits_url":"https://api.github.com/repos/kata-containers/documentation/git/commits{/sha}","comments_url":"https://api.github.com/repos/kata-containers/documentation/comments{/number}","issue_comment_url":"https://api.github.com/repos/kata-containers/documentation/issues/comments{/number}","contents_url":"https://api.github.com/repos/kata-containers/documentation/contents/{+path}","compare_url":"https://api.github.com/repos/kata-containers/documentation/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kata-containers/documentation/merges","archive_url":"https://api.github.com/repos/kata-containers/documentation/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kata-containers/documentation/downloads","issues_url":"https://api.github.com/repos/kata-containers/documentation/issues{/number}","pulls_url":"https://api.github.com/repos/kata-containers/documentation/pulls{/number}","milestones_url":"https://api.github.com/repos/kata-containers/documentation/milestones{/number}","notifications_url":"https://api.github.com/repos/kata-containers/documentation/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kata-containers/documentation/labels{/name}","releases_url":"https://api.github.com/repos/kata-containers/documentation/releases{/id}","deployments_url":"https://api.github.com/repos/kata-containers/documentation/deployments","created_at":"2017-12-21T13:41:45Z","updated_at":"2018-03-13T09:19:57Z","pushed_at":"2018-03-19T08:57:59Z","git_url":"git://github.com/kata-containers/documentation.git","ssh_url":"git@github.com:kata-containers/documentation.git","clone_url":"https://github.com/kata-containers/documentation.git","svn_url":"https://github.com/kata-containers/documentation","homepage":null,"size":13,"stargazers_count":13,"watchers_count":13,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":14,"mirror_url":null,"archived":false,"open_issues_count":12,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":14,"open_issues":12,"watchers":13,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/kata-containers/documentation/pulls/27"},"html":{"href":"https://github.com/kata-containers/documentation/pull/27"},"issue":{"href":"https://api.github.com/repos/kata-containers/documentation/issues/27"},"comments":{"href":"https://api.github.com/repos/kata-containers/documentation/issues/27/comments"},"review_comments":{"href":"https://api.github.com/repos/kata-containers/documentation/pulls/27/comments"},"review_comment":{"href":"https://api.github.com/repos/kata-containers/documentation/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/kata-containers/documentation/pulls/27/commits"},"statuses":{"href":"https://api.github.com/repos/kata-containers/documentation/statuses/54842cc22648469dd16116dfcf482328d8204fa4"}},"author_association":"NONE"}}
{"actor":{"display_login":"bergwolf"}}