diff --git a/x-pack/functionbeat/docs/deploying.asciidoc b/x-pack/functionbeat/docs/deploying.asciidoc index ac0a40234c5..5cfe9d98982 100644 --- a/x-pack/functionbeat/docs/deploying.asciidoc +++ b/x-pack/functionbeat/docs/deploying.asciidoc @@ -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 <> command. +{cloudformation-ref} template. To inspect the template, run the +<> command. * Creates a zip package that includes the function code and +{beatname_lc}.yml+ config file. * Uploads the package to the specified cloud provider. @@ -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. diff --git a/x-pack/functionbeat/docs/getting-started.asciidoc b/x-pack/functionbeat/docs/getting-started.asciidoc index ff5700cf71d..01a5315fb22 100644 --- a/x-pack/functionbeat/docs/getting-started.asciidoc +++ b/x-pack/functionbeat/docs/getting-started.asciidoc @@ -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" @@ -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 <> for more examples. --- +See <> for more examples. include::{libbeat-dir}/shared/config-check.asciidoc[] diff --git a/x-pack/functionbeat/docs/iam-permissions.asciidoc b/x-pack/functionbeat/docs/iam-permissions.asciidoc index 293174071a8..606f3c79239 100644 --- a/x-pack/functionbeat/docs/iam-permissions.asciidoc +++ b/x-pack/functionbeat/docs/iam-permissions.asciidoc @@ -7,10 +7,7 @@ ++++ This section describes the minimum privileges or roles required to deploy -functions to your cloud provider: - -* <> - +functions to your cloud provider. [[iam-permissions-aws]] ==== Permissions required by AWS diff --git a/x-pack/functionbeat/docs/overview.asciidoc b/x-pack/functionbeat/docs/overview.asciidoc index 88e8dc52dbd..c0e4e098f87 100644 --- a/x-pack/functionbeat/docs/overview.asciidoc +++ b/x-pack/functionbeat/docs/overview.asciidoc @@ -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"] @@ -25,6 +22,11 @@ The following sections explore some common use cases for {beatname_uc}: * <> * <> +*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 diff --git a/x-pack/functionbeat/docs/tab-widgets/credentials-google-widget.asciidoc b/x-pack/functionbeat/docs/tab-widgets/credentials-google-widget.asciidoc deleted file mode 100644 index 9802f925f0e..00000000000 --- a/x-pack/functionbeat/docs/tab-widgets/credentials-google-widget.asciidoc +++ /dev/null @@ -1,58 +0,0 @@ -++++ -
-
- - - -
-
-++++ - -include::credentials-google.asciidoc[tag=mac] - -++++ -
- - -
-++++ diff --git a/x-pack/functionbeat/docs/tab-widgets/credentials-google.asciidoc b/x-pack/functionbeat/docs/tab-widgets/credentials-google.asciidoc deleted file mode 100644 index 9bfee91f0ce..00000000000 --- a/x-pack/functionbeat/docs/tab-widgets/credentials-google.asciidoc +++ /dev/null @@ -1,19 +0,0 @@ -// tag::mac[] -[source,shell] ----- -export GOOGLE_APPLICATION_CREDENTIALS="/path/to/myproject-5a90ee91d102.json" ----- -// end::mac[] - -// tag::linux[] -[source,shell] ----- -export GOOGLE_APPLICATION_CREDENTIALS="/path/to/myproject-5a90ee91d102.json" ----- -// end::linux[] -// tag::win[] -[source,shell] ----- -set GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\myproject-5a90ee91d102.json" ----- -// end::win[] diff --git a/x-pack/functionbeat/docs/tab-widgets/deploy-google-widget.asciidoc b/x-pack/functionbeat/docs/tab-widgets/deploy-google-widget.asciidoc deleted file mode 100644 index b5728a56717..00000000000 --- a/x-pack/functionbeat/docs/tab-widgets/deploy-google-widget.asciidoc +++ /dev/null @@ -1,58 +0,0 @@ -++++ -
-
- - - -
-
-++++ - -include::deploy-google.asciidoc[tag=mac] - -++++ -
- - -
-++++ diff --git a/x-pack/functionbeat/docs/tab-widgets/deploy-google.asciidoc b/x-pack/functionbeat/docs/tab-widgets/deploy-google.asciidoc deleted file mode 100644 index 58b707eaee1..00000000000 --- a/x-pack/functionbeat/docs/tab-widgets/deploy-google.asciidoc +++ /dev/null @@ -1,19 +0,0 @@ -// tag::mac[] -["source","sh",subs="attributes"] ----- -./{beatname_lc} -v -e -d "*" deploy storage ----- -// end::mac[] - -// tag::linux[] -["source","sh",subs="attributes"] ----- -./{beatname_lc} -v -e -d "*" deploy storage ----- -// end::linux[] -// tag::win[] -["source","sh",subs="attributes"] ----- -.{backslash}{beatname_lc}.exe -v -e -d "*" deploy storage ----- -// end::win[]