Merge pull request #1 from vmware-tanzu/master

Migrating the code from internal project

Author: Shreyas Sreenivas

.gitignore

@@ -0,0 +1,7 @@
+bin/*
+_output/*
+.DS_Store
+.vscode
+.idea/*
+vendor/*
+cover.out

.golangci.yaml

@@ -0,0 +1,84 @@
+# https://github.com/golangci/golangci-lint#config-file
+
+linters:
+  # please, do not use `enable-all`: it's deprecated and will be removed soon.
+  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+  disable-all: true
+  enable:
+    - asciicheck
+    - bodyclose
+    - deadcode
+    - depguard
+    - dogsled
+    - dupl
+    - errcheck
+    - exportloopref
+    - funlen
+    - goconst
+    - gocognit
+    - gocritic
+    - gocyclo
+    - godot
+    - gofmt
+    - goimports
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - nakedret
+    - nestif
+    - prealloc
+    - rowserrcheck
+    - staticcheck
+    - structcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - varcheck
+    - whitespace
+    - wsl
+
+#   don't enable:
+#   - exhaustive
+#   - gochecknoglobals
+#   - godox
+#   - gomnd
+#   - goerr113
+#   - gofumpt
+#   - interfacer
+#   - lll
+#   - maligned
+#   - nlreturn
+#   - noctx
+#   - nolintlint
+#   - scopelint
+#   - testpackage
+#   - revive
+
+run:
+  # include test files or not, default is true
+  tests: true
+  deadline: 5m
+
+linters-settings:
+  funlen:
+    lines: 150
+    statements: 100
+  gci:
+    local-prefixes: gitlab.eng.vmware.com/olympus
+
+issues:
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - dogsled
+        - funlen
+        - gocognit
+    - path: internal/authctx
+      linters:
+        - gosec
+        - nestif

Dockerfile

@@ -0,0 +1,17 @@
+#Copyright © 2021 VMware, Inc. All Rights Reserved.
+#SPDX-License-Identifier: MPL-2.0
+
+FROM 498533941640.dkr.ecr.us-west-2.amazonaws.com/base-images/golang-build-1.16 as build
+WORKDIR /go/src/gitlab.eng.vmware/olympus/terraform-provider-tanzu
+
+COPY .golangci.yaml go.mod go.sum ./
+COPY cmd cmd
+COPY internal internal
+
+VOLUME /test-results
+
+ENTRYPOINT  go test -coverprofile=/test-results/coverage.out ./internal/... ./cmd/... && \
+            go tool cover -func=/test-results/coverage.out > /test-results/function-wise-coverage.txt && \
+            cat /test-results/function-wise-coverage.txt | awk 'END{print $NF}' > /test-results/totalcoverage.txt && \
+            go tool cover -html=/test-results/coverage.out -o=/test-results/coverage.html && \
+            GO111MODULE=on CGO_ENABLED=0 golangci-lint run -c ./.golangci.yaml ./cmd/... ./internal/...

Jenkinsfile

@@ -0,0 +1,7 @@
+@Library('jenkins-shared-libs@master') _
+
+olympus_ci(
+    // testImage is a Docker image that will be built and run as a test. It
+    // is not pushed anywhere as part of the build
+    testImage: "Dockerfile",
+)

Makefile

@@ -0,0 +1,26 @@
+# Copyright © 2021 VMware, Inc. All Rights Reserved.
+# SPDX-License-Identifier: MPL-2.0
+
+default: build
+
+build:
+	go build -o bin/terraform-provider-tmc ./cmd/main.go
+	mkdir -p ~/.terraform.d/plugins/vmware/tanzu/tmc/0.1.1/darwin_amd64/
+	cp bin/terraform-provider-tmc ~/.terraform.d/plugins/vmware/tanzu/tmc/0.1.1/darwin_amd64/
+
+test: | gofmt vet lint
+	go mod tidy
+	go test ./internal/... ./cmd/... -cover
+
+# Run go fmt against code
+gofmt:
+	@echo Checking code is gofmted
+	go fmt ./...
+
+# Run go vet against code
+vet:
+	go vet ./...
+
+# Linter
+lint: gofmt
+	golangci-lint run -c ./.golangci.yaml ./cmd/... ./internal/...

README.md

@@ -1,29 +1,39 @@
+# terraform-provider-tanzu
 
-# terraform-provider-tanzu-mission-control
+A custom provider for terraform CLI tool to manage TANZU resources.
 
-## Overview
+// usage/playgo (link to examples)
+# Use Cases of TMC Terraform Provider
+[use-cases]: https://gitlab.eng.vmware.com/olympus/terraform-provider-tanzu/examples
 
-## Try it out
+# Manual Installation
 
-### Prerequisites
+## Cloning the Project
 
-* Prereq 1
-* Prereq 2
-* Prereq 3
+First, you will want to clone the repository to
+`gitlab.eng.vmware.com/olympus/terraform-provider-tanzu`:
 
-### Build & Run
+```sh
+mkdir -p $GOPATH/src/gitlab.eng.vmware.com/olympus/terraform-provider-tanzu
+cd $GOPATH/src/gitlab.eng.vmware.com/olympus/terraform-provider-tanzu
+git clone git@gitlab.eng.vmware.com:olympus/terraform-provider-tanzu.git
+```
 
-1. Step 1
-2. Step 2
-3. Step 3
+## Building and Installing the Provider
 
-## Documentation
+Recommended golang version is go1.14 onwards.
+After the clone has been completed, you can enter the provider directory and build the provider.
 
-## Contributing
+```sh
+cd gitlab.eng.vmware.com/olympus/terraform-provider-tanzu
+make
+```
 
-The terraform-provider-tanzu-mission-control project team welcomes contributions from the community. Before you start working with terraform-provider-tanzu-mission-control, please
-read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be
-signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on
-as an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).
+After the build is complete, copy the provider executable `terraform-provider-tanzu` into location specified in your provider installation configuration. Make sure to delete provider lock files that might exist in your working directory due to prior provider usage. Run `terraform init`.
+For developing, consider using [dev overrides configuration][dev-overrides]. Please note that `terraform init` should not be used with dev overrides.
 
-## License
+[dev-overrides]: https://www.terraform.io/docs/cli/config/config-file.html#development-overrides-for-provider-developers
+
+## Utilising TMC provider
+
+Please refer to `examples` folder to perform CRUD operations with TMC provider for various resources

cmd/main.go

@@ -0,0 +1,18 @@
+/*
+Copyright © 2021 VMware, Inc. All Rights Reserved.
+SPDX-License-Identifier: MPL-2.0
+*/
+
+package main
+
+import (
+	"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
+
+	"gitlab.eng.vmware.com/olympus/terraform-provider-tanzu/internal/provider"
+)
+
+func main() {
+	plugin.Serve(&plugin.ServeOpts{
+		ProviderFunc: provider.Provider,
+	})
+}

