Skip to content

Commit

Permalink
Add 'Use with 1Password CLI' section in the documentation
Browse files Browse the repository at this point in the history
'Use with 1Password CLI' section contains the information about retries and how to authenticate CLI with service account or user account
  • Loading branch information
volodymyrZotov committed Dec 8, 2023
1 parent eff8d2e commit b83c776
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
13 changes: 7 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,21 @@ and [1Password CLI](https://developer.1password.com/docs/cli).
You must install [1Password CLI](https://developer.1password.com/docs/cli) on the machine running Terraform to use it. Refer to the
[Terraform documentation](https://developer.hashicorp.com/terraform/cloud-docs/run/install-software#only-install-standalone-binaries) to learn how to install 1Password CLI on Terraform Cloud.

## Authenticate CLI with service account
## Use with 1Password CLI

To authenticate CLI with service account, set `service_account_token` in the provider configuration.

Retry mechanism is implemented when using provider with service account. Each retry fast forwards to the [service account rate limit](https://developer.1password.com/docs/service-accounts/rate-limits/).
Retry mechanism is implemented when using the provider with 1Password CLI. The reason for having a retry mechanism is that 1Password doesn't allow parallel modification on the items located in the same vault.
Note that each retry fast forwards to the [service account rate limit](https://developer.1password.com/docs/service-accounts/rate-limits/) if use with service account.

It's recommended to limit the number of parallel resource operations. It can be done by using `-parallelism=n` flag when running `terraform apply`, where `n` is the number of parallel resource operations (the default is `10`).
```
terraform apply `-parallelism=n`
```

The reason for having a retry mechanism is that 1Password doesn't allow parallel modification on the items located in the same vault.
### Authenticate CLI with service account

To authenticate CLI with service account, set `service_account_token` in the provider configuration.

## Authenticate the CLI with user account using biometric unlock
### Authenticate the CLI with user account using biometric unlock

To authenticate the CLI with user account using biometric unlock:
1. [Turn on the app integration](https://developer.1password.com/docs/cli/app-integration/#step-1-turn-on-the-app-integration)
Expand Down
13 changes: 7 additions & 6 deletions templates/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,21 @@ and [1Password CLI](https://developer.1password.com/docs/cli).
You must install [1Password CLI](https://developer.1password.com/docs/cli) on the machine running Terraform to use it. Refer to the
[Terraform documentation](https://developer.hashicorp.com/terraform/cloud-docs/run/install-software#only-install-standalone-binaries) to learn how to install 1Password CLI on Terraform Cloud.

## Authenticate CLI with service account
## Use with 1Password CLI

To authenticate CLI with service account, set `service_account_token` in the provider configuration.

Retry mechanism is implemented when using provider with service account. Each retry fast forwards to the [service account rate limit](https://developer.1password.com/docs/service-accounts/rate-limits/).
Retry mechanism is implemented when using the provider with 1Password CLI. The reason for having a retry mechanism is that 1Password doesn't allow parallel modification on the items located in the same vault.
Note that each retry fast forwards to the [service account rate limit](https://developer.1password.com/docs/service-accounts/rate-limits/) if use with service account.

It's recommended to limit the number of parallel resource operations. It can be done by using `-parallelism=n` flag when running `terraform apply`, where `n` is the number of parallel resource operations (the default is `10`).
```
terraform apply `-parallelism=n`
```

The reason for having a retry mechanism is that 1Password doesn't allow parallel modification on the items located in the same vault.
### Authenticate CLI with service account

To authenticate CLI with service account, set `service_account_token` in the provider configuration.

## Authenticate the CLI with user account using biometric unlock
### Authenticate the CLI with user account using biometric unlock

To authenticate the CLI with user account using biometric unlock:
1. [Turn on the app integration](https://developer.1password.com/docs/cli/app-integration/#step-1-turn-on-the-app-integration)
Expand Down

0 comments on commit b83c776

Please sign in to comment.