Update EBS- first draft of AWS integration edits by ellis-elastic · Pull Request #3634 · elastic/integrations

ellis-elastic · 2022-06-30T14:21:20Z

What does this PR do?

In #3308 we updated docs for two AWS integrations to align with the new documentation guidelines and establish the relationship between the AWS integration/package ("AWS") and integrations for individual AWS services (for example, "AWS CloudFront").

Now we should update the docs for all AWS integrations for individual services to follow the same format as the updated "AWS CloudFront" integration docs.

This PR adds more context the AWS integration including:

Adds context to the "Overview" including a link to the relevant AWS page and an example
Lists the types of "Data streams" for the service
"Requirements" points back to "AWS" for detailed information on credentials and permissions
"Requirements" includes any other service-specific requirements
"Setup" establishes a relationship between the AWS integration/package ("AWS") and this integration
Includes "Reference" sections

For the reviewer

Checklist

I have reviewed tips for building integrations and this pull request is aligned with them.
I have verified that all data streams collect metrics or logs.
I have added an entry to my package's changelog.yml file.
I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

Review by docs team
Review by integrations team

Related issues

Update integration docs for individual AWS/Amazon services #3572

Added new content based on the new documentation guidelines.

elasticmachine · 2022-06-30T14:31:42Z

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-07-07T10:04:34.397+0000
Duration: 10 min 18 sec

Steps errors

Expand to view the steps failures

`Check integration: aws`

Took 0 min 3 sec . View more details here
Description: ../../build/elastic-package check -v

`Google Storage Download`

Took 0 min 0 sec . View more details here

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.

packages/aws/_dev/build/docs/ebs.md

colleenmcginnis · 2022-07-06T19:00:26Z

packages/aws/_dev/build/docs/ebs.md

