[Maps] deprecate map.proxyElasticMapsServiceInMaps (#103740)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Nathan Reese 2021-06-30 10:59:27 -06:00 committed by GitHub
parent c5741e8b77
commit 5cf0fead02
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 31 additions and 12 deletions

View file

@ -13,17 +13,6 @@ EMS requests are made to the following domains:
Maps makes requests directly from the browser to EMS.
[float]
=== Connect to Elastic Maps Service from an internal network
To connect to EMS when your Kibana server and browser are in an internal network:
. Set `map.proxyElasticMapsServiceInMaps` to `true` in your <<settings, kibana.yml>> file to proxy EMS requests through the Kibana server.
. Update your firewall rules to allow connections from your Kibana server to the EMS domains.
NOTE: Coordinate map and region map visualizations do not support `map.proxyElasticMapsServiceInMaps` and will not proxy EMS requests through the Kibana server.
[float]
=== Disable Elastic Maps Service

View file

@ -374,7 +374,8 @@ When `includeElasticMapsService` is turned off, only tile layer configured by <<
| Specifies the URL of a self hosted <<elastic-maps-server,{hosted-ems}>>
| `map.proxyElasticMapsServiceInMaps:`
| Set to `true` to proxy all <<maps, Maps application>> Elastic Maps Service
| deprecated:[7.14.0,"In 8.0 and later, this setting will no longer be supported."]
Set to `true` to proxy all <<maps, Maps application>> Elastic Maps Service
requests through the {kib} server. *Default: `false`*
| [[regionmap-settings]] `map.regionmap:` {ess-icon}

View file

@ -24,6 +24,35 @@ export const config: PluginConfigDescriptor<MapsXPackConfig> = {
},
schema: configSchema,
deprecations: () => [
(
completeConfig: Record<string, any>,
rootPath: string,
addDeprecation: AddConfigDeprecation
) => {
if (_.get(completeConfig, 'map.proxyElasticMapsServiceInMaps') === undefined) {
return completeConfig;
}
addDeprecation({
documentationUrl:
'https://www.elastic.co/guide/en/kibana/current/maps-connect-to-ems.html#elastic-maps-server',
message: i18n.translate('xpack.maps.deprecation.proxyEMS.message', {
defaultMessage:
'map.proxyElasticMapsServiceInMaps is deprecated and will be removed in 8.0.',
}),
correctiveActions: {
manualSteps: [
i18n.translate('xpack.maps.deprecation.proxyEMS.step1', {
defaultMessage:
'Remove "map.proxyElasticMapsServiceInMaps" in the Kibana config file, CLI flag, or environment variable (in Docker only).',
}),
i18n.translate('xpack.maps.deprecation.proxyEMS.step2', {
defaultMessage: 'Host Elastic Maps Service locally.',
}),
],
},
});
return completeConfig;
},
(
completeConfig: Record<string, any>,
rootPath: string,