Plugin documentation (#13)

Signed-off-by: Viorel Dodin <[email protected]>
cisco-open · Apr 25, 2024 · 28e856e · 28e856e
1 parent d0a8250
commit 28e856e
Show file tree

Hide file tree

Showing 15 changed files with 101 additions and 213 deletions.
diff --git a/docs/data-sources/example.md b/docs/data-sources/example.md
diff --git a/docs/data-sources/type.md b/docs/data-sources/type.md
@@ -0,0 +1,28 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "observability_type Data Source - observability"
+subcategory: ""
+description: |-
+  Type data source
+---
+
+# observability_type (Data Source)
+
+Type data source
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `type_name` (String) Specifies the fully qualified type name used to get the type
+
+### Optional
+
+- `data` (Dynamic) JSON schema of the returned type
+
+### Read-Only
+
+- `id` (String) Used to provide compatibility for testing framework
diff --git a/docs/functions/example.md b/docs/functions/example.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,26 +1,28 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding Provider"
+page_title: "observability Provider"
 subcategory: ""
 description: |-
   
 ---
 
-# scaffolding Provider
+# observability Provider
 
 
 
-## Example Usage
 
-```terraform
-provider "scaffolding" {
-  # example configuration here
-}
-```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
+### Required
+
+- `auth_method` (String) Authentication type selected for observability API requests. Possible values(oauth, headless, service-principal)
+- `tenant` (String) Tenant ID used to make requests to API
+
 ### Optional
 
-- `endpoint` (String) Example provider attribute
+- `password` (String, Sensitive) Password to authenticate using headless
+- `secrets_file` (String) Path to secrets file to authenticate using service-principal
+- `url` (String) URL used when authentication eg. <https://mytenant.com>
+- `username` (String) Username to authenticate using headless
diff --git a/docs/resources/example.md b/docs/resources/example.md
diff --git a/docs/resources/object.md b/docs/resources/object.md
@@ -0,0 +1,32 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "observability_object Resource - observability"
+subcategory: ""
+description: |-
+  Object resource
+---
+
+# observability_object (Resource)
+
+Object resource
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `layer_id` (String) Specifies the layer ID where the object resides
+- `layer_type` (String) Specifies the layer type where the object resides
+- `type_name` (String) Specifies the fully qualified type name used to get the type
+
+### Optional
+
+- `data` (String) JSON schema of the returned object
+- `import_id` (String) ID used when doing import operation on an object
+- `object_id` (String) Spepcified the object ID for the particular object to get
+
+### Read-Only
+
+- `id` (String) Used to provide compatibility for testing framework
diff --git a/examples/data-sources/cop_example/data-source.tf b/examples/data-sources/cop_example/data-source.tf
@@ -4,26 +4,7 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
-terraform {
-  required_providers {
-    observability = {
-      source = "testTerraform.com/appd/observability"
-    }
-  }
-}
-
-provider "observability" {
-  tenant="0eb4e853-34fb-4f77-b3fc-b9cd3b462366"
-  auth_method="service-principal"
-  url="https://aiops-dev.saas.appd-test.com"
-  secrets_file="/home/vdodin/aiops_secret.json"
-}
-
 
 data "observability_type" "ns" {
   type_name = "fmm:namespace"
-}
-
-output "myType" {
-  value = data.observability_type.ns
-}
+}
diff --git a/examples/provider/provider_oauth.tf b/examples/provider/provider_oauth.tf
@@ -7,14 +7,14 @@
 terraform {
   required_providers {
     observability = {
-      source = "testTerraform.com/appd/observability"
+      source = "registry.terraform.io/cisco-open/observability"
     }
   }
 }
 
 provider "observability" {
-  tenant="47a01df9-54a0-472b-96b8-7c8f64eb7cbf"
-  auth_method="oauth"
-  url="https://alameda-c0-test-02.saas.appd-test.com"
+  tenant      = "47a01df9-54a0-472b-96b8-7c8f64eb7cbf"
+  auth_method = "oauth"
+  url         = "https://alameda-c0-test-02.saas.appd-test.com"
 }
 