examples/attach_cluster/attach_cluster.tf

@@ -0,0 +1,36 @@
+terraform {
+  required_providers {
+    tmc = {
+      source = "vmware/tanzu/tmc"
+    }
+  }
+}
+
+// Read TMC cluster : fetch cluster details
+data "tmc_cluster" "ready_only_attach_cluster_view" {
+  management_cluster_name = "attached"       // Default: attached
+  provisioner_name        = "attached"       // Default: attached
+  name                    = "terraform-test" // Required
+}
+
+// Create TMC attach cluster entry
+resource "tmc_cluster" "attach_cluster_without_apply" {
+  management_cluster_name = "attached"         // Default: attached
+  provisioner_name        = "attached"         // Default: attached
+  name                    = "terraform-attach" // Required
+
+  meta {
+    description = "create attach cluster from terraform"
+    labels      = { "key" : "value" }
+  }
+
+  spec {
+    cluster_group = "default" // Default: default
+  }
+
+  wait_until_ready = false
+}
+
+output "attach_output" {
+  value = tmc_cluster.attach_cluster_without_apply
+}

examples/cluster_group/cluster_group.tf

@@ -0,0 +1,42 @@
+terraform {
+  required_providers {
+    tmc = {
+      source = "vmware/tanzu/tmc"
+    }
+  }
+}
+
+// Create cluster group
+resource "tmc_cluster_group" "create_cluster_group" {
+  name = "tf-cluster-group"
+  meta {
+    description = "Create cluster group through terraform"
+    labels = {
+      "key1" : "value1",
+      "key2" : "value2"
+    }
+  }
+}
+
+// Create cluster group with minimal information
+resource "tmc_cluster_group" "create_cluster_group_min_info" {
+  name = "tf-cluster-group-min-info"
+}
+
+// Read TMC cluster group
+data "tmc_cluster_group" "read_cluster_group" {
+  name = "default"
+}
+
+// Output cluster group resource
+output "cluster_group" {
+  value = tmc_cluster_group.create_cluster_group
+}
+
+output "cluster_group_min_info" {
+  value = tmc_cluster_group.create_cluster_group_min_info
+}
+
+output "display_cluster_group" {
+  value = data.tmc_cluster_group.read_cluster_group
+}

examples/namespace/namespace.tf

@@ -0,0 +1,58 @@
+terraform {
+  required_providers {
+    tmc = {
+      source = "vmware/tanzu/tmc"
+    }
+  }
+}
+// Create namespace with attached set as default value.
+resource "tmc_namespace" "create_namespace" {
+  name                    = "tf-namespace" // Required
+  cluster_name            = "testcluster"  // Required
+  provisioner_name        = "attached"     // Default: attached
+  management_cluster_name = "attached"     // Default: attached
+
+  meta {
+    description = "Create namespace through terraform"
+    labels      = { "key" : "value" }
+  }
+
+  spec {
+    workspace_name = "default" // Default: default
+    attach         = false     // Default: false
+  }
+}
+
+// Create namespace with attached set as 'true'
+resource "tmc_namespace" "create_namespace_attached" {
+  name                    = "tf-namespace" // Required
+  cluster_name            = "testcluster"  // Required
+  provisioner_name        = "attached"     // Default: attached
+  management_cluster_name = "attached"     // Default: attached
+
+  meta {
+    description = "Create namespace through terraform"
+    labels      = { "key" : "value" }
+  }
+
+  spec {
+    workspace_name = "default" // Default: default
+    attach         = true
+  }
+}
+// Read TMC namespace : fetch namespace details
+data "tmc_namespace" "read_namespace" {
+  name                    = "tf-namespace" // Required
+  cluster_name            = "testcluster"  // Required
+  management_cluster_name = "attached"     // Default: attached
+  provisioner_name        = "attached"     // Default: attached
+}
+
+// Output namespace resource
+output "namespace" {
+  value = tmc_namespace.create_namespace
+}
+// Get namespace resource
+output "display_namespace" {
+  value = data.tmc_namespace.read_namespace
+}