Adding YAML examples to elastic search output plugin docs. Fixes #1723. (#1750)

Signed-off-by: Eric D. Schabell <[email protected]>

Author: eschabell

pipeline/outputs/elasticsearch.md

@@ -112,7 +112,29 @@ fluent-bit -i cpu -t cpu -o es -p Host=192.168.2.3 -p Port=9200 \
 
 In your main configuration file append the following `Input` and `Output` sections.
 
-```python
+% tabs %}
+{% tab title="fluent-bit.yaml" %}
+
+```yaml
+pipeline:
+    inputs:
+        - name: cpu
+          tag: cpu
+          
+    outputs:
+        - name: es
+          match: '*'
+          host: 192.168.2.3
+          port: 9200
+          index: my_index
+          type: my_type
+```
+
+{% endtab %}
+
+{% tab title="fluent-bit.conf" %}
+
+```text
 [INPUT]
     Name  cpu
     Tag   cpu
@@ -126,7 +148,8 @@ In your main configuration file append the following `Input` and `Output` sectio
     Type  my_type
 ```
 
-![example configuration visualization from Calyptia](../../.gitbook/assets/image%20%282%29.png)
+{% endtab %}
+{% endtabs %}
 
 ## About Elasticsearch field names
 
@@ -158,7 +181,31 @@ See [details](https://github.com/fluent/fluent-bit-docs/tree/43c4fe134611da471e7
 
 Example configuration:
 
-```text copy
+% tabs %}
+{% tab title="fluent-bit.yaml" %}
+
+```yaml
+pipeline:
+    inputs:
+        ...
+          
+    outputs:
+        - name: es
+          match: '*'
+          host: vpc-test-domain-ke7thhzoo7jawsrhmm6mb7ite7y.us-west-2.es.amazonaws.com
+          port: 443
+          index: my_index
+          type: my_type
+          aws_auth: on
+          aws_region: us-west-2
+          tls: on
+```
+
+{% endtab %}
+
+{% tab title="fluent-bit.conf" %}
+
+```text
 [OUTPUT]
     Name  es
     Match *
@@ -171,6 +218,9 @@ Example configuration:
     tls     On
 ```
 
+{% endtab %}
+{% endtabs %}
+
 Be aware that the `Port` is set to `443`, `tls` is enabled, and `AWS_Region` is set.
 
 ### Use Fluent Bit with Elastic Cloud
@@ -184,7 +234,29 @@ to the
 
 Example configuration:
 
-```text copy
+% tabs %}
+{% tab title="fluent-bit.yaml" %}
+
+```yaml
+pipeline:
+    inputs:
+        ...
+          
+    outputs:
+        - name: es
+          include_tag_key: true
+          tag_key: tags
+          tls: on
+          tls.verify: off
+          cloud_id: 'elastic-obs-deployment:ZXVybxxxxxxxxxxxg=='
+          cloud_auth: 'elastic:2vxxxxxxxxYV'
+```
+
+{% endtab %}
+
+{% tab title="fluent-bit.conf" %}
+
+```text
 [OUTPUT]
     Name es
     Include_Tag_Key true
@@ -196,6 +268,9 @@ Example configuration:
     cloud_auth elastic:2vxxxxxxxxYV
 ```
 
+{% endtab %}
+{% endtabs %}
+
 In Elastic Cloud version 8 and great, the type option must be removed by setting
 `Suppress_Type_Name On`.
 
@@ -221,6 +296,30 @@ Rejecting mapping update to [products] as the final mapping would have more than
 
 This means that you can't set up your configuration like the following:.
 
+% tabs %}
+{% tab title="fluent-bit.yaml" %}
+
+```yaml
+pipeline:
+    inputs:
+        ...
+          
+    outputs:
+        - name: es
+          match: 'foo.*'
+          index: search
+          type: type1
+
+        - name: es
+          match: 'bar.*'
+          index: search
+          type: type2
+```
+
+{% endtab %}
+
+{% tab title="fluent-bit.conf" %}
+
 ```text
 [OUTPUT]
     Name  es
@@ -235,6 +334,9 @@ This means that you can't set up your configuration like the following:.
     Type  type2
 ```
 
+{% endtab %}
+{% endtabs %}
+
 For details, read [the official blog post on that issue](https://www.elastic.co/guide/en/elasticsearch/reference/6.7/removal-of-types.html).
 
 ### Mapping type names can't start with underscores (`_`)
@@ -250,7 +352,31 @@ This doesn't work in Elasticsearch versions 5.6 through 6.1
 Ensure you set an explicit map such as `doc` or `flb_type` in the configuration,
 as seen on the last line:
 
-```text copy
+% tabs %}
+{% tab title="fluent-bit.yaml" %}
+
+```yaml
+pipeline:
+    inputs:
+        ...
+          
+    outputs:
+        - name: es
+          match: '*'
+          host: vpc-test-domain-ke7thhzoo7jawsrhmm6mb7ite7y.us-west-2.es.amazonaws.com
+          port: 443
+          index: my_index
+          aws_auth: on
+          aws_region: us-west-2
+          tls: on
+          type: doc
+```
+
+{% endtab %}
+
+{% tab title="fluent-bit.conf" %}
+
+```text
 [OUTPUT]
     Name  es
     Match *
@@ -263,10 +389,13 @@ as seen on the last line:
     Type  doc
 ```
 
+{% endtab %}
+{% endtabs %}
+
 ### Validation failures
 
 In Fluent Bit v1.8.2 and greater, Fluent Bit started using `create` method (instead
-of `index`) for data submission. This makes Fluent Bit compatible with Datastream,
+of `index`) for data submission. This makes Fluent Bit compatible with `Datastream`,
 introduced in Elasticsearch 7.9. You might see errors like:
 
 ```text
@@ -277,19 +406,62 @@ If you see `action_request_validation_exception` errors on your pipeline with
 Fluent Bit versions greater than v1.8.2, correct them  by turning on `Generate_ID`
 as follows:
 
-```text copy
+% tabs %}
+{% tab title="fluent-bit.yaml" %}
+
+```yaml
+pipeline:
+    inputs:
+        ...
+          
+    outputs:
+        - name: es
+          match: '*'
+          host: 192.168.12.1
+          generate_id: on
+```
+
+{% endtab %}
+
+{% tab title="fluent-bit.conf" %}
+
+```text
 [OUTPUT]
     Name es
     Match *
     Host  192.168.12.1
     Generate_ID on
 ```
 
+{% endtab %}
+{% endtabs %}
+
 ### `Logstash_Prefix_Key`
 
 The following snippet demonstrates using the namespace name as extracted by the
 `kubernetes` filter as `logstash` prefix:
 
+% tabs %}
+{% tab title="fluent-bit.yaml" %}
+
+```yaml
+pipeline:
+    inputs:
+        ...
+          
+    outputs:
+        - name: es
+          match: '*'
+          # ...
+          logstash_prefix: logstash
+          logstash_prefix_key: $kubernetes['namespace_name'] 
+          # ...
+```
+
+{% endtab %}
+
+{% tab title="fluent-bit.conf" %}
+
 ```text
 [OUTPUT]
     Name es
@@ -300,5 +472,8 @@ The following snippet demonstrates using the namespace name as extracted by the
     # ...
 ```
 
+{% endtab %}
+{% endtabs %}
+
 For records that don't have the field `kubernetes.namespace_name`, the default prefix
-`logstash` will be used.
+`logstash` will be used.