{"action":"created","comment":{"url":"https://api.github.com/repos/kata-containers/runtime/pulls/comments/176770956","pull_request_review_id":106537056,"id":176770956,"diff_hunk":"@@ -1,5 +1,137 @@\n [![Build Status](https://travis-ci.org/kata-containers/runtime.svg?branch=master)](https://travis-ci.org/kata-containers/runtime)\n+[![Build Status](http://kata-jenkins-ci.westus2.cloudapp.azure.com/job/kata-containers-runtime-ubuntu-16-04-master/badge/icon)](http://kata-jenkins-ci.westus2.cloudapp.azure.com/job/kata-containers-runtime-ubuntu-16-04-master/)\n+[![Go Report Card](https://goreportcard.com/badge/github.com/kata-containers/runtime)](https://goreportcard.com/report/github.com/kata-containers/runtime)\n \n # Runtime\n \n-This project contains the runtime for the Kata Containers project.\n+This project contains the runtime for the [Kata Containers](https://github.com/kata-containers/) project.\n+\n+* [Introduction](#introduction)\n+* [License](#license)\n+* [Platform support](#platform-support)\n+    * [Hardware requirements](#hardware-requirements)\n+* [Quick start for developers](#quick-start-for-developers)\n+* [Configuration](#configuration)\n+* [Logging](#logging)\n+* [Debugging](#debugging)\n+* [Community](#community)\n+* [Home Page](#home-page)\n+\n+## Introduction\n+\n+`kata-runtime`, henceforth known simply as \"the runtime\", is the\n+CLI (command-line interface) part of the Kata Containers runtime component. It leverages the\n+[virtcontainers](https://github.com/kata-containers/runtime/tree/master/virtcontainers)\n+package to provide a high-performance standards-compliant runtime that creates\n+hardware-virtualized containers.\n+\n+The runtime is both\n+[OCI](https://github.com/opencontainers/runtime-spec)-compatible and\n+[CRI-O](https://github.com/kubernetes-incubator/cri-o)-compatible, allowing it\n+to work seamlessly with both Docker and Kubernetes respectively.\n+\n+## License\n+\n+The code is licensed under an Apache 2.0 license.\n+\n+See [the license file](LICENSE) for further details.\n+\n+## Platform support\n+\n+Kata Containers currently works on systems supporting the following\n+technologies:\n+\n+- [Intel](https://www.intel.com)'s VT-x technology.\n+- [ARM](https://www.arm.com)'s Hyp mode (virtualization extension).\n+\n+### Hardware requirements\n+\n+The runtime has a built-in command to determine if your host system is capable\n+of running a Kata Container:\n+\n+```bash\n+$ kata-runtime kata-check\n+```\n+\n+> **Note:**\n+> \n+> If you run the command above as the `root` user, further checks will be\n+> performed (e.g. it will check if another incompatible hypervisor is running):\n+> \n+> ```bash\n+> $ sudo kata-runtime kata-check\n+> ```\n+\n+## Quick start for developers\n+\n+See the\n+[developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md).\n+\n+## Configuration\n+\n+The runtime uses a TOML format configuration file called `configuration.toml`.\n+The file contains comments explaining all options.\n+\n+> **Note:**\n+> \n+> Most users will not need to modify the default configuration.\n+\n+Since the runtime supports a\n+[stateless system](https://clearlinux.org/features/stateless),\n+it checks for this configuration file in multiple locations, two of which are\n+built in to the runtime. The default location is\n+`/usr/share/defaults/kata-containers/configuration.toml` for a standard\n+system. However, if `/etc/kata-containers/configuration.toml` exists, this\n+will take priority.\n+\n+The command below will list the full paths to the configuration files the runtime\n+will attempt to load. The first path that exists will be used:\n+\n+```bash\n+$ kata-runtime --kata-show-default-config-paths\n+```\n+\n+Aside from the built-in locations, it is possible to\n+specify the path to a custom configuration file using the `` option:\n+\n+```bash\n+$ kata-runtime --kata-config=/some/where/configuration.toml\n+```\n+\n+The runtime will log the full path to the configuration file it is using. See\n+the [logging](#Logging) section for further details.\n+\n+To see details of your systems runtime environment (including the location of\n+the configuration file being used), run:\n+\n+```bash\n+$ kata-runtime kata-env\n+```\n+\n+## Logging\n+\n+The runtime provides `--log=` and `--log-format=` options. However, the\n+runtime will always log to the system log (syslog or `journald`).","path":"README.md","position":115,"original_position":115,"commit_id":"78c918a682c91c985b6e97ceac3c9b5f002f2644","original_commit_id":"78c918a682c91c985b6e97ceac3c9b5f002f2644","user":{"login":"grahamwhaley","id":4761717,"avatar_url":"https://avatars3.githubusercontent.com/u/4761717?v=4","gravatar_id":"","url":"https://api.github.com/users/grahamwhaley","html_url":"https://github.com/grahamwhaley","followers_url":"https://api.github.com/users/grahamwhaley/followers","following_url":"https://api.github.com/users/grahamwhaley/following{/other_user}","gists_url":"https://api.github.com/users/grahamwhaley/gists{/gist_id}","starred_url":"https://api.github.com/users/grahamwhaley/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/grahamwhaley/subscriptions","organizations_url":"https://api.github.com/users/grahamwhaley/orgs","repos_url":"https://api.github.com/users/grahamwhaley/repos","events_url":"https://api.github.com/users/grahamwhaley/events{/privacy}","received_events_url":"https://api.github.com/users/grahamwhaley/received_events","type":"User","site_admin":false},"body":"`` around syslog?","created_at":"2018-03-23T15:25:43Z","updated_at":"2018-03-23T15:26:33Z","html_url":"https://github.com/kata-containers/runtime/pull/112#discussion_r176770956","pull_request_url":"https://api.github.com/repos/kata-containers/runtime/pulls/112","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/kata-containers/runtime/pulls/comments/176770956"},"html":{"href":"https://github.com/kata-containers/runtime/pull/112#discussion_r176770956"},"pull_request":{"href":"https://api.github.com/repos/kata-containers/runtime/pulls/112"}}},"pull_request":{"url":"https://api.github.com/repos/kata-containers/runtime/pulls/112","id":177100272,"html_url":"https://github.com/kata-containers/runtime/pull/112","diff_url":"https://github.com/kata-containers/runtime/pull/112.diff","patch_url":"https://github.com/kata-containers/runtime/pull/112.patch","issue_url":"https://api.github.com/repos/kata-containers/runtime/issues/112","number":112,"state":"open","locked":false,"title":"docs: Improve the README","user":{"login":"jodh-intel","id":20315601,"avatar_url":"https://avatars1.githubusercontent.com/u/20315601?v=4","gravatar_id":"","url":"https://api.github.com/users/jodh-intel","html_url":"https://github.com/jodh-intel","followers_url":"https://api.github.com/users/jodh-intel/followers","following_url":"https://api.github.com/users/jodh-intel/following{/other_user}","gists_url":"https://api.github.com/users/jodh-intel/gists{/gist_id}","starred_url":"https://api.github.com/users/jodh-intel/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jodh-intel/subscriptions","organizations_url":"https://api.github.com/users/jodh-intel/orgs","repos_url":"https://api.github.com/users/jodh-intel/repos","events_url":"https://api.github.com/users/jodh-intel/events{/privacy}","received_events_url":"https://api.github.com/users/jodh-intel/received_events","type":"User","site_admin":false},"body":"Add in details to the `README`.\r\n\r\nFixes #111.\r\n\r\nSigned-off-by: James O. D. Hunt <james.o.hunt@intel.com>","created_at":"2018-03-23T15:15:45Z","updated_at":"2018-03-23T15:26:33Z","closed_at":null,"merged_at":null,"merge_commit_sha":"eda2e1b2625a9c7260977ec83bda73bf7731835b","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":837054292,"url":"https://api.github.com/repos/kata-containers/runtime/labels/review","name":"review","color":"ededed","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/kata-containers/runtime/pulls/112/commits","review_comments_url":"https://api.github.com/repos/kata-containers/runtime/pulls/112/comments","review_comment_url":"https://api.github.com/repos/kata-containers/runtime/pulls/comments{/number}","comments_url":"https://api.github.com/repos/kata-containers/runtime/issues/112/comments","statuses_url":"https://api.github.com/repos/kata-containers/runtime/statuses/78c918a682c91c985b6e97ceac3c9b5f002f2644","head":{"label":"jodh-intel:improve-readme","ref":"improve-readme","sha":"78c918a682c91c985b6e97ceac3c9b5f002f2644","user":{"login":"jodh-intel","id":20315601,"avatar_url":"https://avatars1.githubusercontent.com/u/20315601?v=4","gravatar_id":"","url":"https://api.github.com/users/jodh-intel","html_url":"https://github.com/jodh-intel","followers_url":"https://api.github.com/users/jodh-intel/followers","following_url":"https://api.github.com/users/jodh-intel/following{/other_user}","gists_url":"https://api.github.com/users/jodh-intel/gists{/gist_id}","starred_url":"https://api.github.com/users/jodh-intel/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jodh-intel/subscriptions","organizations_url":"https://api.github.com/users/jodh-intel/orgs","repos_url":"https://api.github.com/users/jodh-intel/repos","events_url":"https://api.github.com/users/jodh-intel/events{/privacy}","received_events_url":"https://api.github.com/users/jodh-intel/received_events","type":"User","site_admin":false},"repo":{"id":115030043,"name":"runtimes","full_name":"jodh-intel/runtimes","owner":{"login":"jodh-intel","id":20315601,"avatar_url":"https://avatars1.githubusercontent.com/u/20315601?v=4","gravatar_id":"","url":"https://api.github.com/users/jodh-intel","html_url":"https://github.com/jodh-intel","followers_url":"https://api.github.com/users/jodh-intel/followers","following_url":"https://api.github.com/users/jodh-intel/following{/other_user}","gists_url":"https://api.github.com/users/jodh-intel/gists{/gist_id}","starred_url":"https://api.github.com/users/jodh-intel/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jodh-intel/subscriptions","organizations_url":"https://api.github.com/users/jodh-intel/orgs","repos_url":"https://api.github.com/users/jodh-intel/repos","events_url":"https://api.github.com/users/jodh-intel/events{/privacy}","received_events_url":"https://api.github.com/users/jodh-intel/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/jodh-intel/runtimes","description":"Kata Containers runtimes","fork":true,"url":"https://api.github.com/repos/jodh-intel/runtimes","forks_url":"https://api.github.com/repos/jodh-intel/runtimes/forks","keys_url":"https://api.github.com/repos/jodh-intel/runtimes/keys{/key_id}","collaborators_url":"https://api.github.com/repos/jodh-intel/runtimes/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/jodh-intel/runtimes/teams","hooks_url":"https://api.github.com/repos/jodh-intel/runtimes/hooks","issue_events_url":"https://api.github.com/repos/jodh-intel/runtimes/issues/events{/number}","events_url":"https://api.github.com/repos/jodh-intel/runtimes/events","assignees_url":"https://api.github.com/repos/jodh-intel/runtimes/assignees{/user}","branches_url":"https://api.github.com/repos/jodh-intel/runtimes/branches{/branch}","tags_url":"https://api.github.com/repos/jodh-intel/runtimes/tags","blobs_url":"https://api.github.com/repos/jodh-intel/runtimes/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/jodh-intel/runtimes/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/jodh-intel/runtimes/git/refs{/sha}","trees_url":"https://api.github.com/repos/jodh-intel/runtimes/git/trees{/sha}","statuses_url":"https://api.github.com/repos/jodh-intel/runtimes/statuses/{sha}","languages_url":"https://api.github.com/repos/jodh-intel/runtimes/languages","stargazers_url":"https://api.github.com/repos/jodh-intel/runtimes/stargazers","contributors_url":"https://api.github.com/repos/jodh-intel/runtimes/contributors","subscribers_url":"https://api.github.com/repos/jodh-intel/runtimes/subscribers","subscription_url":"https://api.github.com/repos/jodh-intel/runtimes/subscription","commits_url":"https://api.github.com/repos/jodh-intel/runtimes/commits{/sha}","git_commits_url":"https://api.github.com/repos/jodh-intel/runtimes/git/commits{/sha}","comments_url":"https://api.github.com/repos/jodh-intel/runtimes/comments{/number}","issue_comment_url":"https://api.github.com/repos/jodh-intel/runtimes/issues/comments{/number}","contents_url":"https://api.github.com/repos/jodh-intel/runtimes/contents/{+path}","compare_url":"https://api.github.com/repos/jodh-intel/runtimes/compare/{base}...{head}","merges_url":"https://api.github.com/repos/jodh-intel/runtimes/merges","archive_url":"https://api.github.com/repos/jodh-intel/runtimes/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/jodh-intel/runtimes/downloads","issues_url":"https://api.github.com/repos/jodh-intel/runtimes/issues{/number}","pulls_url":"https://api.github.com/repos/jodh-intel/runtimes/pulls{/number}","milestones_url":"https://api.github.com/repos/jodh-intel/runtimes/milestones{/number}","notifications_url":"https://api.github.com/repos/jodh-intel/runtimes/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/jodh-intel/runtimes/labels{/name}","releases_url":"https://api.github.com/repos/jodh-intel/runtimes/releases{/id}","deployments_url":"https://api.github.com/repos/jodh-intel/runtimes/deployments","created_at":"2017-12-21T17:21:15Z","updated_at":"2017-12-21T13:40:44Z","pushed_at":"2018-03-23T15:19:24Z","git_url":"git://github.com/jodh-intel/runtimes.git","ssh_url":"git@github.com:jodh-intel/runtimes.git","clone_url":"https://github.com/jodh-intel/runtimes.git","svn_url":"https://github.com/jodh-intel/runtimes","homepage":"","size":3659,"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":null,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"kata-containers:master","ref":"master","sha":"057bbf0dc4a6a5c87b272c421b1eecb66ec793b2","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":110539997,"name":"runtime","full_name":"kata-containers/runtime","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/runtime","description":"Kata Containers runtimes","fork":false,"url":"https://api.github.com/repos/kata-containers/runtime","forks_url":"https://api.github.com/repos/kata-containers/runtime/forks","keys_url":"https://api.github.com/repos/kata-containers/runtime/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kata-containers/runtime/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kata-containers/runtime/teams","hooks_url":"https://api.github.com/repos/kata-containers/runtime/hooks","issue_events_url":"https://api.github.com/repos/kata-containers/runtime/issues/events{/number}","events_url":"https://api.github.com/repos/kata-containers/runtime/events","assignees_url":"https://api.github.com/repos/kata-containers/runtime/assignees{/user}","branches_url":"https://api.github.com/repos/kata-containers/runtime/branches{/branch}","tags_url":"https://api.github.com/repos/kata-containers/runtime/tags","blobs_url":"https://api.github.com/repos/kata-containers/runtime/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kata-containers/runtime/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kata-containers/runtime/git/refs{/sha}","trees_url":"https://api.github.com/repos/kata-containers/runtime/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kata-containers/runtime/statuses/{sha}","languages_url":"https://api.github.com/repos/kata-containers/runtime/languages","stargazers_url":"https://api.github.com/repos/kata-containers/runtime/stargazers","contributors_url":"https://api.github.com/repos/kata-containers/runtime/contributors","subscribers_url":"https://api.github.com/repos/kata-containers/runtime/subscribers","subscription_url":"https://api.github.com/repos/kata-containers/runtime/subscription","commits_url":"https://api.github.com/repos/kata-containers/runtime/commits{/sha}","git_commits_url":"https://api.github.com/repos/kata-containers/runtime/git/commits{/sha}","comments_url":"https://api.github.com/repos/kata-containers/runtime/comments{/number}","issue_comment_url":"https://api.github.com/repos/kata-containers/runtime/issues/comments{/number}","contents_url":"https://api.github.com/repos/kata-containers/runtime/contents/{+path}","compare_url":"https://api.github.com/repos/kata-containers/runtime/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kata-containers/runtime/merges","archive_url":"https://api.github.com/repos/kata-containers/runtime/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kata-containers/runtime/downloads","issues_url":"https://api.github.com/repos/kata-containers/runtime/issues{/number}","pulls_url":"https://api.github.com/repos/kata-containers/runtime/pulls{/number}","milestones_url":"https://api.github.com/repos/kata-containers/runtime/milestones{/number}","notifications_url":"https://api.github.com/repos/kata-containers/runtime/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kata-containers/runtime/labels{/name}","releases_url":"https://api.github.com/repos/kata-containers/runtime/releases{/id}","deployments_url":"https://api.github.com/repos/kata-containers/runtime/deployments","created_at":"2017-11-13T11:29:03Z","updated_at":"2018-03-23T09:47:41Z","pushed_at":"2018-03-23T15:19:24Z","git_url":"git://github.com/kata-containers/runtime.git","ssh_url":"git@github.com:kata-containers/runtime.git","clone_url":"https://github.com/kata-containers/runtime.git","svn_url":"https://github.com/kata-containers/runtime","homepage":"","size":3614,"stargazers_count":91,"watchers_count":91,"language":"Go","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":27,"mirror_url":null,"archived":false,"open_issues_count":40,"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":27,"open_issues":40,"watchers":91,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/kata-containers/runtime/pulls/112"},"html":{"href":"https://github.com/kata-containers/runtime/pull/112"},"issue":{"href":"https://api.github.com/repos/kata-containers/runtime/issues/112"},"comments":{"href":"https://api.github.com/repos/kata-containers/runtime/issues/112/comments"},"review_comments":{"href":"https://api.github.com/repos/kata-containers/runtime/pulls/112/comments"},"review_comment":{"href":"https://api.github.com/repos/kata-containers/runtime/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/kata-containers/runtime/pulls/112/commits"},"statuses":{"href":"https://api.github.com/repos/kata-containers/runtime/statuses/78c918a682c91c985b6e97ceac3c9b5f002f2644"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"grahamwhaley"}}