Skip to content

Commit

Permalink
docs: Remove/make generic lyft references in docs (envoyproxy#13559)
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Northey <ryan@synca.io>
  • Loading branch information
phlax authored Oct 14, 2020
1 parent 61d1f38 commit 5607d1b
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/root/configuration/other_features/rate_limit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ gRPC service IDL

Envoy expects the rate limit service to support the gRPC IDL specified in
:ref:`rls.proto <envoy_v3_api_file_envoy/service/ratelimit/v3/rls.proto>`. See the IDL documentation
for more information on how the API works. See Lyft's reference implementation
`here <https://github.com/lyft/ratelimit>`_.
for more information on how the API works. See Envoy's reference implementation
`here <https://github.com/envoyproxy/ratelimit>`_.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ normally during typical request patterns but still prevent cascading failure whe
to fail. Global rate limiting is a good solution for this case.

Envoy integrates directly with a global gRPC rate limiting service. Although any service that
implements the defined RPC/IDL protocol can be used, Lyft provides a `reference implementation <https://github.com/lyft/ratelimit>`_
implements the defined RPC/IDL protocol can be used, Envoy provides a `reference implementation <https://github.com/envoyproxy/ratelimit>`_
written in Go which uses a Redis backend. Envoy’s rate limit integration has the following features:

* **Network level rate limit filter**: Envoy will call the rate limit service for every new
Expand Down
2 changes: 1 addition & 1 deletion docs/root/intro/arch_overview/other_protocols/dynamo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Envoy supports an HTTP level DynamoDB sniffing filter with the following feature
* Batch operation partial failure statistics.

The DynamoDB filter is a good example of Envoy’s extensibility and core abstractions at the HTTP
layer. At Lyft we use this filter for all application communication with DynamoDB. It provides an
layer, and can be used to filter all application communication with DynamoDB. It provides an
invaluable source of data agnostic to the application platform and specific AWS SDK in use.

DynamoDB filter :ref:`configuration <config_http_filters_dynamo>`.
4 changes: 2 additions & 2 deletions docs/root/intro/arch_overview/other_protocols/mongo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Envoy supports a network level MongoDB sniffing filter with the following featur
* Per callsite statistics via the $comment query parameter.
* Fault injection.

The MongoDB filter is a good example of Envoy’s extensibility and core abstractions. At Lyft we use
this filter between all applications and our databases. It provides an invaluable source of data
The MongoDB filter is a good example of Envoy’s extensibility and core abstractions, and can be used
to filter between all applications and MongoDB databases. It provides an invaluable source of data
that is agnostic to the application platform and specific MongoDB driver in use.

MongoDB proxy filter :ref:`configuration reference <config_network_filters_mongo_proxy>`.
5 changes: 2 additions & 3 deletions docs/root/intro/deployment_types/double_proxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,5 @@ ordinarily would not be trustable (such as the x-forwarded-for HTTP header).
Configuration template
^^^^^^^^^^^^^^^^^^^^^^

The source distribution includes an example double proxy configuration that is very similar to
the version that Lyft runs in production. See :ref:`here <install_ref_configs>` for more
information.
The source distribution includes an example double proxy configuration. See
:ref:`here <install_ref_configs>` for more information.
5 changes: 2 additions & 3 deletions docs/root/intro/deployment_types/front_proxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,5 @@ reverse proxy provides the following features:
Configuration template
^^^^^^^^^^^^^^^^^^^^^^

The source distribution includes an example front proxy configuration that is very similar to
the version that Lyft runs in production. See :ref:`here <install_ref_configs>` for more
information.
The source distribution includes an example front proxy configuration. See
:ref:`here <install_ref_configs>` for more information.
3 changes: 1 addition & 2 deletions docs/root/intro/deployment_types/service_to_service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,4 @@ load balancing, statistics gathering, etc.
Configuration template
^^^^^^^^^^^^^^^^^^^^^^

The source distribution includes :ref:`an example service-to-service configuration<install_ref_configs>`
that is very similar to the version that Lyft runs in production.
The source distribution includes :ref:`an example service-to-service configuration<install_ref_configs>`.
9 changes: 4 additions & 5 deletions docs/root/start/install/ref_configs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@ see the :ref:`configuration reference <config>`.
Configuration generator
-----------------------

Envoy configurations can become relatively complicated. At Lyft we use `jinja
<http://jinja.pocoo.org/>`_ templating to make the configurations easier to create and manage. The
source distribution includes a version of the configuration generator that loosely approximates what
we use at Lyft. We have also included three example configuration templates for each of the above
three scenarios.
Envoy configurations can become relatively complicated. The
source distribution includes a version of the configuration generator that uses `jinja
<http://jinja.pocoo.org/>`_ templating to make the configurations easier to create and manage. We
have also included three example configuration templates for each of the above three scenarios.

* Generator script: :repo:`configs/configgen.py`
* Service to service template: :repo:`configs/envoy_service_to_service_v2.template.yaml`
Expand Down

0 comments on commit 5607d1b

Please sign in to comment.