From 5055a888929d6aca545bff0159ab937ee40532f3 Mon Sep 17 00:00:00 2001 From: Matt Klein Date: Fri, 1 Dec 2017 10:03:19 -0800 Subject: [PATCH] docs: 1.5.0 release notes (#302) Signed-off-by: Matt Klein --- .../configuration/http_conn_man/headers.rst | 16 ++--- .../configuration/http_conn_man/stats.rst | 1 + .../network_filters/mongo_proxy_filter.rst | 8 +++ docs/root/configuration/runtime.rst | 2 + .../intro/arch_overview/load_balancing.rst | 3 +- docs/root/intro/arch_overview/mongo.rst | 1 + docs/root/intro/version_history.rst | 63 +++++++++++++++++++ docs/root/operations/admin.rst | 2 + 8 files changed, 86 insertions(+), 10 deletions(-) diff --git a/docs/root/configuration/http_conn_man/headers.rst b/docs/root/configuration/http_conn_man/headers.rst index 36479a09..b28e4eba 100644 --- a/docs/root/configuration/http_conn_man/headers.rst +++ b/docs/root/configuration/http_conn_man/headers.rst @@ -278,19 +278,19 @@ The encode one or more options. For example, Debug is encoded as .. _config_http_conn_man_headers_custom_request_headers: -Custom request headers ----------------------- +Custom request/response headers +------------------------------- -Custom request headers can be added to a request that matches a specific route at the route, -virtual host, and global route configuration level. See the relevant -:ref:`v1 ` and :ref:`v2 ` API +Custom request/response headers can be added to a request/response that matches a specific route at +the route, virtual host, and global route configuration level. See the relevant :ref:`v1 +` and :ref:`v2 ` API documentation. -**Note:** Headers are appended to requests in the following order: route level headers, virtual host +**Note:** Headers are appended to requests/responses in the following order: route level headers, virtual host level headers and finally global level headers. -Envoy additionally supports adding dynamic values to the request headers. Supported dynamic values -are: +Envoy additionally supports adding dynamic values to the **request** headers. Supported dynamic +values are: %CLIENT_IP% The original client IP which is already added by Envoy as a diff --git a/docs/root/configuration/http_conn_man/stats.rst b/docs/root/configuration/http_conn_man/stats.rst index 79df2409..f66dd8a3 100644 --- a/docs/root/configuration/http_conn_man/stats.rst +++ b/docs/root/configuration/http_conn_man/stats.rst @@ -68,6 +68,7 @@ the following statistics: downstream_cx_destroy_remote_active_rq, Counter, Total connections destroyed remotely with 1+ active requests downstream_rq_total, Counter, Total requests +.. _config_http_conn_man_stats_per_listener: Per listener statistics ----------------------- diff --git a/docs/root/configuration/network_filters/mongo_proxy_filter.rst b/docs/root/configuration/network_filters/mongo_proxy_filter.rst index 55e3b71c..186285bd 100644 --- a/docs/root/configuration/network_filters/mongo_proxy_filter.rst +++ b/docs/root/configuration/network_filters/mongo_proxy_filter.rst @@ -7,6 +7,14 @@ Mongo proxy - :ref:`v1 API reference ` - :ref:`v2 API reference ` +.. _config_network_filters_mongo_proxy_fault_injection: + +Fault injection +--------------- + +The Mongo proxy filter supports fault injection. See the v1 and v2 API reference for how to +configure. + .. _config_network_filters_mongo_proxy_stats: Statistics diff --git a/docs/root/configuration/runtime.rst b/docs/root/configuration/runtime.rst index c179be89..6a7e3fae 100644 --- a/docs/root/configuration/runtime.rst +++ b/docs/root/configuration/runtime.rst @@ -45,6 +45,8 @@ that :option:`--service-cluster` has been set to ``my-cluster``. Envoy will firs If found, the value will override any value found in the primary lookup path. This allows the user to customize the runtime values for individual clusters on top of global defaults. +.. _config_runtime_comments: + Comments -------- diff --git a/docs/root/intro/arch_overview/load_balancing.rst b/docs/root/intro/arch_overview/load_balancing.rst index 48188cc2..712230e1 100644 --- a/docs/root/intro/arch_overview/load_balancing.rst +++ b/docs/root/intro/arch_overview/load_balancing.rst @@ -152,8 +152,7 @@ not be used with subsets because the upstream hosts are not known in advance. Su with zone aware routing, but be aware that the use of subsets may easily violate the minimum hosts condition described above. -If subsets are `configured -`_ and a route +If subsets are :ref:`configured ` and a route specifies no metadata or no subset matching the metadata exists, the subset load balancer initiates its fallback policy. The default policy is ``NO_ENDPOINT``, in which case the request fails as if the cluster had no hosts. Conversely, the ``ANY_ENDPOINT`` fallback policy load balances across all diff --git a/docs/root/intro/arch_overview/mongo.rst b/docs/root/intro/arch_overview/mongo.rst index c7199408..6ae713ea 100644 --- a/docs/root/intro/arch_overview/mongo.rst +++ b/docs/root/intro/arch_overview/mongo.rst @@ -10,6 +10,7 @@ Envoy supports a network level MongoDB sniffing filter with the following featur routed clusters. * Query logging. * 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 diff --git a/docs/root/intro/version_history.rst b/docs/root/intro/version_history.rst index 049b2fb7..a009fbb0 100644 --- a/docs/root/intro/version_history.rst +++ b/docs/root/intro/version_history.rst @@ -1,6 +1,69 @@ Version history --------------- +1.5.0 +===== + +* access log: added fields for :ref:`UPSTREAM_LOCAL_ADDRESS and DOWNSTREAM_ADDRESS + `. +* admin: added :ref:`JSON output ` for stats admin endpoint. +* admin: added basic :ref:`Prometheus output ` for stats admin + endpoint. Histograms are not currently output. +* config: the :ref:`v2 API ` is now considered production ready. +* config: added ::option:`--v2-config-only` CLI flag. +* cors: added :ref:`CORS filter `. +* health check: added :ref:`x-envoy-immediate-health-check-fail + ` header support. +* health check: added :ref:`reuse_connection ` option. +* http: added :ref:`per-listener stats `. +* http: end-to-end HTTP flow control is now complete across both connections, streams, and filters. +* load balancer: added :ref:`subset load balancer `. +* load balancer: added ring size and hash :ref:`configuration options + `. This used to be configurable via runtime. The runtime + configuration was deleted without deprecation as we are fairly certain no one is using it. +* log: added the ability to optionally log to a file instead of stderr via the + ::option:`--log-path` option. +* listeners: added :ref:`drain_type ` option. +* lua: added experimental :ref:`Lua filter `. +* mongo filter: added :ref:`fault injection `. +* mongo filter: added :ref:`"drain close" ` support. +* outlier detection: added :ref:`HTTP gateway failure type `. + See `DEPRECATED.md `_ + for outlier detection stats deprecations in this release. +* redis: the :ref:`redis proxy filter ` is now considered + production ready. +* redis: added :ref:`"drain close" ` functionality. +* router: added :ref:`x-envoy-overloaded ` support. +* router: added :ref:`regex ` route matching. +* router: added :ref:`custom request headers ` + for upstream requests. +* router: added :ref:`downstream IP hashing + ` for HTTP ketama routing. +* router: added :ref:`cookie hashing `. +* router: added :ref:`start_child_span ` option + to create child span for egress calls. +* router: added optional :ref:`upstream logs `. +* router: added complete :ref:`custom append/override/remove support + ` of request/response headers. +* router: added support to :ref:`specify response code during redirect + `. +* runtime: added :ref:`comment capability `. +* server: change default ::`-l` to info level. +* stats: maximum stat/name sizes and maximum number of stats are now variable via the + ::option:`--max-obj-name-len` and ::option:`--max-stats` options. +* tcp proxy: added :ref:`access logging `. +* tcp proxy: added :ref:`configurable connect retries + `. +* tcp proxy: enable use of :ref:`outlier detector `. +* tls: added :ref:`SNI support `. +* tls: added support for specifying :ref:`TLS session ticket keys + `. +* tls: allow configuration of the :ref:`min + ` and :ref:`max + ` TLS protocol versions. +* tracing: added :ref:`custom trace span decorators `. +* Many small bug fixes and performance improvements not listed. + 1.4.0 ===== diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 14677992..9d3ae273 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -134,6 +134,8 @@ The fields are: * Total uptime in seconds (across all hot restarts) * Current hot restart epoch +.. _operations_admin_interface_stats: + .. http:get:: /stats Outputs all statistics on demand. This includes only counters and gauges. Histograms are not