{"action":"created","comment":{"url":"https://api.github.com/repos/lyft/envoy-api/pulls/comments/116336824","pull_request_review_id":37957872,"id":116336824,"diff_hunk":"@@ -1 +1,91 @@\n-Envoy v2 gRPC APIs\n+# Envoy v2 gRPC APIs\n+\n+## Goals\n+\n+This repository contains the draft v2 gRPC\n+[Envoy](https://github.com/lyft/envoy/) APIs. Envoy today has a number of JSON\n+REST APIs through which it may discover and have updated its runtime\n+configuration from some management server. These are:\n+\n+* [Cluster Discovery Service (CDS)](https://lyft.github.io/envoy/docs/configuration/cluster_manager/cds.html)\n+* [Rate Limit Service (RLS)](https://lyft.github.io/envoy/docs/configuration/overview/rate_limit.html)\n+* [Route Discovery Service (RDS)](https://lyft.github.io/envoy/docs/configuration/http_conn_man/rds.html)\n+* [Service Discovery Service (SDS)](https://lyft.github.io/envoy/docs/configuration/cluster_manager/sds_api.html)\n+\n+Version 2 of the Envoy API will evolve existing APIs and introduce new APIs to:\n+\n+* Allow for more advanced load balancing through load and resource utilization reporting to management servers.\n+* Improve N^2 health check scalability issues by optionally offloading health checking to other Envoy instances.\n+* Support Envoy deployment in edge, sidecar and middle proxy deployment models via changes to the listener model and CDS/SDS APIs.\n+* Allow streaming updates from the management server on change, instead of polling APIs from Envoy. gRPC APIs will be supported\n+  alongside JSON REST APIs to provide for this.\n+* Ensure all Envoy runtime configuration is dynamically discoverable via API\n+  calls, including listener configuration, certificates and runtime settings, which are today sourced from the filesystem.\n+* Revisit and where appropriate cleanup any v1 technical debt.\n+\n+## Status\n+\n+Draft work-in-progress. Input is welcome via issue filing. Small, localized PRs\n+are also welcome, but any major changes or suggestions should be coordinated in\n+a tracking issue with the authors.\n+\n+## Principles\n+\n+* [Proto3](https://developers.google.com/protocol-buffers/docs/proto3) will be\n+  used to specify the canonical API. This will provide directly the gRPC API and\n+  via gRPC-JSON transcoding the JSON REST API.\n+\n+* xDS APIs should support eventual consistency. For example, if HDS references a\n+  host that has not yet been supplied by EDS, it should be silently ignored.\n+\n+* The API is primarily intended for machine generation and consumption. It is\n+  expected that the management server is responsible for mapping higher level\n+  configuration concepts to API responses. Similarly, static configuration\n+  fragments may be generated by templating tools, etc.\n+\n+* [Wrapped](https://github.com/google/protobuf/blob/master/src/google/protobuf/wrappers.proto)\n+  protobuf fields should be used for all non-string [scalar\n+  types](https://developers.google.com/protocol-buffers/docs/proto3#scalar), to\n+  support non-zero default values. While only some fields require wrapping, for\n+  consistency we prefer to have all non-string scalar fields wrapped.\n+\n+## APIs\n+\n+Unless otherwise states, the APIs with the same names as v1 APIs have a similar role.\n+\n+* [Cluster Discovery Service](api/cds.proto).\n+* [Endpoint Discovery Service](api/eds.proto). This has the same role as SDS in the [v1 API](https://lyft.github.io/envoy/docs/configuration/cluster_manager/sds_api.html). Advanced global load balancing capable of utilizing N-dimensional upstream metrics is now supported.","path":"README.md","position":58,"original_position":58,"commit_id":"2e9ee0f2ab03bb4934228e61ba66fb4d4566609c","original_commit_id":"2e9ee0f2ab03bb4934228e61ba66fb4d4566609c","user":{"login":"mattklein123","id":6305260,"avatar_url":"https://avatars0.githubusercontent.com/u/6305260?v=3","gravatar_id":"","url":"https://api.github.com/users/mattklein123","html_url":"https://github.com/mattklein123","followers_url":"https://api.github.com/users/mattklein123/followers","following_url":"https://api.github.com/users/mattklein123/following{/other_user}","gists_url":"https://api.github.com/users/mattklein123/gists{/gist_id}","starred_url":"https://api.github.com/users/mattklein123/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mattklein123/subscriptions","organizations_url":"https://api.github.com/users/mattklein123/orgs","repos_url":"https://api.github.com/users/mattklein123/repos","events_url":"https://api.github.com/users/mattklein123/events{/privacy}","received_events_url":"https://api.github.com/users/mattklein123/received_events","type":"User","site_admin":false},"body":"I would add that it has been renamed to better describe what it does in practice.","created_at":"2017-05-12T22:41:48Z","updated_at":"2017-05-12T22:41:48Z","html_url":"https://github.com/lyft/envoy-api/pull/28#discussion_r116336824","pull_request_url":"https://api.github.com/repos/lyft/envoy-api/pulls/28","_links":{"self":{"href":"https://api.github.com/repos/lyft/envoy-api/pulls/comments/116336824"},"html":{"href":"https://github.com/lyft/envoy-api/pull/28#discussion_r116336824"},"pull_request":{"href":"https://api.github.com/repos/lyft/envoy-api/pulls/28"}}},"pull_request":{"url":"https://api.github.com/repos/lyft/envoy-api/pulls/28","id":120412588,"html_url":"https://github.com/lyft/envoy-api/pull/28","diff_url":"https://github.com/lyft/envoy-api/pull/28.diff","patch_url":"https://github.com/lyft/envoy-api/pull/28.patch","issue_url":"https://api.github.com/repos/lyft/envoy-api/issues/28","number":28,"state":"open","locked":false,"title":"API goals, principles and terminology.","user":{"login":"htuch","id":10914751,"avatar_url":"https://avatars2.githubusercontent.com/u/10914751?v=3","gravatar_id":"","url":"https://api.github.com/users/htuch","html_url":"https://github.com/htuch","followers_url":"https://api.github.com/users/htuch/followers","following_url":"https://api.github.com/users/htuch/following{/other_user}","gists_url":"https://api.github.com/users/htuch/gists{/gist_id}","starred_url":"https://api.github.com/users/htuch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/htuch/subscriptions","organizations_url":"https://api.github.com/users/htuch/orgs","repos_url":"https://api.github.com/users/htuch/repos","events_url":"https://api.github.com/users/htuch/events{/privacy}","received_events_url":"https://api.github.com/users/htuch/received_events","type":"User","site_admin":false},"body":"This borrows largely from previous writeup by @amb67 and the existing\r\nEnvoy documentation.","created_at":"2017-05-12T21:48:43Z","updated_at":"2017-05-12T22:41:48Z","closed_at":null,"merged_at":null,"merge_commit_sha":"9517c4b09e7192e49047099739584a707a574ed7","assignee":null,"assignees":[],"requested_reviewers":[],"milestone":null,"commits_url":"https://api.github.com/repos/lyft/envoy-api/pulls/28/commits","review_comments_url":"https://api.github.com/repos/lyft/envoy-api/pulls/28/comments","review_comment_url":"https://api.github.com/repos/lyft/envoy-api/pulls/comments{/number}","comments_url":"https://api.github.com/repos/lyft/envoy-api/issues/28/comments","statuses_url":"https://api.github.com/repos/lyft/envoy-api/statuses/2e9ee0f2ab03bb4934228e61ba66fb4d4566609c","head":{"label":"htuch:readme","ref":"readme","sha":"2e9ee0f2ab03bb4934228e61ba66fb4d4566609c","user":{"login":"htuch","id":10914751,"avatar_url":"https://avatars2.githubusercontent.com/u/10914751?v=3","gravatar_id":"","url":"https://api.github.com/users/htuch","html_url":"https://github.com/htuch","followers_url":"https://api.github.com/users/htuch/followers","following_url":"https://api.github.com/users/htuch/following{/other_user}","gists_url":"https://api.github.com/users/htuch/gists{/gist_id}","starred_url":"https://api.github.com/users/htuch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/htuch/subscriptions","organizations_url":"https://api.github.com/users/htuch/orgs","repos_url":"https://api.github.com/users/htuch/repos","events_url":"https://api.github.com/users/htuch/events{/privacy}","received_events_url":"https://api.github.com/users/htuch/received_events","type":"User","site_admin":false},"repo":{"id":90780141,"name":"envoy-api","full_name":"htuch/envoy-api","owner":{"login":"htuch","id":10914751,"avatar_url":"https://avatars2.githubusercontent.com/u/10914751?v=3","gravatar_id":"","url":"https://api.github.com/users/htuch","html_url":"https://github.com/htuch","followers_url":"https://api.github.com/users/htuch/followers","following_url":"https://api.github.com/users/htuch/following{/other_user}","gists_url":"https://api.github.com/users/htuch/gists{/gist_id}","starred_url":"https://api.github.com/users/htuch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/htuch/subscriptions","organizations_url":"https://api.github.com/users/htuch/orgs","repos_url":"https://api.github.com/users/htuch/repos","events_url":"https://api.github.com/users/htuch/events{/privacy}","received_events_url":"https://api.github.com/users/htuch/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/htuch/envoy-api","description":"Envoy REST/proto API definitions","fork":true,"url":"https://api.github.com/repos/htuch/envoy-api","forks_url":"https://api.github.com/repos/htuch/envoy-api/forks","keys_url":"https://api.github.com/repos/htuch/envoy-api/keys{/key_id}","collaborators_url":"https://api.github.com/repos/htuch/envoy-api/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/htuch/envoy-api/teams","hooks_url":"https://api.github.com/repos/htuch/envoy-api/hooks","issue_events_url":"https://api.github.com/repos/htuch/envoy-api/issues/events{/number}","events_url":"https://api.github.com/repos/htuch/envoy-api/events","assignees_url":"https://api.github.com/repos/htuch/envoy-api/assignees{/user}","branches_url":"https://api.github.com/repos/htuch/envoy-api/branches{/branch}","tags_url":"https://api.github.com/repos/htuch/envoy-api/tags","blobs_url":"https://api.github.com/repos/htuch/envoy-api/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/htuch/envoy-api/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/htuch/envoy-api/git/refs{/sha}","trees_url":"https://api.github.com/repos/htuch/envoy-api/git/trees{/sha}","statuses_url":"https://api.github.com/repos/htuch/envoy-api/statuses/{sha}","languages_url":"https://api.github.com/repos/htuch/envoy-api/languages","stargazers_url":"https://api.github.com/repos/htuch/envoy-api/stargazers","contributors_url":"https://api.github.com/repos/htuch/envoy-api/contributors","subscribers_url":"https://api.github.com/repos/htuch/envoy-api/subscribers","subscription_url":"https://api.github.com/repos/htuch/envoy-api/subscription","commits_url":"https://api.github.com/repos/htuch/envoy-api/commits{/sha}","git_commits_url":"https://api.github.com/repos/htuch/envoy-api/git/commits{/sha}","comments_url":"https://api.github.com/repos/htuch/envoy-api/comments{/number}","issue_comment_url":"https://api.github.com/repos/htuch/envoy-api/issues/comments{/number}","contents_url":"https://api.github.com/repos/htuch/envoy-api/contents/{+path}","compare_url":"https://api.github.com/repos/htuch/envoy-api/compare/{base}...{head}","merges_url":"https://api.github.com/repos/htuch/envoy-api/merges","archive_url":"https://api.github.com/repos/htuch/envoy-api/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/htuch/envoy-api/downloads","issues_url":"https://api.github.com/repos/htuch/envoy-api/issues{/number}","pulls_url":"https://api.github.com/repos/htuch/envoy-api/pulls{/number}","milestones_url":"https://api.github.com/repos/htuch/envoy-api/milestones{/number}","notifications_url":"https://api.github.com/repos/htuch/envoy-api/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/htuch/envoy-api/labels{/name}","releases_url":"https://api.github.com/repos/htuch/envoy-api/releases{/id}","deployments_url":"https://api.github.com/repos/htuch/envoy-api/deployments","created_at":"2017-05-09T18:42:40Z","updated_at":"2017-05-09T18:42:41Z","pushed_at":"2017-05-12T21:59:49Z","git_url":"git://github.com/htuch/envoy-api.git","ssh_url":"git@github.com:htuch/envoy-api.git","clone_url":"https://github.com/htuch/envoy-api.git","svn_url":"https://github.com/htuch/envoy-api","homepage":null,"size":44,"stargazers_count":0,"watchers_count":0,"language":"Protocol Buffer","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":"lyft:master","ref":"master","sha":"e13c452e75c227fd5f887aec9d9f8f0c89efd1b3","user":{"login":"lyft","id":4269340,"avatar_url":"https://avatars1.githubusercontent.com/u/4269340?v=3","gravatar_id":"","url":"https://api.github.com/users/lyft","html_url":"https://github.com/lyft","followers_url":"https://api.github.com/users/lyft/followers","following_url":"https://api.github.com/users/lyft/following{/other_user}","gists_url":"https://api.github.com/users/lyft/gists{/gist_id}","starred_url":"https://api.github.com/users/lyft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lyft/subscriptions","organizations_url":"https://api.github.com/users/lyft/orgs","repos_url":"https://api.github.com/users/lyft/repos","events_url":"https://api.github.com/users/lyft/events{/privacy}","received_events_url":"https://api.github.com/users/lyft/received_events","type":"Organization","site_admin":false},"repo":{"id":90675549,"name":"envoy-api","full_name":"lyft/envoy-api","owner":{"login":"lyft","id":4269340,"avatar_url":"https://avatars1.githubusercontent.com/u/4269340?v=3","gravatar_id":"","url":"https://api.github.com/users/lyft","html_url":"https://github.com/lyft","followers_url":"https://api.github.com/users/lyft/followers","following_url":"https://api.github.com/users/lyft/following{/other_user}","gists_url":"https://api.github.com/users/lyft/gists{/gist_id}","starred_url":"https://api.github.com/users/lyft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lyft/subscriptions","organizations_url":"https://api.github.com/users/lyft/orgs","repos_url":"https://api.github.com/users/lyft/repos","events_url":"https://api.github.com/users/lyft/events{/privacy}","received_events_url":"https://api.github.com/users/lyft/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/lyft/envoy-api","description":"Envoy REST/proto API definitions","fork":false,"url":"https://api.github.com/repos/lyft/envoy-api","forks_url":"https://api.github.com/repos/lyft/envoy-api/forks","keys_url":"https://api.github.com/repos/lyft/envoy-api/keys{/key_id}","collaborators_url":"https://api.github.com/repos/lyft/envoy-api/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/lyft/envoy-api/teams","hooks_url":"https://api.github.com/repos/lyft/envoy-api/hooks","issue_events_url":"https://api.github.com/repos/lyft/envoy-api/issues/events{/number}","events_url":"https://api.github.com/repos/lyft/envoy-api/events","assignees_url":"https://api.github.com/repos/lyft/envoy-api/assignees{/user}","branches_url":"https://api.github.com/repos/lyft/envoy-api/branches{/branch}","tags_url":"https://api.github.com/repos/lyft/envoy-api/tags","blobs_url":"https://api.github.com/repos/lyft/envoy-api/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/lyft/envoy-api/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/lyft/envoy-api/git/refs{/sha}","trees_url":"https://api.github.com/repos/lyft/envoy-api/git/trees{/sha}","statuses_url":"https://api.github.com/repos/lyft/envoy-api/statuses/{sha}","languages_url":"https://api.github.com/repos/lyft/envoy-api/languages","stargazers_url":"https://api.github.com/repos/lyft/envoy-api/stargazers","contributors_url":"https://api.github.com/repos/lyft/envoy-api/contributors","subscribers_url":"https://api.github.com/repos/lyft/envoy-api/subscribers","subscription_url":"https://api.github.com/repos/lyft/envoy-api/subscription","commits_url":"https://api.github.com/repos/lyft/envoy-api/commits{/sha}","git_commits_url":"https://api.github.com/repos/lyft/envoy-api/git/commits{/sha}","comments_url":"https://api.github.com/repos/lyft/envoy-api/comments{/number}","issue_comment_url":"https://api.github.com/repos/lyft/envoy-api/issues/comments{/number}","contents_url":"https://api.github.com/repos/lyft/envoy-api/contents/{+path}","compare_url":"https://api.github.com/repos/lyft/envoy-api/compare/{base}...{head}","merges_url":"https://api.github.com/repos/lyft/envoy-api/merges","archive_url":"https://api.github.com/repos/lyft/envoy-api/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/lyft/envoy-api/downloads","issues_url":"https://api.github.com/repos/lyft/envoy-api/issues{/number}","pulls_url":"https://api.github.com/repos/lyft/envoy-api/pulls{/number}","milestones_url":"https://api.github.com/repos/lyft/envoy-api/milestones{/number}","notifications_url":"https://api.github.com/repos/lyft/envoy-api/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/lyft/envoy-api/labels{/name}","releases_url":"https://api.github.com/repos/lyft/envoy-api/releases{/id}","deployments_url":"https://api.github.com/repos/lyft/envoy-api/deployments","created_at":"2017-05-08T21:50:29Z","updated_at":"2017-05-12T15:20:34Z","pushed_at":"2017-05-12T21:59:50Z","git_url":"git://github.com/lyft/envoy-api.git","ssh_url":"git@github.com:lyft/envoy-api.git","clone_url":"https://github.com/lyft/envoy-api.git","svn_url":"https://github.com/lyft/envoy-api","homepage":null,"size":30,"stargazers_count":5,"watchers_count":5,"language":"Protocol Buffer","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":7,"mirror_url":null,"open_issues_count":16,"forks":7,"open_issues":16,"watchers":5,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/lyft/envoy-api/pulls/28"},"html":{"href":"https://github.com/lyft/envoy-api/pull/28"},"issue":{"href":"https://api.github.com/repos/lyft/envoy-api/issues/28"},"comments":{"href":"https://api.github.com/repos/lyft/envoy-api/issues/28/comments"},"review_comments":{"href":"https://api.github.com/repos/lyft/envoy-api/pulls/28/comments"},"review_comment":{"href":"https://api.github.com/repos/lyft/envoy-api/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/lyft/envoy-api/pulls/28/commits"},"statuses":{"href":"https://api.github.com/repos/lyft/envoy-api/statuses/2e9ee0f2ab03bb4934228e61ba66fb4d4566609c"}}}}
{"actor":{"display_login":"mattklein123"}}