merge with master

docs/epm/index.asciidoc → docs/ingest_manager/index.asciidoc

@@ -1,8 +1,8 @@
 [role="xpack"]
 [[epm]]
-== Elastic Package Manager
+== Ingest Manager
 
-These are the docs for the Elastic Package Manager (EPM).
+These are the docs for the Ingest Manager.
 
 
 === Configuration
@@ -39,16 +39,71 @@ curl -X DELETE localhost:5601/api/ingest_manager/epm/packages/iptables-1.0.4
 
 This section is to define terms used across ingest management.
 
+==== Data Source
+
+A data source is a definition on how to collect data from a service, for example `nginx`. A data source contains
+definitions for one or multiple inputs and each input can contain one or multiple streams.
+
+With the example of the nginx Data Source, it contains to inputs: `logs` and `nginx/metrics`. Logs and metrics are collected
+differently. The `logs` input contains two streams, `access` and `error`, the `nginx/metrics` input contains the stubstatus stream.
+
+
+==== Data Stream
+
+Data Streams are a [new concept](https://github.com/elastic/elasticsearch/issues/53100) in Elasticsearch which simplify
+ingesting data and the setup of Elasticsearch.
+
 ==== Elastic Agent
+
 A single, unified agent that users can deploy to hosts or containers. It controls which data is collected from the host or containers and where the data is sent. It will run Beats, Endpoint or other monitoring programs as needed. It can operate standalone or pull a configuration policy from Fleet.
 
+
+==== Elastic Package Registry
+
+The Elastic Package Registry (EPR) is a service which runs under [https://epr.elastic.co]. It serves the packages through its API.
+More details about the registry can be found [here](https://github.com/elastic/package-registry).
+
+==== Fleet
+
+Fleet is the part of the Ingest Manager UI in Kibana that handles the part of enrolling Elastic Agents,
+managing agents and sending configurations to the Elastic Agent.
+
+==== Indexing Strategy
+
+Ingest Management + Elastic Agent follow a strict new indexing strategy: `{type}-{dataset}-{namespace}`. An example
+for this is `logs-nginx.access-default`. More details about it can be found in the Index Strategy below. All data of
+the index strategy is sent to Data Streams.
+
+==== Input
+
+An input is the configuration unit in an Agent Config that defines the options on how to collect data from 
+an endpoint. This could be username / password which are need to authenticate with a service or a host url 
+as an example.
+
+An input is part of a Data Source and contains streams.
+
+==== Integration
+
+An integration is a package with the type integration. An integration package has at least 1 data source
+and usually collects data from / about a service.
+
+
 ==== Namespace
+
 A user-specified string that will be used to part of the index name in Elasticsearch. It helps users identify logs coming from a specific environment (like prod or test), an application, or other identifiers.
 
+
 ==== Package
 
-A package contains all the assets for the Elastic Stack. A more detailed definition of a package can be found under https://github.com/elastic/package-registry.
+A package contains all the assets for the Elastic Stack. A more detailed definition of a 
+package can be found under https://github.com/elastic/package-registry.
+
+Besides the assets, a package contains the data source definitions with its inputs and streams.
+
+==== Stream
 
+A stream is a configuration unit in the Elastic Agent config. A stream is part of an input and defines how the data
+fetched by this input should be processed and which Data Stream to send it to.
 
 == Indexing Strategy
 

examples/embeddable_examples/public/hello_world/hello_world_embeddable_factory.ts

@@ -21,11 +21,11 @@ import { i18n } from '@kbn/i18n';
 import {
   IContainer,
   EmbeddableInput,
-  EmbeddableFactory,
+  EmbeddableFactoryDefinition,
 } from '../../../../src/plugins/embeddable/public';
 import { HelloWorldEmbeddable, HELLO_WORLD_EMBEDDABLE } from './hello_world_embeddable';
 
-export class HelloWorldEmbeddableFactory extends EmbeddableFactory {
+export class HelloWorldEmbeddableFactory implements EmbeddableFactoryDefinition {
   public readonly type = HELLO_WORLD_EMBEDDABLE;
 
   /**

examples/embeddable_examples/public/list_container/list_container_factory.ts

@@ -19,7 +19,7 @@
 
 import { i18n } from '@kbn/i18n';
 import {
-  EmbeddableFactory,
+  EmbeddableFactoryDefinition,
   ContainerInput,
   EmbeddableStart,
 } from '../../../../src/plugins/embeddable/public';
@@ -29,22 +29,20 @@ interface StartServices {
   getEmbeddableFactory: EmbeddableStart['getEmbeddableFactory'];
 }
 
-export class ListContainerFactory extends EmbeddableFactory {
+export class ListContainerFactory implements EmbeddableFactoryDefinition {
   public readonly type = LIST_CONTAINER;
   public readonly isContainerType = true;
 
-  constructor(private getStartServices: () => Promise<StartServices>) {
-    super();
-  }
+  constructor(private getStartServices: () => Promise<StartServices>) {}
 
   public async isEditable() {
     return true;
   }
 
-  public async create(initialInput: ContainerInput) {
+  public create = async (initialInput: ContainerInput) => {
     const { getEmbeddableFactory } = await this.getStartServices();
     return new ListContainer(initialInput, getEmbeddableFactory);
-  }
+  };
 
   public getDisplayName() {
     return i18n.translate('embeddableExamples.searchableListContainer.displayName', {

examples/embeddable_examples/public/multi_task_todo/multi_task_todo_embeddable_factory.ts

@@ -18,18 +18,16 @@
  */
 
 import { i18n } from '@kbn/i18n';
-import { IContainer, EmbeddableFactory } from '../../../../src/plugins/embeddable/public';
+import { IContainer, EmbeddableFactoryDefinition } from '../../../../src/plugins/embeddable/public';
 import {
   MultiTaskTodoEmbeddable,
   MULTI_TASK_TODO_EMBEDDABLE,
   MultiTaskTodoInput,
   MultiTaskTodoOutput,
 } from './multi_task_todo_embeddable';
 
-export class MultiTaskTodoEmbeddableFactory extends EmbeddableFactory<
-  MultiTaskTodoInput,
-  MultiTaskTodoOutput
-> {
+export class MultiTaskTodoEmbeddableFactory
+  implements EmbeddableFactoryDefinition<MultiTaskTodoInput, MultiTaskTodoOutput> {
   public readonly type = MULTI_TASK_TODO_EMBEDDABLE;
 
   public async isEditable() {

examples/embeddable_examples/public/searchable_list_container/searchable_list_container_factory.ts

@@ -18,7 +18,10 @@
  */
 
 import { i18n } from '@kbn/i18n';
-import { EmbeddableFactory, EmbeddableStart } from '../../../../src/plugins/embeddable/public';
+import {
+  EmbeddableFactoryDefinition,
+  EmbeddableStart,
+} from '../../../../src/plugins/embeddable/public';
 import {
   SEARCHABLE_LIST_CONTAINER,
   SearchableListContainer,
@@ -29,22 +32,20 @@ interface StartServices {
   getEmbeddableFactory: EmbeddableStart['getEmbeddableFactory'];
 }
 
-export class SearchableListContainerFactory extends EmbeddableFactory {
+export class SearchableListContainerFactory implements EmbeddableFactoryDefinition {
   public readonly type = SEARCHABLE_LIST_CONTAINER;
   public readonly isContainerType = true;
 
-  constructor(private getStartServices: () => Promise<StartServices>) {
-    super();
-  }
+  constructor(private getStartServices: () => Promise<StartServices>) {}
 
   public async isEditable() {
     return true;
   }
 
-  public async create(initialInput: SearchableContainerInput) {
+  public create = async (initialInput: SearchableContainerInput) => {
     const { getEmbeddableFactory } = await this.getStartServices();
     return new SearchableListContainer(initialInput, getEmbeddableFactory);
-  }
+  };
 
   public getDisplayName() {
     return i18n.translate('embeddableExamples.searchableListContainer.displayName', {

examples/embeddable_examples/public/todo/todo_embeddable_factory.tsx

@@ -23,7 +23,7 @@ import { OverlayStart } from 'kibana/public';
 import { EuiFieldText } from '@elastic/eui';
 import { EuiButton } from '@elastic/eui';
 import { toMountPoint } from '../../../../src/plugins/kibana_react/public';
-import { IContainer, EmbeddableFactory } from '../../../../src/plugins/embeddable/public';
+import { IContainer, EmbeddableFactoryDefinition } from '../../../../src/plugins/embeddable/public';
 import { TodoEmbeddable, TODO_EMBEDDABLE, TodoInput, TodoOutput } from './todo_embeddable';
 
 function TaskInput({ onSave }: { onSave: (task: string) => void }) {
@@ -47,16 +47,11 @@ interface StartServices {
   openModal: OverlayStart['openModal'];
 }
 
-export class TodoEmbeddableFactory extends EmbeddableFactory<
-  TodoInput,
-  TodoOutput,
-  TodoEmbeddable
-> {
+export class TodoEmbeddableFactory
+  implements EmbeddableFactoryDefinition<TodoInput, TodoOutput, TodoEmbeddable> {
   public readonly type = TODO_EMBEDDABLE;
 
-  constructor(private getStartServices: () => Promise<StartServices>) {
-    super();
-  }
+  constructor(private getStartServices: () => Promise<StartServices>) {}
 
   public async isEditable() {
     return true;
@@ -72,7 +67,7 @@ export class TodoEmbeddableFactory extends EmbeddableFactory<
    * used to collect specific embeddable input that the container will not provide, like
    * in this case, the task string.
    */
-  public async getExplicitInput() {
+  public getExplicitInput = async () => {
     const { openModal } = await this.getStartServices();
     return new Promise<{ task: string }>(resolve => {
       const onSave = (task: string) => resolve({ task });
@@ -87,7 +82,7 @@ export class TodoEmbeddableFactory extends EmbeddableFactory<
         )
       );
     });
-  }
+  };
 
   public getDisplayName() {
     return i18n.translate('embeddableExamples.todo.displayName', {

examples/embeddable_explorer/public/todo_embeddable_example.tsx

@@ -37,9 +37,14 @@ import {
 import {
   TodoEmbeddable,
   TODO_EMBEDDABLE,
-  TodoEmbeddableFactory,
+  TodoInput,
 } from '../../../examples/embeddable_examples/public/todo';
-import { EmbeddableStart, EmbeddableRoot } from '../../../src/plugins/embeddable/public';
+import {
+  EmbeddableStart,
+  EmbeddableRoot,
+  EmbeddableOutput,
+  ErrorEmbeddable,
+} from '../../../src/plugins/embeddable/public';
 
 interface Props {
   getEmbeddableFactory: EmbeddableStart['getEmbeddableFactory'];
@@ -53,7 +58,7 @@ interface State {
 }
 
 export class TodoEmbeddableExample extends React.Component<Props, State> {
-  private embeddable?: TodoEmbeddable;
+  private embeddable?: TodoEmbeddable | ErrorEmbeddable;
 
   constructor(props: Props) {
     super(props);
@@ -62,7 +67,9 @@ export class TodoEmbeddableExample extends React.Component<Props, State> {
   }
 
   public componentDidMount() {
-    const factory = this.props.getEmbeddableFactory(TODO_EMBEDDABLE) as TodoEmbeddableFactory;
+    const factory = this.props.getEmbeddableFactory<TodoInput, EmbeddableOutput, TodoEmbeddable>(
+      TODO_EMBEDDABLE
+    );
 
     if (factory === undefined) {
       throw new Error('Embeddable factory is undefined!');