From 7197fef216e72242087f721a0486d612862ad5bd Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 4 Oct 2021 11:27:36 -0400 Subject: [PATCH 1/2] Rename 'Ingest Node Pipelines' to 'Ingest Pipelines' While Elasticsearch ingest pipelines require a node with the `ingest` role, we don't need to include `ingest node` in the feature name. There are no official plans, but the Elasticsearch team has discussed removing the `ingest` role in the future. This also better aligns the Kibana UI with the Elasticsearch docs. Relates to https://github.com/elastic/elasticsearch/pull/70253. --- docs/dev-tools/grokdebugger/index.asciidoc | 25 ++++++++++--------- docs/developer/plugin-list.asciidoc | 2 +- docs/redirects.asciidoc | 2 +- .../monitoring/monitoring-metricbeat.asciidoc | 5 ++-- .../tutorial_fleet_instructions/index.tsx | 2 +- x-pack/plugins/ingest_pipelines/README.md | 12 ++++----- .../ingest_pipelines_list.test.ts | 4 +-- .../shared/map_processor_type_to_form.tsx | 2 +- .../sections/pipelines_list/main.tsx | 4 +-- .../application/services/breadcrumbs.ts | 2 +- .../plugins/ingest_pipelines/public/plugin.ts | 2 +- .../apps/ingest_node_pipelines.ts | 4 +-- .../apis/management/ingest_pipelines/index.ts | 2 +- .../ingest_pipelines/ingest_pipelines.ts | 4 +-- .../ingest_pipelines_security.ts | 2 +- .../apps/ingest_pipelines/ingest_pipelines.ts | 4 +-- 16 files changed, 40 insertions(+), 38 deletions(-) diff --git a/docs/dev-tools/grokdebugger/index.asciidoc b/docs/dev-tools/grokdebugger/index.asciidoc index 934452c54ccca..b4e53e5440766 100644 --- a/docs/dev-tools/grokdebugger/index.asciidoc +++ b/docs/dev-tools/grokdebugger/index.asciidoc @@ -9,21 +9,22 @@ structure it. Grok is good for parsing syslog, apache, and other webserver logs, mysql logs, and in general, any log format that is written for human consumption. -Grok patterns are supported in the ingest node -{ref}/grok-processor.html[grok processor] and the Logstash -{logstash-ref}/plugins-filters-grok.html[grok filter]. See -{logstash-ref}/plugins-filters-grok.html#_grok_basics[grok basics] -for more information on the syntax for a grok pattern. - -The Elastic Stack ships -with more than 120 reusable grok patterns. See -https://github.com/elastic/elasticsearch/tree/master/libs/grok/src/main/resources/patterns[Ingest node grok patterns] and https://github.com/logstash-plugins/logstash-patterns-core/tree/master/patterns[Logstash grok patterns] -for the complete list of patterns. +Grok patterns are supported in {ref}/runtime.html[{es} runtime fields], the {es} +{ref}/grok-processor.html[grok ingest processor], and the {ls} +{logstash-ref}/plugins-filters-grok.html[grok filter]. For syntax, see +{ref}/grok.html[Grokking grok]. + +The {stack} ships with more than 120 reusable grok patterns. For a complete +list of patterns, see +https://github.com/elastic/elasticsearch/tree/master/libs/grok/src/main/resources/patterns[{es} +grok patterns] and +https://github.com/logstash-plugins/logstash-patterns-core/tree/master/patterns[{ls} +grok patterns]. Because -ingest node and Logstash share the same grok implementation and pattern +{es} and {ls} share the same grok implementation and pattern libraries, any grok pattern that you create in the *Grok Debugger* will work -in ingest node and Logstash. +in both {es} and {ls}. [float] [[grokdebugger-getting-started]] diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index edc1821f3b223..f74476dff8ef2 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -452,7 +452,7 @@ the infrastructure monitoring use-case within Kibana. |{kib-repo}blob/{branch}/x-pack/plugins/ingest_pipelines/README.md[ingestPipelines] -|The ingest_pipelines plugin provides Kibana support for Elasticsearch's ingest nodes. Please refer to the Elasticsearch documentation for more details. +|The ingest_pipelines plugin provides Kibana support for Elasticsearch's ingest pipelines. |{kib-repo}blob/{branch}/x-pack/plugins/lens/readme.md[lens] diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index 97a87506f2337..d5bc2ccd8ef7d 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -293,7 +293,7 @@ This content has moved. Refer to <>. This content has moved. Refer to <>. [role="exclude",id="ingest-node-pipelines"] -== Ingest Node Pipelines +== Ingest Pipelines This content has moved. Refer to {ref}/ingest.html[Ingest pipelines]. diff --git a/docs/user/monitoring/monitoring-metricbeat.asciidoc b/docs/user/monitoring/monitoring-metricbeat.asciidoc index 5ef3b8177a9c5..101377e047588 100644 --- a/docs/user/monitoring/monitoring-metricbeat.asciidoc +++ b/docs/user/monitoring/monitoring-metricbeat.asciidoc @@ -189,8 +189,9 @@ If you configured the monitoring cluster to use encrypted communications, you must access it via HTTPS. For example, use a `hosts` setting like `https://es-mon-1:9200`. -IMPORTANT: The {es} {monitor-features} use ingest pipelines, therefore the -cluster that stores the monitoring data must have at least one ingest node. +IMPORTANT: The {es} {monitor-features} use ingest pipelines. The +cluster that stores the monitoring data must have at least one node with the +`ingest` role. If the {es} {security-features} are enabled on the monitoring cluster, you must provide a valid user ID and password so that {metricbeat} can send metrics diff --git a/x-pack/plugins/apm/public/tutorial/tutorial_fleet_instructions/index.tsx b/x-pack/plugins/apm/public/tutorial/tutorial_fleet_instructions/index.tsx index c69623f92987a..175d6797bb29f 100644 --- a/x-pack/plugins/apm/public/tutorial/tutorial_fleet_instructions/index.tsx +++ b/x-pack/plugins/apm/public/tutorial/tutorial_fleet_instructions/index.tsx @@ -86,7 +86,7 @@ function TutorialFleetInstructions({ http, basePath, isDarkTheme }: Props) { 'xpack.apm.tutorial.apmServer.fleet.message', { defaultMessage: - 'The APM integration installs Elasticsearch templates and Ingest Node pipelines for APM data.', + 'The APM integration installs Elasticsearch templates and ingest pipelines for APM data.', } )} footer={ diff --git a/x-pack/plugins/ingest_pipelines/README.md b/x-pack/plugins/ingest_pipelines/README.md index 00d4f5a91863d..dd7c130c7a72d 100644 --- a/x-pack/plugins/ingest_pipelines/README.md +++ b/x-pack/plugins/ingest_pipelines/README.md @@ -1,9 +1,9 @@ -# Ingest Node Pipelines UI +# Ingest Pipelines UI ## Summary -The `ingest_pipelines` plugin provides Kibana support for [Elasticsearch's ingest nodes](https://www.elastic.co/guide/en/elasticsearch/reference/master/ingest.html). Please refer to the Elasticsearch documentation for more details. +The `ingest_pipelines` plugin provides Kibana support for [Elasticsearch's ingest pipelines](https://www.elastic.co/guide/en/elasticsearch/reference/master/ingest.html). -This plugin allows Kibana to create, edit, clone and delete ingest node pipelines. It also provides support to simulate a pipeline. +This plugin allows Kibana to create, edit, clone and delete ingest pipelines. It also provides support to simulate a pipeline. It requires a Basic license and the following cluster privileges: `manage_pipeline` and `cluster:monitor/nodes/info`. @@ -11,7 +11,7 @@ It requires a Basic license and the following cluster privileges: `manage_pipeli ## Development -A new app called Ingest Node Pipelines is registered in the Management section and follows a typical CRUD UI pattern. The client-side portion of this app lives in [public/application](public/application) and uses endpoints registered in [server/routes/api](server/routes/api). For more information on the pipeline processors editor component, check out the [component readme](public/application/components/pipeline_processors_editor/README.md). +A new app called Ingest Pipelines is registered in the Management section and follows a typical CRUD UI pattern. The client-side portion of this app lives in [public/application](public/application) and uses endpoints registered in [server/routes/api](server/routes/api). For more information on the pipeline processors editor component, check out the [component readme](public/application/components/pipeline_processors_editor/README.md). See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions on setting up your development environment. @@ -25,7 +25,7 @@ The app has the following test coverage: ### Quick steps for manual testing -You can run the following request in Console to create an ingest node pipeline: +You can run the following request in Console to create an ingest pipeline: ``` PUT _ingest/pipeline/test_pipeline @@ -73,7 +73,7 @@ PUT _ingest/pipeline/test_pipeline } ``` -Then, go to the Ingest Node Pipelines UI to edit, delete, clone, or view details of the pipeline. +Then, go to the Ingest Pipelines UI to edit, delete, clone, or view details of the pipeline. To simulate a pipeline, go to the "Edit" page of your pipeline. Click the "Add documents" link under the "Processors" section. You may add the following sample documents to test the pipeline: diff --git a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_list.test.ts b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_list.test.ts index 78e3f2dab0d1d..19a2abb5a5a52 100644 --- a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_list.test.ts +++ b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_list.test.ts @@ -52,11 +52,11 @@ describe('', () => { // Verify app title expect(exists('appTitle')).toBe(true); - expect(find('appTitle').text()).toEqual('Ingest Node Pipelines'); + expect(find('appTitle').text()).toEqual('Ingest Pipelines'); // Verify documentation link expect(exists('documentationLink')).toBe(true); - expect(find('documentationLink').text()).toBe('Ingest Node Pipelines docs'); + expect(find('documentationLink').text()).toBe('Ingest Pipelines docs'); // Verify create button exists expect(exists('createPipelineButton')).toBe(true); diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/shared/map_processor_type_to_form.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/shared/map_processor_type_to_form.tsx index 0d61d839156e2..eae48a6b46dd1 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/shared/map_processor_type_to_form.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/shared/map_processor_type_to_form.tsx @@ -557,7 +557,7 @@ export const mapProcessorTypeToDescriptor: MapProcessorTypeToDescriptor = { defaultMessage: 'Pipeline', }), typeDescription: i18n.translate('xpack.ingestPipelines.processors.description.pipeline', { - defaultMessage: 'Runs another ingest node pipeline.', + defaultMessage: 'Runs another ingest pipeline.', }), getDefaultDescription: ({ name }) => i18n.translate('xpack.ingestPipelines.processors.defaultDescription.pipeline', { diff --git a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx index ae68cfcb399f0..95621601011f9 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/sections/pipelines_list/main.tsx @@ -153,7 +153,7 @@ export const PipelinesList: React.FunctionComponent = ({ } @@ -172,7 +172,7 @@ export const PipelinesList: React.FunctionComponent = ({ > , ]} diff --git a/x-pack/plugins/ingest_pipelines/public/application/services/breadcrumbs.ts b/x-pack/plugins/ingest_pipelines/public/application/services/breadcrumbs.ts index 138fdf4e8ead6..f1b2d22e776b9 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/services/breadcrumbs.ts +++ b/x-pack/plugins/ingest_pipelines/public/application/services/breadcrumbs.ts @@ -11,7 +11,7 @@ import { ManagementAppMountParams } from '../../../../../../src/plugins/manageme type SetBreadcrumbs = ManagementAppMountParams['setBreadcrumbs']; const homeBreadcrumbText = i18n.translate('xpack.ingestPipelines.breadcrumb.pipelinesLabel', { - defaultMessage: 'Ingest Node Pipelines', + defaultMessage: 'Ingest Pipelines', }); export class BreadcrumbService { diff --git a/x-pack/plugins/ingest_pipelines/public/plugin.ts b/x-pack/plugins/ingest_pipelines/public/plugin.ts index 4e85490de6209..68dc2c1801e0c 100644 --- a/x-pack/plugins/ingest_pipelines/public/plugin.ts +++ b/x-pack/plugins/ingest_pipelines/public/plugin.ts @@ -25,7 +25,7 @@ export class IngestPipelinesPlugin apiService.setup(http, uiMetricService); const pluginName = i18n.translate('xpack.ingestPipelines.appTitle', { - defaultMessage: 'Ingest Node Pipelines', + defaultMessage: 'Ingest Pipelines', }); management.sections.section.ingest.registerApp({ diff --git a/x-pack/test/accessibility/apps/ingest_node_pipelines.ts b/x-pack/test/accessibility/apps/ingest_node_pipelines.ts index b9bc216db60b5..dab9c86bf018e 100644 --- a/x-pack/test/accessibility/apps/ingest_node_pipelines.ts +++ b/x-pack/test/accessibility/apps/ingest_node_pipelines.ts @@ -14,14 +14,14 @@ export default function ({ getService, getPageObjects }: any) { const log = getService('log'); const a11y = getService('a11y'); /* this is the wrapping service around axe */ - describe('Ingest Node Pipelines', async () => { + describe('Ingest Pipelines', async () => { before(async () => { await putSamplePipeline(esClient); await common.navigateToApp('ingestPipelines'); }); it('List View', async () => { - await retry.waitFor('Ingest Node Pipelines page to be visible', async () => { + await retry.waitFor('Ingest Pipelines page to be visible', async () => { await common.navigateToApp('ingestPipelines'); return testSubjects.exists('pipelineDetailsLink') ? true : false; }); diff --git a/x-pack/test/api_integration/apis/management/ingest_pipelines/index.ts b/x-pack/test/api_integration/apis/management/ingest_pipelines/index.ts index 54bd29ede5865..d36c573e14e1f 100644 --- a/x-pack/test/api_integration/apis/management/ingest_pipelines/index.ts +++ b/x-pack/test/api_integration/apis/management/ingest_pipelines/index.ts @@ -8,7 +8,7 @@ import { FtrProviderContext } from '../../../ftr_provider_context'; export default function ({ loadTestFile }: FtrProviderContext) { - describe('Ingest Node Pipelines', () => { + describe('Ingest Pipelines', () => { loadTestFile(require.resolve('./ingest_pipelines')); }); } diff --git a/x-pack/test/api_integration/apis/management/ingest_pipelines/ingest_pipelines.ts b/x-pack/test/api_integration/apis/management/ingest_pipelines/ingest_pipelines.ts index 1ad2a05d4f783..80790a6df400f 100644 --- a/x-pack/test/api_integration/apis/management/ingest_pipelines/ingest_pipelines.ts +++ b/x-pack/test/api_integration/apis/management/ingest_pipelines/ingest_pipelines.ts @@ -145,7 +145,7 @@ export default function ({ getService }: FtrProviderContext) { await createPipeline({ body: PIPELINE, id: PIPELINE_ID }, true); } catch (err) { // eslint-disable-next-line no-console - console.log('[Setup error] Error creating ingest node pipeline'); + console.log('[Setup error] Error creating ingest pipeline'); throw err; } }); @@ -225,7 +225,7 @@ export default function ({ getService }: FtrProviderContext) { await createPipeline({ body: PIPELINE, id: PIPELINE_ID }, true); } catch (err) { // eslint-disable-next-line no-console - console.log('[Setup error] Error creating ingest node pipeline'); + console.log('[Setup error] Error creating ingest pipeline'); throw err; } }); diff --git a/x-pack/test/functional/apps/ingest_pipelines/feature_controls/ingest_pipelines_security.ts b/x-pack/test/functional/apps/ingest_pipelines/feature_controls/ingest_pipelines_security.ts index aed73d6c9858d..1f89ea8c635a6 100644 --- a/x-pack/test/functional/apps/ingest_pipelines/feature_controls/ingest_pipelines_security.ts +++ b/x-pack/test/functional/apps/ingest_pipelines/feature_controls/ingest_pipelines_security.ts @@ -60,7 +60,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { it('should render the "Ingest" section with ingest pipelines', async () => { await PageObjects.common.navigateToApp('management'); const sections = await managementMenu.getSections(); - // We gave the ingest node pipelines user access to advanced settings to allow them to use ingest node pipelines. + // We gave the ingest pipelines user access to advanced settings to allow them to use ingest pipelines. // See https://github.com/elastic/kibana/pull/102409/ expect(sections).to.have.length(2); expect(sections[0]).to.eql({ diff --git a/x-pack/test/functional/apps/ingest_pipelines/ingest_pipelines.ts b/x-pack/test/functional/apps/ingest_pipelines/ingest_pipelines.ts index 17b4fef06f5ce..026cea52e8102 100644 --- a/x-pack/test/functional/apps/ingest_pipelines/ingest_pipelines.ts +++ b/x-pack/test/functional/apps/ingest_pipelines/ingest_pipelines.ts @@ -29,10 +29,10 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }); it('Loads the app', async () => { - log.debug('Checking for section heading to say Ingest Node Pipelines.'); + log.debug('Checking for section heading to say Ingest Pipelines.'); const headingText = await pageObjects.ingestPipelines.sectionHeadingText(); - expect(headingText).to.be('Ingest Node Pipelines'); + expect(headingText).to.be('Ingest Pipelines'); }); it('Creates a pipeline', async () => { From 327caaf490360e435a9e97c1fddef5aa38e4eb79 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 4 Oct 2021 17:22:46 -0400 Subject: [PATCH 2/2] Fix missed ref. Fix runtime fields link. --- docs/dev-tools/grokdebugger/index.asciidoc | 2 +- docs/user/management.asciidoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev-tools/grokdebugger/index.asciidoc b/docs/dev-tools/grokdebugger/index.asciidoc index b4e53e5440766..6a809c13fcb93 100644 --- a/docs/dev-tools/grokdebugger/index.asciidoc +++ b/docs/dev-tools/grokdebugger/index.asciidoc @@ -9,7 +9,7 @@ structure it. Grok is good for parsing syslog, apache, and other webserver logs, mysql logs, and in general, any log format that is written for human consumption. -Grok patterns are supported in {ref}/runtime.html[{es} runtime fields], the {es} +Grok patterns are supported in {es} {ref}/runtime.html[runtime fields], the {es} {ref}/grok-processor.html[grok ingest processor], and the {ls} {logstash-ref}/plugins-filters-grok.html[grok filter]. For syntax, see {ref}/grok.html[Grokking grok]. diff --git a/docs/user/management.asciidoc b/docs/user/management.asciidoc index 4e5f70db9aef6..1f38d50e2d0bd 100644 --- a/docs/user/management.asciidoc +++ b/docs/user/management.asciidoc @@ -17,7 +17,7 @@ Consult your administrator if you do not have the appropriate access. [cols="50, 50"] |=== -| {ref}/ingest.html[Ingest Node Pipelines] +| {ref}/ingest.html[Ingest Pipelines] | Create and manage ingest pipelines that let you perform common transformations and enrichments on your data.