[Documentation] Add reference to ESF terraform #730
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: constanca <[email protected]>
Signed-off-by: constanca <[email protected]>
constanca-m
commented
Jun 13, 2024
| @@ -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]. | |||
There was a problem hiding this comment.
I am removing this because it does not read right. There are other forms to get logs in S3.
constanca-m
commented
Jun 13, 2024
| @@ -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. | |||
There was a problem hiding this comment.
Adding this warning. See related issue: #721.
constanca-m
commented
Jun 13, 2024
| [[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. |
There was a problem hiding this comment.
I am leaving this section purposely short. There is documentation in the README file and I want to avoid having to maintain two different documents for the same thing.
In the future, I would suggest creating a tutorial documentation on how to get logs similarly to ESF tutorial.
bturquet
reviewed
Jun 13, 2024
| @@ -303,7 +311,7 @@ There are several deployment methods available via the {aws} Serverless Applicat | |||
|
|
|||
| * <<aws-serverless-forwarder-deploy-console>> | |||
| * <<aws-serverless-forwarder-deploy-cloudformation>> | |||
| * <<aws-serverless-forwarder-deploy-terraform>> | |||
| * <<aws-serverless-forwarder-deploy-sar-terraform>> | |||
There was a problem hiding this comment.
@constanca-m Double checking that this renaming has been done to avoid confusion with the "real" Terraform option we are adding ?
There was a problem hiding this comment.
Yes, but mainly because build_docs fails with two IDs that are the same:
INFO:build_docs:
INFO:build_docs:asciidoctor: WARNING: aws-deploy-elastic-serverless-forwarder.asciidoc: line 401: id assigned to block already in use: aws-serverless-forwarder-deploy-terraform
Co-authored-by: Andrew Wilkins <[email protected]>
axw
approved these changes
Jun 16, 2024
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WARNING: Do not merge before ESF terraform is public.
What does this PR do?
We need to add a reference to ESF terraform repository for it to go public.
How to test this PR locally
To see the documents, run the command from elastic docs for a local repo:
Related issues
Relates to elastic/terraform-elastic-esf#8.