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.

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

[8.0](backport #30579) Remove references to gcp from the Functionbeat docs #30608

Merged
merged 1 commit into from
Feb 28, 2022
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
10 changes: 4 additions & 6 deletions x-pack/functionbeat/docs/deploying.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ when you don't have your own deployment infrastructure or process in place.
During deployment, the {beatname_uc} manager:

* Exports a function template to use for deployment. For AWS, it exports an
{cloudformation-ref} template. For Google Cloud, it exports a YAML configuration
file. To inspect the template, run the <<export-command,`export`>> command.
{cloudformation-ref} template. To inspect the template, run the
<<export-command,`export`>> command.
* Creates a zip package that includes the function code and +{beatname_lc}.yml+
config file.
* Uploads the package to the specified cloud provider.
Expand Down Expand Up @@ -103,13 +103,11 @@ same path as the configured +{beatname_lc}.yml+ file.
----------------------------------------------------------------------
+
{beatname_uc} writes the template to stdout. For AWS functions, it writes an
{cloudformation-ref} tempalte. For Google Cloud, it writes a YAML configuration
file.
{cloudformation-ref} template.

. Modify the template to work with your infrastructure.

. Deploy the package, using the infrastructure and automation supported by your
cloud provider, for example, {cloudformation-ref} or
https://cloud.google.com/deployment-manager[Google Cloud Deployment manager].
cloud provider, for example, {cloudformation-ref}.
+
For more information about deployment, see your cloud provider's documentation.
20 changes: 8 additions & 12 deletions x-pack/functionbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,14 @@ details about the cloud functions that you want to deploy, including the
function name and type, and the triggers that will cause the function to
execute.

. In +{beatname_lc}.yml+, configure the functions that you want to deploy. The
In +{beatname_lc}.yml+, configure the functions that you want to deploy. The
configuration settings vary depending on the type of function and cloud provider
you're using. This section provides a couple of example configurations.
+
--
* *AWS example*: This example configures a function called `cloudwatch` that
collects events from CloudWatch Logs. When a message is sent to the specified
log group, the cloud function executes and sends message events to the
configured output:
+
you're using. This section provides a an AWS example configuration.

This example configures a function called `cloudwatch` that collects events from
CloudWatch Logs. When a message is sent to the specified log group, the cloud
function executes and sends message events to the configured output:

["source","sh",subs="attributes"]
-------------------------------------------------------------------------------------
{beatname_lc}.provider.aws.endpoint: "s3.amazonaws.com"
Expand All @@ -72,10 +70,8 @@ uploaded.
<2> Details about the function you want to deploy, including the name of the
function, the type of service to monitor, and the log groups that trigger the
function.
+
See <<configuration-{beatname_lc}-options>> for more examples.

--
See <<configuration-{beatname_lc}-options>> for more examples.

include::{libbeat-dir}/shared/config-check.asciidoc[]

Expand Down
5 changes: 1 addition & 4 deletions x-pack/functionbeat/docs/iam-permissions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@
++++

This section describes the minimum privileges or roles required to deploy
functions to your cloud provider:

* <<iam-permissions-aws>>

functions to your cloud provider.

[[iam-permissions-aws]]
==== Permissions required by AWS
Expand Down
12 changes: 7 additions & 5 deletions x-pack/functionbeat/docs/overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,12 @@
deploy as a function in your serverless environment to collect data from cloud
services and ship it to the {stack}.

Version {version} supports deploying {beatname_uc} as an AWS Lambda service or
Google Cloud Function. It responds to triggers defined for the following event
sources:
Version {version} supports deploying {beatname_uc} as an AWS Lambda service. It
responds to triggers defined for the following event sources:

* https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html[Amazon CloudWatch Logs]
* https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html[Amazon Simple Queue Service (SQS)]
* https://docs.aws.amazon.com/kinesis/latest/APIReference/Welcome.html[Amazon Kinesis]
* https://cloud.google.com/pubsub[Google Cloud Pub/Sub]
* https://cloud.google.com/storage[Google Cloud Storage]

image::./images/diagram-functionbeat-architecture.svg["{beatname_uc} collects events generated by cloud services"]

Expand All @@ -25,6 +22,11 @@ The following sections explore some common use cases for {beatname_uc}:
* <<monitor-cloud-deployments>>
* <<event-drive-processing>>

*Want to ship logs from Google Cloud?* Use our Google Cloud Dataflow templates
to ship Google Pub/Sub and Google Cloud Storage logs directly from the Google
Cloud Console. To learn more, refer to
{observability-guide}/gcp-dataflow.html[GCP Dataflow templates].

[float]
[[monitor-cloud-deployments]]
=== Monitor cloud deployments
Expand Down

This file was deleted.

19 changes: 0 additions & 19 deletions x-pack/functionbeat/docs/tab-widgets/credentials-google.asciidoc

This file was deleted.

58 changes: 0 additions & 58 deletions x-pack/functionbeat/docs/tab-widgets/deploy-google-widget.asciidoc

This file was deleted.

19 changes: 0 additions & 19 deletions x-pack/functionbeat/docs/tab-widgets/deploy-google.asciidoc

This file was deleted.