github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.17][Fleet] update component templates with deprecated setting (#210200) (#210350)

Browse source 
Backport https://github.com/elastic/kibana/pull/210200 to 8.17
This commit is contained in:
Julia Bardi 2025-02-11 12:11:38 +01:00 • committed by GitHub
parent a74534fb87
commit 1d710a2b1a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 161 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
x-pack/plugins/fleet/server/services/setup.test.ts
View file

@ -28,6 +28,7 @@ jest.mock('./download_source');
jest.mock('./epm/packages');
jest.mock('./setup/managed_package_policies');
jest.mock('./setup/upgrade_package_install_version');
jest.mock('./setup/update_deprecated_component_templates');
jest.mock('./epm/elasticsearch/template/install', () => {
return {
...jest.requireActual('./epm/elasticsearch/template/install'),

5
x-pack/plugins/fleet/server/services/setup.ts
View file

@ -58,6 +58,8 @@ import {
getPreconfiguredDeleteUnenrolledAgentsSettingFromConfig,
} from './preconfiguration/delete_unenrolled_agent_setting';
import { updateDeprecatedComponentTemplates } from './setup/update_deprecated_component_templates';
export interface SetupStatus {
isInitialized: boolean;
nonFatalErrors: Array<
@ -300,6 +302,9 @@ async function createSetupSideEffects(
await ensureAgentPoliciesFleetServerKeysAndPolicies({ soClient, esClient, logger });
stepSpan?.end();
logger.debug('Update deprecated _source.mode in component templates');
await updateDeprecatedComponentTemplates(esClient);
const nonFatalErrors = [
...preconfiguredPackagesNonFatalErrors,
...(messageSigningServiceNonFatalError ? [messageSigningServiceNonFatalError] : []),

1
x-pack/plugins/fleet/server/services/setup/index.ts
View file

@ -8,3 +8,4 @@
export { upgradePackageInstallVersion } from './upgrade_package_install_version';
export { upgradeAgentPolicySchemaVersion } from './upgrade_agent_policy_schema_version';
export { ensureAgentPoliciesFleetServerKeysAndPolicies } from './fleet_server_policies_enrollment_keys';
export { updateDeprecatedComponentTemplates } from './update_deprecated_component_templates';

85
x-pack/plugins/fleet/server/services/setup/update_deprecated_component_templates.test.ts Normal file
View file

@ -0,0 +1,85 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import { updateDeprecatedComponentTemplates } from './update_deprecated_component_templates';
jest.mock('..', () => ({
appContextService: {
getLogger: () => ({
debug: jest.fn(),
}),
},
}));
describe('updateDeprecatedComponentTemplates', () => {
it('should update deprecated component templates', async () => {
const esClientMock: any = {
cluster: {
getComponentTemplate: jest.fn().mockResolvedValue({
component_templates: [
{
name: 'metrics-apm.app@package',
component_template: {
template: {
settings: {},
mappings: {
_source: {
mode: 'synthetic',
},
properties: {},
},
},
_meta: {
managed_by: 'fleet',
},
},
},
{
name: 'metrics-other',
component_template: {
template: {
settings: {},
mappings: {
properties: {},
},
},
_meta: {
managed_by: 'fleet',
},
},
},
],
}),
putComponentTemplate: jest.fn(),
},
};
await updateDeprecatedComponentTemplates(esClientMock);
expect(esClientMock.cluster.putComponentTemplate).toHaveBeenCalledTimes(1);
expect(esClientMock.cluster.putComponentTemplate).toHaveBeenCalledWith({
body: {
template: {
mappings: {
_source: {},
properties: {},
},
settings: {
index: {
mapping: {
source: {
mode: 'synthetic',
},
},
},
},
},
},
name: 'metrics-apm.app@package',
});
});
});

69
x-pack/plugins/fleet/server/services/setup/update_deprecated_component_templates.ts Normal file
View file

@ -0,0 +1,69 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import pMap from 'p-map';
import type { ElasticsearchClient } from '@kbn/core/server';
import { appContextService } from '..';
export async function updateDeprecatedComponentTemplates(esClient: ElasticsearchClient) {
const componentTemplates = await esClient.cluster.getComponentTemplate({
name: 'metrics-*',
});
const deprecatedTemplates = componentTemplates.component_templates.filter(
(componentTemplate) =>
componentTemplate.component_template._meta?.managed_by === 'fleet' &&
!!componentTemplate.component_template.template.mappings?._source?.mode
);
appContextService
.getLogger()
.debug(
`Updating component templates with deprecated _source.mode config: ${deprecatedTemplates.map(
(template) => template.name
)}`
);
await pMap(
deprecatedTemplates,
async (componentTemplate) => {
const source = componentTemplate.component_template.template.mappings!._source;
const { mode, ...restOfSource } = source!;
const settings = componentTemplate.component_template.template.settings;
await esClient.cluster.putComponentTemplate({
name: componentTemplate.name,
body: {
template: {
settings: {
...settings,
index: {
...settings?.index,
mapping: {
...settings?.index?.mapping,
// @ts-expect-error Property 'source' does not exist on type 'IndicesMappingLimitSettings'
source: {
// @ts-expect-error Property 'source.mode' does not exist on type 'IndicesMappingLimitSettings'
...settings?.index?.mapping?.source,
mode,
},
},
},
},
mappings: {
...componentTemplate.component_template.template.mappings,
_source: restOfSource,
},
},
},
});
},
{
concurrency: 10,
}
);
}