Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
maxlaverse committed Nov 11, 2024
1 parent 70edc65 commit 059c70d
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 20 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
![Releases](https://img.shields.io/github/v/release/maxlaverse/terraform-provider-bitwarden?include_prereleases)
![Downloads](https://img.shields.io/badge/dynamic/json?color=7b42bc&label=Downloads&labelColor=black&logo=terraform&query=data.attributes.total&url=https%3A%2F%2Fregistry.terraform.io%2Fv2%2Fproviders%2F2657%2Fdownloads%2Fsummary&style=flat-square)

The Terraform Bitwarden provider is a plugin for Terraform that allows to manage different kind of Bitwarden resources from their [Password Manager] and [Secrets Manager] products.
The Terraform Bitwarden provider is a plugin for Terraform/OpenTofu that allows to manage different kind of Bitwarden resources from their [Password Manager] and [Secrets Manager] products.
This project is not associated with the Bitwarden project nor 8bit Solutions LLC.

**[Explore the docs »][Terraform Registry docs]**
Expand All @@ -21,10 +21,10 @@ This project is not associated with the Bitwarden project nor 8bit Solutions LLC

## Supported Versions
The plugin has been tested and built with the following components:
- [Terraform] v1.6.1 / [OpenTofu] v1.8.0
- [Bitwarden CLI] v2023.2.0 (if not using the experimental `embedded_client`)
- [Terraform] v1.9.8 / [OpenTofu] v1.8.0
- [Bitwarden CLI] v2023.2.0 (when not enabling the experimental `embedded_client` feature)
- [Go] 1.23.1 (for development)
- [Docker] 23.0.5 (for development)
- [Docker] 24.0.6 (for development)

The provider likely works with older versions but those haven't been tested.

Expand All @@ -37,7 +37,7 @@ terraform {
required_providers {
bitwarden = {
source = "maxlaverse/bitwarden"
version = ">= 0.10.0"
version = ">= 0.11.1"
}
}
}
Expand All @@ -46,9 +46,10 @@ terraform {
provider "bitwarden" {
email = "terraform@example.com"
# If you have the opportunity, you can try out the embedded client which removes the need
# for a locally installed Bitwarden CLI. Please note that this feature is still considered
# as experimental, might not work as expected, and is not recommended for production use.
# If you have the opportunity, you can try out the embedded client which
# removes the need for a locally installed Bitwarden CLI. Please note that
# this feature is still considered experimental and not recommended for
# production use.
#
# experimental {
# embedded_client = true
Expand Down
14 changes: 8 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,10 @@ terraform {
provider "bitwarden" {
email = "terraform@example.com"
# If you have the opportunity, you can try out the embedded client which removes the need
# for a locally installed Bitwarden CLI. Please note that this feature is still considered
# as experimental, might not work as expected, and is not recommended for production use.
# If you have the opportunity, you can try out the embedded client which
# removes the need for a locally installed Bitwarden CLI. Please note that
# this feature is still considered experimental and not recommended for
# production use.
#
# experimental {
# embedded_client = true
Expand Down Expand Up @@ -115,9 +116,10 @@ provider "bitwarden" {
client_id = "my-client-id"
client_secret = "my-client-secret"
# If you have the opportunity, you can try out the embedded client which removes the need
# for a locally installed Bitwarden CLI. Please note that this feature is still considered
# as experimental, might not work as expected, and is not recommended for production use.
# If you have the opportunity, you can try out the embedded client which
# removes the need for a locally installed Bitwarden CLI. Please note that
# this feature is still considered experimental and not recommended for
# production use.
#
# experimental {
# embedded_client = true
Expand Down
7 changes: 4 additions & 3 deletions examples/quick/provider.tf
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ terraform {
provider "bitwarden" {
email = "terraform@example.com"

# If you have the opportunity, you can try out the embedded client which removes the need
# for a locally installed Bitwarden CLI. Please note that this feature is still considered
# as experimental, might not work as expected, and is not recommended for production use.
# If you have the opportunity, you can try out the embedded client which
# removes the need for a locally installed Bitwarden CLI. Please note that
# this feature is still considered experimental and not recommended for
# production use.
#
# experimental {
# embedded_client = true
Expand Down
7 changes: 4 additions & 3 deletions templates/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,10 @@ provider "bitwarden" {
client_id = "my-client-id"
client_secret = "my-client-secret"

# If you have the opportunity, you can try out the embedded client which removes the need
# for a locally installed Bitwarden CLI. Please note that this feature is still considered
# as experimental, might not work as expected, and is not recommended for production use.
# If you have the opportunity, you can try out the embedded client which
# removes the need for a locally installed Bitwarden CLI. Please note that
# this feature is still considered experimental and not recommended for
# production use.
#
# experimental {
# embedded_client = true
Expand Down

0 comments on commit 059c70d

Please sign in to comment.