Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GCP: improve integration docs #2842

Merged
merged 1 commit into from
Mar 23, 2022
Merged

GCP: improve integration docs #2842

merged 1 commit into from
Mar 23, 2022

Conversation

zmoog
Copy link
Contributor

@zmoog zmoog commented Mar 17, 2022 •
edited
Loading

What does this PR do?

Update README for the Google Cloud Platform (GCP) integration with new sections about how to configure authentication, integration settings, and how to start collecting logs creating a pub/sub topic, a subscription, and a sink.

The fields and events sample are included in both the README and the dedicated .md files, in preparation of making them visible on the main docs site https://docs.elastic.co/en/integrations/gcp.

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.

Related issues

Closes #2802

@elasticmachine
Copy link

elasticmachine commented Mar 17, 2022 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-03-23T16:26:37.263+0000

  • Duration: 18 min 48 sec

Test stats 🧪

Test Results
Failed 0
Passed 28
Skipped 0
Total 28

🤖 GitHub comments

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

  • /test : Re-trigger the build.

@zmoog zmoog force-pushed the zmoog/improve-gcp-docs branch 2 times, most recently from 7ea1e89 to 7b83236 Compare March 17, 2022 16:54
@zmoog zmoog marked this pull request as ready for review March 18, 2022 08:54
@zmoog zmoog requested review from a team as code owners March 18, 2022 08:54
@zmoog zmoog force-pushed the zmoog/improve-gcp-docs branch 2 times, most recently from b6c4337 to 41e2f8b Compare March 18, 2022 10:20
endorama pushed a commit that referenced this pull request Mar 18, 2022
@legoguy1000 @endorama
[GCP] Add GCP Billing Metricset (#2141)
de741ef 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842

Changes to  packages/gcp/data_stream/audit/manifest.yml has been removed
too.
endorama pushed a commit that referenced this pull request Mar 18, 2022
@legoguy1000 @endorama
[GCP] Add GCP Compute Metricset (#2301)
7ed83f9 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842
@elasticmachine
Copy link

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@andrewkroh andrewkroh added the Team:Cloud-Monitoring Label for the Cloud Monitoring team label Mar 18, 2022
efd6
efd6 reviewed Mar 21, 2022
View reviewed changes
packages/gcp/_dev/build/docs/README.md Outdated Show resolved Hide resolved
packages/gcp/_dev/build/docs/README.md Outdated Show resolved Hide resolved
@zmoog zmoog force-pushed the zmoog/improve-gcp-docs branch 4 times, most recently from 8e5c469 to 1f0d675 Compare March 21, 2022 14:20
ravikesarwani
ravikesarwani approved these changes Mar 21, 2022
View reviewed changes
Copy link

@ravikesarwani ravikesarwani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good from my side. Great Work!

endorama pushed a commit that referenced this pull request Mar 22, 2022
@legoguy1000 @endorama
[GCP] Add GCP Billing Metricset (#2141)
6a2d3f5 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842

Changes to  packages/gcp/data_stream/audit/manifest.yml has been removed
too.
endorama pushed a commit that referenced this pull request Mar 22, 2022
@legoguy1000 @endorama
[GCP] Add GCP Compute Metricset (#2301)
f248b18 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842
@zmoog
Copy link
Contributor Author

zmoog commented Mar 22, 2022

@efd6 do you think we're good to go or this PR needs some changes from the elastic/security-external-integrations perspective?

endorama pushed a commit that referenced this pull request Mar 22, 2022
@legoguy1000 @endorama
[GCP] Add GCP Billing Metricset (#2141)
e70e471 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842

Changes to  packages/gcp/data_stream/audit/manifest.yml has been removed
too.
endorama pushed a commit that referenced this pull request Mar 22, 2022
@legoguy1000 @endorama
[GCP] Add GCP Compute Metricset (#2301)
376a5e9 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842
@zmoog
GCP: improve integration docs
0a321f5 
Update README with new sections about how to configure authentication,
integration settings, and how to start collecting logs creating a pub/sub topic,
a subscription and a sink.

The fields and events sample are included in both the README and the
dedicated `.md` files, in preparation of making them visible on the main
docs site https://docs.elastic.co/en/integrations/gcp.
@ravikesarwani
Copy link

@zmoog My suggestion would be to get this merged and promoted to production. My take would be any additional changes can be taken up as incremental work based on users feedback with a separate issue and PR. Thanks!

@zmoog
Copy link
Contributor Author

zmoog commented Mar 23, 2022

@ravikesarwani sounds good, let's make it so.

@zmoog zmoog merged commit 0786c82 into main Mar 23, 2022
@zmoog zmoog deleted the zmoog/improve-gcp-docs branch March 23, 2022 17:28
@ravikesarwani
Copy link

I know there's also a Kibana dependency that we have to specify. Since this is basically a doc and minor changes I would like to see us support as older version of 7.x as possible along with 8.0+. This way more customers can see this and benefit by it.

@zmoog
Copy link
Contributor Author

zmoog commented Mar 24, 2022

@ravikesarwani the current Kibana dependency constraint is set as follow:

conditions:
  kibana.version: ^7.16.3 || ^8.0.0

It was set by Andrew Kroh a few months ago: do you think we need to change it?

@ravikesarwani
Copy link

ravikesarwani commented Mar 28, 2022 •
edited
Loading

No, this is fine.

eyalkraft pushed a commit to build-security/integrations that referenced this pull request Mar 30, 2022
@zmoog
GCP: improve integration docs (elastic#2842)
d189baf 
Update README with new sections about how to configure authentication,
integration settings, and how to start collecting logs creating a pub/sub topic,
a subscription and a sink.

The fields and events sample are included in both the README and the
dedicated `.md` files, in preparation of making them visible on the main
docs site https://docs.elastic.co/en/integrations/gcp.
endorama pushed a commit that referenced this pull request Apr 5, 2022
@legoguy1000 @endorama
[GCP] Add GCP Billing Metricset (#2141)
9718549 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842

Changes to  packages/gcp/data_stream/audit/manifest.yml has been removed
too.
endorama pushed a commit that referenced this pull request Apr 5, 2022
@legoguy1000 @endorama
[GCP] Add GCP Compute Metricset (#2301)
330797b 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842
endorama pushed a commit that referenced this pull request Jun 9, 2022
@legoguy1000 @endorama
[GCP] Add GCP Billing Metricset (#2141)
87bc0ca 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842

Changes to  packages/gcp/data_stream/audit/manifest.yml has been removed
too.
endorama pushed a commit that referenced this pull request Jun 9, 2022
@legoguy1000 @endorama
[GCP] Add GCP Compute Metricset (#2301)
8947679 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842
endorama pushed a commit that referenced this pull request Jul 12, 2022
@legoguy1000 @endorama
[GCP] Add GCP Billing Metricset (#2141)
25c29cd 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842

Changes to  packages/gcp/data_stream/audit/manifest.yml has been removed
too.
endorama pushed a commit that referenced this pull request Jul 12, 2022
@legoguy1000 @endorama
[GCP] Add GCP Compute Metricset (#2301)
fa41120 
This commit has been changed to remove changes to README included in
 #2141 to allow documentation changes from #2842
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kaiyan-sheng kaiyan-sheng kaiyan-sheng left review comments

@efd6 efd6 efd6 left review comments

@ravikesarwani ravikesarwani ravikesarwani approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request Integration:GCP Team:Cloud-Monitoring Label for the Cloud Monitoring team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve Google Cloud Platform (GCP) Agent integration doc
6 participants
@zmoog @elasticmachine @ravikesarwani @kaiyan-sheng @efd6 @andrewkroh