Add high-level overview and diagrams for MCP #805

ayj · 2019-02-20T20:47:53Z

fixes #567

ozevren · 2019-02-21T15:47:25Z

mcp/Readme.md

+
+![Resource full-state incremental success](v1alpha1/diagrams/collection-incremental-update-success.svg)
+
+### Error example


Can you add more details here, specifically about the behavior of server in case of nack in both incremental and non-incremental cases?

How about incremental behavior in case of nack? Does the server try to do keep doing incremental, or should it switch to full-state transfer?

There currently isn't any difference in handling NACK between incremental and non-incremental. NACK is really an exceptional case which requires deeper human investigation and corrective measure, e.g. deploy a new version of Pilot. Switching to full-state shouldn't make a meaningful difference if, for example, schema versions are out of sync.

ozevren · 2019-02-21T19:28:15Z

mcp/Readme.md

+
+![Resource full-state incremental success](v1alpha1/diagrams/collection-incremental-update-success.svg)
+
+### Error example


How about incremental behavior in case of nack? Does the server try to do keep doing incremental, or should it switch to full-state transfer?

ozevren · 2019-02-21T19:28:55Z

mcp/Readme.md

+The nonce in MCP is used to match RequestResources and Resources. On
+reconnect, the sinks may attempt to resume a session with the same
+source by specifying the known resources version with
+initial_resource_version for each collection.


Can you describe the behavior of what happens when there is an unknown nonce? (i.e. server is restarted).

Updated - tl;dr requests with unknown/stale nonces are ignored.

ozevren · 2019-02-21T19:45:07Z

/lgtm

istio-testing · 2019-02-21T19:45:11Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ayj, ozevren

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ozevren]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ayj · 2019-02-21T19:50:31Z

/assign @geeknoid

@duderino @geeknoid @Nino-K - this is a developer documentation change that would be nice to have in 1.1 release. However, we can also push it into the master branch of istio/api and point platform integrators (e.g. CF) there with the understanding that it applies to the 1.1 release.

