Skip to content

Commit

Permalink
version 0.1.4
Browse files Browse the repository at this point in the history
  • Loading branch information
idimov-keeper committed Oct 1, 2021
1 parent 92029e1 commit 85bca27
Show file tree
Hide file tree
Showing 25 changed files with 17 additions and 44 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,12 @@ $ ksm secret get -u [UID]
```

### Plugin configuration
- Keeper credential could be generated with `ksm profile init` command, read from file, or sourced from the `KEEPER_CREDENTIAL` environment variable.
- Keeper credential could be generated with `ksm profile init` command, read from file, or sourced from the `KEEPER_CREDENTIAL` environment variable.
Generate `credential` using Commander CLI
```
sm client add --app <APP_NAME> --unlock-ip --config-init=b64
```
`main.tf`
```
terraform {
required_providers {
Expand Down Expand Up @@ -76,7 +81,7 @@ To run the [acceptance tests](https://www.terraform.io/docs/extend/testing/accep

The acceptance tests expect to find certain records shared to your application - use the script below to create and populate shared folder named `tf_acc_test_dir` with the required records (_use_ [Keeper Commander CLI](https://docs.keeper.io/secrets-manager/commander-cli))

_Note:_ If you get **throttled** sumply re-run the same command again (_and ignore any_ `'...already exists'` _messages on consecutive runs_)
_Note:_ If you get **throttled** simply re-run the same command again (_and ignore any_ `'...already exists'` _messages on consecutive runs_)

`keeper tf_acc_test.cmd --batch-mode`

Expand Down Expand Up @@ -161,14 +166,14 @@ MacOS:
```bash
mkdir -p ~/.terraform.d/plugins/github.com/keeper-security/keeper && \
cd ~/.terraform.d/plugins/github.com/keeper-security/keeper && \
curl -SfL https://github.com/keeper-security/terraform-provider-keeper/releases/latest/download/terraform-provider-keeper_1.0.0_darwin_amd64.zip
curl -SfLOJ https://github.com/keeper-security/terraform-provider-keeper/releases/latest/download/terraform-provider-keeper_1.0.0_darwin_amd64.zip
```
Windows:
```bash
SETLOCAL EnableExtensions && \
mkdir %APPDATA%\.terraform.d\plugins\github.com\keeper-security\keeper && \
cd %APPDATA%\.terraform.d\plugins\github.com\keeper-security\keeper && \
curl -SfL https://github.com/keeper-security/terraform-provider-keeper/releases/latest/download/terraform-provider-keeper_1.0.0_windows_amd64.zip
SETLOCAL EnableExtensions && ^
mkdir %APPDATA%\.terraform.d\plugins\github.com\keeper-security\keeper && ^
cd %APPDATA%\.terraform.d\plugins\github.com\keeper-security\keeper && ^
curl -SfLOJ https://github.com/keeper-security/terraform-provider-keeper/releases/latest/download/terraform-provider-keeper_1.0.0_windows_amd64.zip
```
Have a look at some working [examples](./examples) in this repo.

Expand Down
14 changes: 1 addition & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,7 @@ You can set environment variable `KEEPER_CREDENTIAL` or read it from disk using

### Manual Install

Get the latest version of the Terraform Provider from [GitHub](https://github.com/keeper-security/terraform-provider-keeper) as a single [zip](https://github.com/Keeper-Security/terraform-provider-keeper/releases) archive or clone with git
```git
git clone https://github.com/keeper-security/terraform-provider-keeper
```
Build
```
go build
```
Copy plugin to Terraform plugin folder
```bash
cp terraform-provider-keeper ~/.terraform.d/plugins/terraform-provider-keeper_v0.1.0
```
Note: Default plugin path is %APPDATA%\terraform.d\plugins for Windows and ~/.terraform.d/plugins for all other operating systems.
Download archive from [latest release](https://github.com/keeper-security/terraform-provider-keeper/releases/latest) for your platform and copy it to the corresponding plugin folder (_Linux and MacOS:_ `~/.terraform.d/plugins/github.com/keeper-security/keeper` _Windows:_ `%APPDATA%/terraform.d/plugins/github.com/keeper-security/keeper`)

For help on manually installing Terraform Providers, please refer to the [official Terraform documentation](https://www.terraform.io/docs/configuration/providers.html#third-party-plugins).

Expand Down
1 change: 0 additions & 1 deletion examples/address.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/bank_account.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/bank_card.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/birth_certificate.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/contact.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/database_credentials.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/driver_license.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/encrypted_notes.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/field.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/file.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/general.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/health_insurance.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/login.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/membership.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/passport.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/photo.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/server_credentials.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/software_license.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/ssh_keys.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
1 change: 0 additions & 1 deletion examples/ssn_card.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
terraform {
required_version = ">= 1.0.0"
required_providers {
keeper = {
source = "github.com/keeper-security/keeper"
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ go 1.17

require (
github.com/hashicorp/terraform-plugin-sdk/v2 v2.7.1
github.com/keeper-security/secrets-manager-go/core v0.3.0
github.com/keeper-security/secrets-manager-go/core v0.4.0
)

require (
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,8 @@ github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af/go.mod h1:Nht
github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU=
github.com/jstemmer/go-junit-report v0.9.1 h1:6QPYqodiu3GuPL+7mfx+NwDdp2eTkp9IfEUpgAwUN0o=
github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk=
github.com/keeper-security/secrets-manager-go/core v0.3.0 h1:YuAmmdg73c02dni1wd1oLIPfjxYrEbt1ApBuvFlYBD4=
github.com/keeper-security/secrets-manager-go/core v0.3.0/go.mod h1:9FumYHNubSTnWEjomdScEnEAWgmPnzTj4nSvT0sHNEY=
github.com/keeper-security/secrets-manager-go/core v0.4.0 h1:rS+SznH4xm4mdVgqyWPDc0MHUClDhYsrsJcAybJ9tXA=
github.com/keeper-security/secrets-manager-go/core v0.4.0/go.mod h1:dtlaeeds9+SZsbDAZnQRsDSqEAK9a62SYtqhNql+VgQ=
github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351 h1:DowS9hvgyYSX4TO5NpyC606/Z4SxnNYbT+WX27or6Ck=
github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
Expand Down
2 changes: 1 addition & 1 deletion keeper/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ func Provider() *schema.Provider {
Schema: map[string]*schema.Schema{
"credential": {
Type: schema.TypeString,
Required: true,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("KEEPER_CREDENTIAL", nil),
Description: "Credential to use for Secrets Manager authentication. Can also be sourced from the `KEEPER_CREDENTIAL` environment variable.",
},
Expand Down

0 comments on commit 85bca27

Please sign in to comment.