Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(proto): fixed default serviceAddress and upgrade docs #5236

Merged
merged 6 commits into from
Nov 2, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ changed to agree with the other `image` values.
* The `/versions` endpoint was removed. This is not something that was reliable enough and version compatibility
is checked inside the DP
* We are deprecating `kuma.io/builtindns` and `kuma.io/builtindnsport` annotations in favour of the clearer `kuma.io/builtin-dns` and `kuma.io/builtin-dns-port`. The behavior of the new annotations is unchanged but you should migrate (a warning is present on the log if you are using the deprecated version).
* Applications that are binding to `localhost` won't be reachable anymore. We are changing the default inbound cluster that was always pointing to `localhost` to `DataplaneIP`. Before upgrade check if your applications are listening on `localhost` and should be exposed. In this case change address on which application listen to `0.0.0.0`. Other option is to define `dataplane.networking.inbound[].serviceAddress` to the address which service is binding. Another way is to disable the new behavior by setting `kuma-cp` configuration `KUMA_DEFAULTS_ENABLE_LOCALHOST_INBOUND_CLUSTERS` to `true` or `defaults.enableLocalhostInboundClusters` to `true`. The last option is going to be removed in further versions.
* Applications that are binding to `localhost` won't be reachable anymore. We are changing the default inbound cluster that was always pointing to `localhost` to `DataplaneIP`. Before upgrade check if your applications are listening on `localhost` and should be exposed:
lahabana marked this conversation as resolved.
Show resolved Hide resolved
* Universal: If you don't want to expose application change binding to `127.0.0.1` and define `dataplane.networking.inbound[].serviceAddress: "127.0.0.1"`.
lahabana marked this conversation as resolved.
Show resolved Hide resolved
* Kubernetes: In this case change address on which application listen to `0.0.0.0`.
lahabana marked this conversation as resolved.
Show resolved Hide resolved
Another way is to disable the new behavior by setting `kuma-cp` configuration `KUMA_DEFAULTS_ENABLE_LOCALHOST_INBOUND_CLUSTERS` to `true` or `defaults.enableLocalhostInboundClusters` to `true`. The last option is going to be removed in further versions.
lahabana marked this conversation as resolved.
Show resolved Hide resolved

## Upgrade to `1.7.x`

Expand Down
5 changes: 3 additions & 2 deletions api/mesh/v1alpha1/dataplane.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions api/mesh/v1alpha1/dataplane.proto
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ message Dataplane {
uint32 servicePort = 4;

// Address of the service that requests will be forwarded to.
// Defaults to '127.0.0.1', since Kuma DP should be deployed next to the
// service.
// Defaults to 'DataplaneIP', since Kuma DP should be deployed next to the
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
// service. When `KUMA_DEFAULTS_ENABLE_LOCALHOST_INBOUND_CLUSTERS` is true
// defaults to `127.0.0.1`.
string serviceAddress = 6;

// Address on which inbound listener will be exposed.
Expand Down
5 changes: 3 additions & 2 deletions docs/generated/resources/proxy_dataplane.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,9 @@
- `serviceAddress` (optional)

Address of the service that requests will be forwarded to.
Defaults to '127.0.0.1', since Kuma DP should be deployed next to the
service.
Defaults to 'DataplaneIP', since Kuma DP should be deployed next to the
service. When `KUMA_DEFAULTS_ENABLE_LOCALHOST_INBOUND_CLUSTERS` is true
defaults to `127.0.0.1`.

- `address` (optional)

Expand Down