* Doc fixes. * Add high-level overview and diagrams for MCP (#805) * document MCP * add additional note on NACK behavior * add a note about ignoring stale nonces * Add envoy metrics service configuration to ProxyConfig (#803) * Add envoy metrics service configuration to ProxyConfig Similar to the statsd sink config, this change is in preparation for adding support for the envoy metrics service API. * Update proto.lock * Reorder metrics_service_address just after statsd_udp_address * Update comment in the authN API to match with 1.1 behavior (#808) * Rename metrics_service_address to clarify that it is for Envoy's API (#809) Since "metrics service" is so ambiguous, this change specifically denotes that the config is for Envoy's metrics service API. The comments also now link to detailed info about the metrics service API. * Generate separate HTML page per proto under networking (#811) * Generate separate pages for each networking proto Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * update Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * tweaks Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * Fix interdoc references * separate doc and go gen * change dash to underscore * fix * more fixes * makefile fix Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * remove bad target * Revert "change dash to underscore" This reverts commit 7fbced6. * final update Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * Revert "Generate separate HTML page per proto under networking (#811)" This reverts commit 5f14ead since it breaks the ability to generate reference docs in istio.io * Update to latest tools. * Revert "Update to latest tools." This reverts commit 231fadc which I accidentally pushed to the wrong place. * fix mcp update error diagram (#810) * update istio/tools (#815) * Revert "Revert "Generate separate HTML page per proto under networking (#811)"" (#818) * Minor updates for building docker images. (#817) * Add spell checking for docs. (#819) * Add a bunch of words to the custom dictionary. * Document exportTo restrictions (#820) * Doc fixes. (#821) * Proxy config: Add tls_certs_to_watch field (#824) * Proxy config: Add tls_certs_to_watch field * Address PR comment * Revert "Proxy config: Add tls_certs_to_watch field (#824)" (#825) This reverts commit e613e35. * Update gateway and sidecar hosts doc (#826) * Update gateway and sidecar hosts doc * regen * review comments * Update API docs (service entry, gateway, sidecar) (#831) * Update sidecar and gateway docs Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * gen docs Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * update service entry Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * updates Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * add configurable dns refresh rate to mesh for strict dns cluster, (#832) * add configurable dns refresh rate to mesh for strict dns cluster, issue #12181 * add lock file * Post-merge generation

* Doc fixes. * Add high-level overview and diagrams for MCP (#805) * document MCP * add additional note on NACK behavior * add a note about ignoring stale nonces * Add envoy metrics service configuration to ProxyConfig (#803) * Add envoy metrics service configuration to ProxyConfig Similar to the statsd sink config, this change is in preparation for adding support for the envoy metrics service API. * Update proto.lock * Reorder metrics_service_address just after statsd_udp_address * Update comment in the authN API to match with 1.1 behavior (#808) * Rename metrics_service_address to clarify that it is for Envoy's API (#809) Since "metrics service" is so ambiguous, this change specifically denotes that the config is for Envoy's metrics service API. The comments also now link to detailed info about the metrics service API. * Generate separate HTML page per proto under networking (#811) * Generate separate pages for each networking proto Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * update Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * tweaks Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * Fix interdoc references * separate doc and go gen * change dash to underscore * fix * more fixes * makefile fix Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * remove bad target * Revert "change dash to underscore" This reverts commit 7fbced6. * final update Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * Revert "Generate separate HTML page per proto under networking (#811)" This reverts commit 5f14ead since it breaks the ability to generate reference docs in istio.io * Update to latest tools. * Revert "Update to latest tools." This reverts commit 231fadc which I accidentally pushed to the wrong place. * fix mcp update error diagram (#810) * update istio/tools (#815) * Revert "Revert "Generate separate HTML page per proto under networking (#811)"" (#818) * Minor updates for building docker images. (#817) * Add spell checking for docs. (#819) * Add a bunch of words to the custom dictionary. * Document exportTo restrictions (#820) * Doc fixes. (#821) * Proxy config: Add tls_certs_to_watch field (#824) * Proxy config: Add tls_certs_to_watch field * Address PR comment * Revert "Proxy config: Add tls_certs_to_watch field (#824)" (#825) This reverts commit e613e35. * Update gateway and sidecar hosts doc (#826) * Update gateway and sidecar hosts doc * regen * review comments * Update API docs (service entry, gateway, sidecar) (#831) * Update sidecar and gateway docs Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * gen docs Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * update service entry Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * updates Signed-off-by: Shriram Rajagopalan <shriramr@vmware.com> * add configurable dns refresh rate to mesh for strict dns cluster, (#832) * add configurable dns refresh rate to mesh for strict dns cluster, issue #12181 * add lock file * Hosts are not ignored in ServiceEntry for HTTPs (#833) * Hosts are not ignored in ServiceEntry for HTTPs * Clarify * Reword * Generate protos * Address code review comments * Fix typo * generate * make mixer config marshal deterministic (#846) Signed-off-by: Kuat Yessenov <kuat@google.com> * Fix some doc errors. (#854) This started out to just fix a bad link to unblock work on istio.io, but I ended up fixing a bunch of typos/incorrect format throughout. * Fix two more broken links. (#856) * Fix CRD examples for release-1.1 (#859) * fix MeshNetworks demo (#841) * fix MeshNetworks demo * generate * update * last minute doc fixes (#865) Signed-off-by: Shriram Rajagopalan <rshriram@gmail.com> * Clarify comment for server_name field in Mixer oop auth config (#800) * add mixerclient config to istio.io reference docs (#827) * Envoyfilter docs fix (#867) * Tweaks to get the mixer client config docs to be published. (#868) * Change where the Mixer client docs are published.

googlebot added the cla: yes Set by the Google CLA bot to indicate the author of a PR has signed the Google CLA. label Feb 20, 2019

istio-testing requested review from kyessenov and mandarjog February 20, 2019 20:47

document MCP

0e75c39

ayj force-pushed the document-mcp branch from c417e4d to 0e75c39 Compare February 20, 2019 21:01

ayj requested review from ozevren and removed request for kyessenov and mandarjog February 20, 2019 21:02

ozevren reviewed Feb 21, 2019

View reviewed changes

add additional note on NACK behavior

7797a21

ozevren reviewed Feb 21, 2019

View reviewed changes

add a note about ignoring stale nonces

ff94163

istio-testing assigned ozevren Feb 21, 2019

istio-testing added the lgtm label Feb 21, 2019

istio-testing added the approved label Feb 21, 2019

istio-testing assigned geeknoid Feb 21, 2019

geeknoid merged commit 29a3b64 into istio:release-1.1 Feb 21, 2019

ayj deleted the document-mcp branch February 21, 2019 21:28

ayj mentioned this pull request Mar 1, 2019

Document semantics of MCP #567

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add high-level overview and diagrams for MCP #805

Add high-level overview and diagrams for MCP #805

Uh oh!

ayj commented Feb 20, 2019 •

edited

Loading

Uh oh!

ozevren Feb 21, 2019

Uh oh!

ayj Feb 21, 2019

Uh oh!

ozevren Feb 21, 2019

Uh oh!

ayj Feb 21, 2019

Uh oh!

ozevren Feb 21, 2019

Uh oh!

ozevren Feb 21, 2019

Uh oh!

ayj Feb 21, 2019

Uh oh!

ozevren commented Feb 21, 2019

Uh oh!

istio-testing commented Feb 21, 2019

Uh oh!

ayj commented Feb 21, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants


		![Resource full-state incremental success](v1alpha1/diagrams/collection-incremental-update-success.svg)

		### Error example

Add high-level overview and diagrams for MCP #805

Add high-level overview and diagrams for MCP #805

Uh oh!

Conversation

ayj commented Feb 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ozevren Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

ayj Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

ozevren Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

ayj Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

ozevren Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

ozevren Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

ayj Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

ozevren commented Feb 21, 2019

Uh oh!

istio-testing commented Feb 21, 2019

Uh oh!

ayj commented Feb 21, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ayj commented Feb 20, 2019 •

edited

Loading