Skip to content

Commit

Permalink
docs(UPGRADE.md): add note about Inspect API changes (#4125)
Browse files Browse the repository at this point in the history
Signed-off-by: Mike Beaumont <mjboamail@gmail.com>
  • Loading branch information
michaelbeaumont authored Apr 5, 2022
1 parent 458b7eb commit 2462011
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,23 @@ Previously, a `MeshGatewayInstance` generated a `Deployment` and `Service` whose
names ended with a unique suffix. With this release, those objects will have the
same name as the `MeshGatewayInstance`.

### Inspect API

In connection with the changes around `MeshGateway` and `MeshGatewayRoute`, the output
schema of the `<policy-type>/<policy>/dataplanes` has changed. Every policy can
now affect both normal `Dataplane`s and `Dataplane`s configured as builtin gateways.
The configuration for the latter type is done via `MeshGateway` resources.

Every item in the `items` array now has a `kind` property of either:

* `SidecarDataplane`: a normal `Dataplane` with outbounds, inbounds,
etc.
* `MeshGatewayDataplane`: a `MeshGateway`-configured `Dataplane` with a new
structure representing the `MeshGateway` it serves.

Some examples can be found in the [Inspect API
docs](https://kuma.io/docs/dev/documentation/http-api/#inspect-api).

## Upgrade to `1.5.0`

### Any type
Expand Down

0 comments on commit 2462011

Please sign in to comment.