terraform-provider-onepassword icon indicating copy to clipboard operation
terraform-provider-onepassword copied to clipboard

Documentation for first time users.

Open a-nldisr opened this issue 2 years ago • 5 comments

Currently reviewing the integration with Terraform and documentation could be better to get new users to this provider started.

When trying to find documentation on your website about this provider it points to this page, there seems to be no other documentation? This page is not enough unfortunately.

Example from documentation:

  vault = var.demo_vault
  uuid  = onepassword_item.demo_sections.uuid
}

When I would use the onepassword_item resource I wouldn't need the data object since I can directly use the outputs from the resource, data objects are meant to be used when the item is outside of terraform. Is there a way to find the UUID for objects that have not been created through Terraform? Please document getting the UUID.

When performing a terraform init I get:

│ Error: Invalid provider configuration
│ 
│ Provider "registry.terraform.io/1password/onepassword" requires explicit
│ configuration. Add a provider block to the root module and configure the
│ provider's required arguments as described in the provider documentation.
│ 
╵
╷
│ Error: URL for Connect API is not set. Either provide the "url" field in the provider configuration or set the OP_CONNECT_HOST environment variable
│ 
│   with provider["registry.terraform.io/1password/onepassword"],
│   on <input-prompt> line 1:
│   (source code not available)

Some documentation on how to get this URL would be helpful or basic info about the requirement for the Connect API would be nice. What I understand so far is that you need to create a connect server, pointing someone to this documentation on how to set this up would help. Initially, I tried to set this server up through the op CLI without success, from the documentation I gathered that this is not the way to do this and docker-compose / AWS / helm charts are the easiest way to get this. Is there a public API connect URL we could use as an alternative?

  A valid token for your 1Password Connect API. Can also be sourced from OP_CONNECT_TOKEN.

Some documentation could be helpful on how to generate this token.

Not a support question, just a request to document your provider.

a-nldisr avatar May 19 '22 16:05 a-nldisr