Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ docker-clean: ## Try to remove provisioned nodes and assigned network

.PHONY: docs-generate
docs-generate: tools ## Generate documentation for the provider
@ go tool github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name elasticstack
@ go tool github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name terraform-provider-elasticstack


.PHONY: gen
Expand Down
10 changes: 6 additions & 4 deletions docs/data-sources/elasticsearch_enrich_policy.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@

---
subcategory: "Enrich"
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_enrich_policy Data Source - terraform-provider-elasticstack"
subcategory: "Enrich"
description: |-
Returns information about an enrich policy. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html
Returns information about an enrich policy. See the enrich policy API documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html for more details.
---

# Data Source: elasticstack_elasticsearch_enrich_policy
# elasticstack_elasticsearch_enrich_policy (Data Source)

Returns information about an enrich policy. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html
Returns information about an enrich policy. See the [enrich policy API documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html) for more details.

## Example Usage

Expand Down
11 changes: 6 additions & 5 deletions docs/data-sources/elasticsearch_index_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_index_template Data Source - terraform-provider-elasticstack"
subcategory: "Index"
layout: ""
page_title: "Elasticstack: elasticstack_elasticsearch_index_template Data Source"
description: |-
Retrieves index template.
Retrieves information about an existing index template definition. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html
---

# Data Source: elasticstack_elasticsearch_index_template
# elasticstack_elasticsearch_index_template (Data Source)

Use this data source to retrieve information about existing Elasticsearch index templates. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html
Retrieves information about an existing index template definition. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html

## Example Usage

Expand Down
11 changes: 6 additions & 5 deletions docs/data-sources/elasticsearch_indices.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_indices Data Source - terraform-provider-elasticstack"
subcategory: "Index"
layout: ""
page_title: "Elasticstack: elasticstack_elasticsearch_indices Data Source"
description: |-
Retrieves indices.
Retrieves information about existing Elasticsearch indices. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
---

# Data Source: elasticstack_elasticsearch_indices
# elasticstack_elasticsearch_indices (Data Source)

Use this data source to retrieve and get information about existing Elasticsearch indices. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
Retrieves information about existing Elasticsearch indices. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html

## Example Usage

Expand Down
13 changes: 7 additions & 6 deletions docs/data-sources/elasticsearch_info.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@

---
subcategory: "Cluster"
layout: ""
page_title: "Elasticstack: elasticstack_elasticsearch_info Data Source"
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_info Data Source - terraform-provider-elasticstack"
subcategory: "Elasticsearch"
description: |-
Gets information about the Elasticsearch cluster.
Gets information about the Elastic cluster.
---

# Data Source: elasticstack_elasticsearch_info
# elasticstack_elasticsearch_info (Data Source)

This data source provides the information about the configured Elasticsearch cluster
Gets information about the Elastic cluster.

## Example Usage

Expand Down
15 changes: 6 additions & 9 deletions docs/data-sources/elasticsearch_ingest_processor_append.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_ingest_processor_append Data Source - terraform-provider-elasticstack"
subcategory: "Ingest"
layout: ""
page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_append Data Source"
description: |-
Helper data source to create a processor which appends one or more values to an existing array if the field already exists and it is an array.
Helper data source which can be used to create the configuration for an append processor. This processor appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. See the append processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html for more details.
---

# Data Source: elasticstack_elasticsearch_ingest_processor_append

Helper data source to which can be used to create a processor to append one or more values to an existing array if the field already exists and it is an array.
Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist.
# elasticstack_elasticsearch_ingest_processor_append (Data Source)

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html
Helper data source which can be used to create the configuration for an append processor. This processor appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. See the [append processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html) for more details.

## Example Usage

Expand Down Expand Up @@ -56,4 +54,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {

- `id` (String) Internal identifier of the resource
- `json` (String) JSON representation of this data source.

18 changes: 10 additions & 8 deletions docs/data-sources/elasticsearch_ingest_processor_bytes.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_ingest_processor_bytes Data Source - terraform-provider-elasticstack"
subcategory: "Ingest"
layout: ""
page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_bytes Data Source"
description: |-
Helper data source to create a processor which converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024).
Helper data source which can be used to create the configuration for a bytes processor. The processor converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). See the bytes processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html for more details.
If the field is an array of strings, all members of the array will be converted.
Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.
---

# Data Source: elasticstack_elasticsearch_ingest_processor_bytes
# elasticstack_elasticsearch_ingest_processor_bytes (Data Source)

Helper data source to which can be used to create a processor to convert a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). If the field is an array of strings, all members of the array will be converted.
Helper data source which can be used to create the configuration for a bytes processor. The processor converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). See the [bytes processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html) for more details.

Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.
If the field is an array of strings, all members of the array will be converted.

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html
Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.

## Example Usage

