From 2cbffd19bc25f6743242d8598bd7487a0be450ef Mon Sep 17 00:00:00 2001 From: constanca Date: Thu, 13 Jun 2024 11:24:54 +0200 Subject: [PATCH 1/3] Add terraform docs Signed-off-by: constanca --- ...ws-deploy-elastic-serverless-forwarder.asciidoc | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc b/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc index 7fda4e69..b2c16bc2 100644 --- a/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc +++ b/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc @@ -19,8 +19,7 @@ To deploy Elastic Serverless Forwarder, you have to: [discrete] [[aws-serverless-forwarder-deploy-prereq]] == Prerequisites -This documentation assumes you have some familiarity with {aws} services and you have correctly created and configured the necessary {aws} objects. For example, if you want to use an Amazon S3 (via SQS event notifications) input then you must ensure that you have enabled AWS VPC flow logs to be sent to that bucket, and created an SQS queue to receive those logs. For more information, refer to the relevant https://docs.aws.amazon.com/[{aws} docs]. - +This documentation assumes you have some familiarity with {aws} services, and you have correctly created and configured the necessary {aws} objects. // Need more details on pre-reqs for other input types NOTE: This page describes the basic steps required to deploy Elastic Serverless @@ -180,6 +179,8 @@ inputs: ssl_assert_fingerprint: "22:F7:FB:84:1D:43:3E:E7:BB:F9:72:F3:D8:97:AD:7C:86:E3:08:42" #optional ---- +WARNING: All versions up to 1.14.0 (included) only allow one output per type. So if the `output.type` chosen by a user is `elasticsearch`, then the user can only configure one output for it. + [discrete] [[s3-config-file-fields]] === Fields @@ -210,7 +211,7 @@ The type of the forwarding target output. Currently only the following outputs a * `elasticsearch` * preview:[] `logstash` -If {ls} is chosen as an output, Elastic Serverless Forwarder expects the {logstash-ref}/plugins-inputs-elastic_serverless_forwarder.html[`elastic_serverless_forwarder`] Logstash input to be installed, enabled, and properly configured. For more information about installing Logstash plugins, refer to the {logstash-ref}/working-with-plugins.html#installing-plugins[Logstash documentation]. +Each type can only be used for a maximum of one output up to and including 1.14.0 version. If {ls} is chosen as an output, Elastic Serverless Forwarder expects the {logstash-ref}/plugins-inputs-elastic_serverless_forwarder.html[`elastic_serverless_forwarder`] Logstash input to be installed, enabled, and properly configured. For more information about installing Logstash plugins, refer to the {logstash-ref}/working-with-plugins.html#installing-plugins[Logstash documentation]. `inputs.[].outputs.[].args`: Custom init arguments for the specified forwarding target output. @@ -295,6 +296,13 @@ If the Elastic Serverless Forwarder is attached to a VPC, you need to https://do NOTE: Refer to the {cloud}/ec-traffic-filtering-vpc.html[AWS PrivateLink traffic filters] documentation to find your VPC endpoint ID and the hostname to use in the `config.yml` in order to access your Elasticsearch cluster over PrivateLink. +[discrete] +[[aws-serverless-forwarder-deploy-terraform]] +== Deploy Elastic Serverless Forwarder from Terraform + +The terraform files to deploy ESF can be found in https://github.com/elastic/terraform-elastic-esf[`esf-terraform` repository]. There are two requirements to deploy these files: https://curl.se/download.html[curl] and https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli[terraform]. Refer to the https://github.com/elastic/terraform-elastic-esf/blob/main/README.md[README file] to learn how to use it. + + [discrete] [[aws-serverless-forwarder-deploy-sar]] == Deploy Elastic Serverless Forwarder from SAR From c67fe6e76c9d299f2b5117c0e859330221ef0e70 Mon Sep 17 00:00:00 2001 From: constanca Date: Thu, 13 Jun 2024 11:27:21 +0200 Subject: [PATCH 2/3] Add docs. Signed-off-by: constanca --- docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc b/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc index b2c16bc2..28bca74e 100644 --- a/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc +++ b/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc @@ -311,7 +311,7 @@ There are several deployment methods available via the {aws} Serverless Applicat * <> * <> -* <> +* <> NOTE: To deploy the forwarder directly without using SAR, refer to <> @@ -397,8 +397,8 @@ aws serverlessrepo list-application-versions --application-id arn:aws:serverless NOTE: Starting from **v1.4.0**, if you want to update the Events settings for the forwarder, you do not need to manually delete existing settings before applying new settings. [discrete] -[[aws-serverless-forwarder-deploy-terraform]] -=== Deploy using Terraform +[[aws-serverless-forwarder-deploy-sar-terraform]] +=== Deploy the SAR using Terraform . Save the following yaml content as `sar-application.tf` and fill in the correct parameters according to <>: + From f03a2a26e8d36559ed6b33216d4e6bcf927cc0fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Constan=C3=A7a=20Manteigas?= <113898685+constanca-m@users.noreply.github.com> Date: Thu, 13 Jun 2024 11:55:04 +0200 Subject: [PATCH 3/3] Update docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc Co-authored-by: Andrew Wilkins --- docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc b/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc index 28bca74e..f34e2364 100644 --- a/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc +++ b/docs/en/aws-deploy-elastic-serverless-forwarder.asciidoc @@ -398,7 +398,7 @@ NOTE: Starting from **v1.4.0**, if you want to update the Events settings for th [discrete] [[aws-serverless-forwarder-deploy-sar-terraform]] -=== Deploy the SAR using Terraform +=== Deploy from SAR using Terraform . Save the following yaml content as `sar-application.tf` and fill in the correct parameters according to <>: +