Merge pull request #119 from SumoLogic/ssain-add-missing-docs

seansain · web-flow · commit a5083717fae8 · 2020-02-24T10:22:10.000-08:00
add new docs and fix some formatting on the old ones
diff --git a/website/docs/README.md b/website/docs/README.md
@@ -5,6 +5,7 @@
 #### Data Sources
   + [sumologic_caller_identity][10]
   + [sumologic_collector][11]
+  + [sumologic_personal_folder][12]
 
 #### Resources
 ##### Sources
@@ -23,6 +24,10 @@
   
 ##### Content
   + [sumologic_scheduled_view][40]
+  + [sumologic_partition][41]
+  + [sumologic_extraction_rule][42]
+  + [sumologic_folder][43]
+  + [sumologic_content][44]
 
 #### Common Source Properties
 
@@ -47,16 +52,21 @@ The following properties are common to ALL sources and can be used to configure
 - `lookup_by_name` - (Optional) Configures an existent collector using the same 'name' or creates a new one if non existent. Defaults to false.
 - `destroy` - (Optional) Whether or not to delete the collector in Sumo when it is removed from Terraform.  Defaults to true.
 
-[0]: sumologic-provider.md
+[0]: index.html.markdown
 [2]: https://en.wikipedia.org/wiki/Tz_database
-[10]: d/sumologic_caller_identity.md
-[11]: d/sumologic_collector.md
-[20]: r/sumologic_collector.md
-[21]: r/sumologic_http_source.md
-[22]: r/sumologic_polling_source.md
-[23]: r/sumologic_cloudsyslog_source.md
-[24]: r/sumologic_collector_ingest_budget_assignment.md
-[25]: r/sumologic_ingest_budget.md
-[30]: r/sumologic_role.md
-[31]: r/sumologic_user.md
-[40]: r/sumologic_scheduled_view.md
+[10]: d/caller_identity.html.markdown
+[11]: d/collector.html.markdown
+[12]: d/personal_folder.html.markdown
+[20]: r/collector.html.markdown
+[21]: r/http_source.html.markdown
+[22]: r/polling_source.html.markdown
+[23]: r/cloudsyslog_source.html.markdown
+[24]: r/collector_ingest_budget_assignment.html.markdown
+[25]: r/ingest_budget.html.markdown
+[30]: r/role.html.markdown
+[31]: r/user.html.markdown
+[40]: r/scheduled_view.html.markdown
+[41]: r/partition.html.markdown
+[42]: r/extraction_rule.html.markdown
+[43]: r/folder.html.markdown
+[44]: r/content.html.markdown
diff --git a/website/docs/d/caller_identity.html.markdown b/website/docs/d/caller_identity.html.markdown
@@ -16,7 +16,9 @@ data "sumologic_caller_identity" "current" {}
 
 
 ## Attributes reference
+
 The following attributes are exported:
+
 - `access_id` - Sumo Logic access ID.
 - `access_key` - Sumo Logic access key.
 - `environment` - API endpoint environment.
diff --git a/website/docs/d/collector.html.markdown b/website/docs/d/collector.html.markdown
@@ -29,7 +29,9 @@ A collector can be looked up by either `id` or `name`. One of those attributes n
 If both `id` and `name` have been specified, `id` takes precedence.
 
 ## Attributes reference
+
 The following attributes are exported:
+
 - `id` - The internal ID of the collector. This can be used to attach sources to the collector.
 - `name` - The name of the collector.
 - `description` - The description of the collector.
