cd /path/terraform-provider-conformity

go mod tidy
go mod vendor

# ...
VERSION=0.6 # Set a new version
OS_ARCH=darwin_amd64 # Update to value that matches with your OS
# ...

make install

terraform {
  required_providers {
    conformity = {
      version = "YOUR_VERSION"

      # Set path to match with values in HOSTNAME/NAMESPACE/NAME defined in the Makefile
      source  = "trendmicro.com/cloudone/conformity" 
    }
  }
}

cd example/path-to-main/
terraform init
terraform apply

Notes:

• for your own config, create a file name terraform.tfvars
• add the following:

region  = "region"
apikey  = "apikey"

Turn on debug:

export TF_LOG_CORE=TRACE
export TF_LOG_PROVIDER=TRACE

• when you are testing, you can set environment variable CONFORMITY_API_URL to match your testing API url; otherwise it will use default official API url.

1. Make sure you installed the "Go for Visual Studio Code" extension which will install the golang debug tool dlv for you
2. Make sure you created the correct section in .vscodelaunch.json

{
  "name": "Debug - Attach External CLI",
  "type": "go",
  "request": "launch",
  "mode": "debug",
  // this assumes your workspace is the root of the repo
  "program": "${workspaceFolder}",
  "internalConsoleOptions": "openOnSessionStart",
  "env": {},
  "args": [
      // pass the debug flag for reattaching
      "-debug",
  ],
}

3. Before you start debugging you need update some files:

• Update the getUrl function in pkg/cloudconformity/client.go to make it return the API endpoint you want to test with for example:

return "https://ap-southeast-2-development.cloudconformity.com/api/", nil

• Make sure your test template uses provider config

terraform {
  required_providers {
    conformity = {
      source = "trendmicro/conformity"
      ...
    }
  }
}

4. Start debugging in vscode

• Look at the vscode "DEBUG CONSOLE", the dlv will output the TF_REATTACH_PROVIDERS environment variable

5. Set the breakpoints and run terrafrom commands in the terminal

Create a file name terraform.tfvars and add all necessary variables here

Ensure terraform.tfvars is included in .gitignore so these secrets are not accidentally pushed to a remote git repository.

Terraform provides a way of reading variables from the environment: https://www.terraform.io/docs/cli/config/environment-variables.html#tf_var_name

Use the Doc Preview Tool to understand how the markdown will look once released. The Provider Documentation can also provide further guidance.

After releasing, a webhook will be sent to Terraform registry automatically. Within about 10 minutes https://registry.terraform.io/providers/trendmicro/conformity/latest/docs should be updated with the new release from Github.