Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Load reporting service documentation #10962

Merged
merged 7 commits into from
May 20, 2020
Merged

Load reporting service documentation #10962

merged 7 commits into from
May 20, 2020

Conversation

kathan24
Copy link
Contributor

@kathan24 kathan24 commented Apr 27, 2020 •
edited
Loading

For an explanation of how to fill out the fields, please see the relevant section
in PULL_REQUESTS.md

Commit Message: Load Reporting Service documentation
Additional Description:
Risk Level: Low
Testing:
Docs Changes: Yes, for Load Reporting Service
Release Notes:
[Optional Fixes #Issue]: 9651
[Optional Deprecated:]

kathan24 added 2 commits April 24, 2020 16:42
@kathan24
Doc for Load Reporting Service
1e3dd52 
Signed-off-by: kathan24 <kshah@lyft.com>
@kathan24
Changes to generated_api_shadow
e1dd272 
Signed-off-by: kathan24 <kshah@lyft.com>
@repokitteh-read-only
Copy link

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/.

🐱

Caused by: #10962 was opened by kathan24.

see: more, trace.

wgallagher
wgallagher previously approved these changes Apr 27, 2020
View reviewed changes
Copy link

@wgallagher wgallagher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 very minor comments but looks good

@kathan24
addressed reviewers feedback
01c35a1 
Signed-off-by: kathan24 <kshah@lyft.com>
@mattklein123 mattklein123 self-assigned this Apr 27, 2020
htuch
htuch reviewed Apr 28, 2020
View reviewed changes
Copy link
Member

@htuch htuch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, the existing docs/comment are quite stale, appreciate the cleanup.

api/envoy/config/endpoint/v3/load_report.proto Outdated Show resolved Hide resolved
api/envoy/service/load_stats/v3/lrs.proto Outdated Show resolved Hide resolved
mattklein123
mattklein123 requested changes Apr 28, 2020
View reviewed changes
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this. Can you also add some small blurb about this feature to the arch overview with links into the detailed config as well as a link to your example? Perhaps here? https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/upstream

Thank you!

/wait

api/envoy/service/load_stats/v3/lrs.proto Outdated Show resolved Hide resolved
@stale
Copy link

stale bot commented May 6, 2020

This pull request has been automatically marked as stale because it has not had activity in the last 7 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

@stale stale bot added the stale stalebot believes this issue/PR has not been touched recently label May 6, 2020
@kathan24
arch overview
d0d51d1 
Signed-off-by: kathan24 <kshah@lyft.com>
@repokitteh-read-only
Copy link

CC @envoyproxy/api-watchers: FYI only for changes made to api/.

🐱

Caused by: #10962 was synchronize by kathan24.

see: more, trace.

@stale stale bot removed the stale stalebot believes this issue/PR has not been touched recently label May 12, 2020
mattklein123
mattklein123 requested changes May 12, 2020
View reviewed changes
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Looks good with a few small comments. Please also update the PR description to actually properly fill out the template. Thanks!

/wait

api/envoy/service/load_stats/v3/lrs.proto Outdated
// :ref:`LoadStatsRequest <envoy_api_msg_service.load_stats.v3.LoadStatsRequest>`. This is done periodically
// based on the :ref:`load reporting interval <envoy_api_field_service.load_stats.v3.LoadStatsResponse.load_reporting_interval>`
// For details, take a look at the `sandbox example
// <https://www.envoyproxy.io/docs/envoy/latest/start/sandboxes/load_reporting_service.html>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please ref link directly to the RST page vs. use a hard coded link.

docs/root/intro/arch_overview/upstream/load_reporting_service.rst Outdated Show resolved Hide resolved
docs/root/intro/arch_overview/upstream/load_reporting_service.rst Outdated Show resolved Hide resolved
docs/root/intro/arch_overview/upstream/load_reporting_service.rst Outdated Show resolved Hide resolved
kathan24 added 2 commits May 14, 2020 17:23
@kathan24
Merge branch 'master' of github.com:envoyproxy/envoy into load-repori…
f1dfddd 
…nting-service-doc

� Conflicts:
�	docs/root/api-v3/config/config.rst
�	generated_api_shadow/envoy/service/load_stats/v3/lrs.proto

Signed-off-by: kathan24 <kshah@lyft.com>
@kathan24
minor changes
77e89e1 
Signed-off-by: kathan24 <kshah@lyft.com>
@mattklein123
Copy link
Member

Please fix format.

/wait

@kathan24
format fix
8ff6c9b 
Signed-off-by: kathan24 <kshah@lyft.com>
mattklein123
mattklein123 approved these changes May 20, 2020
View reviewed changes
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!!!

@mattklein123 mattklein123 merged commit 570f7ac into envoyproxy:master May 20, 2020
spenceral added a commit to spenceral/envoy that referenced this pull request May 20, 2020
@spenceral
Merge branch 'master' into response-info-headers
ca19a15 
Signed-off-by: Spencer Lewis <slewis@squareup.com>

* master: (33 commits)
  docs: break release notes into categories (envoyproxy#11217)
  admin: extract more handlers to separate classes  (envoyproxy#11258)
  Load reporting service documentation  (envoyproxy#10962)
  http: testing 304-with-body behavior (envoyproxy#11261)
  fixing typos and breaking link issues (envoyproxy#11270)
  devex: initial commit of devcontainer setup (envoyproxy#11207)
  security: update policy for fix/disclosure SLOs. (envoyproxy#11243)
  http: fixing CONNECT to not advertise chunk encoding. (envoyproxy#11245)
  docs: update upstream network filters description (envoyproxy#11231)
  deps: update datadog tracer to v1.1.5 (envoyproxy#11253)
  test: Fix missing instantiation of parameterized tests. (envoyproxy#11247)
  fix go mirror when no changes (envoyproxy#11249)
  docs: host_rewrite -> host_rewrite_literal (envoyproxy#11229)
  wasm: update V8 to v8.3.110.9. (envoyproxy#11233)
  tls: update BoringSSL to 107c03cf (4103). (envoyproxy#11232)
  bazelci: always exclude nocoverage tag in coverage config (envoyproxy#11226)
  ci: save api revision in go-control-plane (envoyproxy#11220)
  build: fix cares build (envoyproxy#11225)
  stats: Pre-allocate codec stats for http1 and http2 (envoyproxy#11135)
  api: manifest based edge default documentation. (envoyproxy#11151)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@htuch htuch htuch left review comments

@mattklein123 mattklein123 mattklein123 approved these changes

@wgallagher wgallagher wgallagher left review comments

Assignees

@mattklein123 mattklein123

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kathan24 @mattklein123 @wgallagher @htuch