diff --git a/examples/provider/provider_service_principal.tf b/examples/provider/provider_service_principal.tf
@@ -7,15 +7,15 @@
 terraform {
   required_providers {
     observability = {
-      source = "testTerraform.com/appd/observability"
+      source = "registry.terraform.io/cisco-open/observability"
     }
   }
 }
 
 provider "observability" {
-  tenant="47a01df9-54a0-472b-96b8-7c8f64eb7cbf"
-  auth_method="service-principal"
-  url="https://alameda-c0-test-02.saas.appd-test.com"
-  secrets_file="/home/vdodin/secrets.json"
+  tenant       = "47a01df9-54a0-472b-96b8-7c8f64eb7cbf"
+  auth_method  = "service-principal"
+  url          = "https://alameda-c0-test-02.saas.appd-test.com"
+  secrets_file = "/home/yourUser/secrets.json"
 }
 
diff --git a/examples/resources/cop_example/resource.tf b/examples/resources/cop_example/resource.tf
@@ -4,39 +4,23 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
-terraform {
-  required_providers {
-    observability = {
-      source = "testTerraform.com/appd/observability"
-    }
-  }
-}
-
-provider "observability" {
-  tenant="0eb4e853-34fb-4f77-b3fc-b9cd3b462366"
-  auth_method="service-principal"
-  url="https://aiops-dev.saas.appd-test.com"
-  secrets_file="/home/vdodin/aiops_secret.json"
-}
-
-
 resource "observability_object" "conn" {
-  type_name = "anzen:cloudConnection"
-  object_id = "just-terraform-testing"
+  type_name  = "anzen:cloudConnection"
+  object_id  = "just-terraform-testing"
   layer_type = "TENANT"
-  layer_id = "0eb4e853-34fb-4f77-b3fc-b9cd3b462366"
-  import_id = "anzen:cloudConnection|just-terraform-testing|TENANT|0eb4e853-34fb-4f77-b3fc-b9cd3b462366"
+  layer_id   = "0eb4e853-34fb-4f77-b3fc-b9cd3b462366"
+  import_id  = "anzen:cloudConnection|just-terraform-testing|TENANT|0eb4e853-34fb-4f77-b3fc-b9cd3b462366"
   data = jsonencode(
     {
-      "cloudType": "AWS",
-      "connectionName": "just-terraform-testing",
-      "region": "us-east-2",
-      "accessKey": "**********",
-      "secretAccessKey": "**********",
-      "s3AccessLogBucket": "s3://s3-sanity-logging/",
-      "athenaOutputBucket": "s3://s3-sanity-athena-logs/",
-      "createTimestamp": "",
-      "accountId": "81892134343434"
+      "cloudType" : "AWS",
+      "connectionName" : "just-terraform-testing",
+      "region" : "us-east-2",
+      "accessKey" : "**********",
+      "secretAccessKey" : "**********",
+      "s3AccessLogBucket" : "s3://s3-sanity-logging/",
+      "athenaOutputBucket" : "s3://s3-sanity-athena-logs/",
+      "createTimestamp" : "",
+      "accountId" : "81892134343434"
     }
   )
 }
diff --git a/internal/provider/example_function.go b/internal/provider/example_function.go
diff --git a/internal/provider/object_resource.go b/internal/provider/object_resource.go
@@ -47,6 +47,7 @@ func (r *ObjectResource) Metadata(_ context.Context, req resource.MetadataReques
 	resp.TypeName = req.ProviderTypeName + "_object"
 }
 
+// Schema defines the schema for the resource.
 func (r *ObjectResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		// This description is used by the documentation generator and the language server.

diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -45,6 +45,7 @@ func (p *COPProvider) Metadata(_ context.Context, _ provider.MetadataRequest, re
 	resp.Version = p.version
 }
 
+// Schema defines the provider-level schema for configuration data.
 func (p *COPProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		Attributes: map[string]schema.Attribute{
@@ -66,7 +67,7 @@ func (p *COPProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *
 				Sensitive:           true,
 			},
 			"url": schema.StringAttribute{
-				MarkdownDescription: "URL used when authentication eg. https://mytenant.com",
+				MarkdownDescription: "URL used when authentication eg. <https://mytenant.com>",
 				Optional:            true,
 			},
 			"secrets_file": schema.StringAttribute{
@@ -276,9 +277,7 @@ func (p *COPProvider) DataSources(_ context.Context) []func() datasource.DataSou
 }
 
 func (p *COPProvider) Functions(_ context.Context) []func() function.Function {
-	return []func() function.Function{
-		NewExampleFunction,
-	}
+	return []func() function.Function{}
 }
 
 func New(version string) func() provider.Provider {