+The Amazon EBS integration allows you to monitor [Amazon Elastic Block Store (EBS)](https://aws.amazon.com/ebs/). Amazon EBS is a block-storage service designed for Amazon Elastic Compute Cloud (Amazon EC2).
+Use the Amazon EBS integration to collect metrics related to your Amazon EBS storage.
+Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference metrics when troubleshooting an issue.
+For example, you could use this data to view the total number of seconds spent by all write operations that completed in a specified period of time for an EBS volume. Then you can alert the relevant budget holder about that throughput data by email.


I'm curious what the product thinks of this example.

++ We should probably have product and engineering review all of the examples once all PRs have been opened.

packages/aws/_dev/build/docs/ebs.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

elasticmachine · 2022-07-29T18:20:33Z

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-07-29T18:09:36.917+0000
Duration: 11 min 43 sec

Steps errors

Expand to view the steps failures

`Check integration: aws`

Took 0 min 3 sec . View more details here
Description: ../../build/elastic-package check -v

`Google Storage Download`

Took 0 min 0 sec . View more details here

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.

* Update Readme - First draft of AWS integration edits (#3834) Added new content based on the new documentation guidelines * Update WAF - First draft of AWS integration edits (#3833) Added new content based on the new documentation guidelines. * Update VPN.MD First draft of AWS integration edits (#3828) * Update VPN.MD First draft of AWS integration edits Added new content based on the new documentation guidelines. * fixed typo Removed space and duplicated for example * Update vpcflow,md First draft of AWS integration edits (#3826) Added new content based on the new documentation guidelines. * Update AWS Usage - First draft of AWS integration edits (#3824) * Update AWS Usage - First draft of AWS integration edits Added new content based on the new documentation guidelines. * Fixed typo removed a space * Update AWS transit gateway - first draft of AWS integration edits (#3810) added new content based on the new documentation guidelines. * Update SQS First draft of AWS integration edits (#3809) Added new content based on the new documentation guidelines. * Update SNS - First draft of AWS integration edits (#3808) * Update S3 storage lens- First draft of AWS integration edits (#3806) * update S3 - first draft of AWS integration edits (#3804) Added new content based on the new doc guidelines * Update Route 53 - First draft of AWS integration edits (#3756) * update Route 53 - first draft of AWS integration edits Added new content based on the new documentation guidelines * Fixed typo Added missing full stop * Update RDS - first draft of AWS integration edits (#3752) Added new content based on the new documentation guidelines * Update Nat gateway - first draft of AWS integration edits (#3751) Added new content based on the new documentation guidelines * Update Lambda - first draft of AWS integration edits (#3749) * update Lambda - first draft of AWS integration edits Added new content based on the new documentation guidelines * Fix typos in Lambda.md * Update Network Firewall - added new content based on the new doc guidelines (#3732) * Update Network Firewall - added new content based on the new documentation guidelines. * Update Manifest and Changelog * Ran build * revert cl/mani Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update ELB - first draft of AWS integration edits (#3656) * Update ELB - first draft of AWS integration edits Added new content based on the new documentation guidelines. * update changelog and manifest * update elb ran build * revert cl/mani Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update EC2 - first draft of AWS integration edits (#3638) * Update EC2 - first draft of AWS integration edits Added new content based on the new documentation guidelines. * Update Changelog and Manifest * update ec2.md ran build * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * revert cl/mani Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update EBS- first draft of AWS integration edits (#3634) * Update EBS- first draft of AWS integration edits Added new content based on the new documentation guidelines. * Update Changelog and Manifest * Ran elastic-pacakge build * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * revert cl/mani Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update DynamoDB- first draft of AWS integration edits (#3633) * Update Dynamodb - first draft of aws integration edits Added new content based on the new documentation guidelines. * Update Changelog and Manifest * Ran build, updated changelog and manifest * Update packages/aws/_dev/build/docs/dynamodb.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Update dynamoDB Re worded the example para in light of reviewers comments * Ran elastic package build * revert cl/mani Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update CloudTrail - First draft of AWS integration edits (#3611) * Update CloudTrail - first draft of aws integration edits Added new content based on the new documentation guidelines. * Update CouldTrail - fixed typo Changed Cloudtrail to CloudTrail * Update Changelog and manifest * Ran Build * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Updated note section Updated note section in light on Coleen's comments * Re ran build * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * revert cl/mani Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update Billing.md (#3584) * update Billing.md added new content based on the new documentation guidelines. * Update Changelog, manifest and ran build * Revert "Update Changelog, manifest and ran build" This reverts commit c0fda79. * Update changelog and manifest * Update Billing.md * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Revert "Update Billing.md" This reverts commit 3868827. * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * update billing added details on the metrics collected * update billing ran build * fix changelog formatting * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Update packages/aws/docs/billing.md Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co> * Update Billing.md Removed overview heading * Update changelog and ran build * Update Billing Fixed duplicated word * revert cl/mani Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * get it passing ci * update docs * Revert "Update Readme - First draft of AWS integration edits (#3834)" This reverts commit 76eaca3. * Update packages/aws/_dev/build/docs/natgateway.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/vpcflow.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/vpcflow.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/waf.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/vpcflow.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/s3.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/rds.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/elb.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Apply suggestions from code review * Update packages/aws/_dev/build/docs/ebs.md * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * feedback * feedback * Apply suggestions from code review Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * feedback * `elastic-package build` * Update packages/aws/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * `elastic-package build` * docs: address feedback * `elastic-package build` * address more feedback * more feedback * address feedback Co-authored-by: Ellis Pratt <103435263+ellis-elastic@users.noreply.github.com> Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co> Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

Update EBS- first draft of AWS integration edits

405c945

Added new content based on the new documentation guidelines.

ellis-elastic added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Team:Docs Label for the Observability docs team labels Jun 30, 2022

ellis-elastic requested a review from a team as a code owner June 30, 2022 14:21

ellis-elastic added 2 commits June 30, 2022 15:23

Update Changelog and Manifest

0b308f9

Ran elastic-pacakge build

e44ec57

ellis-elastic mentioned this pull request Jun 30, 2022

Update integration docs for individual AWS/Amazon services #3572

Closed

24 tasks

ellis-elastic assigned colleenmcginnis Jun 30, 2022

colleenmcginnis self-requested a review July 6, 2022 18:22

colleenmcginnis reviewed Jul 6, 2022

View reviewed changes

ellis-elastic and others added 7 commits July 7, 2022 11:02

Update packages/aws/_dev/build/docs/ebs.md

c2bbdbc

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/ebs.md

0615799

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/ebs.md

cde3e5c

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/ebs.md

7aaa01f

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/ebs.md

bbe1f78

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/ebs.md

e844b31

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/ebs.md

a406068

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

bmorelli25 marked this pull request as draft July 7, 2022 20:21

bmorelli25 changed the base branch from main to aws-doc-updates July 29, 2022 18:01

bmorelli25 added 2 commits July 29, 2022 11:09

revert cl/mani

8ef1df4

Merge branch 'main' of github.com:elastic/integrations into EBS-Docs

23c1918

bmorelli25 marked this pull request as ready for review July 29, 2022 18:14

bmorelli25 merged commit 0a62d3a into elastic:aws-doc-updates Jul 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update EBS- first draft of AWS integration edits#3634

Update EBS- first draft of AWS integration edits#3634
bmorelli25 merged 12 commits intoelastic:aws-doc-updatesfrom
ellis-elastic:EBS-Docs

ellis-elastic commented Jun 30, 2022 •

edited

Loading

Uh oh!

elasticmachine commented Jun 30, 2022 •

edited

Loading

Build stats

`Check integration: aws`

`Google Storage Download`

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

colleenmcginnis Jul 6, 2022

Uh oh!

bmorelli25 Jul 7, 2022

Uh oh!

Uh oh!

elasticmachine commented Jul 29, 2022

Build stats

`Check integration: aws`

`Google Storage Download`

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

ellis-elastic commented Jun 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

For the reviewer

Checklist

Author's Checklist

Related issues

Uh oh!

elasticmachine commented Jun 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Build stats

Steps errors

Check integration: aws

Google Storage Download

🤖 GitHub comments

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

colleenmcginnis Jul 6, 2022

Choose a reason for hiding this comment

Uh oh!

bmorelli25 Jul 7, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

elasticmachine commented Jul 29, 2022

💔 Build Failed

Build stats

Steps errors

Check integration: aws

Google Storage Download

🤖 GitHub comments

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ellis-elastic commented Jun 30, 2022 •

edited

Loading

elasticmachine commented Jun 30, 2022 •

edited

Loading

`Check integration: aws`

`Google Storage Download`

`Check integration: aws`

`Google Storage Download`