Expand Down Expand Up @@ -55,4 +58,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {

- `id` (String) Internal identifier of the resource
- `json` (String) JSON representation of this data source.

14 changes: 6 additions & 8 deletions docs/data-sources/elasticsearch_ingest_processor_circle.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_ingest_processor_circle Data Source - terraform-provider-elasticstack"
subcategory: "Ingest"
layout: ""
page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_circle Data Source"
description: |-
Helper data source to create a processor which converts circle definitions of shapes to regular polygons which approximate them.
Helper data source which can be used to create the configuration for an circle processor. This processor converts circle definitions of shapes to regular polygons which approximate them. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html
---

# Data Source: elasticstack_elasticsearch_ingest_processor_circle

Helper data source to which can be used to create a processor to convert circle definitions of shapes to regular polygons which approximate them.
# elasticstack_elasticsearch_ingest_processor_circle (Data Source)

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html
Helper data source which can be used to create the configuration for an circle processor. This processor converts circle definitions of shapes to regular polygons which approximate them. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html

## Example Usage

Expand Down Expand Up @@ -57,4 +56,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {

- `id` (String) Internal identifier of the resource
- `json` (String) JSON representation of this data source.

16 changes: 8 additions & 8 deletions docs/data-sources/elasticsearch_ingest_processor_community_id.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_ingest_processor_community_id Data Source - terraform-provider-elasticstack"
subcategory: "Ingest"
layout: ""
page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_community_id Data Source"
description: |-
Helper data source to create a processor which computes the Community ID for network flow data as defined in the Community ID Specification.
Helper data source which can be used to create the configuration for a community ID processor. This processor computes the Community ID for network flow data as defined in the Community ID Specification. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html
You can use a community ID to correlate network events related to a single flow.
The community ID processor reads network flow data from related Elastic Common Schema (ECS) https://www.elastic.co/guide/en/ecs/1.12 fields by default. If you use the ECS, no configuration is required.
---

# Data Source: elasticstack_elasticsearch_ingest_processor_community_id
# elasticstack_elasticsearch_ingest_processor_community_id (Data Source)

Helper data source to which can be used to create a processor to compute the Community ID for network flow data as defined in the [Community ID Specification](https://github.com/corelight/community-id-spec).
Helper data source which can be used to create the configuration for a community ID processor. This processor computes the Community ID for network flow data as defined in the Community ID Specification. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html
You can use a community ID to correlate network events related to a single flow.

The community ID processor reads network flow data from related [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/1.12) fields by default. If you use the ECS, no configuration is required.

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html

## Example Usage

```terraform
Expand Down Expand Up @@ -59,4 +60,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {

- `id` (String) Internal identifier of the resource
- `json` (String) JSON representation of this data source.

31 changes: 21 additions & 10 deletions docs/data-sources/elasticsearch_ingest_processor_convert.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,37 @@

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "elasticstack_elasticsearch_ingest_processor_convert Data Source - terraform-provider-elasticstack"
subcategory: "Ingest"
layout: ""
page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_convert Data Source"
description: |-
Helper data source to create a processor which converts a field in the currently ingested document to a different type, such as converting a string to an integer.
Helper data source which can be used to create the configuration for a convert processor. This processor converts a field in the currently ingested document to a different type, such as converting a string to an integer. See the convert processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html for more details.
The supported types include:
integerlongfloatdoublestringbooleanipauto
Specifying boolean will set the field to true if its string value is equal to true (ignoring case), to false if its string value is equal to false (ignoring case), or it will throw an exception otherwise.
Specifying ip will set the target field to the value of field if it contains a valid IPv4 or IPv6 address that can be indexed into an IP field type.
Specifying auto will attempt to convert the string-valued field into the closest non-string, non-IP type. For example, a field whose value is "true" will be converted to its respective boolean type: true. Do note that float takes precedence of double in auto. A value of "242.15" will "automatically" be converted to 242.15 of type float. If a provided field cannot be appropriately converted, the processor will still process successfully and leave the field value as-is. In such a case, target_field will be updated with the unconverted field value.
---

# Data Source: elasticstack_elasticsearch_ingest_processor_convert
# elasticstack_elasticsearch_ingest_processor_convert (Data Source)

Helper data source to which can be used to convert a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted.
Helper data source which can be used to create the configuration for a convert processor. This processor converts a field in the currently ingested document to a different type, such as converting a string to an integer. See the [convert processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html) for more details.

The supported types include: `integer`, `long`, `float`, `double`, `string`, `boolean`, `ip`, and `auto`.
The supported types include:
- `integer`
- `long`
- `float`
- `double`
- `string`
- `boolean`
- `ip`
- `auto`

Specifying `boolean` will set the field to true if its string value is equal to true (ignore case), to false if its string value is equal to false (ignore case), or it will throw an exception otherwise.
Specifying `boolean` will set the field to true if its string value is equal to true (ignoring case), to false if its string value is equal to false (ignoring case), or it will throw an exception otherwise.

Specifying `ip` will set the target field to the value of `field` if it contains a valid IPv4 or IPv6 address that can be indexed into an IP field type.

Specifying `auto` will attempt to convert the string-valued `field` into the closest non-string, non-IP type. For example, a field whose value is "true" will be converted to its respective boolean type: true. Do note that float takes precedence of double in auto. A value of "242.15" will "automatically" be converted to 242.15 of type `float`. If a provided field cannot be appropriately converted, the processor will still process successfully and leave the field value as-is. In such a case, `target_field` will be updated with the unconverted field value.

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html

## Example Usage

```terraform
Expand Down Expand Up @@ -64,4 +76,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {

- `id` (String) Internal identifier of the resource
- `json` (String) JSON representation of this data source.

Loading