Merge pull request #69 from SumoLogic/apoorv-inventory-source

apoorv-garg · web-flow · commit 858ad6a7896e · 2020-08-19T11:56:30.000+05:30
terraform support for inventory source
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@ DEPRECATIONS:
 
 FEATURES:
 
+* **New Resource:** sumologic_aws_inventory_source (GH-69)
+* **New Resource:** sumologic_aws_xray_source (GH-68)
 * **New Resource:** sumologic_s3_source (GH-64)
 * **New Resource:** sumologic_s3_audit_source (GH-64)
 * **New Resource:** sumologic_cloudwatch_source (GH-64)
diff --git a/sumologic/provider.go b/sumologic/provider.go
@@ -44,6 +44,7 @@ func Provider() terraform.ResourceProvider {
 			"sumologic_s3_source":                          resourceSumologicGenericPollingSource(),
 			"sumologic_s3_audit_source":                    resourceSumologicGenericPollingSource(),
 			"sumologic_cloudwatch_source":                  resourceSumologicGenericPollingSource(),
+			"sumologic_aws_inventory_source":               resourceSumologicGenericPollingSource(),
 			"sumologic_aws_xray_source":                    resourceSumologicGenericPollingSource(),
 			"sumologic_cloudtrail_source":                  resourceSumologicGenericPollingSource(),
 			"sumologic_elb_source":                         resourceSumologicGenericPollingSource(),
diff --git a/sumologic/resource_sumologic_generic_polling_source.go b/sumologic/resource_sumologic_generic_polling_source.go
@@ -1,6 +1,7 @@
 package sumologic
 
 import (
+	"errors"
 	"fmt"
 	"log"
 	"strconv"
@@ -23,7 +24,7 @@ func resourceSumologicGenericPollingSource() *schema.Resource {
 		Required: true,
 		ForceNew: true,
 		ValidateFunc: validation.StringInSlice([]string{"AwsS3Bucket", "AwsElbBucket", "AwsCloudFrontBucket",
-			"AwsCloudTrailBucket", "AwsS3AuditBucket", "AwsCloudWatch", "AwsXRay"}, false),
+			"AwsCloudTrailBucket", "AwsS3AuditBucket", "AwsCloudWatch", "AwsInventory", "AwsXRay"}, false),
 	}
 	pollingSource.Schema["scan_interval"] = &schema.Schema{
 		Type:     schema.TypeInt,
@@ -77,7 +78,7 @@ func resourceSumologicGenericPollingSource() *schema.Resource {
 					Type:     schema.TypeString,
 					Required: true,
 					ValidateFunc: validation.StringInSlice([]string{"S3BucketPathExpression", "CloudWatchPath",
-						"AwsXRayPath"}, false),
+						"AwsInventoryPath", "AwsXRayPath"}, false),
 				},
 				"bucket_name": {
 					Type:     schema.TypeString,
@@ -133,20 +134,20 @@ func resourceSumologicGenericPollingSource() *schema.Resource {
 }
 
 func resourceSumologicGenericPollingSourceCreate(d *schema.ResourceData, meta interface{}) error {
-
 	c := meta.(*Client)
 
 	if d.Id() == "" {
-		source := resourceToGenericPollingSource(d)
-		sourceID, err := c.CreatePollingSource(source, d.Get("collector_id").(int))
-
+		source, err := resourceToGenericPollingSource(d)
 		if err != nil {
 			return err
 		}
 
-		id := strconv.Itoa(sourceID)
+		sourceID, err := c.CreatePollingSource(source, d.Get("collector_id").(int))
+		if err != nil {
+			return err
+		}
 
-		d.SetId(id)
+		d.SetId(strconv.Itoa(sourceID))
 	}
 
 	return resourceSumologicGenericPollingSourceRead(d, meta)
@@ -155,10 +156,12 @@ func resourceSumologicGenericPollingSourceCreate(d *schema.ResourceData, meta in
 func resourceSumologicGenericPollingSourceUpdate(d *schema.ResourceData, meta interface{}) error {
 	c := meta.(*Client)
 
-	source := resourceToGenericPollingSource(d)
-
-	err := c.UpdatePollingSource(source, d.Get("collector_id").(int))
+	source, err := resourceToGenericPollingSource(d)
+	if err != nil {
+		return err
+	}
 
+	err = c.UpdatePollingSource(source, d.Get("collector_id").(int))
 	if err != nil {
 		return err
 	}
@@ -201,7 +204,7 @@ func resourceSumologicGenericPollingSourceRead(d *schema.ResourceData, meta inte
 	return nil
 }
 
-func resourceToGenericPollingSource(d *schema.ResourceData) PollingSource {
+func resourceToGenericPollingSource(d *schema.ResourceData) (PollingSource, error) {
 	source := resourceToSource(d)
 	source.Type = "Polling"
 
@@ -213,15 +216,25 @@ func resourceToGenericPollingSource(d *schema.ResourceData) PollingSource {
 		URL:          d.Get("url").(string),
 	}
 
+	authSettings, errAuthSettings := getPollingAuthentication(d)
+	if errAuthSettings != nil {
+		return pollingSource, errAuthSettings
+	}
+
+	pathSettings, errPathSettings := getPollingPathSettings(d)
+	if errPathSettings != nil {
+		return pollingSource, errPathSettings
+	}
+
 	pollingResource := PollingResource{
 		ServiceType:    d.Get("content_type").(string),
-		Authentication: getPollingAuthentication(d),
-		Path:           getPollingPathSettings(d),
+		Authentication: authSettings,
+		Path:           pathSettings,
 	}
 
 	pollingSource.ThirdPartyRef.Resources = append(pollingSource.ThirdPartyRef.Resources, pollingResource)
 
-	return pollingSource
+	return pollingSource, nil
 }
 
 func getPollingThirdPartyPathAttributes(pollingResource []PollingResource) []map[string]interface{} {
@@ -280,29 +293,35 @@ func getPollingTagFilters(d *schema.ResourceData) []TagFilter {
 	return filters
 }
 
-func getPollingAuthentication(d *schema.ResourceData) PollingAuthentication {
+func getPollingAuthentication(d *schema.ResourceData) (PollingAuthentication, error) {
 	auths := d.Get("authentication").([]interface{})
 	authSettings := PollingAuthentication{}
 
 	if len(auths) > 0 {
 		auth := auths[0].(map[string]interface{})
 		switch authType := auth["type"].(string); authType {
 		case "S3BucketAuthentication":
+			if d.Get("content_type").(string) == "AwsInventory" {
+				return authSettings, errors.New(
+					fmt.Sprintf("[ERROR] Unsupported authType: %v for AwsInventory source", authType))
+			}
 			authSettings.Type = "S3BucketAuthentication"
 			authSettings.AwsID = auth["access_key"].(string)
 			authSettings.AwsKey = auth["secret_key"].(string)
 		case "AWSRoleBasedAuthentication":
 			authSettings.Type = "AWSRoleBasedAuthentication"
 			authSettings.RoleARN = auth["role_arn"].(string)
 		default:
-			log.Printf("[ERROR] Unknown authType: %v", authType)
+			errorMessage := fmt.Sprintf("[ERROR] Unknown authType: %v", authType)
+			log.Print(errorMessage)
+			return authSettings, errors.New(errorMessage)
 		}
 	}
 
-	return authSettings
+	return authSettings, nil
 }
 
-func getPollingPathSettings(d *schema.ResourceData) PollingPath {
+func getPollingPathSettings(d *schema.ResourceData) (PollingPath, error) {
 	pathSettings := PollingPath{}
 	paths := d.Get("path").([]interface{})
 
@@ -313,8 +332,8 @@ func getPollingPathSettings(d *schema.ResourceData) PollingPath {
 			pathSettings.Type = "S3BucketPathExpression"
 			pathSettings.BucketName = path["bucket_name"].(string)
 			pathSettings.PathExpression = path["path_expression"].(string)
-		case "CloudWatchPath":
-			pathSettings.Type = "CloudWatchPath"
+		case "CloudWatchPath", "AwsInventoryPath":
+			pathSettings.Type = pathType
 			rawLimitToRegions := path["limit_to_regions"].([]interface{})
 			LimitToRegions := make([]string, len(rawLimitToRegions))
 			for i, v := range rawLimitToRegions {
@@ -328,7 +347,9 @@ func getPollingPathSettings(d *schema.ResourceData) PollingPath {
 			}
 			pathSettings.LimitToRegions = LimitToRegions
 			pathSettings.LimitToNamespaces = LimitToNamespaces
-			pathSettings.TagFilters = getPollingTagFilters(d)
+			if pathType == "CloudWatchPath" {
+				pathSettings.TagFilters = getPollingTagFilters(d)
+			}
 		case "AwsXRayPath":
 			pathSettings.Type = "AwsXRayPath"
 			rawLimitToRegions := path["limit_to_regions"].([]interface{})
@@ -338,9 +359,11 @@ func getPollingPathSettings(d *schema.ResourceData) PollingPath {
 			}
 			pathSettings.LimitToRegions = LimitToRegions
 		default:
-			log.Printf("[ERROR] Unknown resourceType in path: %v", pathType)
+			errorMessage := fmt.Sprintf("[ERROR] Unknown resourceType in path: %v", pathType)
+			log.Print(errorMessage)
+			return pathSettings, errors.New(errorMessage)
 		}
 	}
 
-	return pathSettings
+	return pathSettings, nil
 }
diff --git a/website/docs/r/aws_inventory_source.html.markdown b/website/docs/r/aws_inventory_source.html.markdown
@@ -0,0 +1,89 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_aws_inventory_source"
+description: |-
+  Provides a Sumologic AWS Inventory source.
+---
+
+# sumologic_aws_inventory_source
+Provides a Sumologic AWS Inventory source to collect AWS resource inventory data.
+
+__IMPORTANT:__ The AWS credentials are stored in plain-text in the state. This is a potential security issue.
+
+## Example Usage
+```hcl
+resource "sumologic_aws_inventory_source" "terraform_aws_inventory_source" {
+  name          = "AWS Inventory"
+  description   = "My description"
+  category      = "aws/terraform_aws_inventory"
+  content_type  = "AwsInventory"
+  scan_interval = 300000
+  paused        = false
+  collector_id  = "${sumologic_collector.collector.id}"
+
+  authentication {
+    type = "AWSRoleBasedAuthentication"
+    role_arn = "arn:aws:iam::01234567890:role/sumo-role"
+  }
+
+  path {
+    type = "AwsInventoryPath"
+    limit_to_regions = ["us-west-2"]
+    limit_to_namespaces = ["AWS/RDS","AWS/EC2"]
+  }
+}
+
+resource "sumologic_collector" "collector" {
+  name        = "my-collector"
+  description = "Just testing this"
+}
+```
+
+## Argument reference
+
+In addition to the common properties, the following arguments are supported:
+
+ - `content_type` - (Required) The content-type of the collected data. This has to be `AwsInventoryPath` for AWS Inventory source.
+ - `scan_interval` - (Required) Time interval in milliseconds of scans for new data. The minimum value is 1000 milliseconds. Currently this value is not respected.
+ - `paused` - (Required) When set to true, the scanner is paused. To disable, set to false.
+ - `authentication` - (Required) Authentication details to access AWS `Describe*` APIs.
+     + `type` - (Required) Must be `AWSRoleBasedAuthentication`
+     + `role_arn` - (Required) Your AWS role ARN. More details [here](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/Grant-Access-to-an-AWS-Product#iam-role).
+ - `path` - (Required) The location to scan for new data.
+     + `type` - (Required) type of polling source. This has to be `AwsInventoryPath` for AWS Inventory source.
+     + `limit_to_regions` - (Optional) List of Amazon regions. 
+     + `limit_to_namespaces` - (Optional) List of namespaces. By default all namespaces are selected. You can also choose a subset from
+        + AWS/EC2
+        + AWS/AutoScaling
+        + AWS/EBS
+        + AWS/ELB
+        + AWS/ApplicationELB
+        + AWS/NetworkELB
+        + AWS/Lambda
+        + AWS/RDS
+        + AWS/Dynamodb
+        + AWS/ECS 
+        + AWS/Elasticache
+        + AWS/Redshift
+        + AWS/Kinesis
+
+### See also
+  * [Common Source Properties](https://github.com/terraform-providers/terraform-provider-sumologic/tree/master/website#common-source-properties)
+
+## Attributes Reference
+The following attributes are exported:
+
+- `id` - The internal ID of the source.
+
+## Import
+AWS Inventory sources can be imported using the collector and source IDs (`collector/source`), e.g.:
+
+```hcl
+terraform import sumologic_aws_inventory_source.test 123/456
+```
+
+AWS Inventory sources can be imported using the collector name and source name (`collectorName/sourceName`), e.g.:
+
+```hcl
+terraform import sumologic_aws_inventory_source.test my-test-collector/my-test-source
+```
