Update PR to reflect change requests

Signed-off-by: Sean Tan <seant@splunk.com>
2021-08-31 12:53:29 -07:00
parent 9aef36dfb4
commit 7177a9a822
15 changed files with 102 additions and 126 deletions
@@ -0,0 +1,28 @@
+---
+id: discovery
+title: AWS S3 Discovery
+sidebar_label: Discovery
+# prettier-ignore
+description: Automatically discovering catalog entities from an AWS S3 Bucket
+---
+
+The AWS S3 integration has a special discovery processor for discovering catalog
+entities located in an S3 Bucket. If you have a bucket that contains multiple
+catalog-info files and want to automatically discover them, you can use this
+processor. The processor will crawl your S3 bucket and register entities
+matching the configured path. This can be useful as an alternative to static
+locations or manually adding things to the catalog.
+
+To use the discovery processor, you'll need an AWS S3 integration
+[set up](locations.md) with an `AWS_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY`, and
+optionally a `roleArn`. Then you can add a location target to the catalog
+configuration:
+
+```yaml
+catalog:
+  locations:
+    - type: awsS3-discovery
+      target: https://sample-bucket.s3.us-east-2.amazonaws.com/
+```
+
+Note the `awsS3-discovery` type, as this is not a regular `url` processor.
@@ -1,28 +0,0 @@
---
-id: read-tree
-title: AWS S3 Read Tree
-sidebar_label: Read Tree
-# prettier-ignore
-description: Discovering multiple catalog entities from an AWS S3 Bucket
---
-
-The AWS S3 integration has a special processor for using AwsS3UrlReader's
-readTree() method. The method readTree() allows a user to retrieve more than one
-file hosted inside an S3 bucket. The processor passes a valid S3 URL and
-credentials to AwsS3UrlReader's readTree(). A user can supply a URL which points
-to root of a bucket or a subdirectory inside the bucket. This can be useful as
-an alternative to static locations or manually adding things to the catalog.
-
-To use the discovery processor, you'll need an AWS S3 integration
-[set up](locations.md) with an `AWS_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY`, and
-optionally a `roleArn`. Then you can add a location target to the catalog
-configuration:
-
-```yaml
-catalog:
-  locations:
-    - type: s3-bucket
-      target: https://sample-bucket.s3.us-east-2.amazonaws.com/
-```
-
-Note the `s3-bucket` type, as this is not a regular `url` processor.