Update documentation in README.md (#13)

alfespa17 · web-flow · commit 03c06c717ac8 · 2023-10-10T16:52:38.000-06:00
* Update documentation in README.md
diff --git a/.github/tf.png b/.github/tf.png
diff --git a/.gitignore b/.gitignore
@@ -33,3 +33,5 @@ website/vendor
 
 # Keep windows files with windows line endings
 *.winfile eol=crlf
+
+/examples/full/
diff --git a/README.md b/README.md
@@ -1,6 +1,10 @@
-# Terraform Provider Terrakube
+<a href="https://terraform.io">
+    <img src=".github/tf.png" alt="Terraform logo" title="Terraform" align="left" height="50" />
+</a>
 
-**THIS IS WORK IN PROGRESS AND IT IS NOT STABLE**
+# Terraform Provider for Terrakube
+
+The Terrakube Terraform Provider allows managing resources within your Terrakube installation.
 
 ## Requirements
 
@@ -10,9 +14,84 @@
 ## Building The Provider
 
 1. Clone the repository
-1. Enter the repository directory
-1. Build the provider using the Go `install` command:
+2. Enter the repository directory
+3. Build the provider using the Go `install` command:
+
+```shell
+go install .
+```
 
+Generate Docs
 ```shell
-go install
+go generate ./...
+```
+
+## Usage Example
+
+```hcl
+terraform {
+  required_providers {
+    terrakube = {
+      source = "registry.terraform.io/alfespa17/terrakube"
+    }
+  }
+}
+
+provider "terrakube" {
+  endpoint = "http://terrakube-api.minikube.net"
+  token    = "(PERSONAL ACCESS TOKEN OR TEAM TOKEN)"
+}
+
+data "terrakube_organization" "org" {
+  name = "simple"
+}
+
+data "terrakube_vcs" "vcs" {
+  name            = "sample_vcs"
+  organization_id = data.terrakube_organization.org.id
+}
+
+data "terrakube_ssh" "ssh" {
+  name            = "sample_ssh"
+  organization_id = data.terrakube_organization.org.id
+}
+
+resource "terrakube_team" "team" {
+  name             = "TERRAKUBE_SUPER_ADMIN"
+  organization_id  = data.terrakube_vcs.vcs.organization_id
+  manage_workspace = false
+  manage_module    = false
+  manage_provider  = true
+  manage_vcs       = true
+  manage_template  = true
+}
+
+resource "terrakube_module" "module1" {
+  name            = "module_public_connection"
+  organization_id = data.terrakube_ssh.ssh.organization_id
+  description     = "module_public_connection"
+  provider_name   = "aws"
+  source          = "https://github.com/terraform-aws-modules/terraform-aws-vpc.git"
+}
+
+resource "terrakube_module" "module2" {
+  name            = "module_vcs_connection"
+  organization_id = data.terrakube_ssh.ssh.organization_id
+  description     = "module_vcs_connection"
+  provider_name   = "aws"
+  source          = "https://github.com/terraform-aws-modules/super_private.git"
+  vcs_id          = data.terrakube_vcs.vcs.id
+}
+
+resource "terrakube_module" "module3" {
+  name            = "module_ssh_connection"
+  organization_id = data.terrakube_ssh.ssh.organization_id
+  description     = "module_ssh_connection"
+  provider_name   = "aws"
+  source          = "https://github.com/terraform-aws-modules/super_private.git"
+  ssh_id          = data.terrakube_ssh.ssh.id
+}
 ```
+
+* [Terrakube Docs](https://docs.terrakube.io/).
+* [Terrakube API Docs](https://docs.terrakube.io/api/methods).
diff --git a/docs/data-sources/ssh.md b/docs/data-sources/ssh.md
@@ -0,0 +1,26 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "terrakube_ssh Data Source - terraform-provider-terrakube"
+subcategory: ""
+description: |-
+  
+---
+
+# terrakube_ssh (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) Ssh Name
+- `organization_id` (String) Terrakube organization id
+
+### Read-Only
+
+- `description` (String) Ssh description information
+- `id` (String) Ssh Id
diff --git a/docs/data-sources/vcs.md b/docs/data-sources/vcs.md
@@ -0,0 +1,26 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "terrakube_vcs Data Source - terraform-provider-terrakube"
+subcategory: ""
+description: |-
+  
+---
+
+# terrakube_vcs (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) Vcs Name
+- `organization_id` (String) Terrakube organization id
+
+### Read-Only
+
+- `description` (String) Vcs description information
+- `id` (String) Vcs Id
diff --git a/docs/index.md b/docs/index.md
@@ -22,7 +22,9 @@ terraform {
 }
 
 provider "terrakube" {
-  endpoint = "http://terrakube-api.minikube.net"
+  endpoint             = "http://terrakube-api.minikube.net"
+  token                = "12345"
+  insecure_http_client = true
 }
 ```
 
@@ -33,3 +35,7 @@ provider "terrakube" {
 
 - `endpoint` (String) Terrakube API Endpoint. Example: https://terrakube-api.minikube.net
 - `token` (String) Personal Access Token generated in Terrakube UI (https://docs.terrakube.io/user-guide/organizations/api-tokens)
+
+### Optional
+
+- `insecure_http_client` (Boolean) Disable https certificate validation
diff --git a/docs/resources/module.md b/docs/resources/module.md
@@ -0,0 +1,33 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "terrakube_module Resource - terraform-provider-terrakube"
+subcategory: ""
+description: |-
+  
+---
+
+# terrakube_module (Resource)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `description` (String) Module description
+- `name` (String) Module name
+- `organization_id` (String) Terrakube organization id
+- `provider_name` (String) Module provider name. Example: azurerm, google, aws, etc
+- `source` (String) Source (git using https or ssh protocol)
+
+### Optional
+
+- `ssh_id` (String) Ssh connection ID for private modules
+- `vcs_id` (String) VCS connection ID for private modules
+
+### Read-Only
+
+- `id` (String) Module Id
diff --git a/examples/data-sources/ssh_example/data-source.tf b/examples/data-sources/ssh_example/data-source.tf
@@ -3,6 +3,6 @@ data "terrakube_organization" "org" {
 }
 
 data "terrakube_ssh" "ssh" {
-  name = "sample"
+  name            = "sample"
   organization_id = data.terrakube_organization.org.id
 }
diff --git a/examples/data-sources/vcs_example/data-source.tf b/examples/data-sources/vcs_example/data-source.tf
@@ -3,6 +3,6 @@ data "terrakube_organization" "org" {
 }
 
 data "terrakube_vcs" "vcs" {
-  name = "sample"
+  name            = "sample"
   organization_id = data.terrakube_organization.org.id
 }
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -7,6 +7,7 @@ terraform {
 }
 
 provider "terrakube" {
-  endpoint = "http://terrakube-api.minikube.net"
-  token    = "XXX"
+  endpoint             = "http://terrakube-api.minikube.net"
+  token                = "12345"
+  insecure_http_client = true
 }
diff --git a/internal/provider/module_resource.go b/internal/provider/module_resource.go
@@ -101,11 +101,18 @@ func (r *ModuleResource) Configure(ctx context.Context, req resource.ConfigureRe
 		return
 	}
 
-	customTransport := http.DefaultTransport.(*http.Transport).Clone()
-	customTransport.TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
-	client := http.Client{Transport: customTransport}
+	if providerData.InsecureHttpClient {
+		if custom, ok := http.DefaultTransport.(*http.Transport); ok {
+			customTransport := custom.Clone()
+			customTransport.TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
+			r.client = &http.Client{Transport: customTransport}
+		} else {
+			r.client = &http.Client{}
+		}
+	} else {
+		r.client = &http.Client{}
+	}
 
-	r.client = &client
 	r.endpoint = providerData.Endpoint
 	r.token = providerData.Token
 
@@ -139,7 +146,12 @@ func (r *ModuleResource) Create(ctx context.Context, req resource.CreateRequest,
 	}
 
 	var out = new(bytes.Buffer)
-	jsonapi.MarshalPayload(out, bodyRequest)
+	err := jsonapi.MarshalPayload(out, bodyRequest)
+
+	if err != nil {
+		resp.Diagnostics.AddError("Unable to marshal payload", fmt.Sprintf("Unable to marshal payload: %s", err))
+		return
+	}
 
 	tflog.Info(ctx, fmt.Sprintf("Body Request: %s", out.String()))
 
@@ -276,7 +288,12 @@ func (r *ModuleResource) Update(ctx context.Context, req resource.UpdateRequest,
 	}
 
 	var out = new(bytes.Buffer)
-	jsonapi.MarshalPayload(out, bodyRequest)
+	err := jsonapi.MarshalPayload(out, bodyRequest)
+
+	if err != nil {
+		resp.Diagnostics.AddError("Unable to marshal payload", fmt.Sprintf("Unable to marshal payload: %s", err))
+		return
+	}
 
 	moduleRequest, err := http.NewRequest(http.MethodPatch, fmt.Sprintf("%s/api/v1/organization/%s/module/%s", r.endpoint, state.OrganizationId.ValueString(), state.ID.ValueString()), strings.NewReader(out.String()))
 	moduleRequest.Header.Add("Authorization", fmt.Sprintf("Bearer %s", r.token))
diff --git a/internal/provider/organization_data_source.go b/internal/provider/organization_data_source.go
@@ -52,11 +52,17 @@ func (d *OrganizationDataSource) Configure(ctx context.Context, req datasource.C
 		return
 	}
 
-	customTransport := http.DefaultTransport.(*http.Transport).Clone()
-	customTransport.TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
-	client := http.Client{Transport: customTransport}
-
-	d.client = &client
+	if providerData.InsecureHttpClient {
+		if custom, ok := http.DefaultTransport.(*http.Transport); ok {
+			customTransport := custom.Clone()
+			customTransport.TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
+			d.client = &http.Client{Transport: customTransport}
+		} else {
+			d.client = &http.Client{}
+		}
+	} else {
+		d.client = &http.Client{}
+	}
 	d.endpoint = providerData.Endpoint
 	d.token = providerData.Token
 
@@ -115,6 +121,11 @@ func (d *OrganizationDataSource) Read(ctx context.Context, req datasource.ReadRe
 
 	orgs, err = jsonapi.UnmarshalManyPayload(strings.NewReader(string(body)), reflect.TypeOf(new(client.OrganizationEntity)))
 
+	if err != nil {
+		resp.Diagnostics.AddError("Unable to unmarshal payload", fmt.Sprintf("Unable to marshal payload: %s", err))
+		return
+	}
+
 	for _, organization := range orgs {
 		data, _ := organization.(*client.OrganizationEntity)
 		state.ID = types.StringValue(data.ID)
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -29,18 +29,15 @@ type TerrakubeProvider struct {
 
 // hashicupsProviderModel maps provider schema data to a Go type.
 type TerrakubeProviderModel struct {
-	Endpoint types.String `tfsdk:"endpoint"`
-	Token    types.String `tfsdk:"token"`
-}
-
-// ScaffoldingProviderModel describes the provider data model.
-type ScaffoldingProviderModel struct {
-	Endpoint types.String `tfsdk:"endpoint"`
+	Endpoint           types.String `tfsdk:"endpoint"`
+	Token              types.String `tfsdk:"token"`
+	InsecureHttpClient types.Bool   `tfsdk:"insecure_http_client"`
 }
 
 type TerrakubeConnectionData struct {
-	Endpoint string
-	Token    string
+	Endpoint           string
+	Token              string
+	InsecureHttpClient bool
 }
 
 func New(version string) func() provider.Provider {
@@ -67,6 +64,10 @@ func (p *TerrakubeProvider) Schema(ctx context.Context, req provider.SchemaReque
 				Required:    true,
 				Description: "Personal Access Token generated in Terrakube UI (https://docs.terrakube.io/user-guide/organizations/api-tokens)",
 			},
+			"insecure_http_client": schema.BoolAttribute{
+				Optional:    true,
+				Description: "Disable https certificate validation",
+			},
 		},
 	}
 }
@@ -108,6 +109,7 @@ func (p *TerrakubeProvider) Configure(ctx context.Context, req provider.Configur
 
 	endpoint := os.Getenv("TERRAKUBE_ENDPOINT")
 	token := os.Getenv("TERRAKUBE_TOKEN")
+	insecureHttpClient := false
 
 	if !config.Endpoint.IsNull() {
 		endpoint = config.Endpoint.ValueString()
@@ -117,6 +119,10 @@ func (p *TerrakubeProvider) Configure(ctx context.Context, req provider.Configur
 		token = config.Token.ValueString()
 	}
 
+	if !config.InsecureHttpClient.IsNull() {
+		insecureHttpClient = config.InsecureHttpClient.ValueBool()
+	}
+
 	// If any of the expected configurations are missing, return
 	// errors with provider-specific guidance.
 
@@ -148,6 +154,7 @@ func (p *TerrakubeProvider) Configure(ctx context.Context, req provider.Configur
 
 	connection.Endpoint = endpoint
 	connection.Token = token
+	connection.InsecureHttpClient = insecureHttpClient
 
 	resp.DataSourceData = connection
 	resp.ResourceData = connection
diff --git a/internal/provider/provider_test.go b/internal/provider/provider_test.go
diff --git a/internal/provider/ssh_data_source.go b/internal/provider/ssh_data_source.go
diff --git a/internal/provider/team_resource.go b/internal/provider/team_resource.go
diff --git a/internal/provider/vcs_data_source.go b/internal/provider/vcs_data_source.go

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@ data "terrakube_organization" "org" {`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`data "terrakube_ssh" "ssh" {`
`6`		`- name = "sample"`
	`6`	`+ name = "sample"`
`7`	`7`	`organization_id = data.terrakube_organization.org.id`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@ data "terrakube_organization" "org" {`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`data "terrakube_vcs" "vcs" {`
`6`		`- name = "sample"`
	`6`	`+ name = "sample"`
`7`	`7`	`organization_id = data.terrakube_organization.org.id`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ terraform {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`provider "terrakube" {`
`10`		`- endpoint = "http://terrakube-api.minikube.net"`
`11`		`- token = "XXX"`
	`10`	`+ endpoint = "http://terrakube-api.minikube.net"`
	`11`	`+ token = "12345"`
	`12`	`+ insecure_http_client = true`
`12`	`13`	`}`