Mark weighted route destinations as deprecated in docs (#3779)

tcdowney · web-flow · commit bfae47ad439e · 2024-05-02T21:40:50.000-07:00
- The Istio Service Mesh routing layer is required for weighted routes to function, but development on it was discontinued in early 2020. See: https://github.com/cloudfoundry-attic/istio-release - As a consequence, weighted route destinations are no longer supported. - See this issue for more information about the removal of Istio support from Cloud Controller: #2942
diff --git a/docs/v3/source/includes/resources/routes/_destination_object.md.erb b/docs/v3/source/includes/resources/routes/_destination_object.md.erb
@@ -18,11 +18,11 @@ Note that when using a custom port, the app process must be listening on the spe
 
 If a destination does not specify a port, the default port depends on the app lifecycle type. For buildpack apps, traffic will be directed to port 8080. For Docker apps, the first port specified in the Dockerfile will be used.
 
-| Name                          | Type                     | Description                                                                                                                               |
-| --------------                | ------------------------ | ------------------------------------------------------                                                                                    |
-| **guid**                      | _uuid_                   | Unique identifier for the destination                                                                                                    |
-| **app.guid**                  | _uuid_                   | Unique identifier for the app to route traffic to                                                                               |
-| **app.process.type**          | _string_                 | Type of the process belonging to the app to route traffic to                                                                      |
-| **port**                      | _integer_                | Port on the destination process to route traffic to
-| **weight** (*experimental*)   | _integer_ or `null`      | Percentage of traffic which will be routed to this destination; _this feature is only available via the BETA Service Mesh routing plane_ |
-| **protocol** | _string_ or `null`       | Protocol to use for this destination. Valid protocols are `http1` or `http2` if route protocol is `http`, `tcp` if route protocol is `tcp`. A `null` value will set it either `http1` or `tcp` based on the route protocol; _this feature is only available if you turn it on in routing release_ |
+| Name                      | Type                     | Description                                                                                                                                                                                                                                                                                       |
+|---------------------------| ------------------------ |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **guid**                  | _uuid_                   | Unique identifier for the destination                                                                                                                                                                                                                                                             |
+| **app.guid**              | _uuid_                   | Unique identifier for the app to route traffic to                                                                                                                                                                                                                                                 |
+| **app.process.type**      | _string_                 | Type of the process belonging to the app to route traffic to                                                                                                                                                                                                                                      |
+| **port**                  | _integer_                | Port on the destination process to route traffic to
+| **weight** (*deprecated*) | _integer_ or `null`      | Percentage of traffic which will be routed to this destination. _**DEPRECATED:** this feature was only available via the experimental Service Mesh routing plane. It is no longer supported._                                                                                                     |
+| **protocol**              | _string_ or `null`       | Protocol to use for this destination. Valid protocols are `http1` or `http2` if route protocol is `http`, `tcp` if route protocol is `tcp`. A `null` value will set it either `http1` or `tcp` based on the route protocol; _this feature is only available if you turn it on in routing release_ |
diff --git a/docs/v3/source/includes/resources/routes/_insert_destinations.md.erb b/docs/v3/source/includes/resources/routes/_insert_destinations.md.erb
@@ -43,8 +43,7 @@ Content-Type: application/json
 
 Add one or more destinations to a route, preserving any existing destinations.
 
-Note that weighted destinations cannot be added with this endpoint. To add weighted destinations,
-replace all destinations for a route at once using the [replace destinations endpoint](#replace-all-destinations-for-a-route).
+Weighted destinations (deprecated) cannot be added with this endpoint.
 
 #### Definition
 `POST /v3/routes/:guid/destinations`
diff --git a/docs/v3/source/includes/resources/routes/_replace_destinations.md.erb b/docs/v3/source/includes/resources/routes/_replace_destinations.md.erb
@@ -79,7 +79,10 @@ Content-Type: application/json
 
 Replaces all destinations for a route, removing any destinations not included in the provided list.
 
-If using weighted destinations, all destinations provided here must have a `weight` specified, and all weights
+Weighted destinations are **deprecated**. Development of the experimental Istio Service Mesh routing layer
+was discontinued in 2020 and is no longer supported by the platform. Specifying a `weight` for a destination will take no effect.
+
+If weighted destinations are provided, however, all destinations provided here must have a `weight` specified, and all weights
 for this route must sum to 100. If not, all provided destinations must not have a `weight`. Mixing weighted
 and unweighted destinations for a route is not allowed.
 
