[7.x] Ingest Node Pipelines UI (#62321) (#64956)

x-pack/.i18nrc.json

@@ -23,6 +23,7 @@
     "xpack.indexLifecycleMgmt": "plugins/index_lifecycle_management",
     "xpack.infra": "plugins/infra",
     "xpack.ingestManager": "plugins/ingest_manager",
+    "xpack.ingestPipelines": "plugins/ingest_pipelines",
     "xpack.lens": "plugins/lens",
     "xpack.licenseMgmt": "plugins/license_management",
     "xpack.licensing": "plugins/licensing",

x-pack/plugins/ingest_pipelines/README.md

@@ -0,0 +1,24 @@
+# Ingest Node 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.
+
+This plugin allows Kibana to create, edit, clone and delete ingest node 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`.
+
+---
+
+## 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).
+
+See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions on setting up your development environment.
+
+### Test coverage
+
+The app has the following test coverage:
+
+- Complete API integration tests
+- Smoke-level functional test
+- Client-integration tests

x-pack/plugins/ingest_pipelines/common/constants.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { LicenseType } from '../../licensing/common/types';
+
+const basicLicense: LicenseType = 'basic';
+
+export const PLUGIN_ID = 'ingest_pipelines';
+
+export const PLUGIN_MIN_LICENSE_TYPE = basicLicense;
+
+export const BASE_PATH = '/management/elasticsearch/ingest_pipelines';
+
+export const API_BASE_PATH = '/api/ingest_pipelines';
+
+export const APP_CLUSTER_REQUIRED_PRIVILEGES = ['manage_pipeline', 'cluster:monitor/nodes/info'];

x-pack/plugins/ingest_pipelines/common/lib/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { deserializePipelines } from './pipeline_serialization';

x-pack/plugins/ingest_pipelines/common/lib/pipeline_serialization.test.ts

@@ -0,0 +1,68 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { deserializePipelines } from './pipeline_serialization';
+
+describe('pipeline_serialization', () => {
+  describe('deserializePipelines()', () => {
+    it('should deserialize pipelines', () => {
+      expect(
+        deserializePipelines({
+          pipeline1: {
+            description: 'pipeline 1 description',
+            version: 1,
+            processors: [
+              {
+                script: {
+                  source: 'ctx._type = null',
+                },
+              },
+            ],
+            on_failure: [
+              {
+                set: {
+                  field: 'error.message',
+                  value: '{{ failure_message }}',
+                },
+              },
+            ],
+          },
+          pipeline2: {
+            description: 'pipeline2 description',
+            version: 1,
+            processors: [],
+          },
+        })
+      ).toEqual([
+        {
+          name: 'pipeline1',
+          description: 'pipeline 1 description',
+          version: 1,
+          processors: [
+            {
+              script: {
+                source: 'ctx._type = null',
+              },
+            },
+          ],
+          on_failure: [
+            {
+              set: {
+                field: 'error.message',
+                value: '{{ failure_message }}',
+              },
+            },
+          ],
+        },
+        {
+          name: 'pipeline2',
+          description: 'pipeline2 description',
+          version: 1,
+          processors: [],
+        },
+      ]);
+    });
+  });
+});

x-pack/plugins/ingest_pipelines/common/lib/pipeline_serialization.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { PipelinesByName, Pipeline } from '../types';
+
+export function deserializePipelines(pipelinesByName: PipelinesByName): Pipeline[] {
+  const pipelineNames: string[] = Object.keys(pipelinesByName);
+
+  const deserializedPipelines = pipelineNames.map((name: string) => {
+    return {
+      ...pipelinesByName[name],
+      name,
+    };
+  });
+
+  return deserializedPipelines;
+}

x-pack/plugins/ingest_pipelines/common/types.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+interface Processor {
+  [key: string]: {
+    [key: string]: unknown;
+  };
+}
+
+export interface Pipeline {
+  name: string;
+  description: string;
+  version?: number;
+  processors: Processor[];
+  on_failure?: Processor[];
+}
+
+export interface PipelinesByName {
+  [key: string]: {
+    description: string;
+    version?: number;
+    processors: Processor[];
+    on_failure?: Processor[];
+  };
+}

x-pack/plugins/ingest_pipelines/kibana.json

@@ -0,0 +1,17 @@
+{
+  "id": "ingestPipelines",
+  "version": "kibana",
+  "server": true,
+  "ui": true,
+  "requiredPlugins": [
+    "licensing",
+    "management"
+  ],
+  "optionalPlugins": [
+    "usageCollection"
+  ],
+  "configPath": [
+    "xpack",
+    "ingest_pipelines"
+  ]
+}

x-pack/plugins/ingest_pipelines/public/application/app.tsx

@@ -0,0 +1,101 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { FormattedMessage } from '@kbn/i18n/react';
+import { EuiPageContent } from '@elastic/eui';
+import React, { FunctionComponent } from 'react';
+import { HashRouter, Switch, Route } from 'react-router-dom';
+
+import { BASE_PATH, APP_CLUSTER_REQUIRED_PRIVILEGES } from '../../common/constants';
+
+import {
+  SectionError,
+  useAuthorizationContext,
+  WithPrivileges,
+  SectionLoading,
+  NotAuthorizedSection,
+} from '../shared_imports';
+
+import { PipelinesList, PipelinesCreate, PipelinesEdit, PipelinesClone } from './sections';
+
+export const AppWithoutRouter = () => (
+  <Switch>
+    <Route exact path={BASE_PATH} component={PipelinesList} />
+    <Route exact path={`${BASE_PATH}/create/:sourceName`} component={PipelinesClone} />
+    <Route exact path={`${BASE_PATH}/create`} component={PipelinesCreate} />
+    <Route exact path={`${BASE_PATH}/edit/:name`} component={PipelinesEdit} />
+    {/* Catch all */}
+    <Route component={PipelinesList} />
+  </Switch>
+);
+
+export const App: FunctionComponent = () => {
+  const { apiError } = useAuthorizationContext();
+
+  if (apiError) {
+    return (
+      <SectionError
+        title={
+          <FormattedMessage
+            id="xpack.ingestPipelines.app.checkingPrivilegesErrorMessage"
+            defaultMessage="Error fetching user privileges from the server."
+          />
+        }
+        error={apiError}
+      />
+    );
+  }
+
+  return (
+    <WithPrivileges
+      privileges={APP_CLUSTER_REQUIRED_PRIVILEGES.map(privilege => `cluster.${privilege}`)}
+    >
+      {({ isLoading, hasPrivileges, privilegesMissing }) => {
+        if (isLoading) {
+          return (
+            <SectionLoading>
+              <FormattedMessage
+                id="xpack.ingestPipelines.app.checkingPrivilegesDescription"
+                defaultMessage="Checking privileges…"
+              />
+            </SectionLoading>
+          );
+        }
+
+        if (!hasPrivileges) {
+          return (
+            <EuiPageContent>
+              <NotAuthorizedSection
+                title={
+                  <FormattedMessage
+                    id="xpack.ingestPipelines.app.deniedPrivilegeTitle"
+                    defaultMessage="You're missing cluster privileges"
+                  />
+                }
+                message={
+                  <FormattedMessage
+                    id="xpack.ingestPipelines.app.deniedPrivilegeDescription"
+                    defaultMessage="To use Ingest Pipelines, you must have {privilegesCount,
+                    plural, one {this cluster privilege} other {these cluster privileges}}: {missingPrivileges}."
+                    values={{
+                      missingPrivileges: privilegesMissing.cluster!.join(', '),
+                      privilegesCount: privilegesMissing.cluster!.length,
+                    }}
+                  />
+                }
+              />
+            </EuiPageContent>
+          );
+        }
+
+        return (
+          <HashRouter>
+            <AppWithoutRouter />
+          </HashRouter>
+        );
+      }}
+    </WithPrivileges>
+  );
+};

x-pack/plugins/ingest_pipelines/public/application/components/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { PipelineForm } from './pipeline_form';

x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { PipelineFormProvider as PipelineForm } from './pipeline_form_provider';