Skip to content

Commit

Permalink
docs: final updates for 1.0.0 (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattklein123 authored Sep 12, 2016
1 parent f654b7f commit ef54a03
Show file tree
Hide file tree
Showing 11 changed files with 26 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Envoy
![Envoy Logo](docs/envoy-logo-bg.png)

C++ L7 proxy and communication bus

Expand Down
3 changes: 2 additions & 1 deletion docs/configuration/cluster_manager/sds_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
Service discovery service REST API
==================================

Envoy expects the service discovery service to expose the following API:
Envoy expects the service discovery service to expose the following API (See Lyft's
`reference implementation <https://github.com/lyft/discovery>`_):

.. http:get:: /v1/registration/(string: service_name)
Expand Down
Binary file added docs/envoy-logo-bg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 6 additions & 5 deletions docs/intro/arch_overview/service_discovery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,15 @@ Service discovery service (SDS)

The *service discovery service* is a generic :ref:`REST based API <config_cluster_manager_sds_api>`
used by Envoy to fetch cluster members. Lyft provides a reference implementation via the Python
discovery service. That implementation uses AWS DynamoDB as the backing store, however the API is
simple enough that it could easily be implemented on top of a variety of different backing stores.
For each SDS cluster, Envoy will periodically fetch the cluster members from the discovery service.
SDS is the preferred service discovery mechanism for a few reasons:
`discovery service <https://github.com/lyft/discovery>`_. That implementation uses AWS DynamoDB as
the backing store, however the API is simple enough that it could easily be implemented on top of a
variety of different backing stores. For each SDS cluster, Envoy will periodically fetch the cluster
members from the discovery service. SDS is the preferred service discovery mechanism for a few
reasons:

* Envoy has explicit knowledge of each upstream host (vs. routing through a DNS resolved load
balancer) and can make more intelligent load balancing decisions.
* Extra attributes carried in the discovery API response for each host inform Envoy of the host’s
* Extra attributes carried in the discovery API response for each host inform Envoy of the host’s
load balancing weight, canary status, zone, etc. These additional attributes are used globally
by the Envoy mesh during load balancing, statistic gathering, etc.

Expand Down
6 changes: 3 additions & 3 deletions docs/intro/arch_overview/terminology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ Terminology

A few definitions before we dive into the main architecture documentation. Some of the definitions
are slightly contentious within the industry, however they are how Envoy uses them throughout the
documentation and codebase, so c'est la vie.
documentation and codebase, so *c'est la vie*.

**Host**: An entity capable of network communication (application on a mobile phone, server, etc.).
In this documentation a host is a logical network application. A physical piece of hardware could
In this documentation a host is a logical network application. A physical piece of hardware could
possibly have multiple hosts running on it as long as each of them can be independently addressed.

**Downstream**: A downstream host connects to Envoy, sends requests, and receives responses.
Expand All @@ -20,7 +20,7 @@ connect to.
**Cluster**: A cluster is a group of logically similar upstream hosts that Envoy connects to. Envoy
discovers the members of a cluster via :ref:`service discovery <arch_overview_service_discovery>`.
It optionally determines the health of cluster members via :ref:`active health checking
<arch_overview_health_checking>`. The cluster member that Envoy routes a request to is determined
<arch_overview_health_checking>`. The cluster member that Envoy routes a request to is determined
by the :ref:`load balancing policy <arch_overview_load_balancing>`.

**Mesh**: A group of hosts that coordinate to provide a consistent network topology. In this
Expand Down
4 changes: 4 additions & 0 deletions docs/intro/what_is_envoy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ and responses. The two systems are very complementary.
web applications. Envoy :ref:`supports <arch_overview_mongo>` L7 sniffing, statistics production,
and logging for MongoDB connections.

**DynamoDB L7 support**: `DynamoDB <https://aws.amazon.com/dynamodb/>`_ is Amazon’s hosted key/value
NOSQL datastore. Envoy :ref:`supports <arch_overview_dynamo>` L7 sniffing and statistics production
for DynamoDB connections.

**Service discovery:** :ref:`Service discovery <arch_overview_service_discovery>` is a critical
component of service oriented architectures. Envoy supports multiple service discovery methods
including asynchronous DNS resolution and REST based lookup via a :ref:`service discovery service
Expand Down
4 changes: 2 additions & 2 deletions docs/landing_generated/footer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<div class="footer-column">
<article class="footer-site-information">
<p>
&copy; 2014&ndash;2016 Lyft, Inc
&copy; 2016 Lyft, Inc
</p>
</article>
<article class="footer-contact">
Expand Down Expand Up @@ -85,7 +85,7 @@
<div class="footer-column">
<article class="footer-site-information">
<p>
&copy; 2014&ndash;2016 Lyft, Inc
&copy; 2016 Lyft, Inc
</p>
</article>
<article class="footer-contact">
Expand Down
4 changes: 3 additions & 1 deletion docs/landing_generated/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ <h4 class="introduction-item-header">
<p><b>GRPC:</b> Envoy has first class support for Google's GRPC framework.</p>
<p><b>MongoDB:</b> Envoy contains a full MongoDB wire format parser that is used to gather
statistics about database connections.</p>
<p><b>DynamoDB:</b> Envoy contains a full DynamoDB API parser that is used to gather
statistics about database requests and responses.</p>
<p><b>Service discovery:</b> Envoy supports multiple methods for service discovery including
asynchronous DNS resolution as well as integration with an external service discovery
service.</p>
Expand All @@ -134,7 +136,7 @@ <h4 class="introduction-item-header">
<div class="footer-column">
<article class="footer-site-information">
<p>
&copy; 2014&ndash;2016 Lyft, Inc
&copy; 2016 Lyft, Inc
</p>
</article>
<article class="footer-contact">
Expand Down
4 changes: 2 additions & 2 deletions docs/landing_generated/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://lyft.github.io/envoy/</loc>
<lastmod>2016-09-06T00:00:00-07:00</lastmod>
<lastmod>2016-09-10T00:00:00-07:00</lastmod>
<changefreq>monthly</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://lyft.github.io/envoy/footer/</loc>
<lastmod>2016-09-06T00:00:00-07:00</lastmod>
<lastmod>2016-09-10T00:00:00-07:00</lastmod>
<changefreq>monthly</changefreq>
<priority>0.5</priority>
</url>
Expand Down
2 changes: 1 addition & 1 deletion docs/landing_source/source/localizable/footer.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<div class="footer-column">
<article class="footer-site-information">
<p>
&copy; 2014&ndash;<%= Date.today.year %> Lyft, Inc
&copy; <%= Date.today.year %> Lyft, Inc
</p>
</article>
<article class="footer-contact">
Expand Down
2 changes: 2 additions & 0 deletions docs/landing_source/source/localizable/index.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ layout: layout
<p><b>GRPC:</b> Envoy has first class support for Google's GRPC framework.</p>
<p><b>MongoDB:</b> Envoy contains a full MongoDB wire format parser that is used to gather
statistics about database connections.</p>
<p><b>DynamoDB:</b> Envoy contains a full DynamoDB API parser that is used to gather
statistics about database requests and responses.</p>
<p><b>Service discovery:</b> Envoy supports multiple methods for service discovery including
asynchronous DNS resolution as well as integration with an external service discovery
service.</p>
Expand Down

0 comments on commit ef54a03

Please sign in to comment.