terraform-provider-pleasantpassword

README

Pleasant Password Server Provider (Terraform Plugin Framework)

Requirements

• Terraform >= 1.0
• Go >= 1.19

Building The Provider

1. Clone the repository

git clone git@github.com:theochita/terraform-provider-pleasantpassword.git

1. Enter the repository directory

cd terraform-provider-pleasantpassword/

1. Build the provider using the Go install command:

go install

Terraform allows you to use local provider builds by setting a dev_overrides block in a configuration file called .terraformrc. This block overrides all other configured installation methods.

Terraform searches for the .terraformrc file in your home directory and applies any configuration settings you set.

provider_installation {

  dev_overrides {
      "registry.terraform.io/theochita/pleasantpassword" = "<PATH>"
  }

  # For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, Terraform will _only_ use
  # the dev_overrides block, and so no other providers will be available.
  direct {}
}

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using the provider

terraform {
  required_providers {
    pleasantpassword = {
      source = "hashicorp.com/theochita/pleasantpassword"
    }
  }
}

provider "pleasantpassword" {
  server_url = "localhost:10001"
  username = var.pps_username
  password = var.pps_pwd
  allow_insecure = "true"
}

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

make testacc