diff --git a/website/docs/d/personal_folder.html.markdown b/website/docs/d/personal_folder.html.markdown
@@ -0,0 +1,29 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_personal_folder"
+description: |-
+  Provides an easy way to retrieve the Personal Folder.
+---
+
+# sumologic_personal_folder
+Provides an easy way to retrieve the Personal Folder.
+
+
+## Example Usage
+```hcl
+data "sumologic_personal_folder" "personalFolder" {}
+```
+
+
+## Attributes reference
+
+The following attributes are exported:
+
+- `id` - The ID of the Personal Folder.
+- `name` - The name of the Personal Folder.
+- `description` - The description of the Personal Folder.
+
+[Back to Index][0]
+
+[0]: ../README.md
+
diff --git a/website/docs/r/cloudsyslog_source.html.markdown b/website/docs/r/cloudsyslog_source.html.markdown
@@ -33,6 +33,7 @@ Only the common properties are valid.
 ## Attributes reference
 
 The following attributes are exported:
+
 - `id` - The internal ID of the source.
 - `token` - The token to use for sending data to this source.
 
diff --git a/website/docs/r/collector.html.markdown b/website/docs/r/collector.html.markdown
@@ -20,7 +20,9 @@ resource "sumologic_collector" "collector" {
 ```
 
 ## Argument reference
+
 The following arguments are supported:
+
 - `name` - (Required) The name of the collector. This is required, and has to be unique. Changing this will force recreation the collector.
 - `description` - (Optional) The description of the collector.
 - `category` - (Optional) The default source category for any source attached to this collector. Can be overridden in the configuration of said sources.
@@ -29,8 +31,8 @@ The following arguments are supported:
 - `lookup_by_name` - (Optional) Configures an existent collector using the same 'name' or creates a new one if non existent. Defaults to false.
 - `destroy` - (Optional) Whether or not to delete the collector in Sumo when it is removed from Terraform.  Defaults to true.
 
-## Attributes reference
 The following attributes are exported:
+
 - `id` - The internal ID of the collector. This can be used to attach sources to the collector.
 
 ## Import
diff --git a/website/docs/r/collector_ingest_budget_assignment.html.markdown b/website/docs/r/collector_ingest_budget_assignment.html.markdown
@@ -27,12 +27,14 @@ resource "sumologic_collector_ingest_budget_assignment" "assignment" {
 ```
 
 ## Argument reference
+
 The following arguments are supported:
+
 - `collector_id` - (Required) ID of the collector to assign to the ingest budget.
 - `ingest_budget_id` - (Required) ID of the ingest budget to assign the collector to.
 
-## Attributes reference
 The following attributes are exported:
+
 - `id` - The internal ID of the assignment.
 
 [Back to Index][0]
diff --git a/website/docs/r/content.html.markdown b/website/docs/r/content.html.markdown
@@ -0,0 +1,75 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_content"
+description: |-
+  Provides a way to interact with Sumologic Content
+---
+
+# sumologic_content
+Provides a way to interact with Sumologic Content.
+
+## Example Usage
+```hcl
+resource "sumologic_content" "test" {
+parent_id = "%s"
+  config = 
+    {
+        "type": "SavedSearchWithScheduleSyncDefinition",
+        "name": "test-333",
+        "search": {
+            "queryText": "\"warn\"",
+            "defaultTimeRange": "-15m",
+            "byReceiptTime": false,
+            "viewName": "",
+            "viewStartTime": "1970-01-01T00:00:00Z",
+            "queryParameters": [],
+            "parsingMode": "Manual"
+        },
+        "searchSchedule": {
+            "cronExpression": "0 0 * * * ? *",
+            "displayableTimeRange": "-10m",
+            "parseableTimeRange": {
+                "type": "BeginBoundedTimeRange",
+                "from": {
+                    "type": "RelativeTimeRangeBoundary",
+                    "relativeTime": "-50m"
+                },
+                "to": null
+            },
+            "timeZone": "America/Los_Angeles",
+            "threshold": null,
+            "notification": {
+                "taskType": "EmailSearchNotificationSyncDefinition",
+                "toList": ["ops@acme.org"],
+                "subjectTemplate": "Search Results: {{SearchName}}",
+                "includeQuery": true,
+                "includeResultSet": true,
+                "includeHistogram": false,
+                "includeCsvAttachment": false
+            },
+            "scheduleType": "1Hour",
+            "muteErrorEmails": false,
+            "parameters": []
+        },
+        "description": "Runs every hour with timerange of 15m and sends email notifications"
+    }
+}
+```
+
+## Argument reference
+
+The following arguments are supported:
+
+- `parent_id` - (Required) The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with Terraform. The identifier needs to be in hexadecimal format.
+- `config` - (Required) JSON block for the content to import.
+
+## Attributes reference
+
+The following attributes are exported:
+
+- `id` - Unique identifier for the contnet item.
+
+[Back to Index][0]
+
+[0]: ../README.md
+[1]: https://help.sumologic.com/APIs/Content-Management-API
diff --git a/website/docs/r/extraction_rule.html.markdown b/website/docs/r/extraction_rule.html.markdown
@@ -0,0 +1,39 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_extraction_rule"
+description: |-
+  Provides a Sumologic Field Extraction Rule
+---
+
+# sumologic_extraction_rule
+Provides a [Sumologic Field Extraction Rule][1].
+
+## Example Usage
+```hcl
+resource "sumologic_field_extraction_rule" "exampleFER" {
+      name = "exampleFieldExtractionRule"
+      scope = "_sourceHost=127.0.0.1"
+      parse_expression = "csv _raw extract 1 as f1"
+      enabled = true
+}
+```
+
+## Argument reference
+
+The following arguments are supported:
+
+- `name` - (Required) Name of the field extraction rule. Use a name that makes it easy to identify the rule.
+- `scope` - (Required) Scope of the field extraction rule. This could be a sourceCategory, sourceHost, or any other metadata that describes the data you want to extract from. Think of the Scope as the first portion of an ad hoc search, before the first pipe ( | ). You'll use the Scope to run a search against the rule.
+- `parse_expression` - (Required) Describes the fields to be parsed.
+- `enabled` - (Required) Is the field extraction rule enabled.
+
+## Attributes reference
+
+The following attributes are exported:
+
+- `id` - Unique identifier for the field extraction rule.
+
+[Back to Index][0]
+
+[0]: ../README.md
+[1]: https://help.sumologic.com/Manage/Field-Extractions
diff --git a/website/docs/r/folder.html.markdown b/website/docs/r/folder.html.markdown
@@ -23,12 +23,15 @@ Unfortunately, the only way to find the parent folder's hexadecimal ID is by sen
 In the future, there will be a button in the UI that will reveal the hex ID.
 
 ## Argument reference
+
 The following arguments are supported:
+
 - `name` - (Required) The name of the folder. This is required, and has to be unique.
 - `parent_id` - (Required) The ID of the folder in which you want to create the new folder.
 - `description` - (Optional) The description of the folder.
 
-## Additional data provided in state
+Additional data provided in state
+
 - `created_at` - (Computed) When the folder was created.
 - `created_by` - (Computed) Who created the folder.
 - `modified_at` - (Computed) When was the folder last modified.
diff --git a/website/docs/r/http_source.html.markdown b/website/docs/r/http_source.html.markdown
@@ -26,11 +26,13 @@ resource "sumologic_collector" "collector" {
 ```
 
 ## Argument reference
+
 In addition to the common properties, the following arguments are supported:
+
 - `message_per_request` - (Optional) When set to `true`, will create one log message per HTTP request.
 
-## Attributes reference
 The following attributes are exported:
+
 - `id` - The internal ID of the source.
 - `url` - The HTTP endpoint to use for sending data to this source.
 
diff --git a/website/docs/r/ingest_budget.html.markdown b/website/docs/r/ingest_budget.html.markdown
@@ -19,7 +19,9 @@ resource "sumologic_ingest_budget" "budget" {
 ```
 
 ## Argument reference
+
 The following arguments are supported:
+
 - `name` - (Required) Display name of the ingest budget. This must be unique across all of the ingest budgets
 - `field_value` - (Required) Custom field value that is used to assign Collectors to the ingest budget.
 - `capacity_bytes` - (Required) Capacity of the ingest budget, in bytes.
@@ -29,10 +31,9 @@ The following arguments are supported:
 - `reset_time` - (Optional) Reset time of the ingest budget in HH:MM format. Defaults to `00:00`
 - `description` - (Optional) Description of the ingest budget.
 - `action` - (Optional) Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are `stopCollecting` and `keepCollecting`.
-                        
 
-## Attributes reference
 The following attributes are exported:
+
 - `id` - The internal ID of the ingest budget. This can be used to assign collectors to the ingest budget.
 
 ## Import
diff --git a/website/docs/r/partition.html.markdown b/website/docs/r/partition.html.markdown
@@ -0,0 +1,41 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_partition"
+description: |-
+  Provides a Sumologic Partition
+---
+
+# sumologic_partition
+Provides a [Sumologic Partition][1].
+
+## Example Usage
+```hcl
+resource "sumologic_partition" "examplePartition" {
+    name = "terraform_examplePartition"
+    routing_expression = "_sourcecategory=*/Terraform"
+    analytics_tier = "enhanced"
+    is_compliant = false
+}
+```
+
+## Argument reference
+
+The following arguments are supported:
+
+- `name` - (Required) The name of the partition.
+- `routing_expression` - (Required) The query that defines the data to be included in the partition.
+- `analytics_tier` - (Required) The Cloud Flex analytics tier for your data; only relevant if your account has basic analytics enabled. Possible values are: `enhanced`, `basic`, `cold`
+- `retention_period` - (Optional) The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
+- `is_compliant` - (Required) Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
+- `data_forwarding_id` - (Optional) An optional ID of a data forwarding configuration to be used by the partition.
+
+## Attributes reference
+
+The following attributes are exported:
+
+- `id` - Unique identifier for the partition.
+
+[Back to Index][0]
+
+[0]: ../README.md
+[1]: https://help.sumologic.com/Manage/Partitions
diff --git a/website/docs/r/polling_source.html.markdown b/website/docs/r/polling_source.html.markdown
@@ -48,7 +48,9 @@ resource "sumologic_collector" "collector" {
 ```
 
 ## Argument reference
+
 In addition to the common properties, the following arguments are supported:
+
  - `content_type` - (Required) The content-type of the collected data. Details can be found in the [Sumologic documentation for hosted sources][1].
  - `scan_interval` - (Required) Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
  - `paused` - (Required) When set to true, the scanner is paused. To disable, set to false.
@@ -61,7 +63,8 @@ In addition to the common properties, the following arguments are supported:
      + `bucket_name` - (Required) The name of the bucket.
      + `path_expression` - (Required) The path to the data.
 
-## Attributes reference
+The following attributes are exported:
+
 - `id` - The internal ID of the source.
 - `url` - The HTTP endpoint to use with [SNS to notify Sumo Logic of new files](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/AWS-S3-Source#Set_up_SNS_in_AWS_(Optional)).
 
diff --git a/website/docs/r/role.html.markdown b/website/docs/r/role.html.markdown
@@ -26,7 +26,9 @@ resource "sumologic_role" "example_role" {
 ```
 
 ## Argument reference
+
 The following arguments are supported:
+
 - `name` - (Required) The name of the role.
 - `description` - (Optional) The description of the role.
 - `filter_predicate` - (Optional) A search filter to restrict access to specific logs.
@@ -35,8 +37,8 @@ The following arguments are supported:
 - `lookup_by_name` - (Optional) Configures an existent role using the same 'name' or creates a new one if non existent. Defaults to false.
 - `destroy` - (Optional) Whether or not to delete the role in Sumo when it is removed from Terraform.  Defaults to true.
 
-## Attributes reference
 The following attributes are exported:
+
 - `id` - The internal ID of the role.
 
 
diff --git a/website/docs/r/scheduled_view.html.markdown b/website/docs/r/scheduled_view.html.markdown
diff --git a/website/docs/r/user.html.markdown b/website/docs/r/user.html.markdown
diff --git a/website/sumologic.erb b/website/sumologic.erb
